Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Latest commit

 

History

History
69 lines (48 loc) · 1.62 KB

File metadata and controls

69 lines (48 loc) · 1.62 KB
code type title description
true
page
create
Collection:create

create

Creates a new collection in the provided index.

You can also provide an optional data mapping that allow you to exploit the full capabilities of our persistent data storage layer, ElasticSearch (check here the mapping capabilities of ElasticSearch).

This method will only update the mapping if the collection already exists.


create([mapping], [options], [callback])

Arguments Type Description
mapping JSON Object Optional data mapping
options JSON Object Optional parameters
callback function Optional callback

Options

Option Type Description Default
queuable boolean Make this request queuable or not true

Return Ralue

Returns the Collection object to allow chaining.


Callback Response

Returns a JSON object containing the raw Kuzzle response.

Usage

<<< ./snippets/create-1.java

Callback response:

{
  "status": 200,
  "error": null,
  "requestId": "<request unique identifier>",
  "controller": "collection",
  "action": "create",
  "collection": "<new collection name>",
  "index": "index",
  "volatile": null,
  "result": {
    "acknowledged": true
  }
}