From 55dbf5493c2bcda053596e07be9bbff81de98bbf Mon Sep 17 00:00:00 2001 From: Benny Halevy Date: Tue, 18 Feb 2025 09:25:44 +0200 Subject: [PATCH] docs: document the views-with-tablets experimental feature Refs scylladb/scylladb#22217 Fixes scylladb/scylladb#22893 Signed-off-by: Benny Halevy Closes scylladb/scylladb#22896 --- docs/architecture/tablets.rst | 9 +++++++++ docs/operating-scylla/admin.rst | 18 ++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/docs/architecture/tablets.rst b/docs/architecture/tablets.rst index 74b24572cf..a723266b90 100644 --- a/docs/architecture/tablets.rst +++ b/docs/architecture/tablets.rst @@ -149,6 +149,15 @@ enabled: If you plan to use any of the above features, CREATE your keyspace :ref:`with tablets disabled `. +The following ScyllaDB features are disabled by default when used with a keyspace +that has tablets enabled: + +* Materialized Views (MV) +* Secondary indexes (SI, as it depends on MV) + +To enable MV and SI for tablet keyspaces, use the `--experimental-features=views-with-tablets` +configuration option. See :ref:`Views with tablets ` for details. + Resharding in keyspaces with tablets enabled has the following limitations: * ScyllaDB does not support reducing the number of shards after node restart. diff --git a/docs/operating-scylla/admin.rst b/docs/operating-scylla/admin.rst index fd56c9c694..5d3380d35b 100644 --- a/docs/operating-scylla/admin.rst +++ b/docs/operating-scylla/admin.rst @@ -352,6 +352,24 @@ Before creating keyspaces with object storage, you also need to :ref:`configure ` the object storage credentials and endpoint. +.. _admin-views-with-tablets: + +Views with tablets +------------------ + +By default, Materialized Views (MV) and Secondary Indexes (SI) +are disabled in keyspaces that use tablets. + +Support for MV and SI with tablets is experimental and must be explicitly +enabled in the ``scylla.yaml`` configuration file by specifying +the ``views-with-tablets`` option: + +.. code-block:: yaml + + experimental_features: + - views-with-tablets + + Monitoring ========== ScyllaDB exposes interfaces for online monitoring, as described below.