PartitionKeyDefinition interface

Properties

paths

An array of paths for which data within the collection can be partitioned. Paths must not contain a wildcard or a trailing slash. For example, the JSON property “AccountNumber” is specified as “/AccountNumber”. The array must contain only a single value.

systemKey
version

An optional field, if not specified the default value is 1. To use the large partition key set the version to 2. To learn about large partition keys, see how to create containers with large partition key article.

Property Details

paths

An array of paths for which data within the collection can be partitioned. Paths must not contain a wildcard or a trailing slash. For example, the JSON property “AccountNumber” is specified as “/AccountNumber”. The array must contain only a single value.

paths: string[]

Property Value

string[]

systemKey

systemKey?: boolean

Property Value

boolean

version

An optional field, if not specified the default value is 1. To use the large partition key set the version to 2. To learn about large partition keys, see how to create containers with large partition key article.

version?: number

Property Value

number