• Article

ScriptingOptions.ScriptDataCompression Property

Gets or sets the Boolean property value that specifies whether to include data compression information in the generated script.

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

Syntax

'Declaration
Public Property ScriptDataCompression As Boolean
    Get
    Set
'Usage
Dim instance As ScriptingOptions
Dim value As Boolean

value = instance.ScriptDataCompression

instance.ScriptDataCompression = value

public bool ScriptDataCompression { get; set; }

public:
property bool ScriptDataCompression {
    bool get ();
    void set (bool value);
}

member ScriptDataCompression : bool with get, set

function get ScriptDataCompression () : boolean
function set ScriptDataCompression (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether to include data compression in the generated script.
If True, the script includes information about the type of data compression.
If False (default), the script does not include information about data compression.

Examples

The following code example specifies that data.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.ScriptDataCompression = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.ScriptDataCompression = $TRUE