Set Search Index Advanced Settings

how-to

Configure advanced settings with the Couchbase Server Web Console for a Search index to improve an index’s search results and performance.

Prerequisites

You have the Search Service enabled on a node in your database. For more information about how to deploy a new node and Services on your database, see Manage Nodes and Clusters.
You have a bucket with scopes and collections in your database. For more information about how to create a bucket, see Create a Bucket.
You have created an index. For more information, see Create a Basic Search Index with the Web Console.
Your user account has the Search Admin role for the bucket where you want to edit an index.
You have logged in to the Couchbase Server Web Console.

Procedure

To set advanced settings for a Search index with the Couchbase Server Web Console:

Go to Search.
Click the index that you want to edit.
Click Edit.
Expand Customize Index Advanced.

Configure any of the following advanced settings for your index:

Option Description

Option	Description
Default Type	Change the default type assigned to documents in the index. The default value is `_default`.
Default Analyzer	Change the default analyzer assigned to type mappings in the index. For more information about the available default analyzers, see Default Analyzers. For more information about how to create your own custom analyzer, see Create a Custom Analyzer.
Default Date/Time Parser	Change the default date/time parser used for date data.
Default Field	When you create a mapping for a child field, you can choose to include that field in an `_all` field. You can add fields to the `_all` field to search their contents without specifying their field name in your search query. Enter a value in the Default Field field to change the name of this default field.
Store Dynamic Fields	Select Store Dynamic Fields to include field values in search results from a dynamic type mapping in the index.
Index Dynamic Fields	Select Index Dynamic Fields to include fields from a dynamic type mapping in the index.
DocValues for Dynamic Fields	Select DocValues for Dynamic Fields to include the values of each field from a dynamic type mapping in the index for Facets and sorting search results.
Index Replicas	Set the number of replicas that the Search Service creates for the index. If a node running the Search Service is lost, you can use an index replica to keep using your data. Replicas exist on nodes separate from the current active replica or any other replicas. You must have enough nodes running the Search Service to support any selection you make for this setting. For more information about replication and the Search Service, see High Availability for Search.
Index Type	This setting is included for compatibility only. For new indexes, this setting is always Version 6.0 (Scorch).
Index Partitions	Enter a number greater than one to divide the index into partitions across multiple nodes running the Search Service. This can improve query latency for large, aggregated queries and help with horizontal scaling for large Search indexes.

Default Type

Change the default type assigned to documents in the index. The default value is _default.

Default Analyzer

Change the default analyzer assigned to type mappings in the index.

For more information about the available default analyzers, see Default Analyzers.

For more information about how to create your own custom analyzer, see Create a Custom Analyzer.

Default Date/Time Parser

Change the default date/time parser used for date data.

Default Field

When you create a mapping for a child field, you can choose to include that field in an _all field.

You can add fields to the _all field to search their contents without specifying their field name in your search query.

Enter a value in the Default Field field to change the name of this default field.

Store Dynamic Fields

Select Store Dynamic Fields to include field values in search results from a dynamic type mapping in the index.

Index Dynamic Fields

Select Index Dynamic Fields to include fields from a dynamic type mapping in the index.

DocValues for Dynamic Fields

Select DocValues for Dynamic Fields to include the values of each field from a dynamic type mapping in the index for Facets and sorting search results.

Index Replicas

Set the number of replicas that the Search Service creates for the index. If a node running the Search Service is lost, you can use an index replica to keep using your data.

Replicas exist on nodes separate from the current active replica or any other replicas. You must have enough nodes running the Search Service to support any selection you make for this setting.

For more information about replication and the Search Service, see High Availability for Search.

Index Type

This setting is included for compatibility only. For new indexes, this setting is always Version 6.0 (Scorch).

Index Partitions

Enter a number greater than one to divide the index into partitions across multiple nodes running the Search Service.

This can improve query latency for large, aggregated queries and help with horizontal scaling for large Search indexes.

Click Update Index.

Next Steps

After you change the settings for your Search index, you can continue to customize your Search index:

To run a search and test the contents of your Search index, see Run A Simple Search with the Web Console or Run a Simple Search with the REST API and curl/HTTP.