A newer version of this documentation is available.

View Latest

Creating Search Indexes

      Full Text Searches are supported by specially purposed indexes, which can be created either from the Couchbase Web Console, or by means of the REST API.

      The PUT request is the only way to create/update indexes.

      If the user does it from the UI/SDK - it will be translated to HTTP PUT requests and executed by curl.

      Specifying the "uuid" parameter in the index definition is required for the index introduction to be treated as a valid update.

      This uuid has to match the one in the system already. Upon a successful index creation/updation, the uuid of the index will be re-initialized.

      Every Full Text Search is performed on a user-created Full Text Index, which contains the targets on which searches are to be performed.

      These targets are values derived from the textual and other contents of documents within a specified bucket or collections within a scope.

      Index-creation is highly configurable; you can select various attributes to search the specific information.

      For example, documents can be grouped by the user into different types (e.g. airline documents versus hotel documents), different scopes (e.g. inventory), and collections (e.g. airport or hotel).

      Based on the document-IDs, or the values of a designated document field, you can perform the following:

      • Assign index mapping to each document type

      • Assign analyzers to each index mapping

      • Apply the index mapping to a specific subset of document fields

      • Included or exclude the index mapping from the index

      Additionally, searches can be performed across multiple buckets/scopes, by means of index aliases or across multiple collections in a scope by selecting the respective non-default scope/collection(s) option.