Cloud service only. Note: this type is only relevant when using the driver with the Cloud Service. It is not relevant when using the driver with on-premise NoSQL Database (see KVSTORE).

TableUsage objects are part of TableUsageResult, that is the result of getTableUsage method. TableUsage represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity. In addition the count of throttling exceptions for the period is reported.

Hierarchy

  • TableUsage

Properties

maxShardUsagePercent: number

Percentage of allowed storage usage for the shard with the highest usage percentage across all table shards. This property can be used as a gauge of total storage available as well as a hint for key distribution across shards.

readThrottleCount: number

Number of read throttling exceptions on this table in the time period, see READ_LIMIT_EXCEEDED.

readUnits: number

Number of read units consumed during this period, see TableLimits.

secondsInPeriod: number

Number of seconds in this usage record.

startTime: Date

Start time for this usage record as Date.

storageGB: number

Amount of storage in Gigabytes consumed by the table. This information may be out of date as it is not maintained in real time.

storageThrottleCount: number

Number of storage throttling exceptions on this table in the time period, see SIZE_LIMIT_EXCEEDED.

writeThrottleCount: number

Number of write throttling exceptions on this table in the time period, see WRITE_LIMIT_EXCEEDED.

writeUnits: number

Number of write units consumed during this period, see TableLimits.

Generated using TypeDoc