diff --git a/src/current/v21.2/restore.md b/src/current/v21.2/restore.md index 80e4aed2854..12fc8d6716e 100644 --- a/src/current/v21.2/restore.md +++ b/src/current/v21.2/restore.md @@ -77,7 +77,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `skip_localities_check` | N/A | **New in v21.2:** Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions](multiregion-overview.html#cluster-regions) between the backup's cluster and the target cluster.

Example: `WITH skip_localities_check` `encryption_passphrase` | Passphrase used to create the [encrypted backup](take-and-restore-encrypted-backups.html) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`](take-and-restore-encrypted-backups.html) statement. `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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](restore.html#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`](show-jobs.html) statement.

To run a restore within a [transaction](transactions.html), use the `DETACHED` option. -`debug_pause_on` | `"error" ` | **New in v21.2:** Use to have a `RESTORE` [job](show-jobs.html) self pause when it encounters an error. The `RESTORE` job can then be [resumed](resume-job.html) after the error has been fixed or [canceled](cancel-job.html) to rollback the job.

Example: `WITH debug_pause_on='error'` ### Backup file URLs diff --git a/src/current/v22.1/restore.md b/src/current/v22.1/restore.md index 399e360be74..dfb8cd6598a 100644 --- a/src/current/v22.1/restore.md +++ b/src/current/v22.1/restore.md @@ -73,7 +73,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions](multiregion-overview.html#cluster-regions) between the backup's cluster and the target cluster.

Example: `WITH skip_localities_check` `encryption_passphrase` | Passphrase used to create the [encrypted backup](take-and-restore-encrypted-backups.html) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`](take-and-restore-encrypted-backups.html) statement. `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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](restore.html#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`](show-jobs.html) statement.

To run a restore within a [transaction](transactions.html), use the `DETACHED` option. -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job](show-jobs.html) self pause when it encounters an error. The `RESTORE` job can then be [resumed](resume-job.html) after the error has been fixed or [canceled](cancel-job.html) to rollback the job.

Example: `WITH debug_pause_on='error'` `incremental_location` | [`STRING`](string.html) | Restore an incremental backup from the alternate collection URI the backup was originally taken with.

See [Restore incremental backups](#restore-from-incremental-backups) for more detail. ### Backup file URLs diff --git a/src/current/v22.2/restore.md b/src/current/v22.2/restore.md index bdeb1734681..16f919c4496 100644 --- a/src/current/v22.2/restore.md +++ b/src/current/v22.2/restore.md @@ -112,7 +112,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op `skip_localities_check` | N/A | Use to skip checking localities of a cluster before a restore when there are mismatched [cluster regions](multiregion-overview.html#cluster-regions) between the backup's cluster and the target cluster.

Example: `WITH skip_localities_check` `encryption_passphrase` | Passphrase used to create the [encrypted backup](take-and-restore-encrypted-backups.html) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`](take-and-restore-encrypted-backups.html) statement. `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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](restore.html#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`](show-jobs.html) statement.

To run a restore within a [transaction](transactions.html), use the `DETACHED` option. -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job](show-jobs.html) self pause when it encounters an error. The `RESTORE` job can then be [resumed](resume-job.html) after the error has been fixed or [canceled](cancel-job.html) to rollback the job.

Example: `WITH debug_pause_on='error'` `incremental_location` | [`STRING`](string.html) | Restore an incremental backup from the alternate collection URI the backup was originally taken with.

See [Restore incremental backups](#restore-from-incremental-backups) for more detail. New in v22.2: `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](backup-validation.html#validate-a-backup-is-restorable) for detail and an example. New in v22.2: `verify_backup_table_data` | N/A | Run a `schema_only` restore **and** have the restore read all user data from external storage, verify checksums, and discard the user data before writing it to disk. You must also include the `schema_only` option in the `RESTORE` statement with `verify_backup_table_data`. For more detail, see [Backup Validation](backup-validation.html#validate-backup-table-data-is-restorable). diff --git a/src/current/v23.1/restore.md b/src/current/v23.1/restore.md index 86efeb356cf..aebc3066ad9 100644 --- a/src/current/v23.1/restore.md +++ b/src/current/v23.1/restore.md @@ -117,7 +117,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. New in v23.1.12:`EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v23.2/restore.md b/src/current/v23.2/restore.md index 5539d76d95e..6cec43931bd 100644 --- a/src/current/v23.2/restore.md +++ b/src/current/v23.2/restore.md @@ -117,7 +117,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. New in v23.2:`EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v24.1/restore.md b/src/current/v24.1/restore.md index 7e793c3fd0b..2be5b2b3140 100644 --- a/src/current/v24.1/restore.md +++ b/src/current/v24.1/restore.md @@ -117,7 +117,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v24.2/restore.md b/src/current/v24.2/restore.md index 7e793c3fd0b..2be5b2b3140 100644 --- a/src/current/v24.2/restore.md +++ b/src/current/v24.2/restore.md @@ -117,7 +117,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v24.3/restore.md b/src/current/v24.3/restore.md index 10f26aaf49d..f5335313da8 100644 --- a/src/current/v24.3/restore.md +++ b/src/current/v24.3/restore.md @@ -117,7 +117,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v25.1/restore.md b/src/current/v25.1/restore.md index 42a8adb81ff..162b6787a56 100644 --- a/src/current/v25.1/restore.md +++ b/src/current/v25.1/restore.md @@ -115,7 +115,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'` diff --git a/src/current/v25.2/restore.md b/src/current/v25.2/restore.md index 42a8adb81ff..162b6787a56 100644 --- a/src/current/v25.2/restore.md +++ b/src/current/v25.2/restore.md @@ -115,7 +115,6 @@ You can control `RESTORE` behavior using any of the following in the `restore_op Option |
Value
| Description -------------------------------------------------------------------+---------------+------------------------------------------------------- -`debug_pause_on` | `"error" ` | Use to have a `RESTORE` [job]({% link {{ page.version.version }}/show-jobs.md %}) self pause when it encounters an error. The `RESTORE` job can then be [resumed]({% link {{ page.version.version }}/resume-job.md %}) after the error has been fixed or [canceled]({% link {{ page.version.version }}/cancel-job.md %}) to rollback the job.

Example: `WITH debug_pause_on='error'` `DETACHED` | N/A | When `RESTORE` runs with `DETACHED`, the job will execute asynchronously. The job ID is returned after the restore job creation 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 }}/restore.md %}#restore-a-backup-asynchronously) below. To check on the job status, use the [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) statement.

To run a restore within a [transaction]({% link {{ page.version.version }}/transactions.md %}), use the `DETACHED` option. `encryption_passphrase` | Passphrase used to create the [encrypted backup]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | The passphrase used to decrypt the file(s) that were encrypted by the [`BACKUP`]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) statement. `EXECUTION LOCALITY` | Key-value pairs | Restricts the execution of the restore to nodes that match the defined [locality filter]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) requirements.

Example: `WITH EXECUTION LOCALITY = 'region=us-west-1a,cloud=aws'`