CosmosEntityTypeBuilderExtensions Class

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Source:

CosmosEntityTypeBuilderExtensions.cs

Cosmos-specific extension methods for EntityTypeBuilder.

public static class CosmosEntityTypeBuilderExtensions

type CosmosEntityTypeBuilderExtensions = class

Public Module CosmosEntityTypeBuilderExtensions

Inheritance

Object

CosmosEntityTypeBuilderExtensions

Remarks

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

Methods

CanSetAnalyticalStoreTimeToLive(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean)	Returns a value indicating whether the time to live for analytical store can be set from the current configuration source
CanSetContainer(IConventionEntityTypeBuilder, String, Boolean)	Returns a value indicating whether the container that the entity type maps to can be set from the current configuration source
CanSetDefaultTimeToLive(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean)	Returns a value indicating whether the default time to live can be set from the current configuration source
CanSetDiscriminatorInJsonId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Returns a value indicating whether the setting for including the discriminator can be set from the current configuration source
CanSetJsonProperty(IConventionEntityTypeBuilder, String, Boolean)	Returns a value indicating whether the parent property name to which the entity type is mapped to can be set from the current configuration source
CanSetPartitionKey(IConventionEntityTypeBuilder, IReadOnlyList<String>, Boolean)	Returns a value indicating whether the properties that are used to store the parts of a hierarchical partition key from the current configuration source
CanSetPartitionKey(IConventionEntityTypeBuilder, String, Boolean)	Obsolete. Returns a value indicating whether the property that is used to store the partition key can be set from the current configuration source
CanSetRootDiscriminatorInJsonId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Returns a value indicating whether the setting for including the discriminator can be set from the current configuration source
CanSetShadowId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Returns a value indicating whether the setting for always creating the "__id" property can be set from the current configuration source
CanSetThroughput(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean, Boolean)	Returns a value indicating whether the given throughput can be set.
HasAnalyticalStoreTimeToLive(EntityTypeBuilder, Nullable<Int32>)	Configures the time to live for analytical store in seconds at container scope.
HasAnalyticalStoreTimeToLive(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean)	Configures the time to live for analytical store in seconds at container scope.
HasAnalyticalStoreTimeToLive<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Int32>)	Configures the time to live for analytical store in seconds at container scope.
HasAutoscaleThroughput(EntityTypeBuilder, Nullable<Int32>)	Configures the autoscale provisioned throughput offering.
HasAutoscaleThroughput<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Int32>)	Configures the autoscale provisioned throughput offering.
HasDefaultTimeToLive(EntityTypeBuilder, Nullable<Int32>)	Configures the default time to live in seconds at container scope.
HasDefaultTimeToLive(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean)	Configures the default time to live in seconds at container scope.
HasDefaultTimeToLive<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Int32>)	Configures the default time to live in seconds at container scope.
HasDiscriminatorInJsonId(EntityTypeBuilder, Nullable<Boolean>)	Includes the discriminator value of the entity type in the JSON "id" value. This was the default behavior before EF Core 9.
HasDiscriminatorInJsonId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Includes the discriminator value of the entity type in the JSON "id" value. This was the default behavior before EF Core 9.
HasDiscriminatorInJsonId<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Boolean>)	Includes the discriminator value of the entity type in the JSON "id" value. This was the default behavior before EF Core 9.
HasManualThroughput(EntityTypeBuilder, Nullable<Int32>)	Configures the manual provisioned throughput offering.
HasManualThroughput<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Int32>)	Configures the manual provisioned throughput offering.
HasPartitionKey(EntityTypeBuilder, String, String[])	Configures the properties that are used to store the parts of a simple or hierarchical partition key.
HasPartitionKey(IConventionEntityTypeBuilder, IReadOnlyList<String>, Boolean)	Configures the properties that are used to store the parts of a hierarchical partition key.
HasPartitionKey(IConventionEntityTypeBuilder, String, Boolean)	Obsolete. Configures the property that is used to store the partition key.
HasPartitionKey<TEntity,TProperty>(EntityTypeBuilder<TEntity>, Expression<Func<TEntity,TProperty>>)	Configures the properties that are used to store the parts of a simple or hierarchical partition key.
HasPartitionKey<TEntity>(EntityTypeBuilder<TEntity>, String, String[])	Configures the properties that are used to store the parts of a simple or hierarchical partition key.
HasRootDiscriminatorInJsonId(EntityTypeBuilder, Nullable<Boolean>)	Includes the discriminator value of the root entity type in the JSON "id" value. This allows types with the same primary key to be saved in the same container, while still allowing "ReadItem" to be used for lookups of an unknown type.
HasRootDiscriminatorInJsonId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Includes the discriminator value of the root entity type in the JSON "id" value. This allows types with the same primary key to be saved in the same container, while still allowing "ReadItem" to be used for lookups of an unknown type.
HasRootDiscriminatorInJsonId<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Boolean>)	Includes the discriminator value of the root entity type in the JSON "id" value. This allows types with the same primary key to be saved in the same container, while still allowing "ReadItem" to be used for lookups of an unknown type.
HasShadowId(EntityTypeBuilder, Nullable<Boolean>)	Forces model building to always create a "__id" shadow property mapped to the JSON "id". This was the default behavior before EF Core 9.0.
HasShadowId(IConventionEntityTypeBuilder, Nullable<Boolean>, Boolean)	Forces model building to always create a "__id" shadow property mapped to the JSON "id". This was the default behavior before EF Core 9.0.
HasShadowId<TEntity>(EntityTypeBuilder<TEntity>, Nullable<Boolean>)	Forces model building to always create a "__id" shadow property mapped to the JSON "id". This was the default behavior before EF Core 9.0. Note that an "__id" property is always created if the primary key is not a single string property, or if the discriminator is included in the JSON "id".
HasThroughput(IConventionEntityTypeBuilder, Nullable<Int32>, Boolean, Boolean)	Configures the provisioned throughput.
ToContainer(EntityTypeBuilder, String)	Configures the container that the entity type maps to when targeting Azure Cosmos.
ToContainer(IConventionEntityTypeBuilder, String, Boolean)	Configures the container that the entity type maps to when targeting Azure Cosmos.
ToContainer<TEntity>(EntityTypeBuilder<TEntity>, String)	Configures the container that the entity type maps to when targeting Azure Cosmos.
ToJsonProperty(IConventionEntityTypeBuilder, String, Boolean)	Configures the property name that the entity is mapped to when stored as an embedded document.
ToJsonProperty(OwnedNavigationBuilder, String)	Configures the property name that the entity is mapped to when stored as an embedded document.
ToJsonProperty<TOwnerEntity,TDependentEntity>(OwnedNavigationBuilder<TOwnerEntity,TDependentEntity>, String)	Configures the property name that the entity is mapped to when stored as an embedded document.
UseETagConcurrency(EntityTypeBuilder)	Configures this entity to use CosmosDb etag concurrency checks.
UseETagConcurrency<TEntity>(EntityTypeBuilder<TEntity>)	Configures this entity to use CosmosDb etag concurrency checks.