LiteSpeed for SQL Server 8.8 - Installation Guide

xp_restore_automated

Restores the most recent full disk and cloud backup created with LiteSpeed and optionally differential and transaction log backups. You can use this extended stored procedure to automate restore operations even if backup files have unique names.

NOTE: A database cannot be restored unless the restore process has exclusive access to the database. No user connections can exist when performing a database restore.

This topic covers:

• Syntax

• Arguments

• Examples

• Returns

Syntax

EXEC master.dbo.xp_restore_automated
[@database = 'database_name'
[, @datafilepath = 'path']
[, @logfilepath = 'path'] ]
, ( @filename = 'backup_filename' | ( @backuppath = 'path'
, @backupextension = 'extensions'
, @checksubfolders = 0 | 1 ) ) [,...n]
, @sourceserver = 'server_name'
, @sourcedatabase = 'database_name'
, @backuptype = N'option',
[, ( @encryptionkey = 'encryption_key' | @jobp = 'encrypted_key' ) ]
[, @with = 'additional_with_parameters'] [,...n]
[, @withreplace = 0 | 1 ]
[, @logging = 0 | 1 | 2 ]
[, @affinity = 0..2147483648]
[, @throttle = 1..100]
[, @ioflag = 'DISK_RETRY_COUNT=n']
[, @ioflag = 'DISK_RETRY_WAIT=n']
[, @buffercount = 'buffer_count']
[, @maxtransfersize = 'maximum_transfer_size']
[, @restoreasreadonly = 0 | 1]
[, @restoreascompressed = 0 | 1]
[, @dryrun = 0 | 1]
[, @dropdatabaseonfailure = 0 | 1 ]
[, @dropdatabaseonsuccess = 0 | 1 ]

xp_restore_automated (Amazon S3)

EXEC master.dbo.xp_restore_automated

@database = N'filegroups' ,

@filename = N'test\test.bak',

@sourceserver = N'test\test',

@sourcedatabase = N'filegroups',

@backuptype = N'diff',

@CloudVendor = N'AmazonS3',

@CloudBucketName = N'test',

@CloudAccessKeyEnc = N'******',

@CloudSecretKeyEnc = N'*******',

@UseSSL = 1,

@CloudGovRegion = 1,

@proxyhost = N'10.1.1.1',

@proxyport = 80,

@proxylogin = N'test',

@ProxyPasswordEnc = N'******',

@affinity = 0,

@logging = 0,

@DontUseReplication = 1,

@withreplace = 1,

@checkdb = 1,

@checkdbphysicalonly = 1,

@checkdbnoindex = 1,

@checkdbnoinfomessages = 1,

@read_write_filegroups = 1,

@returndetails = 1,

@with = N'STATS = 10'

xp_restore_automated (Google Cloud Storage)

exec master.dbo.xp_restore_automated
@database = N'db-ar'
, @backuppath = N''
, @backupextension = N''
, @checksubfolders = 0
, @sourceserver = N'SOURCE\SERVER'
, @sourcedatabase = N'source-db'
, @backuptype = N'diff'
, @affinity = 0
, @logging = 0
, @DontUseReplication = 1
, @checkdb = 1
, @checkdbphysicalonly = 1
, @checkdbnoindex = 1
, @checkdbnoinfomessages = 1
, @with = N'RECOVERY'
, @with = N'STATS = 10'
, @CloudVendor = N'GoogleStorage'
, @CloudBucketName = N'bucketname'
, @CloudAccessKey = N'***' -- my key'
, @CloudSecretKey = N'***' -- my key'

Arguments

Tips:

• To see the list of accepted arguments and data types for arguments, execute the following:
  exec master.dbo.<procedure_name> show_help

• To convert the script for use with the command-line utilities, execute the following:
  exec master.dbo.<procedure_name> show_cmd, <xp_arguments>

@affinity

Processor affinity designates specific processors to run LiteSpeed, while not allowing LiteSpeed to run on the remaining processors.

