From eb107a05f890592b62e82b145c4d865df1c7f183 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Mon, 10 Mar 2025 14:20:37 -0400 Subject: [PATCH] Secondary regions do not work with RBR tables Fixes DOC-8959 NB. This PR includes backported changes to v23.*, v24.*, and v25.* --- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v23.1/sql/regional-by-row-table-description.md | 6 +++++- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v23.2/sql/regional-by-row-table-description.md | 6 +++++- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v24.1/sql/regional-by-row-table-description.md | 6 +++++- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v24.2/sql/regional-by-row-table-description.md | 6 +++++- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v24.3/sql/regional-by-row-table-description.md | 6 +++++- .../secondary-regions-with-regional-by-row-tables.md | 3 +++ .../v25.1/sql/regional-by-row-table-description.md | 6 +++++- src/current/v23.1/alter-database.md | 6 ++++++ src/current/v23.1/create-database.md | 4 ++++ src/current/v23.1/known-limitations.md | 4 ++++ src/current/v23.1/migrate-to-multiregion-sql.md | 4 ++++ src/current/v23.1/multiregion-overview.md | 4 ++++ src/current/v23.2/alter-database.md | 6 ++++++ src/current/v23.2/create-database.md | 4 ++++ src/current/v23.2/known-limitations.md | 4 ++++ src/current/v23.2/migrate-to-multiregion-sql.md | 4 ++++ src/current/v23.2/multiregion-overview.md | 4 ++++ src/current/v24.1/alter-database.md | 6 ++++++ src/current/v24.1/create-database.md | 4 ++++ src/current/v24.1/known-limitations.md | 4 ++++ src/current/v24.1/migrate-to-multiregion-sql.md | 4 ++++ src/current/v24.1/multiregion-overview.md | 4 ++++ src/current/v24.2/alter-database.md | 6 ++++++ src/current/v24.2/create-database.md | 4 ++++ src/current/v24.2/known-limitations.md | 4 ++++ src/current/v24.2/migrate-to-multiregion-sql.md | 4 ++++ src/current/v24.2/multiregion-overview.md | 4 ++++ src/current/v24.3/alter-database.md | 6 ++++++ src/current/v24.3/create-database.md | 4 ++++ src/current/v24.3/known-limitations.md | 4 ++++ src/current/v24.3/migrate-to-multiregion-sql.md | 4 ++++ src/current/v24.3/multiregion-overview.md | 4 ++++ src/current/v25.1/alter-database.md | 6 ++++++ src/current/v25.1/create-database.md | 4 ++++ src/current/v25.1/known-limitations.md | 4 ++++ src/current/v25.1/migrate-to-multiregion-sql.md | 4 ++++ src/current/v25.1/multiregion-overview.md | 4 ++++ src/current/v25.1/table-localities.md | 2 +- 43 files changed, 181 insertions(+), 7 deletions(-) create mode 100644 src/current/_includes/v23.1/known-limitations/secondary-regions-with-regional-by-row-tables.md create mode 100644 src/current/_includes/v23.2/known-limitations/secondary-regions-with-regional-by-row-tables.md create mode 100644 src/current/_includes/v24.1/known-limitations/secondary-regions-with-regional-by-row-tables.md create mode 100644 src/current/_includes/v24.2/known-limitations/secondary-regions-with-regional-by-row-tables.md create mode 100644 src/current/_includes/v24.3/known-limitations/secondary-regions-with-regional-by-row-tables.md create mode 100644 src/current/_includes/v25.1/known-limitations/secondary-regions-with-regional-by-row-tables.md diff --git a/src/current/_includes/v23.1/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v23.1/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v23.1/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v23.1/sql/regional-by-row-table-description.md b/src/current/_includes/v23.1/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v23.1/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v23.1/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/_includes/v23.2/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v23.2/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v23.2/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v23.2/sql/regional-by-row-table-description.md b/src/current/_includes/v23.2/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v23.2/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v23.2/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/_includes/v24.1/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v24.1/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v24.1/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v24.1/sql/regional-by-row-table-description.md b/src/current/_includes/v24.1/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v24.1/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v24.1/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/_includes/v24.2/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v24.2/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v24.2/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v24.2/sql/regional-by-row-table-description.md b/src/current/_includes/v24.2/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v24.2/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v24.2/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/_includes/v24.3/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v24.3/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v24.3/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v24.3/sql/regional-by-row-table-description.md b/src/current/_includes/v24.3/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v24.3/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v24.3/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/_includes/v25.1/known-limitations/secondary-regions-with-regional-by-row-tables.md b/src/current/_includes/v25.1/known-limitations/secondary-regions-with-regional-by-row-tables.md new file mode 100644 index 00000000000..721bf6f1339 --- /dev/null +++ b/src/current/_includes/v25.1/known-limitations/secondary-regions-with-regional-by-row-tables.md @@ -0,0 +1,3 @@ +[Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) are not compatible with databases containing [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) tables. CockroachDB does not prevent you from defining secondary regions on databases with regional by row tables, but the interaction of these features is not supported. + +Therefore, Cockroach Labs recommends that you avoid defining secondary regions on databases that use regional by row table configurations. diff --git a/src/current/_includes/v25.1/sql/regional-by-row-table-description.md b/src/current/_includes/v25.1/sql/regional-by-row-table-description.md index ac788d7b946..6483294d044 100644 --- a/src/current/_includes/v25.1/sql/regional-by-row-table-description.md +++ b/src/current/_includes/v25.1/sql/regional-by-row-table-description.md @@ -12,4 +12,8 @@ To take advantage of regional by row tables: For instructions showing how to set a table's locality to `REGIONAL BY ROW` and configure the home regions of its rows, see [`ALTER TABLE ... SET LOCALITY`]({% link {{ page.version.version }}/alter-table.md %}#crdb_region). -For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). \ No newline at end of file +For more information on regional by row tables, see the [Cockroach Labs blog post](https://www.cockroachlabs.com/blog/regional-by-row/). + +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} diff --git a/src/current/v23.1/alter-database.md b/src/current/v23.1/alter-database.md index 2a41552d094..f9104fb6f7a 100644 --- a/src/current/v23.1/alter-database.md +++ b/src/current/v23.1/alter-database.md @@ -433,6 +433,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -550,6 +552,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v23.1/create-database.md b/src/current/v23.1/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v23.1/create-database.md +++ b/src/current/v23.1/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v23.1/known-limitations.md b/src/current/v23.1/known-limitations.md index c06e36a80a5..d4f373a1ddb 100644 --- a/src/current/v23.1/known-limitations.md +++ b/src/current/v23.1/known-limitations.md @@ -702,6 +702,10 @@ If you think a rollback of a column-dropping schema change has occurred, check t {% include {{ page.version.version }}/known-limitations/drop-unique-index-from-create-table.md %} +### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Row-Level TTL limitations {% include {{page.version.version}}/known-limitations/row-level-ttl-limitations.md %} diff --git a/src/current/v23.1/migrate-to-multiregion-sql.md b/src/current/v23.1/migrate-to-multiregion-sql.md index c590e666f2a..ad03e97bf7d 100644 --- a/src/current/v23.1/migrate-to-multiregion-sql.md +++ b/src/current/v23.1/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v23.1/multiregion-overview.md b/src/current/v23.1/multiregion-overview.md index 4d33baad35c..39b4eea3a0d 100644 --- a/src/current/v23.1/multiregion-overview.md +++ b/src/current/v23.1/multiregion-overview.md @@ -131,6 +131,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v23.2/alter-database.md b/src/current/v23.2/alter-database.md index 2a41552d094..f9104fb6f7a 100644 --- a/src/current/v23.2/alter-database.md +++ b/src/current/v23.2/alter-database.md @@ -433,6 +433,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -550,6 +552,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v23.2/create-database.md b/src/current/v23.2/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v23.2/create-database.md +++ b/src/current/v23.2/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v23.2/known-limitations.md b/src/current/v23.2/known-limitations.md index 217f7c03e9e..880a4500997 100644 --- a/src/current/v23.2/known-limitations.md +++ b/src/current/v23.2/known-limitations.md @@ -701,6 +701,10 @@ This is because the state flip is effected by the CLI program at the end. Only t {% include {{ page.version.version }}/known-limitations/drop-unique-index-from-create-table.md %} +### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Row-Level TTL limitations {% include {{page.version.version}}/known-limitations/row-level-ttl-limitations.md %} diff --git a/src/current/v23.2/migrate-to-multiregion-sql.md b/src/current/v23.2/migrate-to-multiregion-sql.md index 7ef7cb873e5..1b8f777bcc2 100644 --- a/src/current/v23.2/migrate-to-multiregion-sql.md +++ b/src/current/v23.2/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v23.2/multiregion-overview.md b/src/current/v23.2/multiregion-overview.md index 297c76404dd..e8bb467df27 100644 --- a/src/current/v23.2/multiregion-overview.md +++ b/src/current/v23.2/multiregion-overview.md @@ -135,6 +135,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v24.1/alter-database.md b/src/current/v24.1/alter-database.md index 5f09b5d0cee..463dfe09a6d 100644 --- a/src/current/v24.1/alter-database.md +++ b/src/current/v24.1/alter-database.md @@ -437,6 +437,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -554,6 +556,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v24.1/create-database.md b/src/current/v24.1/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v24.1/create-database.md +++ b/src/current/v24.1/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v24.1/known-limitations.md b/src/current/v24.1/known-limitations.md index 4805bd5b937..398ef87aa29 100644 --- a/src/current/v24.1/known-limitations.md +++ b/src/current/v24.1/known-limitations.md @@ -317,6 +317,10 @@ CockroachDB does not allow inverted indexes with a [`STORING` column]({% link {{ {% include {{ page.version.version }}/known-limitations/expression-index-limitations.md %} +#### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Data types #### Spatial support limitations diff --git a/src/current/v24.1/migrate-to-multiregion-sql.md b/src/current/v24.1/migrate-to-multiregion-sql.md index 2bcb2a68859..c059c11a629 100644 --- a/src/current/v24.1/migrate-to-multiregion-sql.md +++ b/src/current/v24.1/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v24.1/multiregion-overview.md b/src/current/v24.1/multiregion-overview.md index 297c76404dd..e8bb467df27 100644 --- a/src/current/v24.1/multiregion-overview.md +++ b/src/current/v24.1/multiregion-overview.md @@ -135,6 +135,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v24.2/alter-database.md b/src/current/v24.2/alter-database.md index 5f09b5d0cee..463dfe09a6d 100644 --- a/src/current/v24.2/alter-database.md +++ b/src/current/v24.2/alter-database.md @@ -437,6 +437,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -554,6 +556,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v24.2/create-database.md b/src/current/v24.2/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v24.2/create-database.md +++ b/src/current/v24.2/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v24.2/known-limitations.md b/src/current/v24.2/known-limitations.md index b6c00e689f2..28bb642cec8 100644 --- a/src/current/v24.2/known-limitations.md +++ b/src/current/v24.2/known-limitations.md @@ -298,6 +298,10 @@ CockroachDB does not allow inverted indexes with a [`STORING` column]({% link {{ {% include {{ page.version.version }}/known-limitations/expression-index-limitations.md %} +#### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Data types #### Spatial support limitations diff --git a/src/current/v24.2/migrate-to-multiregion-sql.md b/src/current/v24.2/migrate-to-multiregion-sql.md index bd5838a1480..cea2526ea01 100644 --- a/src/current/v24.2/migrate-to-multiregion-sql.md +++ b/src/current/v24.2/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v24.2/multiregion-overview.md b/src/current/v24.2/multiregion-overview.md index 297c76404dd..e8bb467df27 100644 --- a/src/current/v24.2/multiregion-overview.md +++ b/src/current/v24.2/multiregion-overview.md @@ -135,6 +135,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v24.3/alter-database.md b/src/current/v24.3/alter-database.md index 5f09b5d0cee..463dfe09a6d 100644 --- a/src/current/v24.3/alter-database.md +++ b/src/current/v24.3/alter-database.md @@ -437,6 +437,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -554,6 +556,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v24.3/create-database.md b/src/current/v24.3/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v24.3/create-database.md +++ b/src/current/v24.3/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v24.3/known-limitations.md b/src/current/v24.3/known-limitations.md index 184ff766a49..cf43f3671e3 100644 --- a/src/current/v24.3/known-limitations.md +++ b/src/current/v24.3/known-limitations.md @@ -309,6 +309,10 @@ CockroachDB does not allow inverted indexes with a [`STORING` column]({% link {{ {% include {{ page.version.version }}/known-limitations/expression-index-limitations.md %} +#### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Data types #### Spatial support limitations diff --git a/src/current/v24.3/migrate-to-multiregion-sql.md b/src/current/v24.3/migrate-to-multiregion-sql.md index bd5838a1480..cea2526ea01 100644 --- a/src/current/v24.3/migrate-to-multiregion-sql.md +++ b/src/current/v24.3/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v24.3/multiregion-overview.md b/src/current/v24.3/multiregion-overview.md index 297c76404dd..e8bb467df27 100644 --- a/src/current/v24.3/multiregion-overview.md +++ b/src/current/v24.3/multiregion-overview.md @@ -135,6 +135,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v25.1/alter-database.md b/src/current/v25.1/alter-database.md index 5f09b5d0cee..463dfe09a6d 100644 --- a/src/current/v25.1/alter-database.md +++ b/src/current/v25.1/alter-database.md @@ -437,6 +437,8 @@ If the [primary region](#set-primary-region) fails, the secondary region becomes {{site.data.alerts.callout_danger}} In order to add a secondary region with `ALTER DATABASE ... SET SECONDARY REGION`, you must first set a primary database region with [`SET PRIMARY REGION`](#set-primary-region), or when [creating the database]({% link {{ page.version.version }}/create-database.md %}). For an example showing how to add a secondary region with `ALTER DATABASE`, see [Set the secondary region](#set-the-secondary-region). + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} {{site.data.alerts.end}} For examples, see [Manage regions](#manage-regions). @@ -554,6 +556,10 @@ ALTER DATABASE SET SECONDARY REGION Now, the `"us-west1"` region will act as the primary region if the original primary region fails. +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Unset the secondary region To unset an existing [database region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) as the [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) on a multi-region database, use the [`DROP SECONDARY REGION`](#drop-secondary-region) statement: diff --git a/src/current/v25.1/create-database.md b/src/current/v25.1/create-database.md index c153aa387ca..3783b53e7f8 100644 --- a/src/current/v25.1/create-database.md +++ b/src/current/v25.1/create-database.md @@ -188,6 +188,10 @@ CREATE DATABASE For more information about secondary regions, see [Secondary regions]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions). +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## See also - [`SHOW DATABASES`]({% link {{ page.version.version }}/show-databases.md %}) diff --git a/src/current/v25.1/known-limitations.md b/src/current/v25.1/known-limitations.md index fb7531fd21f..ed6fa248f79 100644 --- a/src/current/v25.1/known-limitations.md +++ b/src/current/v25.1/known-limitations.md @@ -298,6 +298,10 @@ CockroachDB does not allow inverted indexes with a [`STORING` column]({% link {{ {% include {{ page.version.version }}/known-limitations/expression-index-limitations.md %} +#### Secondary regions and regional by row tables + +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} + ### Data types #### Spatial support limitations diff --git a/src/current/v25.1/migrate-to-multiregion-sql.md b/src/current/v25.1/migrate-to-multiregion-sql.md index bd5838a1480..cea2526ea01 100644 --- a/src/current/v25.1/migrate-to-multiregion-sql.md +++ b/src/current/v25.1/migrate-to-multiregion-sql.md @@ -246,6 +246,10 @@ SHOW ZONE CONFIGURATION FROM TABLE users; ~~~ +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + #### Global tables A [`GLOBAL`]({% link {{ page.version.version }}/table-localities.md %}) table differs from the default by setting the following zone configuration settings: diff --git a/src/current/v25.1/multiregion-overview.md b/src/current/v25.1/multiregion-overview.md index 297c76404dd..e8bb467df27 100644 --- a/src/current/v25.1/multiregion-overview.md +++ b/src/current/v25.1/multiregion-overview.md @@ -135,6 +135,10 @@ If you are using [super regions](#super-regions) in your cluster, there are addi {{site.data.alerts.end}} +{{site.data.alerts.callout_danger}} +{% include {{page.version.version}}/known-limitations/secondary-regions-with-regional-by-row-tables.md %} +{{site.data.alerts.end}} + ## Survival goals A _survival goal_ dictates how many simultaneous failure(s) a database can survive. All tables within the same database operate with the **same survival goal**. Each database can have its own survival goal setting. diff --git a/src/current/v25.1/table-localities.md b/src/current/v25.1/table-localities.md index 83f59e013f6..5f9d5f5b106 100644 --- a/src/current/v25.1/table-localities.md +++ b/src/current/v25.1/table-localities.md @@ -75,4 +75,4 @@ Use a [`GLOBAL` table locality]({% link {{ page.version.version }}/table-localit For an in-depth data placement support comparison and a demonstration of how the [Federal Wire Act (1961)](https://en.wikipedia.org/wiki/Federal_Wire_Act) can only be satisfied with CockroachDB, watch the following video: -{% include_cached youtube.html video_id="3p9VcZOf1Y4" %} \ No newline at end of file +{% include_cached youtube.html video_id="3p9VcZOf1Y4" %}