Cloud service only. Note: this type is only relevant when using the driver with the Cloud Service or Cloud Simulator. It is not relevant when using the driver with on-premise NoSQL Database (see KVSTORE), in which case it is not a part of the operation results mentioned below.

ConsumedCapacity is part of results of data operations such as GetResult, PutResult, DeleteResult, MultiDeleteResult, WriteMultipleResult, PreparedStatement and QueryResult. It contains read and write throughputs consumed by the operation in KBytes as well as in read and write units. Thoughput in read and write units is defined as following:

A read unit represents 1 eventually consistent read per second for data up to 1 KB in size. A read that is absolutely consistent is double that, consuming 2 read units for a read of up to 1 KB in size. This means that if an application is to use ABSOLUTE it may need to specify additional read units when creating a table. A write unit represents 1 write per second of data up to 1 KB in size. Note that:

When driver-side rate limiting is enabled (see rateLimiter), two additional properties, readRateLimitDelay and writeRateLimitDelay may be set. They specify how long given operation was delayed by the rate limiter due to reads and writes performed, respectively (note that each of these values is set only if given operation does reads and/or writes, correspondingly). These values may be useful in gathering statistics to analyze performance and adjust rate limiter configuration (when using custom rate limiter). See RateLimiter. Note that total time the operation was delayed due to rate limiting is readRateLimitDelay (if set) + writeRateLimitDelay (if set).

Hierarchy

  • ConsumedCapacity

Properties

readKB: number

Read throughput consumed by this operation, in KBytes.

readRateLimitDelay?: number

When rate limiting is enabled, specifies how long the operation has been delayed, in milliseconds, due to the table read limit. This value may be 0 if given operation was not delayed by the read rate limiter. Not set if rate limiting is disabled or if given operation does not perform reads.

readUnits: number

Read throughput consumed by this operation, in read units.

writeKB: number

Write throughtput consumed by this operation, in KBytes.

writeRateLimitDelay?: number

When rate limiting is enabled, specifies how long the operation has been delayed, in milliseconds, due to the table write limit. This value may be 0 if the operation was not delayed by the write rate limiter. Not set if rate limiting is disabled or if given operation does not perform writes.

writeUnits: number

Write throughtput consumed by this operation, in write units.

Generated using TypeDoc