Caution

You're viewing documentation for a previous version of ScyllaDB Enterprise. Switch to the latest stable version.

ScyllaDB Docs ScyllaDB Enterprise ScyllaDB for Administrators Admin Tools Nodetool Nodetool scrub

Nodetool scrub¶

NAME¶

scrub - Scrub the SSTable files in the specified keyspace or table(s)

SYNOPSIS¶

nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)]
     [(-pp | --print-port)] [(-pw <password> | --password <password>)]
     [(-pwf <passwordFilePath> | --password-file <passwordFilePath>)]
     [(-ns | --no-snapshot)]
     [(-s | --skip-corrupted)]
     [(-m <scrub_mode> | --mode <scrub_mode>)]
     [--] <keyspace> [<table...>]

Added in version version: 4.6 scrub mode

Supported scrub modes: ABORT, SKIP, SEGREGATE, VALIDATE

OPTIONS¶

Parameter	Description
-ns / –no-snapshot	Do not take a snapshot of all scrubbed tables before starting scrub (default false).
-s / –skip-corrupted	Skip corrupted rows or partitions even when scrubbing counter tables. (Deprecated, use ‘–mode’ instead. default false)
-m <scrub_mode> / –mode <scrub_mode>	How to handle corrupt data (one of: ABORT\|SKIP\|SEGREGATE\|VALIDATE, default ABORT; overrides ‘–skip-corrupted’)

-- This option can be used to separate command-line options from the list of argument, (useful when arguments might be mistaken for command-line options.

<keyspace> The keyspace to scrub.

[<table...>] Optional. One or more tables to scrub. By default, all tables in the keyspace are scrubbed.

SCRUB MODES¶

Scrub mode	Description
ABORT	Abort scrubbing when the first validation error occurs. (default).
SKIP	Skip corrupted rows or partitions. (equivalent to the legacy –skip-corrupted option).
SEGREGATE	Sort out-of-order rows or partitions by segregating them into additional SSTables.
VALIDATE	Read-only mode: report any corruptions found while scrubbing but do not fix them. By default, corrupt SSTables are moved into a “quarantine” subdirectory so they will not be subject to compaction.

Examples¶

Scrub all tables in a keyspace (mykeyspace)

> nodetool scrub mykeyspace

Scrub a specific table (mytable) in a keyspace (mykeyspace)

> nodetool scrub mykeyspace mytable

Scrub a specific table (mytable) in a keyspace (mykeyspace) in SEGREGATE mode

> nodetool scrub -m SEGREGATE mykeyspace mytable

Scrub a specific table (mytable) in a keyspace (mykeyspace) in VALIDATE mode without taking a preliminary snapshot

> nodetool scrub -m VALIDATE --no-snapshot mykeyspace mytable

Apache®, Apache Cassandra®, Cassandra®, the Apache feather logo and the Apache Cassandra® Eye logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. No endorsement by The Apache Software Foundation is implied by the use of these marks.

Was this page helpful?