Quick Editor and Example

The user interface for Full Text Search is provided by the Couchbase Web Console.

Quick Editor is a newer interface in Search where you can quickly select the bucket, scope, and collection and choose the index fields from the searched documents.

Due to this, the search query performance will be optimized as it has to handle fewer fields, increasing the query latency.

To access the Full Text Search screen, left-click on the Search tab in the navigation bar on the left-hand side:

The Full Text Search screen now appears as follows:

To quick edit an index, left-click on the Quick Edit button towards the right-hand side on the Full Text Indexes panel.

The console contains areas for displaying indexes and aliases: but both are empty since none has yet been created.

The Quick Edit screen appears:

Quick Edit allows you to modify and delete the configured mapped fields with the same index. To delete the mapped fields, select the field from the Mapped Fields grid and click Delete.

To map the new fields, select the field from the JSON format document, change the configuration and click Add.

To modify the mapped fields, select the field from the Mapped Fields, change the configuration and click Update.

To save your changes in the quick index, left-click on the Update Index button near the bottom of the screen.

To create a quick index, left-click on the QUICK INDEX button, towards the right-hand side:

The QUICK 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 into the Index Name field, on the upper-left: for example, travel-sample-index. (Note that only alphanumeric characters, hyphens, and underscores are allowed for index names. Note also that the first character of the name must be an alphabetic character.) Then, use the pull-down menu provided for the Keyspace field, at the upper-right, to specify as follows:

bucket: travel-sample

scope: inventory

collection: hotel

The user can continue to randomly pick documents until they find a document of their intended type/schema. It is also possible to have multi-schema documents within a collection.

Select the required field from the document, which is needed to be mapped to this index. Once the field is selected, the configuration panel is displayed on the right.

Select the related type of the field from the Type dropdown.

Select Index this field as an identifier to index the identifier values precisely without any transformation; for this case, language selection is disabled.

After that, select the required language for the chosen field.

Additionally, select from the following configuration options corresponding to the selected language:

The 'Refresh' option will randomly select a document from the given Keyspace (bucket.scope.collection).

Include In search results, Support phrase matching, and Support sorting and faceting. Searchable As field allows you to modify searchable input for the selected field.

Once the configuration is completed for the selected fields, click Add. Mapped fields will display the updated columns.

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. 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. A row now appears, in the Full Text Indexes panel, for the quick 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.