LiteSpeed for SQL Server 8.9.7 - User Guide

Automatically selects the optimal compression level based on CPU usage or Disk IO. For more information, see Compression Methods.

You can tell Adaptive Compression to optimize backups either for size or for speed. This argument accepts one of the following values:

• Size
• Speed

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.

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'

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

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

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.

You can supply multiple instances of this argument.

Backup operation. This argument accepts one of the following values:

• Database—Back up database

• Log—Back up transaction log 

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.

Specifies a description to store with the backup.

This argument accepts variables. For more information, see LiteSpeed Variables.

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.

Examples:

UNC Path: \\servername\share\path\filename

Local path: c:\filedirectory\filename 

For TSM backups and TSM archives, this argument accepts the following formats:

• tsmbkp:<filespace>\<high>\<low>
• tsmarc:<filespace>\<high>\<low>

This argument accepts variables. For more information, see LiteSpeed Variables.

Specifies the particular backup to use when recasting, restoring, extracting or reading from files with multiple appended backups. You can run xp_restore_headeronly to query the files contained within the backup set given by backup_file_name.

Specifies the name of the backup set.

This argument accepts variables. For more information, see LiteSpeed Variables.

Specifies the directory where to search for the backup files.

You can supply multiple instances of this argument. Each instance of this parameter must be followed by --BackupExtension and --CheckSubfolders arguments.

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.

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

NOTE: LiteSpeed defaults typically result in the best performance. You should only modify advanced options after careful planning and testing.

Specifies checking the database integrity after running restores. Options include: --CheckDBPhysicalOnly, --CheckDBDataPurity, --CheckDBExtendedLogicalChecks, --CheckDBNoIndex, --CheckDBTableLocks, and --CheckDBNoInfoMessages.

Specifies the checking database physical structure option. Note: Using this argument can significantly decrease the execution time when using large databases.

Specifies the checking database column values option for validity or out of range.

Specifies the performing consistency checks on indexes option. It checks XML indexes and spacial indexes.

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.

Appends a user comment to the backup.

This argument accepts variables. For more information, see LiteSpeed Variables.

Specifies the compression level for the backup. Valid values are 0 through 8. 0 bypasses the compression routines. The remaining values of 1 through 8 specify compression with increasingly aggressive computation. 2 is the default value for disk backups and 7 is the default value for cloud backups.

When choosing a compression level, it is best to try various options using your equipment and data to determine the best option for your environment. Use the Backup Analyzer to test the performance of different compression levels. For more information, see Test Optimal Backup Settings.

NOTE: If both the compression level and Adaptive Compression option are passed in, LiteSpeed will not error out and will select and use Adaptive Compression.

Name of database to be backed up or restored.

Specifies a location for data files.

Disconnect users on executing restore (in standby mode only). This argument accepts one of the following values:

• 0—Do not disconnect users (default).
• 1—Disconnect users.

Specifies that LiteSpeed is not to use copy-only backups when running restores.

Creates a Double Click Restore executable. This argument accepts one of the following values:

• 1—Creates one Double-Click Restore executable file. Note the following warning: The executable may be greater than 4GB for large databases. Windows Server is unable to run executable files larger than 4GB. However, the file will be convertible/restorable by LiteSpeed file.
• 2—Creates a Double Click Restore loader in the same location. (Default)

For more information, see Double Click Restore Executables.

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

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

Encrypts the specified key. The encrypted key is suitable for use with -jobp in a backup operation.

Encrypts the specified key. The encrypted key is suitable for use with -jobp in a restore operation.

Specifies encryption level. Works in conjunction with the Key (K) parameter. This argument accepts one of the following values:

• 0—40-bit RC2

• 1—56 bit RC2

• 2—112 bit RC2

• 3—128 bit RC2

• 4—168 bit 3DES

• 5—128 bit RC4

• 6—128 bit AES

• 7—192 bit AES

• 8—256 bit AES

• 9—MS_AES_128

• 10—MS_AES_192

• 11—MS_AES_256

Name of database(s) to exclude from this backup / restore.

Example:

--ExcludeDatabase Northwind

Tip: The @ExcludeDatabase argument can be applied together with @MultiDatabaseType to exclude several databases from the process.

Specifies the date and time when the backup expires. LiteSpeed will not overwrite this file until expiration datetime is passed. This argument accepts one of the following formats:

• yyyy-mm-dd
• yyyy-mm-dd hh:mm:ss

