Skip to content

Commit

Permalink
Update the restore parameter SQL diagram options to match syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
kathancox committed Feb 13, 2025
1 parent 4bc6eea commit 121706f
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions src/current/v25.1/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,12 @@ No special privilege is required for:

Parameter | Description
-----------|-------------
`table_pattern` | The table, [view]({% link {{ page.version.version }}/views.md %}), or [sequence]({% link {{ page.version.version }}/create-sequence.md %}) you want to restore. For details on how restore works with objects that are dependent on one another, refer to [Object dependencies](#object-dependencies).
`database_name` | The name of the database you want to restore (i.e., restore all tables and views in the database). You can restore an entire database only if you had backed up the entire database.
`collectionURI` | The [collection]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#backup-collections) URI where the [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups) (and appended [incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups), if applicable) is stored. <br/><br/>For information about this URL structure, see [Backup File URLs](#backup-file-urls).
`LATEST` | Restore the most recent backup in the given collection URI. See the [Restore from the most recent backup](#restore-the-most-recent-full-or-incremental-backup) example.
<a name="subdir-param"></a>`subdirectory` | Restore from a specific subdirectory in the given collection URI. See the [Restore a specific backup](#restore-a-specific-full-or-incremental-backup) example.
`localityURI` | The URI where a [locality-aware backup]({% link {{ page.version.version }}/take-and-restore-locality-aware-backups.md %}) is stored. When restoring from an incremental locality-aware backup, you need to include **every** locality ever used, even if it was only used once.<br/><br/>For information about this URL structure, see [Backup File URLs](#backup-file-urls).
<a name="as-of-system-time"></a>`AS OF SYSTEM TIME timestamp` | Restore data as it existed as of [`timestamp`]({% link {{ page.version.version }}/as-of-system-time.md %}). You can restore point-in-time data if you had taken full or incremental backup [with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}). If the backup was not taken with `revision_history`, you can use `SHOW BACKUP` to restore to a time that the backup covers (including in the full or incremental backup). See the [example](#restore-with-as-of-system-time).
`restore_options_list` | Control your backup's behavior with [these options](#options).
`table_pattern` | The table, [view]({% link {{ page.version.version }}/views.md %}), or [sequence]({% link {{ page.version.version }}/create-sequence.md %}) you want to restore. For details on how restore works with objects that are dependent on one another, refer to [Object dependencies](#object-dependencies).
`database_name` | The name of the database you want to restore (i.e., restore all tables and views in the database). You can restore an entire database only if you had backed up the entire database.
<a name="subdir-param"></a>`string_or_placeholder` | One of the following:<ul><li>`LATEST`: Restore the most recent backup in the given [collection]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#backup-collections) URI. Refer to the [Restore from the most recent backup](#restore-the-most-recent-full-or-incremental-backup) example.</li><li>`your_backup_subdirectory`: Restore from a specific subdirectory in the given collection URI. Refer to the [Restore a specific backup](#restore-a-specific-full-or-incremental-backup) example.</li></ul>
`string_or_placeholder_opt_list` | One of the following:<ul><li>`your_backup_collection_URI`: The [collection]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#backup-collections) URI where the [full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups) (and appended [incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups), if applicable) is stored.</li><li>`your_locality_aware_backup_URI`: The URI where a [locality-aware backup]({% link {{ page.version.version }}/take-and-restore-locality-aware-backups.md %}) is stored. When [restoring from an incremental locality-aware backup]({% link {{ page.version.version }}/take-and-restore-locality-aware-backups.md %}#restore-from-an-incremental-locality-aware-backup), include **every** locality ever used, even if it was only used once.</li></ul>
<a name="as-of-system-time"></a>`timestamp` | Restore data as it existed as of [`timestamp`]({% link {{ page.version.version }}/as-of-system-time.md %}). You can restore point-in-time data if you had taken a full or incremental backup [with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}). If the backup was not taken with `revision_history`, you can use [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) to restore to a time that the backup covers (including in the full or incremental backup). Refer to the [Restore with as of system time](#restore-with-as-of-system-time) example.
`restore_options_list` | Control the backup job behavior with [these options](#options).

### Options

Expand Down

0 comments on commit 121706f

Please sign in to comment.