mirrors/scylladb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: language, formatting, and organization improvements

Browse Source
This commit is contained in:
Anna Stuchlik
2022-08-09 10:34:22 +02:00
parent 61d33cb2a8
commit e753b4e793
1 changed files with 53 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
docs/operating-scylla/admin-tools/sstableloader.rst
View File

@@ -1,15 +1,15 @@
SSTableLoader
=============
Bulk load the sstables from a directory to a Scylla cluster via the **CQL API**.
Bulk loads SSTables from a directory to a ScyllaDB cluster via the **CQL API**.
.. note::
This is **different** than Apache Cassandra tool with the same name, which uses internal RPC protocol to load the data.
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 :ref:`Migration to Scylla <cassandra-to-scylla-procedure>`.
sstableloader does **not** support loading from encrypted files. For restoring data from encrypted files, see :ref:`Migration to ScyllaDB <cassandra-to-scylla-procedure>`.
.. note::
@@ -17,47 +17,60 @@ Bulk load the sstables from a directory to a Scylla cluster via the **CQL API**.
ScyllaDB supports global counters, which are used by Cassandra 2.1 and later.
SSTableLoader can be used to restore data from Scylla or Apache Cassandra backups or to clone data from cluster to cluster.
It is especially useful, when the number of nodes, or token range distrbution between the source and target cluster are **not** the same. Since CQL API is used, Scylla will take care of distrbution the data.
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.
For example of such usage see :doc:`Apache Cassandra to Scylla Migration Process </operating-scylla/procedures/cassandra-to-scylla-migration-process>`
See :doc:`Apache Cassandra to ScyllaDB Migration Process </operating-scylla/procedures/cassandra-to-scylla-migration-process>` for an example of usage.
usage: sstableloader [options] <dir_path>
Bulk load the sstables found in the directory <dir_path> to the configured cluster. The parent directories of <dir_path> are used as the target ``keyspace/table`` name. So, 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`` into a directory ``/path/to/Keyspace1/Standard1/``.
Usage
------
Parameters:
.. code-block:: console
* ``-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>`` - cassandra.yaml file path for streaming throughput and client/server SSL.
* ``-g,--ignore-missing-columns <COLUMN NAMES...>`` - ignore named missing columns in tables
* ``-h,--help`` - display this help message
* ``-i,--ignore <NODES>`` - don't stream to this (comma separated) list of nodes
* ``-ic,--ignore-dropped-counter-data`` - ignore dropping local and remote counter shard data
* ``-ir,--no-infinite-retry`` - Disable infinite retry policy
* ``-j,--threads-count <Number of threads to execute tasks>`` - Run tasks in parallel
* ``-ks,--keystore <KEYSTORE>`` - Client SSL: full path to keystore
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`` - Do not use batch statements updates for same partition key.
* ``--no-progress`` - don't display progress
* ``-nx,--no-prepared`` - Do not use 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 cluster value
* ``-pw,--password <password>`` - password for cassandra authentication
* ``-s,--ssl <SSL>`` - Use SSL connection(s)
* ``-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>`` - throttle speed in Mbits (default unlimited)
* ``-tr,--token-ranges <<lo>:<hi>,...>`` - import 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 of the truststore
* ``--use-unset`` - Use 'unset' values in prepared statements
* ``--username <username>`` - username for cassandra authentication
* ``-v,--verbose <LEVEL>`` - verbose output
* ``-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.