Class ContainerDefinition<T>

Namespace

Microsoft.Azure.Cosmos.Fluent

Assembly

Microsoft.Azure.Cosmos.Client.dll

Azure Cosmos container fluent definition.

public abstract class ContainerDefinition<T> where T : ContainerDefinition<T>

Type Parameters

T

Inheritance

object

ContainerDefinition<T>

Derived

ContainerBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

ContainerDefinition()

Creates an instance for unit-testing

public ContainerDefinition()

See Also

Container

Methods

Build()

Applies the current Fluent definition and creates a container configuration.

public ContainerProperties Build()

Returns

ContainerProperties

Builds the current Fluent configuration into an instance of ContainerProperties.

See Also

Container

WithDefaultTimeToLive(int)

DefaultTimeToLive will be applied to all the items in the container as the default time-to-live policy. The individual item could override the default time-to-live policy by setting its time to live.

public T WithDefaultTimeToLive(int defaultTtlInSeconds)

Parameters

defaultTtlInSeconds int

The default Time To Live.

Returns

T

An instance of the current Fluent builder.

See Also

DefaultTimeToLive

WithDefaultTimeToLive(TimeSpan)

DefaultTimeToLive will be applied to all the items in the container as the default time-to-live policy. The individual item could override the default time-to-live policy by setting its time to live.

public T WithDefaultTimeToLive(TimeSpan defaultTtlTimeSpan)

Parameters

defaultTtlTimeSpan TimeSpan

The default Time To Live.

Returns

T

An instance of the current Fluent builder.

See Also

DefaultTimeToLive

WithIndexingPolicy()

IndexingPolicy definition for the current Azure Cosmos container.

public IndexingPolicyDefinition<T> WithIndexingPolicy()

Returns

IndexingPolicyDefinition<T>

An instance of IndexingPolicyDefinition<T>.

See Also

Container

WithPartitionKeyDefinitionVersion(PartitionKeyDefinitionVersion)

Sets the PartitionKeyDefinitionVersion

The partition key definition version 1 uses a hash function that computes hash based on the first 100 bytes of the partition key. This can cause conflicts for documents with partition keys greater than 100 bytes.

The partition key definition version 2 uses a hash function that computes hash based on the first 2 KB of the partition key.

public T WithPartitionKeyDefinitionVersion(PartitionKeyDefinitionVersion partitionKeyDefinitionVersion)

Parameters

partitionKeyDefinitionVersion PartitionKeyDefinitionVersion

The partition key definition version

Returns

T

An instance of the current Fluent builder.

See Also

PartitionKeyDefinitionVersion

WithTimeToLivePropertyPath(string)

Sets the time to live base timestamp property path.

public T WithTimeToLivePropertyPath(string propertyPath)

Parameters

propertyPath string

This property should be only present when DefaultTimeToLive is set. When this property is present, time to live for a item is decided based on the value of this property in an item. By default, time to live is based on the _ts property in an item. Example: /property

Returns

T

An instance of the current Fluent builder.

See Also

TimeToLivePropertyPath

See Also

Container