Classic Editor

It is intended for users already familiar with the concepts of full-text search.

To create an index, through the classic editor, left-click on the Add Index button towards the right-hand side.

The Add Index screen appears.

To define a basic index on which Full Text Search can be performed, begin by entering a unique name for the index in the Name field, on the upper-left: for example, travel-sample-index. (Note that only alphanumeric characters, hyphens, and underscores are allowed for index names. Also note that the first character of the name must be alphabetic.) Then, use the pull-down menu provided for the Bucket field, on the upper-right, to specify the travel-sample bucket:

This is all you need to specify in order to create a basic index for test and development. No further configuration is required. Note, however, that such default indexing is not recommended for production environments since it creates indexes that may be unnecessarily large, and therefore insufficiently performant.

Select this checkbox if you want the index to stream data from a non-default scope and/or non-default collection(s) on the source bucket.

To review the wide range of available options for creating indexes appropriate for production environments, see Creating Indexes.

To save your index, left-click on the Create Index button near the bottom of the screen:

At this point, you are returned to the Full Text Search screen. In the Full Text Indexes panel, a row now appears for the index you have created. When left-clicked on, the row opens as follows:

Once the new index has been built, it supports Full Text Searches performed by all available means: the Console UI, the Couchbase REST API, and the Couchbase SDK.

The indexing progress is determined as index_doc_count / source_doc_count.

The index_doc_count is retrieved from the search endpoint. The source_doc_count is retrieved from a KV endpoint.