Package version:

Interface PartitionKeyDefinition

interface PartitionKeyDefinition {
    kind?: PartitionKeyKind;
    paths: string[];
    systemKey?: boolean;
    version?: PartitionKeyDefinitionVersion;
}

Properties

kind? paths systemKey? version?

Properties

Optionalkind

kind?: PartitionKeyKind

What kind of partition key is being defined (default: "Hash")

paths

paths: string[]

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.

OptionalsystemKey

systemKey?: boolean

Optionalversion

version?: PartitionKeyDefinitionVersion

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.

Settings

Member Visibility