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
ScyllaDB Docs Scylla Manager Restore

Restore¶

  • Restore types

  • Features

  • Restore speed and granularity

The sctool restore command allows you to run a restore of backed-up data (identified by its snapshot-tag) into a cluster. Restore and backups are scheduled in the same manner: you can start, stop, resume, and track task progress on demand.

Note

Restore procedure works with any cluster topologies, so backed-up cluster can have different number of nodes than restore destination cluster.

Restore types¶

Restore task has to be one of two types:

  • restore tables - restores the content of the tables (rows)

  • restore schema - restores the ScyllaDB cluster schema

Each of those types has required prerequisites and follow-up actions. For more information, please read given restore type documentation.

If both the schema and the content of the tables need to be restored, you must start with restoring the schema. Only after the schema is successfully restored can you proceed with restoring the content of the tables.

Features¶

ScyllaDB Manager Restore command supports the following features:

  • Glob patterns to select keyspaces or tables to restore

  • Control over the restore speed and granularity

  • Dry run - Test restore before live execution

  • Progress tracking (sctool progress, Prometheus metrics, Scylla Monitoring Manager dashboard)

  • Pausing and resuming at any point of the process

Restore speed and granularity¶

Restore speed is controlled by two parameters: --parallel and --batch-size. Parallel specifies how many nodes can be used in restore procedure at the same time. Batch size specifies how many SSTable bundles can be restored from backup location in a single job. Those parameters can be set when you:

  • Schedule a restore with sctool restore

  • Update a restore specification with sctool restore update

Was this page helpful?

PREVIOUS
Specification
NEXT
Restore tables
Scylla Manager
  • 3.1
    • master
    • 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

  • Restore
    • Restore types
    • Features
    • Restore speed and granularity
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 07 June 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.5.1