Database.DefineContainer(String, String) Method

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

Database.cs

Creates a containerBuilder.

public abstract Microsoft.Azure.Cosmos.Fluent.ContainerBuilder DefineContainer (string name, string partitionKeyPath);

abstract member DefineContainer : string * string -> Microsoft.Azure.Cosmos.Fluent.ContainerBuilder

Public MustOverride Function DefineContainer (name As String, partitionKeyPath As String) As ContainerBuilder

Parameters

name

String

Azure Cosmos container name to create.

partitionKeyPath

String

The path to the partition key. Example: /partitionKey

Returns

ContainerBuilder

A fluent definition of an Azure Cosmos container.

Examples

CosmosContainerResponse container = await this.cosmosDatabase.DefineContainer("TestContainer", "/partitionKey")
    .UniqueKey()
        .Path("/path1")
        .Path("/path2")
        .Attach()
    .IndexingPolicy()
        .IndexingMode(IndexingMode.Consistent)
        .AutomaticIndexing(false)
        .IncludedPaths()
            .Path("/includepath1")
            .Path("/includepath2")
            .Attach()
        .ExcludedPaths()
            .Path("/excludepath1")
            .Path("/excludepath2")
            .Attach()
        .CompositeIndex()
            .Path("/root/leaf1")
            .Path("/root/leaf2", CompositePathSortOrder.Descending)
            .Attach()
        .CompositeIndex()
            .Path("/root/leaf3")
            .Path("/root/leaf4")
            .Attach()
        .Attach()
    .CreateAsync(5000 /* throughput /*);