CosmosEntityTypeExtensions Class

  • 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

Entity type extension methods for Cosmos metadata.

public static class CosmosEntityTypeExtensions
type CosmosEntityTypeExtensions = class
Public Module CosmosEntityTypeExtensions
Inheritance
Object
CosmosEntityTypeExtensions

Remarks

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

Methods

GetAnalyticalStoreTimeToLive(IReadOnlyEntityType)

Returns the time to live for analytical store in seconds at container scope.
GetAnalyticalStoreTimeToLiveConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the time to live for analytical store in seconds at container scope.
GetContainer(IEntityType)

Returns the name of the container to which the entity type is mapped.
GetContainer(IReadOnlyEntityType)

Returns the name of the container to which the entity type is mapped.
GetContainerConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the container to which the entity type is mapped.
GetContainingPropertyName(IEntityType)

Returns the name of the parent property to which the entity type is mapped.
GetContainingPropertyName(IReadOnlyEntityType)

Returns the name of the parent property to which the entity type is mapped.
GetContainingPropertyNameConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the parent property to which the entity type is mapped.
GetDefaultTimeToLive(IReadOnlyEntityType)

Returns the default time to live in seconds at container scope.
GetDefaultTimeToLiveConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the default time to live in seconds at container scope.
GetETagProperty(IConventionEntityType)

Gets the property on this entity that is mapped to Cosmos ETag, if it exists.
GetETagProperty(IEntityType)

Gets the property on this entity that is mapped to Cosmos ETag, if it exists.
GetETagProperty(IMutableEntityType)

Gets the property on this entity that is mapped to Cosmos ETag, if it exists.
GetETagProperty(IReadOnlyEntityType)

Gets the property on this entity that is mapped to Cosmos ETag, if it exists.
GetETagPropertyName(IEntityType)

Returns the name of the property that is used to store the etag.
GetETagPropertyName(IReadOnlyEntityType)

Returns the name of the property that is used to store the ETag.
GetETagPropertyNameConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the property that is used to store the etag.
GetPartitionKeyProperty(IConventionEntityType)

Returns the property that is used to store the partition key.
GetPartitionKeyProperty(IEntityType)

Returns the property that is used to store the partition key.
GetPartitionKeyProperty(IMutableEntityType)

Returns the property that is used to store the partition key.
GetPartitionKeyProperty(IReadOnlyEntityType)

Returns the property that is used to store the partition key.
GetPartitionKeyPropertyName(IEntityType)

Returns the name of the property that is used to store the partition key.
GetPartitionKeyPropertyName(IReadOnlyEntityType)

Returns the name of the property that is used to store the partition key.
GetPartitionKeyPropertyNameConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the property that is used to store the partition key.
GetThroughput(IReadOnlyEntityType)

Returns the provisioned throughput at container scope.
GetThroughputConfigurationSource(IConventionEntityType)

Gets the ConfigurationSource for the provisioned throughput at container scope.
SetAnalyticalStoreTimeToLive(IConventionEntityType, Nullable<Int32>, Boolean)

Sets the time to live for analytical store in seconds at container scope.
SetAnalyticalStoreTimeToLive(IMutableEntityType, Nullable<Int32>)

Sets the time to live for analytical store in seconds at container scope.
SetContainer(IConventionEntityType, String, Boolean)

Sets the name of the container to which the entity type is mapped.
SetContainer(IMutableEntityType, String)

Sets the name of the container to which the entity type is mapped.
SetContainingPropertyName(IConventionEntityType, String, Boolean)

Sets the name of the parent property to which the entity type is mapped.
SetContainingPropertyName(IMutableEntityType, String)

Sets the name of the parent property to which the entity type is mapped.
SetDefaultTimeToLive(IConventionEntityType, Nullable<Int32>, Boolean)

Sets the default time to live in seconds at container scope.
SetDefaultTimeToLive(IMutableEntityType, Nullable<Int32>)

Sets the default time to live in seconds at container scope.
SetETagPropertyName(IConventionEntityType, String, Boolean)

Sets the name of the property that is used to store the ETag.
SetETagPropertyName(IMutableEntityType, String)

Sets the name of the property that is used to store the ETag key.
SetPartitionKeyPropertyName(IConventionEntityType, String, Boolean)

Sets the name of the property that is used to store the partition key.
SetPartitionKeyPropertyName(IMutableEntityType, String)

Sets the name of the property that is used to store the partition key key.
SetThroughput(IConventionEntityType, Nullable<Int32>, Nullable<Boolean>, Boolean)

Sets the provisioned throughput at container scope.
SetThroughput(IMutableEntityType, Nullable<Int32>, Nullable<Boolean>)

Sets the provisioned throughput at container scope.

Applies to