Class PartitionKeyRangeStatistics

Namespace

Microsoft.Azure.Documents

Assembly

Microsoft.Azure.Documents.Client.dll

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

public sealed class PartitionKeyRangeStatistics

Inheritance

object

PartitionKeyRangeStatistics

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Remarks

For usage, please refer to the example in PartitionKeyRangeStatistics.

Constructors

PartitionKeyRangeStatistics()

public PartitionKeyRangeStatistics()

Properties

DocumentCount

Gets the document count of a partition key range in the Azure Cosmos DB service.

public long DocumentCount { get; }

Property Value

long

PartitionKeyRangeId

Gets the ID of a partition key range in the Azure Cosmos DB service.

public string PartitionKeyRangeId { get; }

Property Value

string

PartitionKeyStatistics

Gets the partition key statistics for a partition key range in the Azure Cosmos DB service.

public IReadOnlyList<PartitionKeyStatistics> PartitionKeyStatistics { get; }

Property Value

IReadOnlyList<PartitionKeyStatistics>

Remarks

This is reported based on a sub-sampling of partition keys within the partition key range and hence these are approximate. If your partition keys are below 1GB of storage, they may not show up in the reported statistics.

SizeInKB

Gets the size in KB of a partition key range in the Azure Cosmos DB service.

public long SizeInKB { get; }

Property Value

long

Methods

ToString()

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

public override string ToString()

Returns

string