ArangoDB v3.10 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent stable version.

Working with full-text indexes

Create a full-text index

POST /_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

Query Parameters

collection* string
The collection name.

HTTP Headers

Request Body application/json object

fields* array of strings
an array of attribute names. Currently, the array is limited to exactly one attribute.
inBackground boolean
You can set this option to true to create the index in the background, which will not write-lock the underlying collection for as long as if the index is built in the foreground. The default value is false.
minLength* integer
Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus 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
If the index already exists, then a HTTP 200 is returned.
201 Created
If the index does not already exist and could be created, then a HTTP 201 is returned.
404 Not Found
If the collection-name is unknown, then a HTTP 404 is returned.

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/70931", 
  "isNewlyCreated" : true, 
  "minLength" : 2, 
  "name" : "idx_1795421227034083328", 
  "sparse" : true, 
  "type" : "fulltext", 
  "unique" : false, 
  "error" : false, 
  "code" : 201 
}