ScriptingOptions.ClusteredIndexes Property

 

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)

public bool ClusteredIndexes { get; set; }

Property Value

Type: System.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
Return to top
Show: