From b2122cf140696b82e09d0d48fbc8e40745c10aa6 Mon Sep 17 00:00:00 2001 From: InlinePizza <249805557+InlinePizza@users.noreply.github.com> Date: Sun, 3 May 2026 10:42:54 -0700 Subject: [PATCH 1/6] docs: Add glossary to Vitess documentation Co-authored-by: promptless[bot] --- content/en/docs/23.0/reference/glossary.md | 207 +++++++++++++++++++++ content/en/docs/24.0/reference/glossary.md | 207 +++++++++++++++++++++ content/en/docs/25.0/reference/glossary.md | 207 +++++++++++++++++++++ 3 files changed, 621 insertions(+) create mode 100644 content/en/docs/23.0/reference/glossary.md create mode 100644 content/en/docs/24.0/reference/glossary.md create mode 100644 content/en/docs/25.0/reference/glossary.md diff --git a/content/en/docs/23.0/reference/glossary.md b/content/en/docs/23.0/reference/glossary.md new file mode 100644 index 000000000..d01cf4277 --- /dev/null +++ b/content/en/docs/23.0/reference/glossary.md @@ -0,0 +1,207 @@ +--- +title: Glossary +description: Definitions of terms used in Vitess documentation +weight: 1 +--- + +This document defines terms used throughout Vitess documentation, command-line tools, and source code. + +## Backup + +A tablet state indicating the tablet is currently taking a backup of its data. + +## Cell + +A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. + +## Consistent Lookup Vindex + +A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. + +## Drained + +A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. + +## Functional Vindex + +A [vindex](#vindex) that computes the [keyspace ID](#keyspace-id) using an algorithmic mapping such as a hash or identity function, without consulting external data. + +## Global Topology + +The portion of the [topology service](#topology-service) that stores cluster-wide metadata shared across all [cells](#cell). + +## GTID Position + +Global Transaction Identifier position. Marks a specific point in the MySQL binary log for replication tracking. + +## Keyrange + +The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible for. Expressed in hexadecimal notation like `-80` (up to 0x80) or `80-` (from 0x80 onward). + +## Keyspace + +A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. + +## Keyspace ID + +A computed value that determines which [shard](#shard) contains a given row. The [primary vindex](#primary-vindex) maps a column value to a keyspace ID. + +## Local Topology + +The portion of the [topology service](#topology-service) that stores metadata specific to a single [cell](#cell). + +## Lookup Vindex + +A [vindex](#vindex) that uses a lookup table to map column values to [keyspace IDs](#keyspace-id). Enables routing queries on columns other than the sharding key. + +## Materialize + +A VReplication workflow that creates and maintains materialized views or realtime rollups across [shards](#shard). + +## MoveTables + +A VReplication workflow that migrates tables from one [keyspace](#keyspace) to another. + +## mysqlctl + +A command-line utility for managing the lifecycle of local MySQL instances used by Vitess. + +## Online DDL + +Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. + +## Primary + +The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." + +## Primary Vindex + +The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. + +## Rdonly + +A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. + +## Reparenting + +The process of changing which [tablet](#tablet) serves as the [primary](#primary) for a [shard](#shard). + +## Replica + +A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). + +## Replication Graph + +Metadata that tracks MySQL primary-replica relationships within the cluster. + +## Reshard + +A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. + +## Restore + +A tablet state indicating the tablet is restoring data from a backup. + +## Routing Rules + +Configuration that overrides default query routing during migrations, allowing gradual traffic shifts between [keyspaces](#keyspace). + +## Secondary Vindex + +A [vindex](#vindex) that provides additional query routing optimization beyond the [primary vindex](#primary-vindex). + +## Shard + +A horizontal partition of a [keyspace](#keyspace). Each shard contains a subset of the keyspace's data based on [keyrange](#keyrange). An unsharded keyspace has a single shard named `0` or `-`. + +## SwitchTraffic + +A VReplication operation that redirects query traffic from a source to a target during workflows like [MoveTables](#movetables) or [Reshard](#reshard). + +## Tablet + +A combination of a `vttablet` process and its associated MySQL instance. Tablets are the basic unit of data storage and query serving in Vitess. + +## Tablet Alias + +A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `zone1-100`. + +## Topology Service + +A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." + +## Unsharded + +A [keyspace](#keyspace) with a single [shard](#shard), containing all data without horizontal partitioning. + +## VDiff + +A VReplication tool that verifies data consistency between source and target during migrations. + +## VEXPLAIN + +A SQL command that shows how Vitess will execute a query across [shards](#shard), including the generated MySQL queries. + +## Vindex + +Virtual index. A mechanism that maps column values to [keyspace IDs](#keyspace-id) for query routing. Types include [primary](#primary-vindex), [secondary](#secondary-vindex), [lookup](#lookup-vindex), and [functional](#functional-vindex). + +## VReplication + +Vitess's streaming replication mechanism for data movement operations like [MoveTables](#movetables), [Reshard](#reshard), and [Materialize](#materialize). + +## VSchema + +Virtual schema. Configuration that defines how a [keyspace](#keyspace) is sharded, including [vindexes](#vindex), table definitions, and routing rules. + +## VStream + +A change notification service on [VTGate](#vtgate) that streams row changes to clients. + +## VStreamer + +The component on [VTTablet](#vttablet) that streams MySQL binary log events for [VReplication](#vreplication) and [VStream](#vstream). + +## vtbackup + +A standalone utility for taking backups of MySQL data managed by Vitess. + +## vtcombo + +A single-process test environment that runs all Vitess components together. Useful for local development and testing. + +## VTAdmin + +A web-based administrative interface for managing and monitoring Vitess clusters. + +## vtctl + +The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). + +## vtctld + +The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). + +## vtctldclient + +The current command-line client for Vitess cluster management. Communicates with [vtctld](#vtctld) to execute administrative operations. + +## VTEXPLAIN + +A command-line tool for offline query analysis that shows how Vitess would route and execute queries without connecting to a live cluster. + +## VTGate + +A lightweight, stateless proxy that routes queries to the appropriate [tablets](#tablet). Applications connect to VTGate rather than directly to MySQL. + +## VTOrc + +Vitess Orchestrator. Provides automated failover, recovery, and tablet management for Vitess clusters. + +## VTTablet + +The Vitess process that manages a MySQL instance, handling query serving, replication, and schema management. Together with MySQL, it forms a [tablet](#tablet). + +## vttestserver + +A lightweight Vitess server for local development and testing that simulates a Vitess cluster. diff --git a/content/en/docs/24.0/reference/glossary.md b/content/en/docs/24.0/reference/glossary.md new file mode 100644 index 000000000..d01cf4277 --- /dev/null +++ b/content/en/docs/24.0/reference/glossary.md @@ -0,0 +1,207 @@ +--- +title: Glossary +description: Definitions of terms used in Vitess documentation +weight: 1 +--- + +This document defines terms used throughout Vitess documentation, command-line tools, and source code. + +## Backup + +A tablet state indicating the tablet is currently taking a backup of its data. + +## Cell + +A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. + +## Consistent Lookup Vindex + +A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. + +## Drained + +A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. + +## Functional Vindex + +A [vindex](#vindex) that computes the [keyspace ID](#keyspace-id) using an algorithmic mapping such as a hash or identity function, without consulting external data. + +## Global Topology + +The portion of the [topology service](#topology-service) that stores cluster-wide metadata shared across all [cells](#cell). + +## GTID Position + +Global Transaction Identifier position. Marks a specific point in the MySQL binary log for replication tracking. + +## Keyrange + +The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible for. Expressed in hexadecimal notation like `-80` (up to 0x80) or `80-` (from 0x80 onward). + +## Keyspace + +A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. + +## Keyspace ID + +A computed value that determines which [shard](#shard) contains a given row. The [primary vindex](#primary-vindex) maps a column value to a keyspace ID. + +## Local Topology + +The portion of the [topology service](#topology-service) that stores metadata specific to a single [cell](#cell). + +## Lookup Vindex + +A [vindex](#vindex) that uses a lookup table to map column values to [keyspace IDs](#keyspace-id). Enables routing queries on columns other than the sharding key. + +## Materialize + +A VReplication workflow that creates and maintains materialized views or realtime rollups across [shards](#shard). + +## MoveTables + +A VReplication workflow that migrates tables from one [keyspace](#keyspace) to another. + +## mysqlctl + +A command-line utility for managing the lifecycle of local MySQL instances used by Vitess. + +## Online DDL + +Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. + +## Primary + +The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." + +## Primary Vindex + +The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. + +## Rdonly + +A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. + +## Reparenting + +The process of changing which [tablet](#tablet) serves as the [primary](#primary) for a [shard](#shard). + +## Replica + +A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). + +## Replication Graph + +Metadata that tracks MySQL primary-replica relationships within the cluster. + +## Reshard + +A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. + +## Restore + +A tablet state indicating the tablet is restoring data from a backup. + +## Routing Rules + +Configuration that overrides default query routing during migrations, allowing gradual traffic shifts between [keyspaces](#keyspace). + +## Secondary Vindex + +A [vindex](#vindex) that provides additional query routing optimization beyond the [primary vindex](#primary-vindex). + +## Shard + +A horizontal partition of a [keyspace](#keyspace). Each shard contains a subset of the keyspace's data based on [keyrange](#keyrange). An unsharded keyspace has a single shard named `0` or `-`. + +## SwitchTraffic + +A VReplication operation that redirects query traffic from a source to a target during workflows like [MoveTables](#movetables) or [Reshard](#reshard). + +## Tablet + +A combination of a `vttablet` process and its associated MySQL instance. Tablets are the basic unit of data storage and query serving in Vitess. + +## Tablet Alias + +A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `zone1-100`. + +## Topology Service + +A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." + +## Unsharded + +A [keyspace](#keyspace) with a single [shard](#shard), containing all data without horizontal partitioning. + +## VDiff + +A VReplication tool that verifies data consistency between source and target during migrations. + +## VEXPLAIN + +A SQL command that shows how Vitess will execute a query across [shards](#shard), including the generated MySQL queries. + +## Vindex + +Virtual index. A mechanism that maps column values to [keyspace IDs](#keyspace-id) for query routing. Types include [primary](#primary-vindex), [secondary](#secondary-vindex), [lookup](#lookup-vindex), and [functional](#functional-vindex). + +## VReplication + +Vitess's streaming replication mechanism for data movement operations like [MoveTables](#movetables), [Reshard](#reshard), and [Materialize](#materialize). + +## VSchema + +Virtual schema. Configuration that defines how a [keyspace](#keyspace) is sharded, including [vindexes](#vindex), table definitions, and routing rules. + +## VStream + +A change notification service on [VTGate](#vtgate) that streams row changes to clients. + +## VStreamer + +The component on [VTTablet](#vttablet) that streams MySQL binary log events for [VReplication](#vreplication) and [VStream](#vstream). + +## vtbackup + +A standalone utility for taking backups of MySQL data managed by Vitess. + +## vtcombo + +A single-process test environment that runs all Vitess components together. Useful for local development and testing. + +## VTAdmin + +A web-based administrative interface for managing and monitoring Vitess clusters. + +## vtctl + +The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). + +## vtctld + +The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). + +## vtctldclient + +The current command-line client for Vitess cluster management. Communicates with [vtctld](#vtctld) to execute administrative operations. + +## VTEXPLAIN + +A command-line tool for offline query analysis that shows how Vitess would route and execute queries without connecting to a live cluster. + +## VTGate + +A lightweight, stateless proxy that routes queries to the appropriate [tablets](#tablet). Applications connect to VTGate rather than directly to MySQL. + +## VTOrc + +Vitess Orchestrator. Provides automated failover, recovery, and tablet management for Vitess clusters. + +## VTTablet + +The Vitess process that manages a MySQL instance, handling query serving, replication, and schema management. Together with MySQL, it forms a [tablet](#tablet). + +## vttestserver + +A lightweight Vitess server for local development and testing that simulates a Vitess cluster. diff --git a/content/en/docs/25.0/reference/glossary.md b/content/en/docs/25.0/reference/glossary.md new file mode 100644 index 000000000..d01cf4277 --- /dev/null +++ b/content/en/docs/25.0/reference/glossary.md @@ -0,0 +1,207 @@ +--- +title: Glossary +description: Definitions of terms used in Vitess documentation +weight: 1 +--- + +This document defines terms used throughout Vitess documentation, command-line tools, and source code. + +## Backup + +A tablet state indicating the tablet is currently taking a backup of its data. + +## Cell + +A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. + +## Consistent Lookup Vindex + +A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. + +## Drained + +A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. + +## Functional Vindex + +A [vindex](#vindex) that computes the [keyspace ID](#keyspace-id) using an algorithmic mapping such as a hash or identity function, without consulting external data. + +## Global Topology + +The portion of the [topology service](#topology-service) that stores cluster-wide metadata shared across all [cells](#cell). + +## GTID Position + +Global Transaction Identifier position. Marks a specific point in the MySQL binary log for replication tracking. + +## Keyrange + +The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible for. Expressed in hexadecimal notation like `-80` (up to 0x80) or `80-` (from 0x80 onward). + +## Keyspace + +A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. + +## Keyspace ID + +A computed value that determines which [shard](#shard) contains a given row. The [primary vindex](#primary-vindex) maps a column value to a keyspace ID. + +## Local Topology + +The portion of the [topology service](#topology-service) that stores metadata specific to a single [cell](#cell). + +## Lookup Vindex + +A [vindex](#vindex) that uses a lookup table to map column values to [keyspace IDs](#keyspace-id). Enables routing queries on columns other than the sharding key. + +## Materialize + +A VReplication workflow that creates and maintains materialized views or realtime rollups across [shards](#shard). + +## MoveTables + +A VReplication workflow that migrates tables from one [keyspace](#keyspace) to another. + +## mysqlctl + +A command-line utility for managing the lifecycle of local MySQL instances used by Vitess. + +## Online DDL + +Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. + +## Primary + +The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." + +## Primary Vindex + +The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. + +## Rdonly + +A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. + +## Reparenting + +The process of changing which [tablet](#tablet) serves as the [primary](#primary) for a [shard](#shard). + +## Replica + +A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). + +## Replication Graph + +Metadata that tracks MySQL primary-replica relationships within the cluster. + +## Reshard + +A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. + +## Restore + +A tablet state indicating the tablet is restoring data from a backup. + +## Routing Rules + +Configuration that overrides default query routing during migrations, allowing gradual traffic shifts between [keyspaces](#keyspace). + +## Secondary Vindex + +A [vindex](#vindex) that provides additional query routing optimization beyond the [primary vindex](#primary-vindex). + +## Shard + +A horizontal partition of a [keyspace](#keyspace). Each shard contains a subset of the keyspace's data based on [keyrange](#keyrange). An unsharded keyspace has a single shard named `0` or `-`. + +## SwitchTraffic + +A VReplication operation that redirects query traffic from a source to a target during workflows like [MoveTables](#movetables) or [Reshard](#reshard). + +## Tablet + +A combination of a `vttablet` process and its associated MySQL instance. Tablets are the basic unit of data storage and query serving in Vitess. + +## Tablet Alias + +A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `zone1-100`. + +## Topology Service + +A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." + +## Unsharded + +A [keyspace](#keyspace) with a single [shard](#shard), containing all data without horizontal partitioning. + +## VDiff + +A VReplication tool that verifies data consistency between source and target during migrations. + +## VEXPLAIN + +A SQL command that shows how Vitess will execute a query across [shards](#shard), including the generated MySQL queries. + +## Vindex + +Virtual index. A mechanism that maps column values to [keyspace IDs](#keyspace-id) for query routing. Types include [primary](#primary-vindex), [secondary](#secondary-vindex), [lookup](#lookup-vindex), and [functional](#functional-vindex). + +## VReplication + +Vitess's streaming replication mechanism for data movement operations like [MoveTables](#movetables), [Reshard](#reshard), and [Materialize](#materialize). + +## VSchema + +Virtual schema. Configuration that defines how a [keyspace](#keyspace) is sharded, including [vindexes](#vindex), table definitions, and routing rules. + +## VStream + +A change notification service on [VTGate](#vtgate) that streams row changes to clients. + +## VStreamer + +The component on [VTTablet](#vttablet) that streams MySQL binary log events for [VReplication](#vreplication) and [VStream](#vstream). + +## vtbackup + +A standalone utility for taking backups of MySQL data managed by Vitess. + +## vtcombo + +A single-process test environment that runs all Vitess components together. Useful for local development and testing. + +## VTAdmin + +A web-based administrative interface for managing and monitoring Vitess clusters. + +## vtctl + +The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). + +## vtctld + +The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). + +## vtctldclient + +The current command-line client for Vitess cluster management. Communicates with [vtctld](#vtctld) to execute administrative operations. + +## VTEXPLAIN + +A command-line tool for offline query analysis that shows how Vitess would route and execute queries without connecting to a live cluster. + +## VTGate + +A lightweight, stateless proxy that routes queries to the appropriate [tablets](#tablet). Applications connect to VTGate rather than directly to MySQL. + +## VTOrc + +Vitess Orchestrator. Provides automated failover, recovery, and tablet management for Vitess clusters. + +## VTTablet + +The Vitess process that manages a MySQL instance, handling query serving, replication, and schema management. Together with MySQL, it forms a [tablet](#tablet). + +## vttestserver + +A lightweight Vitess server for local development and testing that simulates a Vitess cluster. From 8f6342eb1ad277c93cf0c3ed6af8c9a9e30aa62f Mon Sep 17 00:00:00 2001 From: Susan Kraft-Yorke Date: Sun, 3 May 2026 16:06:45 -0700 Subject: [PATCH 2/6] Delete glossary.md deleted glossary in v 23. Reasoning: I am updating v24 glossary. --- content/en/docs/23.0/reference/glossary.md | 207 --------------------- 1 file changed, 207 deletions(-) delete mode 100644 content/en/docs/23.0/reference/glossary.md diff --git a/content/en/docs/23.0/reference/glossary.md b/content/en/docs/23.0/reference/glossary.md deleted file mode 100644 index d01cf4277..000000000 --- a/content/en/docs/23.0/reference/glossary.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Glossary -description: Definitions of terms used in Vitess documentation -weight: 1 ---- - -This document defines terms used throughout Vitess documentation, command-line tools, and source code. - -## Backup - -A tablet state indicating the tablet is currently taking a backup of its data. - -## Cell - -A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. - -## Consistent Lookup Vindex - -A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. - -## Drained - -A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. - -## Functional Vindex - -A [vindex](#vindex) that computes the [keyspace ID](#keyspace-id) using an algorithmic mapping such as a hash or identity function, without consulting external data. - -## Global Topology - -The portion of the [topology service](#topology-service) that stores cluster-wide metadata shared across all [cells](#cell). - -## GTID Position - -Global Transaction Identifier position. Marks a specific point in the MySQL binary log for replication tracking. - -## Keyrange - -The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible for. Expressed in hexadecimal notation like `-80` (up to 0x80) or `80-` (from 0x80 onward). - -## Keyspace - -A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. - -## Keyspace ID - -A computed value that determines which [shard](#shard) contains a given row. The [primary vindex](#primary-vindex) maps a column value to a keyspace ID. - -## Local Topology - -The portion of the [topology service](#topology-service) that stores metadata specific to a single [cell](#cell). - -## Lookup Vindex - -A [vindex](#vindex) that uses a lookup table to map column values to [keyspace IDs](#keyspace-id). Enables routing queries on columns other than the sharding key. - -## Materialize - -A VReplication workflow that creates and maintains materialized views or realtime rollups across [shards](#shard). - -## MoveTables - -A VReplication workflow that migrates tables from one [keyspace](#keyspace) to another. - -## mysqlctl - -A command-line utility for managing the lifecycle of local MySQL instances used by Vitess. - -## Online DDL - -Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. - -## Primary - -The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." - -## Primary Vindex - -The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. - -## Rdonly - -A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. - -## Reparenting - -The process of changing which [tablet](#tablet) serves as the [primary](#primary) for a [shard](#shard). - -## Replica - -A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). - -## Replication Graph - -Metadata that tracks MySQL primary-replica relationships within the cluster. - -## Reshard - -A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. - -## Restore - -A tablet state indicating the tablet is restoring data from a backup. - -## Routing Rules - -Configuration that overrides default query routing during migrations, allowing gradual traffic shifts between [keyspaces](#keyspace). - -## Secondary Vindex - -A [vindex](#vindex) that provides additional query routing optimization beyond the [primary vindex](#primary-vindex). - -## Shard - -A horizontal partition of a [keyspace](#keyspace). Each shard contains a subset of the keyspace's data based on [keyrange](#keyrange). An unsharded keyspace has a single shard named `0` or `-`. - -## SwitchTraffic - -A VReplication operation that redirects query traffic from a source to a target during workflows like [MoveTables](#movetables) or [Reshard](#reshard). - -## Tablet - -A combination of a `vttablet` process and its associated MySQL instance. Tablets are the basic unit of data storage and query serving in Vitess. - -## Tablet Alias - -A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `zone1-100`. - -## Topology Service - -A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." - -## Unsharded - -A [keyspace](#keyspace) with a single [shard](#shard), containing all data without horizontal partitioning. - -## VDiff - -A VReplication tool that verifies data consistency between source and target during migrations. - -## VEXPLAIN - -A SQL command that shows how Vitess will execute a query across [shards](#shard), including the generated MySQL queries. - -## Vindex - -Virtual index. A mechanism that maps column values to [keyspace IDs](#keyspace-id) for query routing. Types include [primary](#primary-vindex), [secondary](#secondary-vindex), [lookup](#lookup-vindex), and [functional](#functional-vindex). - -## VReplication - -Vitess's streaming replication mechanism for data movement operations like [MoveTables](#movetables), [Reshard](#reshard), and [Materialize](#materialize). - -## VSchema - -Virtual schema. Configuration that defines how a [keyspace](#keyspace) is sharded, including [vindexes](#vindex), table definitions, and routing rules. - -## VStream - -A change notification service on [VTGate](#vtgate) that streams row changes to clients. - -## VStreamer - -The component on [VTTablet](#vttablet) that streams MySQL binary log events for [VReplication](#vreplication) and [VStream](#vstream). - -## vtbackup - -A standalone utility for taking backups of MySQL data managed by Vitess. - -## vtcombo - -A single-process test environment that runs all Vitess components together. Useful for local development and testing. - -## VTAdmin - -A web-based administrative interface for managing and monitoring Vitess clusters. - -## vtctl - -The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). - -## vtctld - -The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). - -## vtctldclient - -The current command-line client for Vitess cluster management. Communicates with [vtctld](#vtctld) to execute administrative operations. - -## VTEXPLAIN - -A command-line tool for offline query analysis that shows how Vitess would route and execute queries without connecting to a live cluster. - -## VTGate - -A lightweight, stateless proxy that routes queries to the appropriate [tablets](#tablet). Applications connect to VTGate rather than directly to MySQL. - -## VTOrc - -Vitess Orchestrator. Provides automated failover, recovery, and tablet management for Vitess clusters. - -## VTTablet - -The Vitess process that manages a MySQL instance, handling query serving, replication, and schema management. Together with MySQL, it forms a [tablet](#tablet). - -## vttestserver - -A lightweight Vitess server for local development and testing that simulates a Vitess cluster. From 4112d63d12453d73bce749e676861a07ba6e4523 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Sun, 3 May 2026 23:24:59 +0000 Subject: [PATCH 3/6] Move glossary to unversioned location after FAQ As requested, the glossary no longer lives under version-specific paths. It is now a standalone article at /docs/glossary/, positioned after FAQ in the navigation (weight: 3000 vs FAQ's weight: 2900). --- content/en/docs/25.0/reference/glossary.md | 207 ------------------ .../glossary.md => glossary/_index.md} | 4 +- 2 files changed, 3 insertions(+), 208 deletions(-) delete mode 100644 content/en/docs/25.0/reference/glossary.md rename content/en/docs/{24.0/reference/glossary.md => glossary/_index.md} (99%) diff --git a/content/en/docs/25.0/reference/glossary.md b/content/en/docs/25.0/reference/glossary.md deleted file mode 100644 index d01cf4277..000000000 --- a/content/en/docs/25.0/reference/glossary.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Glossary -description: Definitions of terms used in Vitess documentation -weight: 1 ---- - -This document defines terms used throughout Vitess documentation, command-line tools, and source code. - -## Backup - -A tablet state indicating the tablet is currently taking a backup of its data. - -## Cell - -A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. - -## Consistent Lookup Vindex - -A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. - -## Drained - -A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. - -## Functional Vindex - -A [vindex](#vindex) that computes the [keyspace ID](#keyspace-id) using an algorithmic mapping such as a hash or identity function, without consulting external data. - -## Global Topology - -The portion of the [topology service](#topology-service) that stores cluster-wide metadata shared across all [cells](#cell). - -## GTID Position - -Global Transaction Identifier position. Marks a specific point in the MySQL binary log for replication tracking. - -## Keyrange - -The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible for. Expressed in hexadecimal notation like `-80` (up to 0x80) or `80-` (from 0x80 onward). - -## Keyspace - -A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. - -## Keyspace ID - -A computed value that determines which [shard](#shard) contains a given row. The [primary vindex](#primary-vindex) maps a column value to a keyspace ID. - -## Local Topology - -The portion of the [topology service](#topology-service) that stores metadata specific to a single [cell](#cell). - -## Lookup Vindex - -A [vindex](#vindex) that uses a lookup table to map column values to [keyspace IDs](#keyspace-id). Enables routing queries on columns other than the sharding key. - -## Materialize - -A VReplication workflow that creates and maintains materialized views or realtime rollups across [shards](#shard). - -## MoveTables - -A VReplication workflow that migrates tables from one [keyspace](#keyspace) to another. - -## mysqlctl - -A command-line utility for managing the lifecycle of local MySQL instances used by Vitess. - -## Online DDL - -Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. - -## Primary - -The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." - -## Primary Vindex - -The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. - -## Rdonly - -A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. - -## Reparenting - -The process of changing which [tablet](#tablet) serves as the [primary](#primary) for a [shard](#shard). - -## Replica - -A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). - -## Replication Graph - -Metadata that tracks MySQL primary-replica relationships within the cluster. - -## Reshard - -A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. - -## Restore - -A tablet state indicating the tablet is restoring data from a backup. - -## Routing Rules - -Configuration that overrides default query routing during migrations, allowing gradual traffic shifts between [keyspaces](#keyspace). - -## Secondary Vindex - -A [vindex](#vindex) that provides additional query routing optimization beyond the [primary vindex](#primary-vindex). - -## Shard - -A horizontal partition of a [keyspace](#keyspace). Each shard contains a subset of the keyspace's data based on [keyrange](#keyrange). An unsharded keyspace has a single shard named `0` or `-`. - -## SwitchTraffic - -A VReplication operation that redirects query traffic from a source to a target during workflows like [MoveTables](#movetables) or [Reshard](#reshard). - -## Tablet - -A combination of a `vttablet` process and its associated MySQL instance. Tablets are the basic unit of data storage and query serving in Vitess. - -## Tablet Alias - -A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `zone1-100`. - -## Topology Service - -A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." - -## Unsharded - -A [keyspace](#keyspace) with a single [shard](#shard), containing all data without horizontal partitioning. - -## VDiff - -A VReplication tool that verifies data consistency between source and target during migrations. - -## VEXPLAIN - -A SQL command that shows how Vitess will execute a query across [shards](#shard), including the generated MySQL queries. - -## Vindex - -Virtual index. A mechanism that maps column values to [keyspace IDs](#keyspace-id) for query routing. Types include [primary](#primary-vindex), [secondary](#secondary-vindex), [lookup](#lookup-vindex), and [functional](#functional-vindex). - -## VReplication - -Vitess's streaming replication mechanism for data movement operations like [MoveTables](#movetables), [Reshard](#reshard), and [Materialize](#materialize). - -## VSchema - -Virtual schema. Configuration that defines how a [keyspace](#keyspace) is sharded, including [vindexes](#vindex), table definitions, and routing rules. - -## VStream - -A change notification service on [VTGate](#vtgate) that streams row changes to clients. - -## VStreamer - -The component on [VTTablet](#vttablet) that streams MySQL binary log events for [VReplication](#vreplication) and [VStream](#vstream). - -## vtbackup - -A standalone utility for taking backups of MySQL data managed by Vitess. - -## vtcombo - -A single-process test environment that runs all Vitess components together. Useful for local development and testing. - -## VTAdmin - -A web-based administrative interface for managing and monitoring Vitess clusters. - -## vtctl - -The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). - -## vtctld - -The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). - -## vtctldclient - -The current command-line client for Vitess cluster management. Communicates with [vtctld](#vtctld) to execute administrative operations. - -## VTEXPLAIN - -A command-line tool for offline query analysis that shows how Vitess would route and execute queries without connecting to a live cluster. - -## VTGate - -A lightweight, stateless proxy that routes queries to the appropriate [tablets](#tablet). Applications connect to VTGate rather than directly to MySQL. - -## VTOrc - -Vitess Orchestrator. Provides automated failover, recovery, and tablet management for Vitess clusters. - -## VTTablet - -The Vitess process that manages a MySQL instance, handling query serving, replication, and schema management. Together with MySQL, it forms a [tablet](#tablet). - -## vttestserver - -A lightweight Vitess server for local development and testing that simulates a Vitess cluster. diff --git a/content/en/docs/24.0/reference/glossary.md b/content/en/docs/glossary/_index.md similarity index 99% rename from content/en/docs/24.0/reference/glossary.md rename to content/en/docs/glossary/_index.md index d01cf4277..eb49a72e5 100644 --- a/content/en/docs/24.0/reference/glossary.md +++ b/content/en/docs/glossary/_index.md @@ -1,7 +1,9 @@ --- title: Glossary description: Definitions of terms used in Vitess documentation -weight: 1 +weight: 3000 +cascade: + skipversions: true --- This document defines terms used throughout Vitess documentation, command-line tools, and source code. From 41324e732c3c45b9d4b4d083e33873158c111d72 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Mon, 4 May 2026 16:46:31 +0000 Subject: [PATCH 4/6] docs: Address review feedback on glossary - Update Backup definition: describe as data snapshot concept rather than tablet state, reference backup tablet type anchor - Fix Keyspace definition: use "MySQL replica sets" terminology as suggested by reviewer - Remove deprecated gh-ost and pt-osc from Online DDL entry - Add Consul to Topology Service backends - Remove vtctl entry (deprecated tool being removed) Signed-off-by: promptless[bot] --- content/en/docs/glossary/_index.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/content/en/docs/glossary/_index.md b/content/en/docs/glossary/_index.md index eb49a72e5..40971768d 100644 --- a/content/en/docs/glossary/_index.md +++ b/content/en/docs/glossary/_index.md @@ -10,7 +10,7 @@ This document defines terms used throughout Vitess documentation, command-line t ## Backup -A tablet state indicating the tablet is currently taking a backup of its data. +A consistent snapshot of data stored for disaster recovery and provisioning new tablets. Vitess supports full backups (entire dataset) and incremental backups (binary log changes). See also the [backup tablet type](#backup-tablet-type). ## Cell @@ -42,7 +42,7 @@ The range of [keyspace IDs](#keyspace-id) that a [shard](#shard) is responsible ## Keyspace -A logical database that maps to one or more MySQL databases. If using [sharding](#shard), a keyspace spans multiple databases; otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single databases. +A logical database that maps to one or more MySQL replica sets. If using [sharding](#shard), a keyspace spans multiple MySQL replica sets (one replica set per shard); otherwise it maps to a single MySQL database. Applications interact with keyspaces as if they were single MySQL servers. ## Keyspace ID @@ -70,7 +70,7 @@ A command-line utility for managing the lifecycle of local MySQL instances used ## Online DDL -Non-blocking schema changes that allow tables to remain available during migrations. Vitess supports multiple strategies including its native approach, gh-ost, and pt-osc. +Non-blocking schema changes that allow tables to remain available during migrations. ## Primary @@ -130,7 +130,7 @@ A unique identifier for a [tablet](#tablet) in the format `cell-uid`, such as `z ## Topology Service -A metadata store (backed by etcd or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." +A metadata store (backed by etcd, Consul, or ZooKeeper) that holds cluster configuration, [replication graph](#replication-graph), and serving state. Often abbreviated as "topo." ## Unsharded @@ -176,10 +176,6 @@ A single-process test environment that runs all Vitess components together. Usef A web-based administrative interface for managing and monitoring Vitess clusters. -## vtctl - -The legacy command-line administration tool for Vitess. Deprecated in favor of [vtctldclient](#vtctldclient). - ## vtctld The Vitess control daemon. A server process that executes cluster management commands issued by [vtctldclient](#vtctldclient). From c47380872ac6755491258cb6d205bd5e1596ca91 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Mon, 4 May 2026 16:47:04 +0000 Subject: [PATCH 5/6] docs: Add backup tablet type entry to glossary Adds separate entry for the backup tablet type to avoid broken internal link from the Backup definition. Clarifies the distinction between backup (data snapshot) and backup (tablet state). Signed-off-by: promptless[bot] --- content/en/docs/glossary/_index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/en/docs/glossary/_index.md b/content/en/docs/glossary/_index.md index 40971768d..f2b49c25e 100644 --- a/content/en/docs/glossary/_index.md +++ b/content/en/docs/glossary/_index.md @@ -12,6 +12,10 @@ This document defines terms used throughout Vitess documentation, command-line t A consistent snapshot of data stored for disaster recovery and provisioning new tablets. Vitess supports full backups (entire dataset) and incremental backups (binary log changes). See also the [backup tablet type](#backup-tablet-type). +## Backup (tablet type) {#backup-tablet-type} + +A [tablet](#tablet) state indicating the tablet has stopped replication at a consistent snapshot to upload a new [backup](#backup). After completion, it resumes replication and returns to its previous type. + ## Cell A data center, availability zone, or other failure domain. Vitess uses cells to isolate failures and route queries to geographically appropriate tablets. From 475a9ff286443dc2f8888f67f0269e14b2b2df55 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Mon, 4 May 2026 17:10:26 +0000 Subject: [PATCH 6/6] docs: Add separate tablet type entries for dual-meaning terms Addresses reviewer feedback to disambiguate terms used for both MySQL concepts and Vitess tablet types. Following the pattern established for Backup, creates separate entries for: - Primary / Primary (tablet type) - Replica / Replica (tablet type) - Rdonly (tablet type) - Drained (tablet type) - Restore (tablet type) Each tablet type entry now has an explicit anchor for linking. Signed-off-by: promptless[bot] --- content/en/docs/glossary/_index.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/content/en/docs/glossary/_index.md b/content/en/docs/glossary/_index.md index f2b49c25e..1891ef21d 100644 --- a/content/en/docs/glossary/_index.md +++ b/content/en/docs/glossary/_index.md @@ -24,9 +24,9 @@ A data center, availability zone, or other failure domain. Vitess uses cells to A [lookup vindex](#lookup-vindex) that maintains consistency without requiring two-phase commit. -## Drained +## Drained (tablet type) {#drained-tablet-type} -A tablet state reserved for Vitess background operations. Drained tablets do not serve queries. +A [tablet](#tablet) state reserved for Vitess background operations such as resharding. Drained tablets do not serve queries. ## Functional Vindex @@ -78,15 +78,19 @@ Non-blocking schema changes that allow tables to remain available during migrati ## Primary -The tablet type for the MySQL primary of a [shard](#shard). Handles all write operations. Formerly called "master." +In MySQL replication, the database server that receives write operations and streams changes to replicas. In Vitess, each [shard](#shard) has one primary. See also [Primary (tablet type)](#primary-tablet-type). + +## Primary (tablet type) {#primary-tablet-type} + +A [tablet](#tablet) currently serving as the MySQL primary for its [shard](#shard). Handles all write operations. Formerly called "master." A [replica](#replica-tablet-type) tablet that has been promoted to primary through [reparenting](#reparenting). ## Primary Vindex The [vindex](#vindex) that determines row-to-shard mapping. Equivalent to the sharding key. -## Rdonly +## Rdonly (tablet type) {#rdonly-tablet-type} -A tablet type for read-only replicas that are not eligible for promotion to primary. Used for batch jobs, analytics, and other background operations. +A [tablet](#tablet) type for read-only MySQL replicas that are not eligible for promotion to [primary](#primary-tablet-type). Used for batch jobs, analytics, backups, and other background operations. ## Reparenting @@ -94,7 +98,11 @@ The process of changing which [tablet](#tablet) serves as the [primary](#primary ## Replica -A tablet type for MySQL replicas that are eligible for promotion to [primary](#primary). +In MySQL replication, a database server that receives and applies changes from a primary. See also [Replica (tablet type)](#replica-tablet-type). + +## Replica (tablet type) {#replica-tablet-type} + +A [tablet](#tablet) type for MySQL replicas that are eligible for promotion to [primary](#primary-tablet-type). Conventionally used for serving live, user-facing read requests. ## Replication Graph @@ -104,9 +112,9 @@ Metadata that tracks MySQL primary-replica relationships within the cluster. A VReplication workflow that splits or merges [shards](#shard) to scale horizontally. -## Restore +## Restore (tablet type) {#restore-tablet-type} -A tablet state indicating the tablet is restoring data from a backup. +A [tablet](#tablet) state indicating the tablet is restoring data from a [backup](#backup). After completion, it begins replicating and becomes either [replica](#replica-tablet-type) or [rdonly](#rdonly-tablet-type). ## Routing Rules