This topic has not yet been rated - Rate this topic

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)

Syntax

C++

JScript

Copy


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

Remarks

This property applies only when scripting a SQL Server table.

Examples

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

Visual Basic

Copy

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

PowerShell

Copy

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

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