From 264ee51a7714e64784a5c93ca4fd85d4b6cc703b Mon Sep 17 00:00:00 2001 From: Kathryn May <44557882+kathancox@users.noreply.github.com> Date: Thu, 24 Oct 2024 17:00:33 -0400 Subject: [PATCH] Remove include liquid from markdown table on restore sql page (#19044) --- .../v23.1/backups/skip-localities-check-serverless.md | 1 - .../v23.2/backups/skip-localities-check-serverless.md | 1 - .../v24.1/backups/skip-localities-check-serverless.md | 1 - .../v24.2/backups/skip-localities-check-serverless.md | 1 - .../v24.3/backups/skip-localities-check-serverless.md | 1 - src/current/v23.1/restore.md | 4 ++-- src/current/v23.2/restore.md | 4 ++-- src/current/v24.1/restore.md | 4 ++-- src/current/v24.2/restore.md | 4 ++-- src/current/v24.3/restore.md | 4 ++-- 10 files changed, 10 insertions(+), 15 deletions(-) delete mode 100644 src/current/_includes/v23.1/backups/skip-localities-check-serverless.md delete mode 100644 src/current/_includes/v23.2/backups/skip-localities-check-serverless.md delete mode 100644 src/current/_includes/v24.1/backups/skip-localities-check-serverless.md delete mode 100644 src/current/_includes/v24.2/backups/skip-localities-check-serverless.md delete mode 100644 src/current/_includes/v24.3/backups/skip-localities-check-serverless.md diff --git a/src/current/_includes/v23.1/backups/skip-localities-check-serverless.md b/src/current/_includes/v23.1/backups/skip-localities-check-serverless.md deleted file mode 100644 index 72714f3fc5f..00000000000 --- a/src/current/_includes/v23.1/backups/skip-localities-check-serverless.md +++ /dev/null @@ -1 +0,0 @@ -Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. diff --git a/src/current/_includes/v23.2/backups/skip-localities-check-serverless.md b/src/current/_includes/v23.2/backups/skip-localities-check-serverless.md deleted file mode 100644 index 72714f3fc5f..00000000000 --- a/src/current/_includes/v23.2/backups/skip-localities-check-serverless.md +++ /dev/null @@ -1 +0,0 @@ -Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. diff --git a/src/current/_includes/v24.1/backups/skip-localities-check-serverless.md b/src/current/_includes/v24.1/backups/skip-localities-check-serverless.md deleted file mode 100644 index 55ee795a59e..00000000000 --- a/src/current/_includes/v24.1/backups/skip-localities-check-serverless.md +++ /dev/null @@ -1 +0,0 @@ -Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.CockroachDB {{ site.data.products.standard }} }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. diff --git a/src/current/_includes/v24.2/backups/skip-localities-check-serverless.md b/src/current/_includes/v24.2/backups/skip-localities-check-serverless.md deleted file mode 100644 index 72714f3fc5f..00000000000 --- a/src/current/_includes/v24.2/backups/skip-localities-check-serverless.md +++ /dev/null @@ -1 +0,0 @@ -Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. diff --git a/src/current/_includes/v24.3/backups/skip-localities-check-serverless.md b/src/current/_includes/v24.3/backups/skip-localities-check-serverless.md deleted file mode 100644 index 72714f3fc5f..00000000000 --- a/src/current/_includes/v24.3/backups/skip-localities-check-serverless.md +++ /dev/null @@ -1 +0,0 @@ -Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. diff --git a/src/current/v23.1/restore.md b/src/current/v23.1/restore.md index ec651ed9116..f696577398a 100644 --- a/src/current/v23.1/restore.md +++ b/src/current/v23.1/restore.md @@ -126,7 +126,7 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats) on the Encrypted Backups page. The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates, decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}).

AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. `new_db_name` | Database name | [Rename a database during a restore](#rename-a-database-on-restore). The existing backed-up database can remain active while the same database is restored with a different name.

Example: `RESTORE DATABASE movr ... WITH new_db_name = 'new_movr'` `schema_only` | N/A | Verify that a backup is valid by running `RESTORE ... schema_only`, which will restore the backed-up schema without any user data. Refer to [Backup Validation]({% link {{ page.version.version }}/backup-validation.md %}#validate-a-backup-is-restorable) for detail and an example. -`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

**Note:** {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %}

Example: `WITH skip_localities_check` +`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

Example: `WITH skip_localities_check` `skip_missing_foreign_keys` | N/A | Use to remove the missing [foreign key]({% link {{ page.version.version }}/foreign-key.md %}) constraints before restoring.

Example: `WITH skip_missing_foreign_keys` `skip_missing_sequences` | N/A | Use to ignore [sequence]({% link {{ page.version.version }}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence).

Example: `WITH skip_missing_sequences` `skip_missing_sequence_owners` | N/A | Must be used when restoring either a table that was previously a [sequence owner]({% link {{ page.version.version }}/create-sequence.md %}#owned-by) or a sequence that was previously owned by a table.

Example: `WITH skip_missing_sequence_owners` @@ -265,7 +265,7 @@ CockroachDB does **not** support incremental-only restores. - A [cluster's regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) will be checked before a restore. Mismatched regions between backup and restore clusters will be flagged before the restore begins, which allows for a decision between updating the [cluster localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality) or restoring with the [`skip_localities_check`](#skip-localities-check) option to continue with the restore regardless. {{site.data.alerts.callout_info}} - {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %} + Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. {{site.data.alerts.end}} - A database that is restored with the `sql.defaults.primary_region` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) will have the [`PRIMARY REGION`]({% link {{ page.version.version }}/alter-database.md %}#set-primary-region) from this cluster setting assigned to the target database. diff --git a/src/current/v23.2/restore.md b/src/current/v23.2/restore.md index 9a30911af95..fd5f1d3295f 100644 --- a/src/current/v23.2/restore.md +++ b/src/current/v23.2/restore.md @@ -126,7 +126,7 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats) on the Encrypted Backups page. The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates, decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}).

AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. `new_db_name` | Database name | [Rename a database during a restore](#rename-a-database-on-restore). The existing backed-up database can remain active while the same database is restored with a different name.

Example: `RESTORE DATABASE movr ... WITH new_db_name = 'new_movr'` `schema_only` | N/A | Verify that a backup is valid by running `RESTORE ... schema_only`, which will restore the backed-up schema without any user data. Refer to [Backup Validation]({% link {{ page.version.version }}/backup-validation.md %}#validate-a-backup-is-restorable) for detail and an example. -`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

**Note:** {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %}

Example: `WITH skip_localities_check` +`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

Example: `WITH skip_localities_check` `skip_missing_foreign_keys` | N/A | Use to remove the missing [foreign key]({% link {{ page.version.version }}/foreign-key.md %}) constraints before restoring.

Example: `WITH skip_missing_foreign_keys` `skip_missing_sequences` | N/A | Use to ignore [sequence]({% link {{ page.version.version }}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence).

Example: `WITH skip_missing_sequences` `skip_missing_sequence_owners` | N/A | Must be used when restoring either a table that was previously a [sequence owner]({% link {{ page.version.version }}/create-sequence.md %}#owned-by) or a sequence that was previously owned by a table.

Example: `WITH skip_missing_sequence_owners` @@ -265,7 +265,7 @@ CockroachDB does **not** support incremental-only restores. - A [cluster's regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) will be checked before a restore. Mismatched regions between backup and restore clusters will be flagged before the restore begins, which allows for a decision between updating the [cluster localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality) or restoring with the [`skip_localities_check`](#skip-localities-check) option to continue with the restore regardless. {{site.data.alerts.callout_info}} - {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %} + Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. {{site.data.alerts.end}} - A database that is restored with the `sql.defaults.primary_region` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) will have the [`PRIMARY REGION`]({% link {{ page.version.version }}/alter-database.md %}#set-primary-region) from this cluster setting assigned to the target database. diff --git a/src/current/v24.1/restore.md b/src/current/v24.1/restore.md index 62036dc4277..20074af2171 100644 --- a/src/current/v24.1/restore.md +++ b/src/current/v24.1/restore.md @@ -126,7 +126,7 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats) on the Encrypted Backups page. The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates, decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}).

AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. `new_db_name` | Database name | [Rename a database during a restore](#rename-a-database-on-restore). The existing backed-up database can remain active while the same database is restored with a different name.

Example: `RESTORE DATABASE movr ... WITH new_db_name = 'new_movr'` `schema_only` | N/A | Verify that a backup is valid by running `RESTORE ... schema_only`, which will restore the backed-up schema without any user data. Refer to [Backup Validation]({% link {{ page.version.version }}/backup-validation.md %}#validate-a-backup-is-restorable) for detail and an example. -`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

**Note:** {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %}

Example: `WITH skip_localities_check` +`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

Example: `WITH skip_localities_check` `skip_missing_foreign_keys` | N/A | Use to remove the missing [foreign key]({% link {{ page.version.version }}/foreign-key.md %}) constraints before restoring.

Example: `WITH skip_missing_foreign_keys` `skip_missing_sequences` | N/A | Use to ignore [sequence]({% link {{ page.version.version }}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence).

Example: `WITH skip_missing_sequences` `skip_missing_sequence_owners` | N/A | Must be used when restoring either a table that was previously a [sequence owner]({% link {{ page.version.version }}/create-sequence.md %}#owned-by) or a sequence that was previously owned by a table.

Example: `WITH skip_missing_sequence_owners` @@ -265,7 +265,7 @@ CockroachDB does **not** support incremental-only restores. - A [cluster's regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) will be checked before a restore. Mismatched regions between backup and restore clusters will be flagged before the restore begins, which allows for a decision between updating the [cluster localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality) or restoring with the [`skip_localities_check`](#skip-localities-check) option to continue with the restore regardless. {{site.data.alerts.callout_info}} - {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %} + Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. {{site.data.alerts.end}} - A database that is restored with the `sql.defaults.primary_region` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) will have the [`PRIMARY REGION`]({% link {{ page.version.version }}/alter-database.md %}#set-primary-region) from this cluster setting assigned to the target database. diff --git a/src/current/v24.2/restore.md b/src/current/v24.2/restore.md index 62036dc4277..20074af2171 100644 --- a/src/current/v24.2/restore.md +++ b/src/current/v24.2/restore.md @@ -126,7 +126,7 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats) on the Encrypted Backups page. The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates, decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}).

AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. `new_db_name` | Database name | [Rename a database during a restore](#rename-a-database-on-restore). The existing backed-up database can remain active while the same database is restored with a different name.

Example: `RESTORE DATABASE movr ... WITH new_db_name = 'new_movr'` `schema_only` | N/A | Verify that a backup is valid by running `RESTORE ... schema_only`, which will restore the backed-up schema without any user data. Refer to [Backup Validation]({% link {{ page.version.version }}/backup-validation.md %}#validate-a-backup-is-restorable) for detail and an example. -`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

**Note:** {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %}

Example: `WITH skip_localities_check` +`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

Example: `WITH skip_localities_check` `skip_missing_foreign_keys` | N/A | Use to remove the missing [foreign key]({% link {{ page.version.version }}/foreign-key.md %}) constraints before restoring.

Example: `WITH skip_missing_foreign_keys` `skip_missing_sequences` | N/A | Use to ignore [sequence]({% link {{ page.version.version }}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence).

Example: `WITH skip_missing_sequences` `skip_missing_sequence_owners` | N/A | Must be used when restoring either a table that was previously a [sequence owner]({% link {{ page.version.version }}/create-sequence.md %}#owned-by) or a sequence that was previously owned by a table.

Example: `WITH skip_missing_sequence_owners` @@ -265,7 +265,7 @@ CockroachDB does **not** support incremental-only restores. - A [cluster's regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) will be checked before a restore. Mismatched regions between backup and restore clusters will be flagged before the restore begins, which allows for a decision between updating the [cluster localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality) or restoring with the [`skip_localities_check`](#skip-localities-check) option to continue with the restore regardless. {{site.data.alerts.callout_info}} - {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %} + Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. {{site.data.alerts.end}} - A database that is restored with the `sql.defaults.primary_region` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) will have the [`PRIMARY REGION`]({% link {{ page.version.version }}/alter-database.md %}#set-primary-region) from this cluster setting assigned to the target database. diff --git a/src/current/v24.3/restore.md b/src/current/v24.3/restore.md index fdedccffca3..e1d3ad489fb 100644 --- a/src/current/v24.3/restore.md +++ b/src/current/v24.3/restore.md @@ -126,7 +126,7 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `kms` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The URI of the cryptographic key stored in a key management service (KMS), or a comma-separated list of key URIs, used to [take and restore encrypted backups]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples). Refer to [URI Formats]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#uri-formats) on the Encrypted Backups page. The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates, decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and list the contents of the backup when using [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}).

AWS KMS, Google Cloud KMS, and Azure Key Vault are supported. `new_db_name` | Database name | [Rename a database during a restore](#rename-a-database-on-restore). The existing backed-up database can remain active while the same database is restored with a different name.

Example: `RESTORE DATABASE movr ... WITH new_db_name = 'new_movr'` `schema_only` | N/A | Verify that a backup is valid by running `RESTORE ... schema_only`, which will restore the backed-up schema without any user data. Refer to [Backup Validation]({% link {{ page.version.version }}/backup-validation.md %}#validate-a-backup-is-restorable) for detail and an example. -`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

**Note:** {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %}

Example: `WITH skip_localities_check` +`skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) between the backup's cluster and the target cluster. For further details, refer to [Restoring to multi-region databases](#restoring-to-multi-region-databases).

Example: `WITH skip_localities_check` `skip_missing_foreign_keys` | N/A | Use to remove the missing [foreign key]({% link {{ page.version.version }}/foreign-key.md %}) constraints before restoring.

Example: `WITH skip_missing_foreign_keys` `skip_missing_sequences` | N/A | Use to ignore [sequence]({% link {{ page.version.version }}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence).

Example: `WITH skip_missing_sequences` `skip_missing_sequence_owners` | N/A | Must be used when restoring either a table that was previously a [sequence owner]({% link {{ page.version.version }}/create-sequence.md %}#owned-by) or a sequence that was previously owned by a table.

Example: `WITH skip_missing_sequence_owners` @@ -265,7 +265,7 @@ CockroachDB does **not** support incremental-only restores. - A [cluster's regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) will be checked before a restore. Mismatched regions between backup and restore clusters will be flagged before the restore begins, which allows for a decision between updating the [cluster localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality) or restoring with the [`skip_localities_check`](#skip-localities-check) option to continue with the restore regardless. {{site.data.alerts.callout_info}} - {% include {{ page.version.version }}/backups/skip-localities-check-serverless.md %} + Restoring a multi-region cluster into a single-region CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster is not supported. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do **not** support the `skip_localities_check` option with `RESTORE`. To restore a multi-region cluster, you must [create a new multi-region {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/basic-cluster-management.md %}#move-cluster-to-a-new-region) with regions that match the backed-up multi-region cluster. {{site.data.alerts.end}} - A database that is restored with the `sql.defaults.primary_region` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) will have the [`PRIMARY REGION`]({% link {{ page.version.version }}/alter-database.md %}#set-primary-region) from this cluster setting assigned to the target database.