Create a Search Index
- Capella Operational
- concept
Create a Search index to get started with the Search Service in your operational cluster.
You can create a Search index with:
-
The Couchbase Capella UI.
-
A JSON payload that you import through the UI.
All Search indexes are built from a JSON payload. For more information about the available properties for a Search index JSON payload, see Search Index JSON Properties.
If you’re new to developing with the Search Service, create a Search index with the UI. You can export the Search index definition JSON payload from the UI to Import a Search Index Definition with the Capella UI. |
Creating a Search Index with the Capella UI
Couchbase Capella supports creating a Search index with a streamlined experience, or Advanced Options.
When you create a new Search index, you can:
-
Configure global index settings, which include:
-
Create Type mappings and mappings
-
Configure Replica and partition settings
If you select Enable Advanced Options to enable Advanced Mode in the Search index editor, the following additional options become available:
-
Creating custom analyzers, which can include:
-
Custom character filters
-
Custom tokenizers
-
Custom token filters, which can use custom word lists
-
-
Creating custom date/time parsers
-
Creating mappings for Extended Attributes (XATTRs) data in documents
-
Creating mappings for objects and fields that do not yet exist in your document schema
-
Configuring a document filter
All initial editing options remain available in Advanced Mode editing.
For indexes created with Couchbase Server version 7.6 and later, index names must be unique inside a bucket and scope. You cannot have 2 indexes with the same name inside the same bucket and scope on a Capella operational cluster running version 7.6 or later. The Capella UI marks indexes as scoped or not scoped to a specific bucket and scope. Indexes created with a previous version of Couchbase Server are not scoped. |
After you create a Search index, the Search Service streams data from your chosen collection or collections, and any document mutations, into the index builder. Before your index finishes building, you can run a search and return partial results.