diff --git a/src/current/_includes/v26.1/backups/backup-options.md b/src/current/_includes/v26.1/backups/backup-options.md index a4c3eeae595..049f881bc74 100644 --- a/src/current/_includes/v26.1/backups/backup-options.md +++ b/src/current/_includes/v26.1/backups/backup-options.md @@ -5,4 +5,5 @@ `detached` | [`BOOL`]({% link {{ page.version.version }}/bool.md %}) / None | When a backup runs in `detached` mode, it will execute asynchronously. The job ID will be returned after the backup [job creation]({% link {{ page.version.version }}/backup-architecture.md %}#job-creation-phase) completes. Note that with `detached` specified, further job information and the job completion status will not be returned. For more on the differences between the returned job data, see the [example]({% link {{ page.version.version }}/backup.md %}#run-a-backup-asynchronously). To check on the job status, use the [`SHOW JOBS`](show-jobs.html) statement. Backups running on a [schedule](create-schedule-for-backup.html) have the `detached` option applied implicitly.

To run a backup within a [transaction](transactions.html), use the `detached` option. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the backup to nodes that match the defined locality filter requirements. For example, `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'`.

Refer to [Take Locality-restricted backups]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) for usage and reference detail. `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). The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates and to decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and to 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. -`incremental_location` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location.

`WITH incremental_location = 'explicit_incrementals_URI'`

See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. \ No newline at end of file +`incremental_location` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location.

`WITH incremental_location = 'explicit_incrementals_URI'`

See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. +`STRICT` | [`BOOL`]({% link {{ page.version.version }}/bool.md %}) / None | A locality-aware backup running in `STRICT` mode fails if it cannot back up data from a node with a locality tag to a bucket with a matching locality tag. \ No newline at end of file diff --git a/src/current/_includes/v26.2/backups/backup-options.md b/src/current/_includes/v26.2/backups/backup-options.md index a4c3eeae595..049f881bc74 100644 --- a/src/current/_includes/v26.2/backups/backup-options.md +++ b/src/current/_includes/v26.2/backups/backup-options.md @@ -5,4 +5,5 @@ `detached` | [`BOOL`]({% link {{ page.version.version }}/bool.md %}) / None | When a backup runs in `detached` mode, it will execute asynchronously. The job ID will be returned after the backup [job creation]({% link {{ page.version.version }}/backup-architecture.md %}#job-creation-phase) completes. Note that with `detached` specified, further job information and the job completion status will not be returned. For more on the differences between the returned job data, see the [example]({% link {{ page.version.version }}/backup.md %}#run-a-backup-asynchronously). To check on the job status, use the [`SHOW JOBS`](show-jobs.html) statement. Backups running on a [schedule](create-schedule-for-backup.html) have the `detached` option applied implicitly.

To run a backup within a [transaction](transactions.html), use the `detached` option. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the backup to nodes that match the defined locality filter requirements. For example, `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'`.

Refer to [Take Locality-restricted backups]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) for usage and reference detail. `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). The key or keys are used to encrypt the manifest and data files that the `BACKUP` statement generates and to decrypt them during a [restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#examples) operation, and to 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. -`incremental_location` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location.

`WITH incremental_location = 'explicit_incrementals_URI'`

See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. \ No newline at end of file +`incremental_location` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | Create an incremental backup in a different location than the default incremental backup location.

`WITH incremental_location = 'explicit_incrementals_URI'`

See [Incremental backups with explicitly specified destinations]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups-with-explicitly-specified-destinations) for usage. +`STRICT` | [`BOOL`]({% link {{ page.version.version }}/bool.md %}) / None | A locality-aware backup running in `STRICT` mode fails if it cannot back up data from a node with a locality tag to a bucket with a matching locality tag. \ No newline at end of file diff --git a/src/current/_includes/v26.2/known-limitations/restore-zones.md b/src/current/_includes/v26.2/known-limitations/restore-zones.md new file mode 100644 index 00000000000..4dfad262e73 --- /dev/null +++ b/src/current/_includes/v26.2/known-limitations/restore-zones.md @@ -0,0 +1 @@ +When restoring from [non-cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), `RESTORE` does not restore [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) for restored objects. [#167824](https://github.com/cockroachdb/cockroach/issues/167824) \ No newline at end of file diff --git a/src/current/v26.1/take-and-restore-locality-aware-backups.md b/src/current/v26.1/take-and-restore-locality-aware-backups.md index c86e24b057e..a34b0c1edbc 100644 --- a/src/current/v26.1/take-and-restore-locality-aware-backups.md +++ b/src/current/v26.1/take-and-restore-locality-aware-backups.md @@ -45,6 +45,8 @@ When you run the `BACKUP` statement for a locality-aware backup, check the follo - {% include {{ page.version.version }}/backups/cap-parameter-ext-connection.md %} - {% include {{ page.version.version }}/backups/locality-aware-access.md %} +Locality-aware backups attempt to match data to buckets in corresponding regions as specified. However, edge cases exist in which a locality-aware backup may be forced to write to the default bucket instead, such as when the cluster has unhealthy nodes. Use the [`STRICT`]({% link {{ page.version.version }}/backup.md %}#options) option when creating a locality-aware backup to force the backup to fail in these cases to avoid violating data domiciling requirements. + You can restore the backup by running: {% include_cached copy-clipboard.html %} diff --git a/src/current/v26.2/restore.md b/src/current/v26.2/restore.md index 32943361078..07fc051afc1 100644 --- a/src/current/v26.2/restore.md +++ b/src/current/v26.2/restore.md @@ -584,6 +584,7 @@ For more detail on using this option with `BACKUP`, see [Incremental backups wit - {% include {{ page.version.version }}/known-limitations/restore-udf.md %} - {% include {{ page.version.version }}/known-limitations/restore-tables-non-multi-reg.md %} +- {% include {{ page.version.version }}/known-limitations/restore-zones.md %} - {% include {{ page.version.version }}/known-limitations/restore-multiregion-match.md %} ## See also diff --git a/src/current/v26.2/take-and-restore-locality-aware-backups.md b/src/current/v26.2/take-and-restore-locality-aware-backups.md index c86e24b057e..a34b0c1edbc 100644 --- a/src/current/v26.2/take-and-restore-locality-aware-backups.md +++ b/src/current/v26.2/take-and-restore-locality-aware-backups.md @@ -45,6 +45,8 @@ When you run the `BACKUP` statement for a locality-aware backup, check the follo - {% include {{ page.version.version }}/backups/cap-parameter-ext-connection.md %} - {% include {{ page.version.version }}/backups/locality-aware-access.md %} +Locality-aware backups attempt to match data to buckets in corresponding regions as specified. However, edge cases exist in which a locality-aware backup may be forced to write to the default bucket instead, such as when the cluster has unhealthy nodes. Use the [`STRICT`]({% link {{ page.version.version }}/backup.md %}#options) option when creating a locality-aware backup to force the backup to fail in these cases to avoid violating data domiciling requirements. + You can restore the backup by running: {% include_cached copy-clipboard.html %}