MAmacrometa
Collections

Update collection properties

Changes the properties of a collection.

put/_fabric/{fabric}/_api/collection/{collection-name}/properties

Request

Path parameters

fabricstring string required

The name of the fabric.

collection-namestring string required

The name of the collection.

Request body

hasStreamboolean required

True if a local stream is associated with the collection.

waitForSyncboolean

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

cacheEnabledboolean

True if collection has cache enabled

Response

Successfully updated the document.

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.

typenumber

Type of the collection.

collectionModelstring

Type of collection model.

  • DOC: document model
  • KV: key/value model
  • DYNAMO: dynamo model
isSpotboolean

True if collection is a spot collection.

isLocalboolean

True if collection is a local collection.

cacheEnabledboolean

True if collection has cache enabled

hasStreamboolean

True if 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.

status0 | 2 | 3 | 4 | 5 | 6

Status of the collection.

  • 0: corrupted
  • 2: unloaded
  • 3: loaded
  • 4: unloading
  • 5: deleted
  • 6: loading

Example response

{
  "code": 200,
  "id": "89218",
  "objectId": "6966663",
  "name": "colltest0127133421258ogefv",
  "type": 2,
  "collectionModel": "DOC",
  "hasStream": true,
  "keyOptions": {
    "increment": 1,
    "offset": 1,
    "type": "autoincrement"
  },
  "globallyUniqueId": "h2C627F3DCC8E/89218"
}

Changes

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