Specifies a logical database file used for file or filegroup backups. You can supply multiple instances of this argument.

Specifies a database filegroup to include in the backup or restore. You can supply multiple instances of this argument.

A filegroup backup is a single backup of all files in the filegroup and is equivalent to explicitly listing all files in the filegroup when creating the backup. Files in a filegroup backup can be restored individually or as a group.

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 more information, see Network Resilience.

Specifies an encrypted key. (Similar to -K).

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

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.

Specifies a location for log files.

Creates a log file. 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 run this utility with the following argument: --trace logpath = "path".

For more information, see Configure Logging in LiteSpeed.

Produces a backup that is compatible for use with LiteSpeed Engine for SQL Server. The parameter can be used whenever a new backup file is created and should only be set when backups are needed for cross-compatibility between the products. This switch will force modifications to internal settings such as the thread count, striping model, and encryption levels. In some cases, performance may be degraded. The parameter is ignored when appending to a backup file created without the switch.

This argument accepts one of the following values:

• 0—False (default)
• 1—True

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).

Mirrors the backup file (copies the backup to multiple locations). If you back up the primary to a set of striped files, all mirrored backups must match the primary in the number of stripes in each mirror.

This argument accepts variables. For more information, see LiteSpeed Variables.

Produces a backup that includes several types of databases. Types can include: all, system, user, or selected databases.

This argument accepts one of the following values:

• All - Backup all system and user databases.
• System - Backup only system databases.
• User - Backup only user databases.
• Selected - Backup specifically selected databases.

The argument is similar to backup log xxx to disk = 'NUL'. When the backup is completed, it is not written to disk.

NOTES:

• You need to supply a filename (-F). The MSDB history tables are updated with the filename specified, but the file will not get created and no IO is performed.
• If compression or encryption parameters are specified, then the data will get compressed or encrypted before being thrown away.

Generates a map file during a backup for Object Level Recovery. This argument accepts one of the following values:

• 0—False (default)
• 1—True

Re-initializes (overwrites and replaces) the target backup files. For TSM backups, this will create the TSM object and version the backup based on the retention policy. The argument accept the values:

• 0 (appends the backup to an existing backup file)
• 1 (overwrite the existing target backup file)

Specifies the user password. Passwords are case-sensitive. Required if the connection type is not a trusted connection.

Specifies the priority of the LiteSpeed process compared to other processes running on the same server. This argument accepts one of the following values:

• 0—Normal (Default)

• 1—AboveNormal

• 2—High

Specifies a partial backup, which includes the primary filegroup and any read-write secondary filegroups.

Specifies a number of days to retain the backup. LiteSpeed will not overwrite this file for this number of days. 

Restore operation.This argument accepts one of the following values:

• AttachedFilesOnly —Restore attached files without restoring the database.

• Database—Restore database backup.

• Log—Restore log backup.

• VerifyOnly—Verify backup. 

• HeaderOnly—Provide backup details.

• FileListOnly—Provide database file details.

• CheckPassword—Check password/key.

• CheckSumOnly—Checksum a backup file.

• AttachedFileNamesOnly—List names of all attached files.

• Automated—Restore the most recent full backup and optionally differential and transaction log backups.

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

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.

Specifies the instance of Microsoft SQL Server to connect to. This argument accepts one of the following values:

• server_name
• server_name\instance_name

If no server is specified, the LiteSpeed command-line utility will connect to the default instance of SQL Server on the local computer.

Displays the syntax summary of the LiteSpeed command-line utility.

Skips normal retention checks and overwrites the backup that has not expired.

• 0—False (default)
• 1—True

Backups of this database are the source for restore.

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

Initializes the media on the device. This argument only applies to tape backups. This argument accepts one of the following values:

• 0—Do not format (default)

• 1—Write new header

• 2—Long erase / write new header

• 3—Low level controller format / write new header

NOTE: Any successful format operation (values 1, 2, and 3; not all are available to all drive types) lays down a LiteSpeed tape header that will identify this tape as containing LiteSpeed backups. Using @init=1 (or -I in the command line) will not lay down a tape header.

Applies only to backing up and restoring tape. This argument accepts one of the following values:

• 0—Leave the tape unwound (default)

• 1—Rewind the tape after writing/reading

Applies to tape backups and restores. This argument accepts one of the following values:

• 0—Keep tape loaded (default)

• 1—Unload and eject tape from the drive after operation

Specifies a temporary directory for use with Object Level Recovery. Use this argument when the default Windows temp directory does not have enough free disk space for the restore process.

