SqlServerIndexBuilderExtensions.ForSqlServerIsClustered Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.SqlServer.dll

Package:

Microsoft.EntityFrameworkCore.SqlServer v3.1.0

Overloads

ForSqlServerIsClustered(IndexBuilder, Boolean)	Obsolete. Configures whether the index is clustered when targeting SQL Server.
ForSqlServerIsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	Obsolete. Configures whether the index is clustered when targeting SQL Server.
ForSqlServerIsClustered<TEntity>(IndexBuilder<TEntity>, Boolean)	Obsolete. Configures whether the index is clustered when targeting SQL Server.

ForSqlServerIsClustered(IndexBuilder, Boolean)

Source:

SqlServerIndexBuilderExtensions.cs

Caution

Use IsClustered

Configures whether the index is clustered when targeting SQL Server.

[System.Obsolete("Use IsClustered")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder ForSqlServerIsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder indexBuilder, bool clustered = true);

[<System.Obsolete("Use IsClustered")>]
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder

<Extension()>
Public Function ForSqlServerIsClustered (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.

Attributes

ObsoleteAttribute

ForSqlServerIsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)

Source:

SqlServerIndexBuilderExtensions.cs

Caution

Use IsClustered

Configures whether the index is clustered when targeting SQL Server.

[System.Obsolete("Use IsClustered")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder ForSqlServerIsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, bool? clustered, bool fromDataAnnotation = false);

[<System.Obsolete("Use IsClustered")>]
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder * Nullable<bool> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder

<Extension()>
Public Function ForSqlServerIsClustered (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.

Attributes

ObsoleteAttribute

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

Source:

SqlServerIndexBuilderExtensions.cs

Caution

Use IsClustered

Configures whether the index is clustered when targeting SQL Server.

[System.Obsolete("Use IsClustered")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> ForSqlServerIsClustered<TEntity> (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> indexBuilder, bool clustered = true);

[<System.Obsolete("Use IsClustered")>]
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity>

<Extension()>
Public Function ForSqlServerIsClustered(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.

Attributes

ObsoleteAttribute