sstableupgrade
Upgrades the SSTables in the given table or snapshot to the current version of DataStax Enterprise (DSE) while the DSE node is offline.
|
Stop DSE before you run this command. |
The default location of this SSTable tool depends on the type of installation:
-
Package installations:
/usr/bin/ -
Tarball installations:
INSTALL_DIRECTORY/resources/cassandra/tools/bin
Synopsis
sstableupgrade
[--debug]
[-h | --help]
[[-k | --keep-source] | --keep-generation]
[-b | --backups]
[-o | --output-dir <output-dir>]
[--schema <schema-file> [--schema <schema-file2> ... ]]
[--sstable-files <sstable>]
[-t | --throughput <rate-limit>]
[--temp-storage <tmp-dir>]
<keyspace_name> <table_name>
[snapshot_name]SSTable compatibility
For details on SSTable versions and compatibility, see DSE product compatibility.
Options
If an option has a short and long form, both forms are given, separated by a comma.
- --debug
-
Display stack traces.
- -h, --help
-
Display the usage and listing of the commands.
- -k, --keep-source
-
Do not delete the source SSTables. Do not use with the
--keep-generationoption. - -b, --backups
-
Rewrite incremental backups for the given table. Cannot be combined with the
snapshot_nameoption. - --keep-generation
-
Keep the generated SSTables. Do not use with the
--keep-sourceoption. - -o, --output-dir
-
Rewritten files are placed in
output-dirin subdirectories named after the keyspace and table:OUTPUT_DIR/KEYSPACE_NAME/TABLE_NAME_UUID. - --schema
-
Allows upgrading and downgrading SSTables using the schema of the table in a CQL file containing the DDL statements to re-create the schema. Must be a DDL file that allows the recreation of the table including dropped columns. Repeat the option to specify multiple DDL schema files.
Always use the
schema.cqlfrom a snapshot of the table so that the DDL has all of the information omitted byDESCRIBE TABLE, including dropped columns. - --sstable-files
-
Instead of processing all SSTables in the default data directories, process only the tables specified via this option. If a single SSTable file, only that SSTable is processed. If a directory is specified, all SSTables within that directory are processed. Snapshots and backups are not supported with this option.
- -t, --throughput
-
Set to limit the maximum disk read rate in MB per second
- --temp-storage
-
When used with
--schema, specifies location of temporary data. Directory and contents are deleted when the tool terminates. Directory must not be shared with other tools and must be empty. If not specified the default directory is/tmp. - keyspace_name
-
Keyspace name. Required.
- table_name
-
Table name. Required.
- snapshot_name
-
Snapshot name. Rewrites only the specified snapshot. Replaces files in the given snapshot and breaks any hard links to live SSTables.
Required when before attempting to restore a snapshot taken in a different DSE version than the one that is currently running.
Examples
Upgrade events table in the cycling keyspace:
sstableupgrade cycling eventsFound 0 sstables that need upgrading.The SSTables are already on the current version, so the command returns immediately and no action is taken.