Determines the number of threads used for the backup. You will achieve the best results by specifying multiple threads, but the exact value depends on several factors including: processors available, affinity setting, compression level, encryption settings, IO device speed, and SQL Server responsiveness. The default is n-1 threads, where n is the number of processors.

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.

Create table script:

• 0—Off. Create table with native types, if possible; othervise (CLR UDT) create with UDT. (Default).
• 1—On. Create table with UDT.

Specifies user login ID. Required if the connection type is not a trusted connection.

Login IDs are case-sensitive.

Performs a restore verification on the backup file just created (if backup was successful).

• 0—False (default)
• 1—True

Uses a trusted connection (to the server) instead of requiring a password.

Specifies strings that will be passed directly to SQL Server. You can supply multiple instances of this argument.

Some of the accepted parameters are the following:

• DIFFERENTIAL—Specifies that the database or file backup should consist only of the portions of the database or file changed since the last full backup. A differential backup is usually smaller than a full backup. Use this option so that all individual log backups since the last full backup do not need to be applied.

• CHECKSUM—Causes checksums to be verified when a LiteSpeed backup is created.
  NOTE: When you restore a backup containing checksum, it is automatically checked. If you do not want to check the checksums during a restore, supply 'NO_CHECKSUM' .

• CONTINUE_AFTER_ERROR—Causes the backup be executed despite encountering an invalid backup checksum.
• COPY_ONLY—Specifies the copy-only backup.
• KEEP_REPLICATION—Instructs the restore operation to keep the replication settings when restoring a published database to a server other than that on which it was created (used when setting up replication with log shipping).
• MOVE—Specifies that the given logical_file_name should be moved to operating_system_file_name.
• REPLACE—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.
• RECOVERY—Instructs the restore operation to roll back any uncommitted transactions. After the recovery process, the database is ready for use.
• NORECOVERY—Instructs the restore operation to not roll back any uncommitted transactions.
• NO_TRUNCATE—Allows backing up the log in situations where the database is damaged.
• RESTRICTED_USER—When used in conjunction with recovery (another with param and the default) leaving a usable database, this restricts access for the restored database to members of the db_owner, dbcreator, or sysadmin roles.
• STATS—Displays a message each time a percentage of the activity completes. The default is 10%.
• BLOCKSIZE—Specifies the physical block size, in bytes. Supported values are: 512, 1024, 2048, 4096, 8192, 16384, 32768, and 65536 (Default).
• PASSWORD—Specifies the password for the backup set.

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

Specifies the TSM administrative user name that has client authority for the TSM node. Some operations may require an administrative user with client owner authority to be specified in order to open a TSM session. The correct username and password may be obtained from the TSM administrator.

Specifies the plain text password of the administrative user which is used to log in to the TSM server and start the TSM session.

Specifies to store the backup as a TSM archive. This argument accepts one of the following values:

• 0—False (default)
• 1—True

Specifies the TSM server LiteSpeed connects to during backups and restores. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option.

Specifies the TSM client owner user password. Not required, if specified in the options file or if backing up with the Passwordaccess Generate option.

Specifies how long to wait for a TSM device.

DSMI_DIR path if needed.

DSMI_LOG path.

Specifies the TSM configuration file.

Defines the TSM filespace, high level and low level. This argument accepts the following format:

tsm_filespace\tsm_high_level\tsm_low_level

where:

• tsm_filespace is the logical space on the TSM server that contains a group of files. It can be the drive label name or UNC name.

• tsm_high_level specifies the directory path in which the file belongs.

• tsm_low_level specifies actual name of the file.

NOTE: You may only store one item the location specified by this argument. It is not possible to append an object to this location. You can use the -I command-line argument or @init to back up to a non-unique location.

Specifies the TSM file space, the logical space on the TSM server. It can be the drive label name or UNC name. You can supply multiple instances of this argument.

NOTE: IBM recommends that an application client should select a unique file space; it is recommended that LiteSpeed users follow this practice with a specific file space reserved for LiteSpeed backups.

Log name.

Specifies the TSM management class. If not specified, LiteSpeed uses the default management class.

Specifies the date for restore/to filter results. If it is not passed, LiteSpeed will choose the most recent archived backup. The format is yyyy-mm-dd hh:mm:ss.

NOTE: If the backup was a striped backup and the point-in-times of the various striped files are different (rare but can be different a second or so), then the most recent of the times must be chosen.

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

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

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

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

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