Skip to content

Commit 55dbf54

Browse files
bhalevypiodul
authored andcommitted
docs: document the views-with-tablets experimental feature
Refs scylladb#22217 Fixes scylladb#22893 Signed-off-by: Benny Halevy <[email protected]> Closes scylladb#22896
1 parent d99df7a commit 55dbf54

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/architecture/tablets.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,15 @@ enabled:
149149
If you plan to use any of the above features, CREATE your keyspace
150150
:ref:`with tablets disabled <tablets-enable-tablets>`.
151151

152+
The following ScyllaDB features are disabled by default when used with a keyspace
153+
that has tablets enabled:
154+
155+
* Materialized Views (MV)
156+
* Secondary indexes (SI, as it depends on MV)
157+
158+
To enable MV and SI for tablet keyspaces, use the `--experimental-features=views-with-tablets`
159+
configuration option. See :ref:`Views with tablets <admin-views-with-tablets>` for details.
160+
152161
Resharding in keyspaces with tablets enabled has the following limitations:
153162

154163
* ScyllaDB does not support reducing the number of shards after node restart.

docs/operating-scylla/admin.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,24 @@ Before creating keyspaces with object storage, you also need to
352352
:ref:`configure <object-storage-configuration>` the object storage
353353
credentials and endpoint.
354354

355+
.. _admin-views-with-tablets:
356+
357+
Views with tablets
358+
------------------
359+
360+
By default, Materialized Views (MV) and Secondary Indexes (SI)
361+
are disabled in keyspaces that use tablets.
362+
363+
Support for MV and SI with tablets is experimental and must be explicitly
364+
enabled in the ``scylla.yaml`` configuration file by specifying
365+
the ``views-with-tablets`` option:
366+
367+
.. code-block:: yaml
368+
369+
experimental_features:
370+
- views-with-tablets
371+
372+
355373
Monitoring
356374
==========
357375
ScyllaDB exposes interfaces for online monitoring, as described below.

0 commit comments

Comments
 (0)