PartitionKeyStatistics Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents statistics of a partition key in the Azure Cosmos DB service.

[Newtonsoft.Json.JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)]
public sealed class PartitionKeyStatistics

[<Newtonsoft.Json.JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)>]
type PartitionKeyStatistics = class

Public NotInheritable Class PartitionKeyStatistics

Inheritance: Object
PartitionKeyStatistics

Attributes: Newtonsoft.Json.JsonObjectAttribute

Remarks

This is reported based on a sub-sampling of partition keys within the collection and hence these are approximate. If your partition keys are below 1GB of storage, they may not show up in the reported statistics. For usage, please refer to the example in PartitionKeyRangeStatistics.

Constructors

PartitionKeyStatistics()

Properties

PartitionKey	Gets the partition key in the Azure Cosmos DB service.
SizeInKB	Gets the size of the partition key in the Azure Cosmos DB service.

Methods

ToString()

Gets the stringified version of PartitionKeyStatistics object in the Azure Cosmos DB service.

Applies to