ScriptingOptions.ClusteredIndexes Property

Applies To: SQL Server 2016 Preview

Gets or sets a Boolean property value that specifies whether statements that define clustered indexes are included in the generated script.

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

Syntax

public bool ClusteredIndexes { get; set; }

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

member ClusteredIndexes : bool with get, set

Public Property ClusteredIndexes As Boolean

A Boolean value that specifies whether statements that define clustered indexes are included in the generated script.

If True, clustered indexes are included in the script. Otherwise, False (default).

This property applies only when scripting a SQL Server table.

The following code example specifies that statements defining clustered indexes are included in the script.

Visual Basic

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

PowerShell

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