A newer version of this documentation is available.

View Latest

Classic Editor Examples

      The classic editor is the most advanced interface where users can directly configure the index mapping with all of capabilities in Search.


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

      • Ensure that Couchbase Server has the Search service appropriately enabled. The service must be enabled for a given node as part of that node’s initial configuration. Refer to Create a Cluster for information.

      • You must have permission to log into the console, load sample data, create indexes, create search indexes, and perform searches. For information on Role-Based Access Control, see Authorization.

      • The example(s) provided assume that you have can load or have loaded the travel-sample dataset. You will perform your Search operations on the data under this bucket. For instructions on how to load this sample dataset, see Sample Buckets.

      • The Couchbase Web Console by accessing http://localhost:8091 or if remote http://${CB_HOSTNAME}:8091 where CB_HOSTNAME is an environment variable set to a FQDN or an IP address for a node on your Couchbase cluster.

      Quickstart via the Classic Editor

      To quickly become familiarized with the Search service, try one of the step by step index creation (and query) examples against the travel-sample sample dataset:

      • Collections

      • Bucket Compatibility

        • Creating a Legacy Index via the UI (or via the REST API), followed by a sample Search query.

          The above Legacy Index is used for compatibility after an upgrade from buckets to collections uses the old bucket style "default _mapping which only works on the default scope and _default collection where buckets are upgraded into. The preferred method as of version 7.0 is shown in Creating a Dynamic Index above.

      For a more detailed explanation of the available index creation, including index creation by means of the Couchbase REST API, refer to Creating Search Indexes.

      To install the travel-sample sample dataset, refer to Install Sample Buckets with the UI .