Share via

SqlServerKeyBuilderExtensions.ForSqlServerIsClustered Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.SqlServer.dll
Package:
Microsoft.EntityFrameworkCore.SqlServer v1.0.6
Package:
Microsoft.EntityFrameworkCore.SqlServer v1.1.6
Package:
Microsoft.EntityFrameworkCore.SqlServer v2.0.3
Package:
Microsoft.EntityFrameworkCore.SqlServer v2.1.11
Package:
Microsoft.EntityFrameworkCore.SqlServer v2.2.6
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.1.0

Overloads

ForSqlServerIsClustered(KeyBuilder, Boolean)
Obsolete.

Configures whether the key is clustered when targeting SQL Server.
ForSqlServerIsClustered(IConventionKeyBuilder, Nullable<Boolean>, Boolean)
Obsolete.

Configures whether the key is clustered when targeting SQL Server.

ForSqlServerIsClustered(KeyBuilder, Boolean)

Source:
SqlServerKeyBuilderExtensions.cs
Source:
SqlServerKeyBuilderExtensions.cs
Source:
SqlServerKeyBuilderExtensions.cs
Source:
SqlServerKeyBuilderExtensions.cs

Caution

Use IsClustered

Configures whether the key is clustered when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder ForSqlServerIsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder keyBuilder, bool clustered = true);
[System.Obsolete("Use IsClustered")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder ForSqlServerIsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder keyBuilder, bool clustered = true);
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder
[<System.Obsolete("Use IsClustered")>]
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder
<Extension()>
Public Function ForSqlServerIsClustered (keyBuilder As KeyBuilder, Optional clustered As Boolean = true) As KeyBuilder

Parameters

keyBuilder
KeyBuilder

The builder for the key being configured.

clustered
Boolean

A value indicating whether the key is clustered.

Returns

KeyBuilder

The same builder instance so that multiple calls can be chained.

Attributes
ObsoleteAttribute

Applies to

ForSqlServerIsClustered(IConventionKeyBuilder, Nullable<Boolean>, Boolean)

Source:
SqlServerKeyBuilderExtensions.cs
Source:
SqlServerKeyBuilderExtensions.cs

Caution

Use IsClustered

Configures whether the key is clustered when targeting SQL Server.

[System.Obsolete("Use IsClustered")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder ForSqlServerIsClustered (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, bool? clustered, bool fromDataAnnotation = false);
[<System.Obsolete("Use IsClustered")>]
static member ForSqlServerIsClustered : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder * Nullable<bool> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder
<Extension()>
Public Function ForSqlServerIsClustered (keyBuilder As IConventionKeyBuilder, clustered As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false) As IConventionKeyBuilder

Parameters

keyBuilder
IConventionKeyBuilder

The builder for the key being configured.

clustered
Nullable<Boolean>

A value indicating whether the key is clustered.

fromDataAnnotation
Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionKeyBuilder

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

Attributes
ObsoleteAttribute

Applies to