Cloud Service only.

Result returned by getReplicaStats. It contains replica statistics for the requested table.

See

getReplicaStats

Hierarchy

  • ReplicaStatsResult

Properties

nextStartTime: Date

Next start time. This can be used when retrieving large number of replica stats records over multiple calls to getReplicaStats. Pass this value as startTime on the subsequent call to getReplicaStats.

statsRecords: {
    [regionId: string]: ReplicaStats[];
}

Replica statistics information. Represented as an object with keys being region id (see regionId) of a replica and values being an array of ReplicaStats for that replica. If region option is set, this object will contain only one key-value pair for the given region.

Note that in either case this object will contain only keys for which there is at least one ReplicaStats record returned (it will not contain keys for regions for which no stats records were found according to values specified in ReplicaStatsOpt or applicable defaults).

See

ReplicaStatsOpt

Example

Print replica lag info for EU_ZURICH_1 region.

for(const rec of statsResult.statsRecords['eu-zurich-1']) {
console.log(rec.replicaLag);
}

Type declaration

tableName: string

Table name.

Generated using TypeDoc