Share via

  • Article

Table.HasClusteredIndex Property

Gets the Boolean property value that specifies whether the table has a clustered index.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.None Or SfcPropertyFlags.Standalone Or SfcPropertyFlags.SqlAzureDatabase)> _
Public ReadOnly Property HasClusteredIndex As Boolean
    Get
'Usage
Dim instance As Table
Dim value As Boolean

value = instance.HasClusteredIndex

[SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase)]
public bool HasClusteredIndex { get; }

[SfcPropertyAttribute(SfcPropertyFlags::None|SfcPropertyFlags::Standalone|SfcPropertyFlags::SqlAzureDatabase)]
public:
property bool HasClusteredIndex {
    bool get ();
}

[<SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase)>]
member HasClusteredIndex : bool

function get HasClusteredIndex () : boolean

Property Value

Type: System.Boolean
A Boolean value that specifies whether there is a clustered index defined on the table.
If True, there is a clustered index defined on the table. Otherwise, False (default).

Remarks

The B-tree leaf level of a clustered index is the rows of data.

Examples

The following code example shows how to check each table in the AdventureWorks2008R2 database to see if it has a clustered index.

C#

Server srv = new Server("(local)");
Database db = srv.Databases["AdventureWorks2008R2"];

Foreach (Table tb in db.Tables) 
{
   Console.WriteLine("The " + tb.Name + " table has a clustered index:" + tb.HasClusteredIndex.ToString());
}

Powershell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")

Foreach ($tb in $db.Tables) 
{
   Write-Host "The" $tb.Name "table has a clustered index:" $tb.HasClusteredIndex
}