This argument accepts decimal values and hexadecimal values. If a value begins with "0x" it is interpreted as hexadecimal. A positive 64-bit integer value translates to a binary mask where a value of 1 designates the corresponding processor to be able to run the LiteSpeed process.

NOTE: 32-bit Windows is internally limited to a 32-bit mask.

For example, you need to select processors 2, 3, and 6 for use with LiteSpeed. Number the bits from the right to left. The rightmost bit represents the first processor. Set the second, third, and sixth bits to 1 and all other bits to 0. The result is binary 100110, which is decimal 38 or hexadecimal 0x26. Review the following for additional information:

Tip: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance, try limiting the number of threads. If you decide to use an affinity value other than default, it is recommended that you limit the threading as well. You may also want to consider using Adaptive Compression to maintain backup performance. For more information, see Adaptive Compression.

@ARPeriod

Specifies a point in time to restore from where the time is measured in days, hours, minutes and seconds from the restore time.

Set 0's for periods not used.

@ARPeriod = N'DD.HH:MM:SS'

@ARPointInTime

Specifies a point in time to restore from: year, month, day, hours, minutes, seconds.

@ARPointInTime = N'YYYY-MM-DD HH:MM:SS'

@AttachedFile

Specifies filepaths to include in both backup and restore operations. The filepath can be either a single file or a directory. If it is a directory, then LiteSpeed recursively includes all files and subdirectories. All attached files are encrypted and compressed, with all pertinent backup parameters supported. This feature works for disk, tape, TSM, and Double Click Restore as well. You can supply multiple instances of this argument.

When used within the context of a restore operation, the path parameter can be expanded to include a new destination. This form will take the syntax of <file_path> to <new_file_path>. The new filepath can be used to specify a new location but cannot rename a file.

This argument only restores the attached files. It does not restore the database, just the files that were attached to that backup.

NOTES:

• The original entire directory path need not be supplied (e.g. c: to c:\testadSattsm is allowed).

• c:\testad to testadr would restore all files in directory c:\testad to c:\testadr.

@AWSAccessKey

The @AWSAccessKey argument specifies the name of the unique Amazon Web Service alphanumeric access key that identifies each user.

@AWSAccessKeyEnc

The @AWSAccessKeyEnc argument specifies the name of the encrypted unique Amazon Web Service alphanumeric access key that identifies each user.

@AWSBucketName

The @AWSBucketName argument specifies the name of the container for AWS objects. Bucket names must be at least 3 and no more than 63 characters long.

@AWSRegionName

The @AWSRegionName argument specifies the name of the Amazon Web Service region to use for a bucket. Example values are but not limited to: us-east-1, us-west-2, us-west-1, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, and sa-east-1.

@AWSSecretKey

The @AWSSecretKey argument specifies the name of the Amazon Web Service secret key that is assigned when you initially get an AWS account.

@AWSSecretKeyEnc

The @AWSSecretKeyEnc argument specifies the name of the encrypted Amazon Web Service secret key that is assigned when you initially get an AWS account.

@AWSUseGovCloud

The @AWSUseGovCloud argument enables a special restricted region for the US Government use in Amazon S3. This argument accepts one of the following values:

• 0—Do not use government cloud
• 1—Use government cloud

@backupextension

When looking for database backups, LiteSpeed will only consider backup files that have the extensions you specify. The value of this parameter is a list of extensions, separated with commas. No value or asterisk (*) specifies any file extension.

@backuppath

Specifies the directory where to search for the backup files.

@backuptype

Specifies backup types to use for the restore. This argument accepts one of the following values:

• full—LiteSpeed will only restore the most recent full database backup.
• diff—LiteSpeed will restore the most recent full database backup and any existing differential backups based on this full.
• tlog—LiteSpeed will restore the most recent full database backup and any existing differential and/or transaction log backups created after the most recent full backup.

@buffercount

Specifies the number of SQL Server buffers available for a LiteSpeed operation. The default value is set by SQL Server.

@checkdb

Checks database integrity after restore. This argument accepts one of the following values:

• 0—False. LiteSpeed will not confirm integrity of the database after restore.
• 1—True. LiteSpeed will confirm integrity of the database after restore.

@checkdbdatapurity

Checks data purity validations on every column value in all rows of the table or tables in the database. This argument accepts one of the following values:

• 0—False. LiteSpeed will not confirm integrity of the database column values after restore.
• 1—True. LiteSpeed will confirm integrity of the database column values after restore.

@checkdbextendedlogical

Checks logical consistency on an indexed view, XML indexes, and spatial indexes after restore. This argument accepts one of the following values:

• 0—False. LiteSpeed will not confirm logical consistency after restore.
• 1—True. LiteSpeed will confirm logical consistency after restore.

@checkdbnoindex

Checks the database but does not check the index. This argument accepts one of the following values:

• 0—False. LiteSpeed will check the database and check the index.
• 1—True. LiteSpeed will check the database but not check the index.

@checkdbnoinfomessages

Causes check database to suppress all informational messages. after restore. This argument accepts one of the following values:

• 0—False. LiteSpeed will include informational messages in notification report after restore.
• 1—True. LiteSpeed will not include informational messages in notification report after restore.

@checkdbphysicalonly

Checks physical structure of the database only. This argument accepts one of the following values:

• 0—False. LiteSpeed will not confirm physical structure of the database.
• 1—True. LiteSpeed will confirm physical structure of the database.

@checkdbtablelocks

Causes check database to obtain locks instead of using an internal database snapshot. This includes a short-term exclusive (X) lock on the database. This argument accepts one of the following values:

• 0—False. LiteSpeed will not use locks instead of using an internal database snapshot after restore.
• 1—True. LiteSpeed will use locks instead of using an internal database snapshot after restore.

@checksubfolders

Specifies whether to use subfolders to look for database backups. This argument accepts one of the following values:

• 0—False. LiteSpeed will only use backups located in the specified folder.
• 1—True. LiteSpeed will look for backups in the specified folder and in its subfolders.

@CloudAccessKey

The @CloudAccessKey argument specifies the name of the unique Cloud Web Service alphanumeric access key that identifies each user. The selections include Amazon Access Key, Azure Account Name, Google e-mail styled account.

@CloudAccessKeyEnc

The @CloudAccessKeyEnc argument specifies the name of the encrypted unique Cloud Web Service alphanumeric access key that identifies each user.

@CloudBucketName

The @CloudBucketName argument specifies the name of the container for cloud objects. Bucket names must be at least 3 and no more than 63 characters long. The selections are Amazon Bucket Name, Azure Container Name, Google Bucket Name. Google Bucket Name requirements are described at https://cloud.google.com/storage/docs/naming.

@CloudGovRegion

The @CloudGovRegion argument enables a special restricted region for the US Government use in Amazon S3 and Azure Clouds. This argument accepts one of the following values:

• 0—Do not use government cloud (default)
• 1—Use government cloud

@CloudRegionName

The @CloudRegionName argument specifies the name of the Cloud Web Service region to use for a bucket. Example values are but not limited to: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, sa-east-1, N'Germany' and N'China'.

@CloudSecretKey

The @CloudSecretKey argument specifies the name of the Cloud Web Service secret key that is assigned when you initially get a Cloud account.

@CloudSecretKeyEnc

The @CloudSecretKeyEnc argument specifies the name of the encrypted Cloud Web Service secret key that is assigned when you initially get a Cloud account.

@CloudVendor

The @CloudVendor argument specifies the name of the cloud service provider. The argument accepts one of the following values: "AmazonS3", "AzureBlob" or "GoogleStorage".

@database

Name of database to be backed up or restored.

This parameter specifies a database:

• to be backed up (xp_backup_database and xp_slsFastCompression)

• containing the transaction log to be backed up (xp_backup_log)

• to be restored (xp_restore_database and xp_restore_log)

• on which you wish to check the progress of an activity (xp_slsReadProgress)

• for which you want to delete old backups (xp_slsSmartCleanup)

If supplied as a variable (@database), this name can be specified either as a string constant (@database = database name) or as a variable of character string data type, except for the ntext or text data types.

@datafilepath

Specifies a location for data files.

@dontusecopyonly

Specifies whether copy only backups are included during automated restores. This argument accepts one of the following values:

• 0—False. Include copy only backups.
• 1—True. Do not include copy only backups.

@DontUseReplication

Specifies whether replication is used during automated restores. This argument accepts one of the following values:

• 0—False. Use replication.
• 1—True. Do not use replication.

@dropdatabaseonfailure

Drops the restored database only if the restore fails. Use this option if you no longer need the restored database. For example, if you are only restoring the latest backup for testing purposes. This option contains two additional options to select. One or both options can be selected.On success restore and check database integrity operations - The database is dropped after a successful restore and database integrity check.On failure any of restore or check databases integrity operations - The database is dropped after failing the restore or database integrity check. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@dropdatabaseonsuccess

Drops database on success only. Use this option if you no longer need the restored database. For example, if you are only restoring the latest backup for testing purposes. This option contains two additional options to select. One or both options can be selected.On success restore and check database integrity operations - The database is dropped after a successful restore and database integrity check.On failure any of restore or check databases integrity operations - The database is dropped after failing the restore or database integrity check. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@dryrun

Shows backups that are candidates for restore at this time, but does not restore them. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@encryptionkey

Value used to generate the encryption key for the encryption algorithm. If you do not supply encryption key, then the program will not encrypt the backup. If you use the wrong encryption key, the restore will fail.

Caution: When encrypting data, take care not to lose the encryption key; a backup cannot be restored or recovered without the original encryption key.

Example of key: 'Mypassword'

NOTE: Automated Restore requires that you use the same password for all encrypted backups.

@FileName

Specifies a backup location (e.g. C:\backups\AdventureWorks.bak). This argument accepts network destinations. You can supply multiple instances of this argument to use stripe backups.

@ioflag

Specifies if LiteSpeed should wait and retry the read or write operation on failure. You can define retry options using the following parameters:

• DISK_RETRY_COUNT—Specifies the number of times that a specific operation will be retried on failure. The default is 4 retries, the maximum allowed setting is 1000.
• DISK_RETRY_WAIT—Specifies the number of seconds to wait immediately following a failure before retrying. The default is 15 seconds, the maximum allowed setting is 300.

NOTE: This functionality is only available for disk and cloud operations.

For example, to specify a database backup where each failure can be retried once after a 30-second wait:

EXEC master.dbo.xp_backup_database
@filename='c:\test.bkp'
, @database='test'
, @ioflag='DISK_RETRY_COUNT=1'
, @ioflag='DISK_RETRY_WAIT=30'

Network Resilience

@jobp

Specifies an encrypted key. (Similar to @EncryptionKey).

You can use xp_encrypt_backup_key to convert the password (encryption_key) for use with @jobp. The original password (or encrypted key generated by xp_encrypt_restore_key) must be used to restore a backup.

NOTE: Automated Restore requires that you use the same password for all encrypted backups.

@logfilepath

Specifies a location for log files.

@logging

Writes a log file for the operation. This argument accepts one of the following values:

• 0—Logging off.

• 1 or any odd value—Logging on. Log file is removed on success.

• 2 or any even value—Logging on.

The default output directory is C:\Documents and Settings\All Users\Application Data\Quest Software\LiteSpeed\SQL Server\Logs (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs) (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs). To log to a different directory add @Trace='logpath=path'.

See Configure Logging in LiteSpeed for information about LiteSpeed logging.

@maxtransfersize

Specifies the largest unit of transfer in bytes to be used between SQL Server and LiteSpeed. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4,194,304 bytes (4 MB). The default is 1048576 (1 MB).

@ProxyHost

The @ProxyHost argument is optional and specifies the name of the proxy host name that is running the proxy server.

@ProxyLogin

The @ProxyLogin argument is optional and specifies the proxy server login credential.

@ProxyPassword

