@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
21 lines • 1.06 kB
TypeScript
import type { PartitionKeyDefinitionVersion } from "./PartitionKeyDefinitionVersion.js";
import type { PartitionKeyKind } from "./PartitionKeyKind.js";
export interface PartitionKeyDefinition {
/**
* 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[];
/**
* 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](https://learn.microsoft.com/azure/cosmos-db/large-partition-keys) article.
*/
version?: PartitionKeyDefinitionVersion;
systemKey?: boolean;
/**
* What kind of partition key is being defined (default: "Hash")
*/
kind?: PartitionKeyKind;
}
//# sourceMappingURL=PartitionKeyDefinition.d.ts.map