Manage Full Text Indexes

    +
    Full text searches are supported by specially purposed indexes, which can be created and managed from the Couchbase Capella UI.

    This page describes the various ways you can manage Full Text Indexes using the Capella UI, including viewing and modifying the Full Text Index details, deleting Full Text Indexes, and viewing statistics.

    Accessing Full Text Indexes in the Couchbase Capella UI

    If a cluster is running the Search Service, Full Text Indexes can be accessed under the cluster’s Tools > Full Text Search tab. (Full Text Indexes are different from the Global indexes that are accessed under the Tools > Indexes tab.)

    The cluster’s 'Tools > Full Text Search' tab.
    Permissions Required

    In order to access Full Text Indexes in the Couchbase Capella UI, the following permissions are required:

    Index Summary

    A cluster’s Tools > Full Text Search tab shows a summary of all the Full Text Indexes on the cluster. The summary is displayed in a table format, with sortable columns and a row for each index.

    The Full Text Indexes list displays the following information about each index:

    • Couchbase 7.0+

    • Couchbase 6.6

    • Index Name: The name of the Full Text Index.

    • Bucket: The bucket for which the Full Text Index was created.

    • Scope: The scope for which the Full Text Index was created.

    • Doc Count: Number of documents examined while building the index. (Note that this is not a reflection of the number of documents in the index.)

    • Indexing Progress: The build-progress of the index. When 100% is reached, the index build is considered complete. An index can be searched as soon as it’s created, but only partial results can be expected until the index build is complete.

    • Index Name: The name of the Full Text Index.

    • Bucket: The bucket for which the Full Text Index was created.

    • Doc Count: Number of documents examined while building the index. (Note that this is not a reflection of the number of documents in the index.)

    • Indexing Progress: The build-progress of the index. When 100% is reached, the index build is considered complete. An index can be searched as soon as it’s created, but only partial results can be expected until the index build is complete.

    Indexing progress is determined by index_doc_count / source_doc_count, with index_doc_count being retrieved from the Search Service endpoint and source_doc_count being retrieved from a Data Service endpoint. If one or more Data Service nodes in the cluster become unavailable and/or become failed over, the indexing progress may show a value greater than 100% since source_doc_count for the bucket would be missing some active partitions.

    View and Modify a Full Text Index

    The procedure in this section describes how to access the configuration page of a Full Text Index. From this page you can view and/or modify the index’s configuration settings, as well as take actions such as searching the index, monitoring index statistics, and copying the index definition.

    Permissions Required

    In order to view or modify a Full Text Index via the Couchbase Capella UI, the following permissions are required:

    1. Go to the cluster’s Tools > Full Text Search tab.

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on the cluster that contains the Full Text Index that you wish to view/modify.

        This opens the cluster with its Metrics tab selected.

      3. Click the Tools > Full Text Search tab.

    2. Find and click on the index that you wish to view/modify.

      This opens the index’s configuration page.

      The configuration page of a Full Text Index.
    3. After making modifications to the index configuration, click Save Index at the bottom of the index’s configuration page to commit the new configuration and to begin rebuilding the index.

      When making changes to the index configuration, those changes are only saved in browser memory until the Save Index button is clicked. Only after this button is clicked will the new configuration be committed and the index re-built.

    The buttons on the upper-right side of the index’s configuration page allow you to do the following:

    The Index Details section contains the following expandable panels:

    • Couchbase 7.0+

    • Couchbase 6.6

    • General: This panel displays the Name of the index and the Bucket on which the index is built. When using Couchbase Server 7.0, you will also see the chosen Scope.

      Clicking Edit allows you to change the value of the Bucket field so that you can change the bucket on which the index is built. You can also change the Use default scope/collection(s) check box to be selected or deselected. If you deselect the Use default scope/collection(s) checkbox, the Scope drop-down menu is shown and allows you to specify the scope.

    If you have not yet created collections for your documents, then the Use default scope/collection(s) check box should remain selected as this will ensure that all documents within the bucket’s _default collection are indexed and searchable.
    • General: This panel displays the Name of the index and the Bucket on which the index is built. Clicking Edit allows you to change the value of the Bucket field so that you can change the bucket on which the index is built.

    • Type Identifier: Expanding this panel displays the type identifier configuration of the index. Clicking Edit Type Identifier allows you to specify the type identifier for the index.

    • Analyzer Defaults: Expanding this panel displays the currently-configured analyzer default settings for the index. Clicking Edit Analyzer Defaults allows you to specify the analyzer defaults for the index.

    The Index Settings section displays controls for the following:

    • Type Mappings: Expanding this panel displays any type mappings that are currently configured for the index. Clicking Add Mapping allows you to specify a new type mapping for the index. Clicking the vertical ellipses next to an existing type mapping displays options to edit or delete the type mapping, along with options to insert child mappings and child fields. Refer to Specifying Type Mappings for more information.

      Full text indexes require valid type mappings.
    • Analyzers: Expanding this panel displays any analyzers that are currently configured for the index. Clicking Add Analyzer allows you to create a new analyzer for the index. Clicking the vertical ellipses next to an existing analyzer displays options to edit or delete the analyzer. Refer to Creating Analyzers for more information.

    • Custom Filters: Expanding this panel displays any custom filters that are currently configured for the index. Refer to Adding Custom Filters for more information about adding and managing the various custom filters.

    • Date/Time Parsers: Expanding this panel displays any date/time parsers that are currently configured for the index. Clicking Add Date/Time Parser allows you to create a new date/time parser for the index. Clicking the vertical ellipses next to an existing date/time parser displays options to edit or delete the date/time parser. Refer to Date Time Parsers for more information.

    Delete a Full Text Index

    Permissions Required

    In order to delete a Full Text Index using the Couchbase Capella UI, the following permissions are required:

    1. Go to the cluster’s Tools > Full Text Search tab.

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on the cluster that contains the Full Text Index that you wish to delete.

        This opens the cluster with its Metrics tab selected.

      3. Click the Tools > Full Text Search tab.

    2. Find the index that you wish to delete, and click the Trash icon at the end of the row on the right side.

    3. When prompted to confirm the deletion, click Confirm.

      The index is deleted and removed from the list of indexes on the Tools > Full Text Search tab.

    Deleting a bucket also deletes any Full Text Indexes configured on that bucket.

    View Full Text Index Statistics

    Within the Couchbase Capella UI, you can view statistics for a specific Full Text Index.

    Permissions Required

    In order to view the statistics for a particular Full Text Index via the Couchbase Capella UI, the following permissions are required:

    1. Go to the cluster’s Tools > Full Text Search tab.

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on the cluster that contains the Full Text Index whose statistics you wish to view.

        This opens the cluster with its Metrics tab selected.

      3. Click the Tools > Full Text Search tab.

    2. Find and click on the index whose statistics you wish to view.

      This opens the index’s configuration page.

      The configuration page of a Full Text Index.
    3. Click Stats.

      This opens the index’s Stats fly-out menu.

      The index’s 'Stats' fly-out menu.
    4. (Optional) Use the Past drop-down menu to change the time interval over which the statistics are displayed. This can be Minute, Hour, Day, Week, or Month.

    The index’s Stats fly-out menu displays several statistics related to the current index:

    Disk Used

    The amount of disk used by the Full Text Index.

    Doc Count

    The number of documents examined while building the index. (Note that this is not a reflection of the number of documents in the index.)

    Query Error Rate

    The rate of query errors: Errors due to query rejection (high memory usage) or due to internal errors.

    Query Latency

    The average time to answer Search queries after they reach the Search Service on the cluster.

    Slow Queries

    The number of Search queries that took five seconds or greater.

    Total Queries

    The number of Search queries executed per node.