CosmosDatabase.DefineContainer(String, String) Method

Reference

Definition

Namespace:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Package:: Azure.Cosmos v4.0.0-preview3

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.

Creates a containerBuilder.

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

abstract member DefineContainer : string * string -> 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

ContainerResponse 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 /*);

Applies to

Share via