From e753b4e793faab20bf943de7fc2bf65f01643e17 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Tue, 9 Aug 2022 10:34:22 +0200 Subject: [PATCH] doc: language, formatting, and organization improvements --- .../admin-tools/sstableloader.rst | 93 +++++++++++-------- 1 file changed, 53 insertions(+), 40 deletions(-) diff --git a/docs/operating-scylla/admin-tools/sstableloader.rst b/docs/operating-scylla/admin-tools/sstableloader.rst index 0bffa57c93..1859083a0c 100644 --- a/docs/operating-scylla/admin-tools/sstableloader.rst +++ b/docs/operating-scylla/admin-tools/sstableloader.rst @@ -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 `. + sstableloader does **not** support loading from encrypted files. For restoring data from encrypted files, see :ref:`Migration to ScyllaDB `. .. 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 ` +See :doc:`Apache Cassandra to ScyllaDB Migration Process ` for an example of usage. -usage: sstableloader [options] -Bulk load the sstables found in the directory to the configured cluster. The parent directories of 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 `` - Client SSL: algorithm (default: SunX509) -* ``-bs,--batch-size `` - Does not work with ``-nb`` -* ``-ciphers,--ssl-ciphers `` - Client SSL: comma-separated list of encryption suites to use -* ``-cl,--consistency-level `` - sets the consistency level for statements -* ``-cph,--connections-per-host `` - number of concurrent connections-per-host. -* ``-d,--nodes `` - Required. try to connect to these hosts (comma separated) initially for ring information -* ``-f,--conf-path `` - cassandra.yaml file path for streaming throughput and client/server SSL. -* ``-g,--ignore-missing-columns `` - ignore named missing columns in tables -* ``-h,--help`` - display this help message -* ``-i,--ignore `` - 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 `` - Run tasks in parallel -* ``-ks,--keystore `` - Client SSL: full path to keystore + sstableloader [options] + + +Bulk loads the SSTables found in the specified directory (````) to the configured cluster. The parent directories of +```` 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 `` - Client SSL: algorithm (default: SunX509). +* ``-bs,--batch-size `` - Does not work with ``-nb``. +* ``-ciphers,--ssl-ciphers `` - Client SSL: comma-separated list of encryption suites to use. +* ``-cl,--consistency-level `` - Sets the consistency level for statements. +* ``-cph,--connections-per-host `` - Number of concurrent connections-per-host. +* ``-d,--nodes `` - Required. Try to connect to these hosts (comma separated) initially for ring information. +* ``-f,--conf-path `` - Path to `cassandra.yaml` file for streaming throughput and client/server SSL. +* ``-g,--ignore-missing-columns `` - Ignores the specified missing columns in tables. +* ``-h,--help`` - Displays this help message. +* ``-i,--ignore `` - 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 `` - Runs tasks in parallel. +* ``-ks,--keystore `` - Client SSL: full path to keystore. * ``-kspw,--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 used for connections (default 9042) -* ``-prtcl,--ssl-protocol `` - Client SSL: connections protocol to use (default: TLS) -* ``-pt,--partitioner `` - Partitioner type to use, defaults to cluster value -* ``-pw,--password `` - password for cassandra authentication -* ``-s,--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 used for connections (default: 9042). +* ``-prtcl,--ssl-protocol `` - Client SSL: connections protocol to use (default: TLS). +* ``-pt,--partitioner `` - Partitioner type to use, defaults to the cluster value. +* ``-pw,--password `` - Password for ScyllaDB authentication. +* ``-s,--ssl `` - Enables using the SSL connection(s). * ``-sim,--simulate`` - simulate. Only print CQL generated -* ``-st,--store-type `` - Client SSL: type of store -* ``-t,--throttle `` - throttle speed in Mbits (default unlimited) -* ``-tr,--token-ranges <:,...>`` - import only partitions that satisfy lo < token(partition) <= hi -* ``-translate,--translate `` - comma-separated list of column name mappings -* ``-ts,--truststore `` - Client SSL: full path to truststore -* ``-tspw,--truststore-password `` - Client SSL: password of the truststore -* ``--use-unset`` - Use 'unset' values in prepared statements -* ``--username `` - username for cassandra authentication -* ``-v,--verbose `` - verbose output +* ``-st,--store-type `` - Client SSL: type of store. +* ``-t,--throttle `` - Throttles the speed in Mbits (unlimited by default). +* ``-tr,--token-ranges <:,...>`` - Imports only partitions that satisfy lo < token(partition) <= hi. +* ``-translate,--translate `` - Comma-separated list of column name mappings. +* ``-ts,--truststore `` - Client SSL: full path to truststore. +* ``-tspw,--truststore-password `` - Client SSL: password to the truststore. +* ``--use-unset`` - Enables using `unset`` values in prepared statements. +* ``--username `` - Username for ScyllaDB authentication. +* ``-v,--verbose `` - Enables verbose output.