ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for an unstable version of Scylla Manager. Switch to the latest stable version.

ScyllaDB Docs Scylla Manager CLI sctool Download files

Download files¶

Scylla Manger Agent comes with a download-files subcommand that given a backup location can be used to:

  1. List clusters, datacenters and nodes.

  2. Search for snapshot tags.

  3. Download files without a need for third-party tools.

Please note, that the command may require higher demand on the number of file descriptors. We recommend prefixing this command with ulimit to extend the default fd soft limit.

ulimit -n 10000

Download-files¶

Syntax:

scylla-manager-agent download-files --location <backup location> [OPTION]...

parameters¶

--clear-tables¶

Remove sstables before downloading


-c, --config-file path¶

Configuration file path, you can specify the flag multiple times to overwrite configuration options.

Default: /etc/scylla-manager-agent/scylla-manager-agent.yaml


-d, --data-dir path¶

Path to Scylla data directory (typically /var/lib/scylla/data) or other directory to use for downloading the files.

Default: current directory


--debug¶

Enable debug logs.

Default: current directory


--dry-run¶

Validate and print a plan without downloading (or clearing) any files.


--dump-manifest¶

Print Scylla Manager backup manifest as JSON.


--dump-tokens¶

Print list of tokens from the manifest.


-K, --keyspace list¶

A comma-separated list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’.


--list-nodes¶

Print list of nodes including cluster name and node IP, this command would help you find nodes you can restore data from.


--list-snapshots¶

Print list of snapshots of the specified node, this also takes into account keyspace filter and returns only snapshots containing any of requested keyspaces or tables, newest snapshots are printed first.


-L, --location string¶

Backup location in the format <provider>:<name> e.g. s3:my-bucket, the supported providers are: s3, gcs, azure.


--mode upload, sstableloader¶

Mode changes resulting directory structure, supported values are: upload, sstableloader, set ‘upload’ to use table upload directories, set ‘sstableloader’ for <keyspace>/<table> directories layout.


-n, --node ID¶

‘Host ID’ value from nodetool status command output of a node you want to restore.

Default: local node


-p, --parallel int¶

How many files to download in parallel.

Default: 8


--rate-limit int¶

Rate limit in megabytes (MiB) per second.

Default: no limit


-T, --snapshot-tag tag¶

Scylla Manager snapshot tag as read from backup listing e.g. sm_20060102150405UTC, use –list-snapshots to get a list of snapshots of the node.

Was this page helpful?

PREVIOUS
Completion
NEXT
Backup
Scylla Manager
  • master
    • master
    • 3.2
    • 3.1
    • 3.0
    • 2.6
    • 2.5
    • 2.4
    • 2.3
    • 2.2
  • Docker
  • Install ScyllaDB Manager
  • Install ScyllaDB Manager Agent
  • ScyllaDB Manager Upgrade
  • Add a Cluster
  • Backup
    • Setup Amazon S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Restore tables
    • Restore schema
    • Examples
    • Compatibility Matrix
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Environment variables
    • Completion
    • Download files
    • Backup
    • Restore
    • Cluster
    • Info
    • Progress
    • Repair
    • Start
    • Status
    • Stop
    • Suspend & Resume
    • Tasks
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • ScyllaDB Monitoring
  • Troubleshooting
  • Slack
  • Create an issue
  • Edit this page

On this page

  • Download files
    • Download-files
      • parameters
        • --clear-tables
        • -c, --config-file path
        • -d, --data-dir path
        • --debug
        • --dry-run
        • --dump-manifest
        • --dump-tokens
        • -K, --keyspace list
        • --list-nodes
        • --list-snapshots
        • -L, --location string
        • --mode upload, sstableloader
        • -n, --node ID
        • -p, --parallel int
        • --rate-limit int
        • -T, --snapshot-tag tag
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 26 September 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.5.1