The @ProxyPassword argument is optional and specifies the proxy server password credential.

@ProxyPasswordEnc

The @ProxyPasswordEnc argument is optional and specifies the encrypted proxy server password credential.

@ProxyPort

The @ProxyPort argument is optional and contains the port number of the proxy server. The TCP/IP port values can be 1-65535.

@Read_Write_Filegroups

Specifies a partial backup, which includes all the read/write files in a database: the primary filegroup, any read/write secondary filegroups, and any specified read-only files or filegroups. If the database is read-only, @read_write_filegroups includes only the primary filegroup.

@RestoreAsCompressed

Works in conjunction with @restoreasreadonly, creates a folder if it does not exist, and then compresses it. This argument accepts one of the following values:

• 0—False (default)
• 1—True

@RestoreAsReadOnly

Instructs the restore operation to leave the database in read-only mode. This argument accepts one of the following values:

• 0—False (default)
• 1—True

Using this option, you can restore a user database into an NTFS compressed folder or restore a tlog to a read-only database in a compressed folder.

NOTES:

• When using an NTFS-compressed folder for a database, it can only be restored as read-only.
• You can only use this feature on Windows NTFS file systems.

@ReturnDetails

Generates a single-row result set.

• 0—False (default)
• 1—True

The result set contains the following details:

Tip: In Toad, you can use Group Execute to produce a single result set for several server instances.

@sourcedatabase

Backups of this database are the source for restore.

@sourceserver

Backups created on this instance of SQL Server are the source for restore.

@throttle

Specifies the maximum CPU usage allowed. The argument accepts an integer value between 1 and 100. The default value is 100. This is the percentage of the total amount of CPU usage (across all enabled processors) available.

TIP: Before you start tuning the CPU Throttle or Affinity parameters to adjust backup performance, try limiting the number of threads. If you decide to use an affinity value other than default, it is recommended that you limit the threading as well. You may also want to consider using Adaptive Compression to maintain backup performance. For more information, see Adaptive Compression.

@UseSSL

The @UseSSL argument specifies that the connection uses SSL security. This argument accepts one of the following values:

• 0—Do not use SSL
• 1—Use SSL (default)

@with

Each @with argument should be a syntactically complete and correct statement. Please refer to the SQL Server Transact-SQL backup and restore documentation for the syntax and usage.

The supported formats are:

• @with='PARAMETER'
• @with='PARAMETER=''accepted_value'''

NOTES:

• Extended stored procedure arguments are limited to 255 characters. If you need more than 255 characters, use multiple @with arguments.
• Do not supply the @with parameter if no additional features are required.

This extended stored procedure accepts the following @with parameters:

@withreplace

Instructs LiteSpeed to create the specified database and its related files even if another database already exists with the same name. The existing database is deleted. This argument accepts one of the following values:

• 0—False (default)
• 1—True

Examples

Restore the Most Recent Full Database Backup to a New Database

EXEC master.dbo.xp_restore_automated
@database='NEWDB'
, @datafilepath = 'D:\DATA'
, @logfilepath = 'D:\DATA'
, @backuppath = N'D:\temp'
, @backupextension = 'bak,bkp'
, @checksubfolders = 1
, @sourceserver = N'LITESPEED\SQL2005'
, @sourcedatabase = N'FOX'
, @backuptype = N'full'

Restore the Most Recent Full and Drop Database

EXEC master.dbo.xp_restore_automated
@database='TESTDB'
, @datafilepath = 'D:\DATA'
, @logfilepath = 'D:\DATA'
, @backuppath = N'D:\temp'
, @backupextension = ''
, @checksubfolders = 1
, @sourceserver = N'LITESPEED\SQL2005'
, @sourcedatabase = N'FOX'
, @backuptype = N'full'
, @dropdatabaseonfailure = 1
, @dropdatabaseonsuccess = 1
, @withreplace = 1

Restore the Most Recent Fast Compression Backups

