sstableupgrade

Upgrades the SSTables in the given table or snapshot to the current version of Cassandra.

cassandra.yaml

The location of the cassandra.yaml file depends on the type of installation:
Package installations /etc/dse/cassandra/cassandra.yaml
Tarball installations installation_location/resources/cassandra/conf/cassandra.yaml

Upgrades the SSTables in the given table or snapshot to the current version of Cassandra.

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]
Table 1. SSTable compatibility and upgrade version
DSE version SSTable sstableloader supported format-version sstableupgrade and nodetool upgradesstables supported format-version
format version
6.7.x bti aa big-ma, big-mb, big-mc, and bti-aa big-ma, big-mb, and big-mc
6.0.x
5.1.x big mc big-ka, big-ma, big-mb, and big-mc big-ka, big-ma, and big-mb
5.0.x
5.0.x mb big-ka, big-ma, and big-mb big-ka and big-ma
5.0.x ma big-ka and big-ma big-k* only

Definition

The short form and long form parameters are comma-separated.

Command arguments

--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-generation option.
-b, --backups
Rewrite incremental backups for the given table. May not be combined with the snapshot_name option.
--keep-generation
Keep the generated SSTables. Do not use with the --keep-source option.
-o, --output-dir
Rewritten files are placed in output-dir/keyspace-name/table-name-and-id.
--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.
Important: Always use the schema.cql from a snapshot of the table so that the DDL has all of the information omitted by DESCRIBE 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/s.
--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. Overrides the client_encryption_options in cassandra.yaml.
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 events
Found 0 sstables that need upgrading.

The SSTables are already on the current version, so the command returns immediately and no action is taken.