partition_key Module

Represents partition key missing from the document.

Represents null value for a partition key.

Key used to partition a container into logical partitions.

See https://free.blessedness.top/azure/cosmos-db/partitioning-overview#choose-partitionkey for information on how to choose partition keys.

This constructor supports multiple overloads:

1. Single Partition Key:

   Parameters:

   • path (str): The path of the partition key.

   • kind (Literal["Hash"], optional): The kind of partition key. Defaults to "Hash".

   • version (int, optional): The version of the partition key. Defaults to 2.

   Example:

   
   >>> pk = PartitionKey(path="/id")
   

2. Hierarchical Partition Key:

   Parameters:

   • path (list[str]): A list of paths representing the partition key, supports up to three hierarchical levels.

   • kind (Literal["MultiHash"], optional): The kind of partition key. Defaults to "MultiHash".

   • version (int, optional): The version of the partition key. Defaults to 2.

   Example:

   
   >>> pk = PartitionKey(path=["/id", "/category"], kind="MultiHash")