Table of Contents

Class UniqueKey

Namespace
Microsoft.Azure.Cosmos
Assembly
Microsoft.Azure.Cosmos.Client.dll

Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

public class UniqueKey
Inheritance
UniqueKey
Inherited Members
Extension Methods

Remarks

  1. For partitioned collections, the value of partition key is implicitly a part of each unique key.
  2. Uniqueness constraint is also enforced for missing values. For instance, if unique key policy defines a unique key with single property path, there could be only one document that has missing value for this property.

Constructors

UniqueKey()

public UniqueKey()
See Also

Properties

Paths

Gets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.

public Collection<string> Paths { get; }

Property Value

Collection<string>

The paths to enforce uniqueness on. Each path is a rooted path of the unique property in the document, such as "/name/first".

Examples

uniqueKey.Paths = new Collection<string> { "/name/first", "/name/last" };

See Also

See Also