Interface TableUsageResult

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).

TableUsageResult is the result of getTableUsage method. It encapsulates the dynamic state of the requested table.

Hierarchy

  • TableUsageResult

Properties

nextIndex tableName usageRecords

Properties

Readonly nextIndex

nextIndex: number

The next index after the last table usage record returned. Can be used for paging table usage records. For manual paging, assign this value to startIndex as shown in the example of getTableUsage. This property is not needed if you are using tableUsageIterable.

Readonly tableName

tableName: string

Table name.

Readonly usageRecords

usageRecords: TableUsage[]

Array of TableUsage records based on options provided to getTableUsage. May be empty if no usage records are found for requested time period.

Settings

Member Visibility

Theme

Generated using TypeDoc