ArangoDB v3.13 is under development and not released yet. This documentation is not final and potentially incomplete.

HTTP interface for full-text indexes

Create a full-text index

POST /_db/{database-name}/_api/index

The fulltext index type is deprecated from version 3.10 onwards.

Creates a fulltext index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.

Path Parameters

database-name* string
The name of the database.

Query Parameters

collection* string
The collection name.

HTTP Headers

Request Body application/json object

fields* array of strings
A list with exactly one attribute path.
inBackground boolean (default: false)
Set this option to true to keep the collection/shards available for write operations by not using an exclusive write lock for the duration of the index creation.
minLength* integer (default: 2)
Minimum character length of words to index. The default is low, thus it is recommended to set this value explicitly when creating the index.
name string
An easy-to-remember name for the index to look it up or refer to it in index hints. Index names are subject to the same character restrictions as collection names. If omitted, a name is auto-generated so that it is unique with respect to the collection, e.g. idx_832910498.
type* string
Must be equal to "fulltext".

Responses

200 OK
The index exists already.
201 Created
The index is created as there is no such existing index.
404 Not Found
The collection is unknown.

Examples

Creating a fulltext index

curl -X POST --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/index?collection=products
{
  "type": "fulltext",
  "fields": [
    "text"
  ]
}

Show output

HTTP/1.1 201 Created
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 182
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "fields" : [ 
    "text" 
  ], 
  "id" : "products/69118", 
  "isNewlyCreated" : true, 
  "minLength" : 2, 
  "name" : "idx_1793257748263075840", 
  "sparse" : true, 
  "type" : "fulltext", 
  "unique" : false, 
  "code" : 201, 
  "error" : false 
}