exec master.dbo.xp_restore_automated
@database = N'LiteSpeedLocal_AutomatedRestore'
, @backuppath = N'D:\temp\FC\'
, @backupextension = ''
, @checksubfolders = 0
, @sourceserver = N'LITESPEED\SQL2005'
, @sourcedatabase = N'LiteSpeedLocal'
, @backuptype = N'diff'
, @jobp = N'5jzOEztgLxQ='
, @withreplace = 1

Restore the Most Recent Striped Backup

EXEC master.dbo.xp_restore_automated
@database='NEWDB'
, @datafilepath = 'D:\DATA'
, @logfilepath = 'D:\DATA'
, @backuppath = N'D:\temp'
, @backupextension = 'stripe1'
, @checksubfolders = 0
, @backuppath = N'E:\temp'
, @backupextension = 'stripe2'
, @checksubfolders = 0
, @sourceserver = N'LITESPEED\SQL2005'
, @sourcedatabase = N'FOX'
, @backuptype = N'full'

Restore with Database Integrity Enabled

exec master.dbo.xp_restore_automated
@database = N'CM_1_Testing_1' ,
@backuppath = N'C:\backup',
@backupextension = N'',
@checksubfolders = 0,
@sourceserver = N'SPB8595',
@sourcedatabase = N'CM_1_Testing',
@backuptype = N'diff',
@affinity = 0,
@logging = 0,
@withreplace = 1,
@checkdb = 1,
@checkdbphysicalonly = 1,
@checkdbnoindex = 1,
@with = N'STATS = 10'

View Candidates for Automated Restore

EXEC master.dbo.xp_restore_automated
@backuppath = N'D:\temp'
, @backupextension = ''
, @checksubfolders = 1
, @encryptionkey = N'******'
, @sourceserver = N'LITESPEED\SQL2005'
, @sourcedatabase = N'FOX'
, @backuptype = N'tlog'
, @dryrun = 1

Restore from Amazon S3

exec master.dbo.xp_restore_automated @database = N'model' ,

@backuppath = N'test',

@backupextension = N'',

@checksubfolders = 0,

@sourceserver = N 'servername',

@sourcedatabase = N'model',

@backuptype = N'tlog',

@CloudVendor = N'AmazonS3',

@CloudBucketName = N'california',

@CloudAccessKey = N'********',

@CloudSecretKey = N'*********',

@UseSSL = 1,

@affinity = 0,

@logging = 0,

@DontUseReplication = 1,

@checkdb = 1,

@checkdbphysicalonly = 1,

@checkdbnoindex = 1,

@checkdbnoinfomessages = 1,

@progressname = N'f94ee3d8-f6ac-47e0-80cd-a6326a532dd9',

@with = N'STATS = 10'

Restore from Microsoft Azure

exec master.dbo.xp_restore_automated @database = N'newtest' ,

@backuppath = N'test',

@backupextension = N'bak',

@checksubfolders = 1,

@sourceserver = N'Server\SQL_instance',

@sourcedatabase = N'test',

@backuptype = N'diff',

@CloudVendor = N'AzureBlob',

@CloudBucketName = N'test',

@CloudAccessKeyEnc = N'******',

@CloudSecretKeyEnc = N'******',

@UseSSL = 1,

@affinity = 0,

@logging = 0,

@DontUseReplication = 1,

@withreplace = 1,

@checkdb = 1,

@checkdbphysicalonly = 1,

@checkdbnoindex = 1,

@checkdbnoinfomessages = 1,

@with = N'STATS = 10'

Returns

0 (success) or non-zero (failure). Return codes represent the native error number returned from SQL Server for any errors encountered during the operation.

To capture the output message, run the following:

declare @rmsg varchar(999)
exec master..<procedure_name> <arguments>, @resultmsg=@rmsg output
select @rmsg

To capture the output message and the result code, run the following:

declare @rc int
declare @rmsg varchar(999)
exec master..<procedure_name> <arguments>, @resultmsg=@rmsg output, @resultcode=@rc output
select @rc, @rmsg

Related Topic

About Using Extended Stored Procedures

LiteSpeed Command-Line Arguments