From da90e368dc65bf50890d2fede374bff13fff76d6 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sat, 23 Mar 2024 07:55:42 +0800 Subject: [PATCH 1/2] docs/operating-scylla: document nodetool getsstables Signed-off-by: Kefu Chai --- .../nodetool-commands/getsstables.rst | 41 +++++++++++++++++++ docs/operating-scylla/nodetool.rst | 2 + 2 files changed, 43 insertions(+) create mode 100644 docs/operating-scylla/nodetool-commands/getsstables.rst diff --git a/docs/operating-scylla/nodetool-commands/getsstables.rst b/docs/operating-scylla/nodetool-commands/getsstables.rst new file mode 100644 index 0000000000..04877e2f72 --- /dev/null +++ b/docs/operating-scylla/nodetool-commands/getsstables.rst @@ -0,0 +1,41 @@ +Nodetool getsstables +==================== + +**getsstables** ``[-hf | --hex-format] `` - Gets the SStables that contain the given key. + +Syntax +------ + +.. code-block:: console + + nodetool getsstables [-hf | --hex-format]
+ +Options +------- + +==================================================================== ================================================================================================================== +Parameter Description +==================================================================== ================================================================================================================== +-hf / --hex-format Specify the key in hexadecimal string format +==================================================================== ================================================================================================================== + +Examples +-------- + +For example: + +.. code-block:: shell + + nodetool getsstables ks tbl mykey + +Example output: + +.. code-block:: shell + + /var/lib/scylla/data/ks/tbl-3ca78460d61611eea0b49524e39553c0/me-3gec_0mu7_5az0024x96bfm476r6-big-Data.db + /var/lib/scylla/data/ks/tbl-3ca78460d61611eea0b49524e39553c0/me-3gec_0mu7_7bz0024x96bfm476r6-big-Data.db + +See Also +-------- + +.. include:: nodetool-index.rst diff --git a/docs/operating-scylla/nodetool.rst b/docs/operating-scylla/nodetool.rst index f98b91d0d9..04686d9fb8 100644 --- a/docs/operating-scylla/nodetool.rst +++ b/docs/operating-scylla/nodetool.rst @@ -29,6 +29,7 @@ Nodetool nodetool-commands/enablegossip nodetool-commands/flush nodetool-commands/getendpoints + nodetool-commands/getsstables nodetool-commands/gettraceprobability nodetool-commands/gossipinfo nodetool-commands/help @@ -105,6 +106,7 @@ Operations that are not listed below are currently not available. * :doc:`flush ` - Flush one or more column families. * :doc:`getendpoints ` :code:`` :code:`
` :code:``- Print the end points that owns the key. * **getlogginglevels** - Get the runtime logging levels. +* :doc:`getsstables ` - Print the sstable filenames that own the key. * :doc:`gettraceprobability ` - Displays the current trace probability value. 0 is disabled 1 is enabled. * :doc:`gossipinfo ` - Shows the gossip information for the cluster. * :doc:`help ` - Display list of available nodetool commands. From 8af9c735f2ec02778b28ace8eddaa7ca5d7bde3f Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sat, 23 Mar 2024 08:34:47 +0800 Subject: [PATCH 2/2] docs/operating-scylla: document nodetool sstableinfo Signed-off-by: Kefu Chai --- .../nodetool-commands/sstableinfo.rst | 73 +++++++++++++++++++ docs/operating-scylla/nodetool.rst | 2 + 2 files changed, 75 insertions(+) create mode 100644 docs/operating-scylla/nodetool-commands/sstableinfo.rst diff --git a/docs/operating-scylla/nodetool-commands/sstableinfo.rst b/docs/operating-scylla/nodetool-commands/sstableinfo.rst new file mode 100644 index 0000000000..0e82c7f402 --- /dev/null +++ b/docs/operating-scylla/nodetool-commands/sstableinfo.rst @@ -0,0 +1,73 @@ +Nodetool sstableinfo +==================== + +**sstableinfo** ``[
...]`` - Gets information about SStables per keyspace/table. + +Syntax +------ + +.. code-block:: console + + nodetool sstableinfo [
...] + +Examples +-------- + +For example: + +.. code-block:: shell + + nodetool sstableinfo + +Example output: + +.. code-block:: shell + + keyspace : ks + table : tbl + sstables : + 0 : + data size : 90 + filter size : 332 + index size : 24 + level : 0 + size : 5746 + generation : 3gec_0mu7_5az0024x96bfm476r6 + version : me + timestamp : 2024-03-11T08:13:19Z + extended properties : + compression_parameters : + sstable_compression : org.apache.cassandra.io.compress.LZ4Compressor + 1 : + data size : 290 + filter size : 232 + index size : 124 + level : 0 + size : 6746 + generation : 3gec_0mu7_6bz0024x96bfm476r6 + version : me + timestamp : 2024-03-10T08:13:19Z + properties : + foo : bar + keyspace : ks + table : tbl2 + sstables : + 0 : + data size : 44 + filter size : 172 + index size : 8 + level : 0 + size : 5481 + generation : 3gec_0mu8_5vrgh24x96bfm476r6 + version : me + timestamp : 2024-03-11T08:13:20Z + extended properties : + compression_parameters : + sstable_compression : org.apache.cassandra.io.compress.LZ4Compressor + keyspace : ks2 + table : tbl + +See Also +-------- + +.. include:: nodetool-index.rst diff --git a/docs/operating-scylla/nodetool.rst b/docs/operating-scylla/nodetool.rst index 04686d9fb8..85766df38c 100644 --- a/docs/operating-scylla/nodetool.rst +++ b/docs/operating-scylla/nodetool.rst @@ -46,6 +46,7 @@ Nodetool nodetool-commands/settraceprobability nodetool-commands/setlogginglevel nodetool-commands/snapshot + nodetool-commands/sstableinfo nodetool-commands/statusbackup nodetool-commands/statusbinary nodetool-commands/statusgossip @@ -125,6 +126,7 @@ Operations that are not listed below are currently not available. * :doc:`setlogginglevel` - sets the logging level threshold for Scylla classes * :doc:`settraceprobability ` ```` - Sets the probability for tracing a request. race probability value * :doc:`snapshot ` :code:`[-t tag] [-cf column_family] ` - Take a snapshot of specified keyspaces or a snapshot of the specified table. +* :doc:`sstableinfo ` - Get information about sstables per keyspace/table. * :doc:`statusbackup ` - Status of incremental backup. * :doc:`statusbinary ` - Status of native transport (binary protocol). * :doc:`statusgossip ` - Status of gossip.