ScyllaDB University LIVE, FREE Virtual Training Event | March 21
Register for Free
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Open Source ScyllaDB for Administrators Admin Tools SSTableLoader

Caution

You're viewing documentation for a previous version. Switch to the latest stable version.

SSTableLoader¶

Bulk loads SSTables from a directory to a ScyllaDB cluster via the CQL API.

Note

This tool is different than Apache Cassandra’s sstableloader, which uses an internal RPC protocol to load data.

Note

sstableloader does not support loading from encrypted files. For restoring data from encrypted files, see Migration to ScyllaDB.

Note

ScyllaDB does not support local counters used by Apache Cassandra 2.0. If you are migrating from Cassandra 2.0 or a later Cassandra version upgraded from 2.0, using SSTableLoader to migrate local counters to ScyllaDB will not work.

ScyllaDB supports global counters, which are used by Cassandra 2.1 and later.

SSTableLoader can be used to restore data from ScyllaDB or Apache Cassandra backups or to clone data from cluster to cluster. It is especially useful when the number of nodes or token range distribution between the source and target cluster are not the same. ScyllaDB takes care of distributing the data via the CQL API.

See Apache Cassandra to ScyllaDB Migration Process for an example of usage.

Usage¶

sstableloader [options] <dir_path>

Bulk loads the SSTables found in the specified directory (<dir_path>) to the configured cluster. The parent directories of <dir_path> are used as the target keyspace/table name. For instance, to load an SSTable named Standard1-g-1-Data.db into Keyspace1/Standard1, you will need to have the files Standard1-g-1-Data.db and Standard1-g-1-Index.db in the /path/to/Keyspace1/Standard1/ directory.

