SqlServerIndexBuilderExtensions.IsClustered Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.SqlServer.dll
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.1.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v5.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v6.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v7.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v8.0.0

Overloads

IsClustered(IndexBuilder, Boolean)

Configures whether the index is clustered when targeting SQL Server.
IsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)

Configures whether the index is clustered when targeting SQL Server.
IsClustered<TEntity>(IndexBuilder<TEntity>, Boolean)

Configures whether the index is clustered when targeting SQL Server.

IsClustered(IndexBuilder, Boolean)

Configures whether the index is clustered when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder IsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder indexBuilder, bool clustered = true);
static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder
<Extension()>
Public Function IsClustered (indexBuilder As IndexBuilder, Optional clustered As Boolean = true) As IndexBuilder

Parameters

indexBuilder
IndexBuilder

The builder for the index being configured.

clustered
Boolean

A value indicating whether the index is clustered.

Returns

IndexBuilder

A builder to further configure the index.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.

Applies to

IsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)

Configures whether the index is clustered when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder IsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, bool? clustered, bool fromDataAnnotation = false);
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder? IsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, bool? clustered, bool fromDataAnnotation = false);
static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder * Nullable<bool> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder
<Extension()>
Public Function IsClustered (indexBuilder As IConventionIndexBuilder, clustered As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false) As IConventionIndexBuilder

Parameters

indexBuilder
IConventionIndexBuilder

The builder for the index being configured.

clustered
Nullable<Boolean>

A value indicating whether the index is clustered.

fromDataAnnotation
Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionIndexBuilder

The same builder instance if the configuration was applied, null otherwise.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.

Applies to

IsClustered<TEntity>(IndexBuilder<TEntity>, Boolean)

Configures whether the index is clustered when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> IsClustered<TEntity> (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> indexBuilder, bool clustered = true);
static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity>
<Extension()>
Public Function IsClustered(Of TEntity) (indexBuilder As IndexBuilder(Of TEntity), Optional clustered As Boolean = true) As IndexBuilder(Of TEntity)

Type Parameters

TEntity

Parameters

indexBuilder
IndexBuilder<TEntity>

The builder for the index being configured.

clustered
Boolean

A value indicating whether the index is clustered.

Returns

IndexBuilder<TEntity>

A builder to further configure the index.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.

Applies to