From 346e883dfcaeaa2b296de83de2012d747d4cf753 Mon Sep 17 00:00:00 2001 From: Benny Halevy Date: Tue, 14 Nov 2023 19:52:20 +0200 Subject: [PATCH] scylla-nodetool, docs: improve optional params documentation Document the behavior if no keyspace is specified or no table(s) are specified for a given keyspace. Fixes scylladb/scylladb#16032 Signed-off-by: Benny Halevy (cherry picked from commit 9324363e552ce38d97cbe3058ede182364065635) --- .../nodetool-commands/flush.rst | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/operating-scylla/nodetool-commands/flush.rst b/docs/operating-scylla/nodetool-commands/flush.rst index 6cf6803748..73845378a6 100644 --- a/docs/operating-scylla/nodetool-commands/flush.rst +++ b/docs/operating-scylla/nodetool-commands/flush.rst @@ -1,6 +1,6 @@ Nodetool flush ============== -**flush** ``[ ...]``- Specify a keyspace and one or more tables that you want to flush from the memtable to on disk SSTables. +**flush** - Flush memtables to on-disk SSTables in the specified keyspace and table(s). For example: @@ -8,6 +8,26 @@ For example: nodetool flush keyspaces1 standard1 +Syntax +------ + +.. code-block:: none + + nodetool flush [ [ ...]] + +nodetool flush takes the following parameters: + +.. list-table:: + :widths: 50 50 + :header-rows: 1 + + * - Parameter Name + - Description + * - ```` + - The keyspace to operate on. If omitted, all keyspaces are flushed. + * - ``
...`` + - One or more tables to operate on. Tables may be specified only if a keyspace is given. If omitted, all tables in the specified keyspace are flushed. + See also :doc:`Nodetool drain `