Backup.CompressionOption Property

Gets or sets the backup compression option.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public Property CompressionOption As BackupCompressionOptions 
    Get 
    Set
'Usage
Dim instance As Backup 
Dim value As BackupCompressionOptions 

value = instance.CompressionOption

instance.CompressionOption = value
public BackupCompressionOptions CompressionOption { get; set; }
public:
property BackupCompressionOptions CompressionOption {
    BackupCompressionOptions get ();
    void set (BackupCompressionOptions value);
}
member CompressionOption : BackupCompressionOptions with get, set
function get CompressionOption () : BackupCompressionOptions 
function set CompressionOption (value : BackupCompressionOptions)

Property Value

Type: Microsoft.SqlServer.Management.Smo.BackupCompressionOptions
The backup compression option.

Remarks

Member Name

Value

Description

Default

0

Use the default backup compression server configuration

On

1

Enable the backup compression

Off

2

Disable the backup compression

Examples

Backing Up and Restoring Databases and Transaction Logs

See Also

Reference

Backup Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

BACKUP (Transact-SQL)