CosmosEntityTypeBuilderExtensions.CanSetPartitionKey Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.Cosmos.dll

Package:: Microsoft.EntityFrameworkCore.Cosmos v3.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v3.1.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v5.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v6.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v7.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v8.0.0

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.

Returns a value indicating whether the property that is used to store the partition key can be set from the current configuration source

public static bool CanSetPartitionKey (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder entityTypeBuilder, string name, bool fromDataAnnotation = false);

public static bool CanSetPartitionKey (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder entityTypeBuilder, string? name, bool fromDataAnnotation = false);

static member CanSetPartitionKey : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder * string * bool -> bool

<Extension()>
Public Function CanSetPartitionKey (entityTypeBuilder As IConventionEntityTypeBuilder, name As String, Optional fromDataAnnotation As Boolean = false) As Boolean

Parameters

entityTypeBuilder: IConventionEntityTypeBuilder

The builder for the entity type being configured.

name: String

The name of the partition key property.

fromDataAnnotation: Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

Boolean

true if the configuration can be applied.

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

Applies to