From fbca8a764408fa759ff01d2ce16ae859eb45d373 Mon Sep 17 00:00:00 2001 From: Michael Litvak Date: Tue, 9 Dec 2025 09:46:50 +0100 Subject: [PATCH] docs: document restrictions of colocated tables Currently some things are not supported for colocated tables: it's not possible to repair a colocated table, and due to this it's also not possible to use the tombstone_gc=repair mode on a colocated table. Extend the documentation to explain what colocated tables are and document these restrictions. Fixes scylladb/scylladb#27261 Closes scylladb/scylladb#27516 (cherry picked from commit 33f7bc28dacfb25b54f0fa96fc65ebe38bb687cd) Closes scylladb/scylladb#27772 --- docs/cql/ddl.rst | 2 ++ docs/operating-scylla/nodetool-commands/cluster/repair.rst | 2 ++ docs/reference/glossary.rst | 4 ++++ 3 files changed, 8 insertions(+) diff --git a/docs/cql/ddl.rst b/docs/cql/ddl.rst index 96bb93e15d..20cd119544 100644 --- a/docs/cql/ddl.rst +++ b/docs/cql/ddl.rst @@ -954,6 +954,8 @@ The following modes are available: * - ``immediate`` - Tombstone GC is immediately performed. There is no wait time or repair requirement. This mode is useful for a table that uses the TWCS compaction strategy with no user deletes. After data is expired after TTL, ScyllaDB can perform compaction to drop the expired data immediately. +.. warning:: The ``repair`` mode is not supported for :term:`Colocated Tables ` in this version. + .. _cql-per-table-tablet-options: Per-table tablet options diff --git a/docs/operating-scylla/nodetool-commands/cluster/repair.rst b/docs/operating-scylla/nodetool-commands/cluster/repair.rst index b27324be0e..5c57d4bcf4 100644 --- a/docs/operating-scylla/nodetool-commands/cluster/repair.rst +++ b/docs/operating-scylla/nodetool-commands/cluster/repair.rst @@ -9,6 +9,8 @@ Running ``cluster repair`` on a **single node** synchronizes all data on all nod To synchronize all data in clusters that have both tablets-based and vnodes-based keyspaces, run :doc:`nodetool repair -pr ` on **all** of the nodes in the cluster, and :doc:`nodetool cluster repair ` on **any** of the nodes in the cluster. +.. warning:: :term:`Colocated Tables ` cannot be synchronized using cluster repair in this version. + To check if a keyspace enables tablets, use: .. code-block:: cql diff --git a/docs/reference/glossary.rst b/docs/reference/glossary.rst index 0f4d0721a7..9d2db94f4e 100644 --- a/docs/reference/glossary.rst +++ b/docs/reference/glossary.rst @@ -201,3 +201,7 @@ Glossary The name comes from two basic operations, multiply (MU) and rotate (R), used in its inner loop. The MurmurHash3 version used in ScyllaDB originated from `Apache Cassandra `_, and is **not** identical to the `official MurmurHash3 calculation `_. More `here `_. + Colocated Table + An internal table of a special type in a :doc:`tablets ` enabled keyspace that is colocated with another base table, meaning it always has the same tablet replicas as the base table. + Current types of colocated tables include CDC log tables, local indexes, and materialized views that have the same partition key as their base table. +