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
  • The name of the database.

Query Parameters
  • The collection name.

HTTP Headers
    Request Body application/json object
    • A list with exactly one attribute path.

    • 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.

    • 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.

    • 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.

    • Must be equal to "fulltext".

    Responses
    • The index exists already.

    • The index is created as there is no such existing index.

    • 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' <<'EOF'
    {
      "type": "fulltext",
      "fields": [
        "text"
      ]
    }
    EOF
    Show output