MAmacrometa
Collections

Return figures of a collection

Returns an object containing statistics about a collection.

Note: This always loads the collection into memory.

get/_fabric/{fabric}/_api/collection/{collection-name}/figures

Request

Path parameters

fabricstring string required

The name of the fabric.

collection-namestring string required

The name of the collection.

Response

Returns information about the collection.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

idstring

ID of the the collection.

objectIdstring

Object ID of the the collection.

namestring

Name of the collection.

statusString'unloaded' | 'loading' | 'loaded' | 'unloading' | 'deleted' | 'unknown'

Status of the collection.

collectionModelnumber

Type of collection model.

  • 0: document model
  • 1: key/value model
  • 2: dynamo model
isSpotboolean

True if the collection is a spot collection.

isLocalboolean

True if the collection is a local collection.

cacheEnabledboolean

True if the collection has cache enabled.

hasStreamboolean

True if the collection has a stream.

waitForSyncboolean

True if all data must be synced to storage before operation returns.

isSystemboolean

True if collection is a system collection.

globallyUniqueIdstring

Collection's global unique ID.

searchEnabledboolean

True if collection is searchable.

Example response

{
  "code": 200,
  "id": "89218",
  "objectId": "6966663",
  "name": "colltest0127133421258ogefv",
  "hasStream": true,
  "keyOptions": {
    "increment": 1,
    "offset": 1,
    "type": "autoincrement"
  },
  "globallyUniqueId": "h2C627F3DCC8E/89218",
  "figures": {
    "indexes": {
      "count": 1,
      "size": 2070
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.