SqlServerIndexBuilderExtensions.IsClustered Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 IndexBuilderParameters
- indexBuilder
- IndexBuilder
The builder for the index being configured.
- clustered
- Boolean
A value indicating whether the index is clustered.
Returns
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 IConventionIndexBuilderParameters
- indexBuilder
- IConventionIndexBuilder
The builder for the index being configured.
- fromDataAnnotation
- Boolean
Indicates whether the configuration was specified using a data annotation.
Returns
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
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
Entity Framework