Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Manual. Switch to the latest stable version.
Nodetool backup¶
backup - Copy SSTables from a specified keyspace’s snapshot to a designated bucket in object storage
Note that status of backup can be checked for user_task_ttl seconds after the operation is done.
You can set the ttl using nodetool tasks user-ttl.
If --nowait flag is not set, the command relies on user_task_ttl internally.
Syntax¶
nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)] backup
--keyspace <keyspace> --table <table>
[--snapshot <snapshot>]
--endpoint <endpoint> --bucket <bucket> --prefix <prefix>
[--nowait]
[--move-files]
Example¶
nodetool backup --endpoint s3.us-east-2.amazonaws.com --bucket bucket-foo --prefix foo/bar/baz --keyspace ks --table table --snapshot ss --move-files
Options¶
-h <host>or--host <host>- Node hostname or IP address.--keyspace- Name of a keyspace to copy SSTables from--table- Name of a table to copy SSTables from--snapshot- Name of a snapshot to copy sstables from--endpoint- Name of the configured object storage endpoint to copy SSTables to. This should be configured as per the object storage configuration instructions.--bucket- Name of the bucket to backup SSTables to--prefix- Prefix to backup SSTables to--nowait- Don’t wait on the backup process--move-files- Move files instead of copying them. This will delete the files from the local disk after they are uploaded to the object storage.
Nodetool cluster backup¶
cluster backup - Copy SSTables from a specified snapshot to a designated bucket in object storage
Note that status of backup can be checked for user_task_ttl seconds after the operation is done.
You can set the ttl using nodetool tasks user-ttl.
If --nowait flag is not set, the command relies on user_task_ttl internally.
Syntax¶
nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)] cluster backup
[--keyspaces <keyspace>]...
[--table <table>[,<table>...]]
[(-s <snapshot> | --snapshot <snapshot>)]
(-l | --location) <dc>,<endpoint>,<bucket>[,<prefix>]
[(-l | --location) <dc2>,<endpoint2>,<bucket2>[,<prefix2>]]...
[--nowait]
[--move-files]
Example¶
nodetool cluster backup --location mydc,s3.us-east-2.amazonaws.com,bucket-foo,foo/bar/baz --keyspaces ks --table table --snapshot ss --move-files
Options¶
-h <host>or--host <host>- Node hostname or IP address.--keyspaces- Keyspace to back up. Repeat for each keyspace. If omitted, all keyspaces are backed up.--table- Table(s) to back up, multiple ones can be joined with,. Requires exactly one keyspace to be specified.-sor--snapshot- Name of the snapshot to back up. It is created if it does not exist. If omitted, a new snapshot, named after the current timestamp, is taken.-lor--location- Tuple of <dc>,<endpoint>,<bucket> and optional <prefix> which to write the backup to. Required; repeat it for each DC. Endpoints should be configured as per the object storage configuration instructions.--nowait- Don’t wait on the backup process--move-files- Move files instead of copying them. This will delete the files from the local disk after they are uploaded to the object storage.
See also