Dela via

PartitionKey Class

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")

Constructor

PartitionKey(path: list[str], *, kind: Literal['MultiHash'] = 'MultiHash', version: int = _PartitionKeyVersion.V2)

Variables

Name Description
path
str

The path(s) of the partition key.
kind
str

The kind of partition key ("Hash" or "MultiHash") (default: "Hash").
version
int

The version of the partition key (default: 2).

Methods

clear
copy
fromkeys

Create a new dictionary with keys from iterable and values set to value.
get

Return the value for key if key is in the dictionary, else default.
items
keys
pop

If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.
setdefault

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.
update

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

clear 

clear() -> None.  Remove all items from D.

copy 

copy() -> a shallow copy of D

fromkeys

Create a new dictionary with keys from iterable and values set to value.

fromkeys(value=None, /)

Positional-Only Parameters

Name Description
iterable
Required
value
Default value: None

get

Return the value for key if key is in the dictionary, else default.

get(key, default=None, /)

Positional-Only Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> a set-like object providing a view on D's items

keys 

keys() -> a set-like object providing a view on D's keys

pop

If the key is not found, return the default if given; otherwise, raise a KeyError.

pop(k, [d]) -> v, remove specified key and return the corresponding value.

popitem

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

popitem()

setdefault

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

setdefault(key, default=None, /)

Positional-Only Parameters

Name Description
key
Required
default
Default value: None

update

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

update([E], **F) -> None.  Update D from dict/iterable E and F.

values 

values() -> an object providing a view on D's values

Attributes

kind

path

version