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] [-k] keyspace_name table_name [snapshot_name]
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a valid option or user-defined value.
[ ] Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key:value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement;End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[ -- ] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.
Table 2. 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.
keyspace_name
Keyspace name. Required. Overrides the client_encryption_options in cassandra.yaml.
snapshot_name
Snapshot name.
  • Upgrades the specified snapshot before restoring a snapshot from a major version older than the currently running major Cassandra version.
  • Replaces files in the given snapshot and breaks any hard links to live SSTables.
table_name
Table name. Required.

Examples

Upgrade events table on 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.