MAmacrometa
Key Value

Create key-value collection

Create key-value collection.

post/_fabric/{fabric}/_api/kv/{collection}

Request

Path parameters

fabricstring string required

The name of the fabric.

collectionstring string required

The name of the key-value collection.

Query parameters

expirationboolean

Enable TTL support.

groupboolean

Enable KV group support.

Request body

streamboolean

Flag for on-demand stream collection

enableShardsboolean

Enabling sharding for the collection

waitForSyncboolean

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

cacheEnabledboolean

True if collection has cache enabled

blobsboolean

True if collection is a blob-only collection.

shardKeysstring[]

Example request

{
  "waitForSync": true,
  "shardKeys": [
    "key1"
  ]
}

Response

Successfully created key-value collection.

codeinteger

HTTP response code.

errorboolean required

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

namestring

It shows name of the collection.

Example response

{
  "code": 200,
  "name": "testCollection"
}

Changes

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