The Index API is used to manage individual indices.
The Create Index API is used to manually create an index in Cockatrice. The most basic usage is the following:
PUT /indices/<INDEX_NAME>?sync=<SYNC>&output=<OUTPUT>
---
schema:
id:
field_type: id
args:
unique: true
stored: true
...
<INDEX_NAME>
: The index name.<SYNC>
: Specifies whether to execute the command synchronously or asynchronously. IfTrue
is specified, command will execute synchronously. Default isFalse
, command will execute asynchronously.<OUTPUT>
: The output format.json
oryaml
. Default isjson
.- Request Body: JSON or YAML formatted schema definition.
The Get Index API allows to retrieve information about the index. The most basic usage is the following:
GET /indices/<INDEX_NAME>?output=<OUTPUT>
<INDEX_NAME>
: The index name.<OUTPUT>
: The output format.json
oryaml
. Default isjson
.
The Delete Index API allows to delete an existing index. The most basic usage is the following:
DELETE /indices/<INDEX_NAME>?sync=<SYNC>&output=<OUTPUT>
<INDEX_NAME>
: The index name.<SYNC>
: Specifies whether to execute the command synchronously or asynchronously. IfTrue
is specified, command will execute synchronously. Default isFalse
, command will execute asynchronously.<OUTPUT>
: The output format.json
oryaml
. Default isjson
.