Create

Create a collection

Create a collection #

Creates a new collection.

The following request creates a new collection called my-collection in the namespace my-namespace:

PUT /my-namespace:my-collection

If creating a collection within the default namespace, it can be simplified as:

PUT /my-collection

PUT /[<namespace>:]<name>

<namespace>
(Optional, string) The namespace which the collection belongs to. Namespace names must meet the following criteria:
- Lowercase only
- Cannot include \ /, *, ?, ", <, >, |, , ,, #
- Cannot start with -, _, +
- Cannot be . or ..
- Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster)
<name>
(Required, string) Name of the collection you wish to create. Collection names must meet the same criteria as namespace names.

Creates a new document.

Insert a JSON document into the my-collection collection:

POST /my-collection/_doc
{
  "message": "GET /search HTTP/1.1 200 1070000",
  "org": {
    "id": "infini"
  }
}

The API returns the following result:

{
  "_collection": "default:my-collection",
  "_id": "0,0",
  "result": "created",
  "_shards": { "total": 2, "successful": 1, "failed": 0 }
}

The API supports passing a customized UUID as the document identify, eg:

POST /my-collection/_doc/news_001
{
  "message": "GET /search HTTP/1.1 200 1070000",
  "org": {
    "id": "infini"
  }
}

The keyed form answers with the user key as _key:

Creates a new namespace.

If creating a website namespace, the following request creates a new namespace called website:

PUT /_namespace/website

PUT /_namespace/<name>

/_ns/<name> is accepted as a shorter alias.

Creates a new index under a collection.

The following request creates a new index called my-index under collection my-namespace:my-collection

PUT /my-namespace:my-collection/_index/my-index

PUT /<target>/_index/<name>