Page History
- SQLsafeCmd Restore
...
- <db_name>
...
- <backup_archive> [options]
...
- SQLsafeCmd
...
- Restore <db_name>
...
- <point_in_time> [options]
...
- SQLsafeCmd
...
- Restore <db_name>
...
- TSM [options]
...
Where:
| Action | Description |
|---|---|
| <db_name> |
...
| Name of the database. | |
| <backup_archive> | Path to the backup archive. |
<point_in_time> | Date/Time {"MM/dd/yyyy hh:mm:ss"} to restore to. |
| Tsm | Use Tivoli Storage Manager |
...
. |
Common Options
The following options help you perform restore operations:
...
| Options |
|---|
...
{Full | Differential | Log | File} The backup type required.
...
{0 | 1 | 2 | 3 | 4} The backup destination type is used for the backup.
...
{ispeed | isize | 0 | 1 | 2 | 3 | 4} The compression level used for the backup. If the compression level is not specified, ispeed is the default.
...
One or more names of database(s) to not backup.
| Descriptions | |
|---|---|
| -BackupSet <index> | <index> - the index of the backup set within the backup archive (1-based). |
| -DisconnectUsers | Disconnects all users from the target database before the restore operation begins. |
| -EncryptedRestorePassword <pwd> | <pwd> - the encrypted password used to decrypt the backup. |
| -InstanceName <name> | <name> - SQL server instance name. Note: it is not required if instance is |
...
the default instance on the target server. |
...
Don't truncate the transaction log (Log backup only)
...
Overwrite existing archive if one exists. If this option is omitted, the default behavior is to append.
| -Move <logical_filename> <target_filename> | Move the database logical database file to the physical target file. <logical_filename> - the database logical database file. <target_filename> - the physical target file. Corresponds to the WITH MOVE option in the RESTORE DATABASE T/SQL command. |
| -Password <pwd> | <pwd> - the non-encrypted password used to encrypt the backup. |
| -Server <hostname> | <hostname> - the hostname |
...
of server hosting the SQL Server where the operation should be performed. |
...
Note: this option is required for accessing remote or clustered SQL Servers (where applicable). |
...
Verify the backup set after backup is complete.
Encryption Options:
EncryptionType <type> | {AES128 | AES256} The type of encryption used to encrypt the backup. |
| Password <pwd> | The non-encrypted password used to encrypt the backup. |
| EncryptedBackupPassword <pwd> | The encrypted password used to encrypt the backup. (Used with EncryptionType) |
Security Options:
...
| -Replace | Override database if exists. |
Security Options
Secure your restore operations with the following options:
| Options | Description |
|---|---|
| -NoPrompt |
| Never prompt for credentials even if necessary. |
| -SecurityModel <model> |
...
The security model used to log into SQL Server. <model> - Integrated or SQL. Note: Integrated ( |
...
Windows authentication) is the default. | |
| -SqlUsername <username> | <username> - the SQL Server username (SQL SecurityModel). |
| -SqlPassword <pwd> | <pwd> - the SQL Server password (SQL SecurityModel). |
| -EncryptedSqlPassword <pwd> |
...
| <pwd> - the encrypted SQL Server password generated by EncryptSqlPassword action |
...
| (SQL SecurityModel). |
| -WindowsUsername <domain\user> |
...
| <domain\user> - the Windows user that will be used to read/write the backup archive. |
| -WindowsPassword <pwd> |
...
| <pwd> - the password for the Windows user. |
| -EncryptedWindowsPassword <pwd> |
...
| <pwd> - the encrypted password for the Windows user generated by EncryptWindowsPassword action. |
Advanced Options
The following advanced options help you perform restore operations:
...
| Options |
|---|
...
| Description |
|---|
| -ArgsFile <filename> |
...
The path to a file containing command-line arguments. <filename> - specifies the file that contains the command line arguments. | |
| -BackupFile <filename> | Specifies additional backup archive files to be used for striping backups. |
...
<filename> - specifies the backup archive files. Note: use once for each additional stripe. |
...
Checksum
| -ContinueAfterError |
Instructs SQL Server to |
...
continue the operation despite encountering errors such as invalid checksums. |
...
CopyOnly
...
Note: SQL 2005 and later only |
...
(File BackupType only) The database logical filegroup.
...
. |
...
...
{Minutes | Hours | Days | Weeks | Months}
After a backup successfully completes, delete archives that are older than the specified amount of time. There must be NO SPACE between <n> and time_period>. E.g., -delete 2hours. If used, the backup archive filename will be automatically generated with the following pattern: <instancename>_<databasename>_<backuptype>_ <timestamp>.safe. The <timestamp> is in UTC time and is of the form YYYYMMDDHHMM.
-IncludeLogins | For backup, |
...
{Minutes | Hours | Days | Weeks | Months}
After a backup successfully completes, delete mirrors that are older than the specified amount of time. There must be NO SPACE between <n> and <time_period>. E.g., -deletemirror 2hours. If used, the mirror filename will be automatically generated with the following pattern:<instancename>_<databasename>_<backuptype>_<timestamp>.safe. The <timestamp> is in UTC time and is of the form YYYYMMDDHHMM.
...
FailOnMirrorError
...
includes the database logins in the backup file. For restore, creates the logins from the backup file on the destination server. | |
| -KeepReplication | Preserves replication settings when restoring a published database to a server other than that on which it was created. |
| -MailTo <email_address> |
...
<email_address> - an e-mail address(es) |
...
to send a notification via SMTP. Note: multiple addresses may be |
...
separated by spaces, semicolons, or commas. |
...
Specifiy additional backup archive files to be used for mirroring backups. Use once for each additional mirror. Up to two mirrors may be specified.
...
Disables automatic skipping of databases that cannot be backed up, such as offline databases.
| -NoStatus |
...
Prevents status messages from being cached or sent to the Repository. |
...
ReadWriteFileGroups
...
(SQL 2005 and later only) Instructs SQL Server to perform a partial backup, which includes the primary filegroup and any read-write secondary filegroups.
| -RecoveryMode <mode> [-UndoFile <filename>] |
...
Specifies the mode in which to leave the database after the operation is completed. |
...
<mode> - NoRecovery or Standby. Note: for Standby mode an undo file may be specified with the -UndoFile option. |
...
| -UndoFile <filename> |
...
<filename> - specifies the ABSOLUTE path to the undo filename |
...
. Note: for Standby recovery mode only |
...
. |
| - |
...
| RetryReads <interval> <retry_time> <total_time> | On a network file error, retry every certain amount of time. <interval> |
...
- retry from every certain amount of time in seconds. <retry_time> - retry up to certain amount of time in seconds. |
...
...
<total_time> - total retry time allowed in minutes. |
| - |
...
| StopAt <datetime> | Specifies |
...
Do not optimize for quick access by SQL virtual database.
...
that the database be restored to the state it was in as of the specified date and time. <datetime> - "mm/dd/yyyy hh:mm:ss". Note: for Log BackupType only. | |
| -StopAtMark <mark> [-After <datetime>] | Specifies recovery to the specified <mark>, including the transaction that contains the <mark>. Note: for Log BackupType only. |
| -StopBeforeMark <mark> [-After <datetime>] | Specifies recovery to the specified <mark> but does not include the transaction that contains the <mark>. Note: for Log BackupType only. |
| -After <datetime> | Recovery stops at the first <mark> having the specified name exactly at or after <datetime>. Note: only valid with -StopAtMark/-StopBeforeMark options. For Log BackupType only |
...
. |
Tivoli Storage Manager Options
There are TSM options for your restore operations:
...
Options |
|---|
...
Description |
|---|
| -TsmClientOwnerName <name> |
...
| <name> - the client owner name. |
| -TsmClientOwnerPassword <pwd> |
...
| <pwd> - the client owner password. |
| -EncryptedTsmClientOwnerPassword <pwd> |
...
| <pwd> - the encrypted TSM client owner password. |
| -TsmConfigFile <filename> |
...
| <filename> - the configuration file location. |
| -TsmHighLevel <name> |
...
| <name> - the high level file specification (path). |
| -TsmLowLevel <name> |
...
| <name> - the low level file specification (file name). |
| -TsmTcpServerAddress <address> |
...
| <address> - the TCP/IP address for the TSM server. |
| -TsmTcpPort <port> |
...
| <port> - the TCP/IP port address for the TSM server |
...
| . | |
| -TsmId <object_id> | <object_id> - The TSM object id. Note: if provided, high level and low level are not needed |
...
. |
For detailed descriptions and available options, see the CLI Help (SQLsafecmd help
...
restore).