Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Create a Search Index with the Capella UI

  • Capella Operational
  • how-to
    +
    You can create a Search index using the Couchbase Capella UI to generate a properly formatted Search index definition.

    Use Advanced Mode to create a Search index in the Couchbase Capella UI with full customization and advanced features, such as creating custom analyzers or setting a document filter.

    You must create a Search index before you can run a search with the Search Service.

    Prerequisites

    • You have the Search Service enabled on a node in your operational cluster. For more information about how to change Services on your operational cluster, see Modify a Paid Cluster.

    • You have a bucket with scopes and collections in your operational cluster. For more information, see Manage Buckets.

    • You have logged in to the Couchbase Capella UI.

    Procedure

    To use the Capella UI to create a Search index:

    1. On the Operational Clusters page, select the operational cluster where you want to create a Search index.

    2. Go to Data Tools  Search.

    3. Click Create Search Index.

    4. (Optional) To add additional customization options to your Search index, click Enable Advanced Mode.

    5. In the Index Name field, enter a name for the Search index.

      Your index name must start with an alphabetic character (a-z or A-Z). It can only contain alphanumeric characters (a-z, A-Z, or 0-9), hyphens (-), or underscores (_).

      For Couchbase Server version 7.6 and later, your index name must be unique inside your selected bucket and scope. You cannot have 2 indexes with the same name inside the same bucket and scope.

    6. In the Bucket and Scope lists, choose the bucket and scope where you want to create your Search index.

    7. In the Collections list, select the collections you want to include in your Search index, or accept the default of All.

      If you select specific collections, you can only use documents from these collections in your Search index.

    8. In the Choose a Collection or Document Field panel, click a collection name.

    9. Click Index everything from: $COLLECTION_NAME.

    10. Click Index All Fields.

    11. Click Add to Index.

    12. (Optional) Configure Global Index settings.

    13. (Optional) Expand Replicas & Partitions and configure your Number of Replicas and Number of Partitions.

      For more information, see Replica and Partition Settings.

    14. Click Create Index.

    Configure Global Search Index Settings

    To configure global settings for your Search index:

    1. Expand Global Index Settings:

      1. In the Default Analyzer list, select the default analyzer to assign to new type mappings in your index.

      2. In the Default Date/Time Parser list, select the default date/time parser to use for date data in your index.

        If you’re editing your index in Advanced Mode Editing, you can also choose to Create a Custom Analyzer or Create a Custom Date/Time Parser.

    2. (Advanced Mode Only) In the Configured Type Mappings pane, under Choose Document Filter, configure a document filter for your Search index.

    Next Steps

    Your Search index will contain documents that match the collection type mapping you specified. You can run a search against your index, but it’s recommended that you create more specific type mappings to improve performance and reduce the index size.

    For more information about the different features you can add to your Search index to improve performance and search results, see Search Index Features.

    For more information about how to run a search, see Run A Simple Search with the Capella UI.