SqlServerIndexBuilderExtensions.IsCreatedOnline Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.SqlServer.dll

Package:

Microsoft.EntityFrameworkCore.SqlServer v8.0.0

Overloads

IsCreatedOnline(IndexBuilder, Boolean)	Configures whether the index is created with online option when targeting SQL Server.
IsCreatedOnline(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	Configures whether the index is created with online option when targeting SQL Server.
IsCreatedOnline<TEntity>(IndexBuilder<TEntity>, Boolean)	Configures whether the index is created with online option when targeting SQL Server.

IsCreatedOnline(IndexBuilder, Boolean)

Configures whether the index is created with online option when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder IsCreatedOnline (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder indexBuilder, bool createdOnline = true);

static member IsCreatedOnline : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder

<Extension()>
Public Function IsCreatedOnline (indexBuilder As IndexBuilder, Optional createdOnline As Boolean = true) As IndexBuilder

Parameters

indexBuilder

IndexBuilder

The builder for the index being configured.

createdOnline

Boolean

A value indicating whether the index is created with online option.

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.

IsCreatedOnline(IConventionIndexBuilder, Nullable<Boolean>, Boolean)

Configures whether the index is created with online option when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder? IsCreatedOnline (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, bool? createdOnline, bool fromDataAnnotation = false);

static member IsCreatedOnline : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder * Nullable<bool> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder

<Extension()>
Public Function IsCreatedOnline (indexBuilder As IConventionIndexBuilder, createdOnline As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false) As IConventionIndexBuilder

Parameters

indexBuilder

IConventionIndexBuilder

The builder for the index being configured.

createdOnline

Nullable<Boolean>

A value indicating whether the index is created with online option.

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.

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

Configures whether the index is created with online option when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> IsCreatedOnline<TEntity> (this Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<TEntity> indexBuilder, bool createdOnline = true);

static member IsCreatedOnline : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'Entity>

<Extension()>
Public Function IsCreatedOnline(Of TEntity) (indexBuilder As IndexBuilder(Of TEntity), Optional createdOnline As Boolean = true) As IndexBuilder(Of TEntity)

Type Parameters

TEntity

Parameters

indexBuilder

IndexBuilder<TEntity>

The builder for the index being configured.

createdOnline

Boolean

A value indicating whether the index is created with online option.

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.