From dfa88ccc282477d7de14861a6278590ec378e055 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Mon, 15 Jan 2024 20:55:10 +0100 Subject: [PATCH] doc: document nodetool resetlocalschema This adds the documentation for the nodetool resetlocalschema command. The syntax description is based on the description for Cassandra and the ScyllaDB help for nodetool. Fixes https://github.com/scylladb/scylladb/issues/16286 Closes scylladb/scylladb#16790 --- .../nodetool-commands/resetlocalschema.rst | 33 +++++++++++++++++++ docs/operating-scylla/nodetool.rst | 2 ++ 2 files changed, 35 insertions(+) create mode 100644 docs/operating-scylla/nodetool-commands/resetlocalschema.rst diff --git a/docs/operating-scylla/nodetool-commands/resetlocalschema.rst b/docs/operating-scylla/nodetool-commands/resetlocalschema.rst new file mode 100644 index 0000000000..ef6babbdbc --- /dev/null +++ b/docs/operating-scylla/nodetool-commands/resetlocalschema.rst @@ -0,0 +1,33 @@ +============================ +Nodetool resetlocalschema +============================ + +This command reloads in-memory schema objects from disk. It recalculates +the per-node and per-table schema versions. This can help you solve some +cases of schema version disagreement that would otherwise require a node restart. + +.. note:: + + This command cannot be used to hot-update the node's schema from manually + placed schema SStables. If the schema on disk doesn't match the schema in + memory, such reload will likely fail. + +Syntax +------- + +.. code-block:: console + + nodetool [(-h | --host )] [(-p | --port )] + [(-pp | --print-port)] [(-pw | --password )] + [(-pwf | --password-file )] + [(-u | --username )] resetlocalschema + + +Options +-------- + +* ``-h `` or ``--host `` - Node hostname or IP address. +* For other options, see :ref:`Nodetool generic options `. + + + diff --git a/docs/operating-scylla/nodetool.rst b/docs/operating-scylla/nodetool.rst index fce92a1cb6..f98b91d0d9 100644 --- a/docs/operating-scylla/nodetool.rst +++ b/docs/operating-scylla/nodetool.rst @@ -39,6 +39,7 @@ Nodetool nodetool-commands/refresh nodetool-commands/removenode nodetool-commands/repair + nodetool-commands/resetlocalschema nodetool-commands/ring nodetool-commands/scrub nodetool-commands/settraceprobability @@ -116,6 +117,7 @@ Operations that are not listed below are currently not available. * :doc:`refresh `- Load newly placed SSTables to the system without restart * :doc:`removenode `- Remove node with the provided ID * :doc:`repair ` :code:`` :code:`` - Repair one or more tables +* :doc:`resetlocalschema ` - Reset the node's local schema. * :doc:`ring ` - The nodetool ring command display the token ring information. * :doc:`scrub ` :code:`[-m mode] [--no-snapshot] [
...]` - Scrub the SSTable files in the specified keyspace or table(s) * :doc:`setlogginglevel` - sets the logging level threshold for Scylla classes