Package com.azure.spring.data.cosmos.core.mapping

Annotation Type CosmosUniqueKey

@Inherited @Retention(RUNTIME) @Target(TYPE) public @interface CosmosUniqueKey
Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos DB service.

1) For containers, 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 item that has missing value for this property.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    paths
    A set of paths which must be unique for each item in the Azure Cosmos DB service.

  • Element Details

    • paths

      String[] paths
      A set of paths which must be unique for each item in the Azure Cosmos DB service.

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

      Returns:
      unique paths
      Default:
      {}