Skip to content

Commit

Permalink
fix(docs): improve restore schema topology requirement
Browse files Browse the repository at this point in the history
Fixes #3782

(cherry picked from commit fcce87d)
  • Loading branch information
Michal-Leszczynski committed Apr 22, 2024
1 parent 56fd95f commit 90926b8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/source/restore/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ Restore and backups are scheduled in the same manner: you can start, stop, resum

.. note:: If you are using ScyllaDB Manager deployed by ScyllaDB Operator, see dedicated `ScyllaDB Operator documentation <https://operator.docs.scylladb.com/stable/nodeoperations/restore.html#>`_.

.. note:: Restore procedure works with any cluster topologies, so backed-up cluster can have different number of nodes than restore destination cluster.

.. warning::
Restore works only when ScyllaDB version of backed-up cluster is the same or older than ScyllaDB version of restore destination cluster.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/restore/restore-schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Restore schema

.. include:: _common/restore-raft-schema-warn.rst

In order to restore Scylla cluster schema use :ref:`sctool restore <sctool-restore>` with ``--restore-schema`` flag.
| In order to restore Scylla cluster schema use :ref:`sctool restore <sctool-restore>` with ``--restore-schema`` flag.
| The restore schema procedure works with any cluster size, so the backed-up cluster can have a different number of nodes per data center than the restore destination cluster. However, it is important that the restore destination cluster consists of at least all of the data centers present in the backed-up cluster.
Prerequisites
=============
Expand Down
5 changes: 3 additions & 2 deletions docs/source/restore/restore-tables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Restore tables

.. note:: Currently, Scylla Manager does not support restoring content of `CDC log tables <https://docs.scylladb.com/stable/using-scylla/cdc/cdc-log-table.html>`_.

To restore the content of the tables (rows), use the :ref:`sctool restore <sctool-restore>` command with the ``--restore-tables`` flag.
| To restore the content of the tables (rows), use the :ref:`sctool restore <sctool-restore>` command with the ``--restore-tables`` flag.
| The restore tables procedure works with any cluster topologies, so the backed-up cluster can have a different number of nodes or data centers than the restore destination cluster.
You can add the ``--keyspace`` flag to define the base tables that will be restored. All Materialized Views and Secondary Indexes of those tables will be automatically recreated in order to ensure the correct data state.
| You can add the ``--keyspace`` flag to define the base tables that will be restored. All Materialized Views and Secondary Indexes of those tables will be automatically recreated in order to ensure the correct data state.
Prerequisites
=============
Expand Down

0 comments on commit 90926b8

Please sign in to comment.