Parameters¶

  • -alg,--ssl-alg <ALGORITHM> - Client SSL: algorithm (default: SunX509).

  • -bs,--batch-size <Number of bytes above which batch is being sent out> - Does not work with -nb.

  • -ciphers,--ssl-ciphers <CIPHER-SUITES> - Client SSL: comma-separated list of encryption suites to use.

  • -cl,--consistency-level <consistency level (default: ONE)> - Sets the consistency level for statements.

  • -cph,--connections-per-host <connectionsPerHost> - Number of concurrent connections-per-host.

  • -d,--nodes <initial hosts> - Required. Try to connect to these hosts (comma separated) initially for ring information.

  • -f,--conf-path <path to config file> - Path to cassandra.yaml file for streaming throughput and client/server SSL.

  • -g,--ignore-missing-columns <COLUMN NAMES...> - Ignores the specified missing columns in tables.

  • -h,--help - Displays this help message.

  • -i,--ignore <NODES> - Comma-separated list of nodes to ignore (not to stream to).

  • -ic,--ignore-dropped-counter-data - Ignores dropping local and remote counter shard data.

  • -ir,--no-infinite-retry - Disables infinite retry policy.

  • -j,--threads-count <Number of threads to execute tasks> - Runs tasks in parallel.

  • -ks,--keystore <KEYSTORE> - Client SSL: full path to keystore.

  • -kspw,--keystore-password <KEYSTORE-PASSWORD> - Client SSL: password of the keystore

  • -nb,--no-batch - Prevents using batch statement updates for the same partition key.

  • --no-progress - Prevents displaying progress.

  • -nx,--no-prepared - Prevents using prepared statements.

  • -p,--port <port> - Port used for connections (default: 9042).

  • -prtcl,--ssl-protocol <PROTOCOL> - Client SSL: connections protocol to use (default: TLS).

  • -pt,--partitioner <class> - Partitioner type to use, defaults to the cluster value.

  • -pw,--password <password> - Password for ScyllaDB authentication.

  • -s,--ssl <SSL> - Enables using the SSL connection(s).

  • -sim,--simulate - simulate. Only print CQL generated

  • -st,--store-type <STORE-TYPE> - Client SSL: type of store.

  • -t,--throttle <throttle> - Throttles the speed in Mbits (unlimited by default).

  • -tr,--token-ranges <<lo>:<hi>,...> - Imports only partitions that satisfy lo < token(partition) <= hi.

  • -translate,--translate <mapping list> - Comma-separated list of column name mappings.

  • -ts,--truststore <TRUSTSTORE> - Client SSL: full path to truststore.

  • -tspw,--truststore-password <TRUSTSTORE-PASSWORD> - Client SSL: password to the truststore.

  • --use-unset - Enables using unset` values in prepared statements.

  • --username <username> - Username for ScyllaDB authentication.

  • -v,--verbose <LEVEL> - Enables verbose output.

Was this page helpful?

PREVIOUS
Scylla Types
NEXT
Cassandra Stress
  • Create an issue
  • Edit this page

On this page

  • SSTableLoader
    • Usage
    • Parameters
ScyllaDB Open Source
  • 5.2
    • master
    • 6.2
    • 6.1
    • 6.0
    • 5.4
    • 5.2
    • 5.1
  • Getting Started
    • Install ScyllaDB
      • ScyllaDB Web Installer for Linux
      • ScyllaDB Unified Installer (relocatable executable)
      • Air-gapped Server Installation
      • What is in each RPM
      • ScyllaDB Housekeeping and how to disable it
      • ScyllaDB Developer Mode
      • ScyllaDB Configuration Reference
    • Configure ScyllaDB
    • ScyllaDB Requirements
      • System Requirements
      • OS Support by Linux Distributions and Version
      • ScyllaDB in a Shared Environment
    • Migrate to ScyllaDB
      • Migration Process from Cassandra to Scylla
      • Scylla and Apache Cassandra Compatibility
      • Migration Tools Overview
    • Integration Solutions
      • Integrate Scylla with Spark
      • Integrate Scylla with KairosDB
      • Integrate Scylla with Presto
      • Integrate Scylla with Elasticsearch
      • Integrate Scylla with Kubernetes
      • Integrate Scylla with the JanusGraph Graph Data System
      • Integrate Scylla with DataDog
      • Integrate Scylla with Kafka
      • Integrate Scylla with IOTA Chronicle
      • Integrate Scylla with Spring
      • Shard-Aware Kafka Connector for Scylla
      • Install Scylla with Ansible
      • Integrate Scylla with Databricks
    • Tutorials
  • ScyllaDB for Administrators
    • Administration Guide
    • Procedures
      • Cluster Management
      • Backup & Restore
      • Change Configuration
      • Maintenance
      • Best Practices
      • Benchmarking Scylla
      • Migrate from Cassandra to Scylla
      • Disable Housekeeping
    • Security
      • ScyllaDB Security Checklist
      • Enable Authentication
      • Enable and Disable Authentication Without Downtime
      • Generate a cqlshrc File
      • Reset Authenticator Password
      • Enable Authorization
      • Grant Authorization CQL Reference
      • Role Based Access Control (RBAC)
      • ScyllaDB Auditing Guide
      • Encryption: Data in Transit Client to Node
      • Encryption: Data in Transit Node to Node
      • Generating a self-signed Certificate Chain Using openssl
      • Encryption at Rest
      • LDAP Authentication
      • LDAP Authorization (Role Management)
    • Admin Tools
      • Nodetool Reference
      • CQLSh
      • REST
      • Tracing
      • Scylla SStable
      • Scylla Types
      • SSTableLoader
      • cassandra-stress
      • SSTabledump
      • SSTable2json
      • Scylla Logs
      • Seastar Perftune
      • Virtual Tables
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
    • ScyllaDB Manager
    • Upgrade Procedures
      • ScyllaDB Open Source Upgrade
      • ScyllaDB Open Source to ScyllaDB Enterprise Upgrade
      • ScyllaDB Image
      • ScyllaDB Enterprise
    • System Configuration
      • System Configuration Guide
      • scylla.yaml
      • ScyllaDB Snitches
    • Benchmarking ScyllaDB
  • ScyllaDB for Developers
    • Learn To Use ScyllaDB
      • Scylla University
      • Course catalog
      • Scylla Essentials
      • Basic Data Modeling
      • Advanced Data Modeling
      • MMS - Learn by Example
      • Care-Pet an IoT Use Case and Example
    • Scylla Alternator
    • Scylla Features
      • Scylla Open Source Features
      • Scylla Enterprise Features
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
    • Workload Attributes
  • CQL Reference
    • CQLSh: the CQL shell
    • Appendices
    • Compaction
    • Consistency Levels
    • Consistency Level Calculator
    • Data Definition
    • Data Manipulation
    • Data Types
    • Definitions
    • Global Secondary Indexes
    • Additional Information
    • Expiring Data with Time to Live (TTL)
    • Additional Information
    • Functions
    • JSON Support
    • Materialized Views
    • Non-Reserved CQL Keywords
    • Reserved CQL Keywords
    • ScyllaDB CQL Extensions
  • ScyllaDB Architecture
    • ScyllaDB Ring Architecture
    • ScyllaDB Fault Tolerance
    • Consistency Level Console Demo
    • ScyllaDB Anti-Entropy
      • Scylla Hinted Handoff
      • Scylla Read Repair
      • Scylla Repair
    • SSTable
      • ScyllaDB SSTable - 2.x
      • ScyllaDB SSTable - 3.x
    • Compaction Strategies
    • Raft Consensus Algorithm in ScyllaDB
  • Troubleshooting ScyllaDB
    • Errors and Support
      • Report a Scylla problem
      • Error Messages
      • Change Log Level
    • ScyllaDB Startup
      • Ownership Problems
      • Scylla will not Start
      • Scylla Python Script broken
    • Upgrade
      • Inaccessible configuration files after ScyllaDB upgrade
    • Cluster and Node
      • Failed Decommission Problem
      • Cluster Timeouts
      • Node Joined With No Data
      • SocketTimeoutException
      • NullPointerException
    • Data Modeling
      • Scylla Large Partitions Table
      • Scylla Large Rows and Cells Table
      • Large Partitions Hunting
    • Data Storage and SSTables
      • Space Utilization Increasing
      • Disk Space is not Reclaimed
      • SSTable Corruption Problem
      • Pointless Compactions
      • Limiting Compaction
    • CQL
      • Time Range Query Fails
      • COPY FROM Fails
      • CQL Connection Table
      • Reverse queries fail
    • ScyllaDB Monitor and Manager
      • Manager and Monitoring integration
      • Manager lists healthy nodes as down
  • Knowledge Base
    • Upgrading from experimental CDC
    • Compaction
    • Counting all rows in a table is slow
    • CQL Query Does Not Display Entire Result Set
    • When CQLSh query returns partial results with followed by “More”
    • Run Scylla and supporting services as a custom user:group
    • Decoding Stack Traces
    • Snapshots and Disk Utilization
    • DPDK mode
    • Debug your database with Flame Graphs
    • How to Change gc_grace_seconds for a Table
    • Gossip in Scylla
    • Increase Permission Cache to Avoid Non-paged Queries
    • How does Scylla LWT Differ from Apache Cassandra ?
    • Map CPUs to Scylla Shards
    • Scylla Memory Usage
    • NTP Configuration for Scylla
    • Updating the Mode in perftune.yaml After a ScyllaDB Upgrade
    • POSIX networking for Scylla
    • Scylla consistency quiz for administrators
    • Recreate RAID devices
    • How to Safely Increase the Replication Factor
    • Scylla and Spark integration
    • Increase Scylla resource limits over systemd
    • Scylla Seed Nodes
    • How to Set up a Swap Space
    • Scylla Snapshots
    • Scylla payload sent duplicated static columns
    • Stopping a local repair
    • System Limits
    • How to flush old tombstones from a table
    • Time to Live (TTL) and Compaction
    • Scylla Nodes are Unresponsive
    • Update a Primary Key
    • Using the perf utility with Scylla
    • Configure Scylla Networking with Multiple NIC/IP Combinations
  • ScyllaDB FAQ
  • Contribute to ScyllaDB
  • Glossary
  • Alternator: DynamoDB API in Scylla
    • Getting Started With ScyllaDB Alternator
    • ScyllaDB Alternator for DynamoDB users
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 08 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6