Customize a Search Index with the Web Console
- concept
Configure additional options for a Search index to improve performance and fine tune your search results.
Some Search index options are only available when you use the standard editor.
You can add the following components and configure the following options for a Search index:
| Option | Quick Editor | Standard Editor | Description |
|---|---|---|---|
✓ |
Set a type identifier to add a filter to the documents added to your Search index through a type mapping:
Type identifiers add a more granular filter to the documents in a type mapping. If a type mapping has a type identifier, only documents that match the type identifier can be included in the Search index. For more information about how to configure a type identifier, see Set the Type Identifier for a Search Index. |
||
✓ |
✓ |
Use a type mapping to include or exclude specific documents in a collection from an index. For more information about the different kinds of mappings in a Search index, see Map Document Collections, Objects, and Fields. |
|
✓ |
Use analyzers to improve and customize the search results in your index. Analyzers transform input text into tokens, which give you greater control over your index’s text matching. You can use one of Couchbase’s built-in analyzers or create your own. For more information about how to create a custom analyzer, see Create a Custom Analyzer. Analyzers have different components that control how text is transformed for search. When you create a custom analyzer, you can choose these components. For more information, see Custom Filters. |
||
✓ |
Use custom filters to add more customization to a custom analyzer. For more information about these filters, see the Custom Filters section. |
||
✓ |
If the documents in your index contain date and time data in a format other than RFC-3339 (ISO-8601), then you need to create a date/time parser. A custom date/time parser tells the Search index how to interpret date data from your documents. If any values are missing from a date/time string in your documents, the Search Service automatically fills in default date/time values to make it easier to compare date/time strings. For more information about how to add a custom date/time parser, see Create a Custom Date/Time Parser. For more information about the available default date/time parsers, see Default Date/Time Parsers. |
||
Advanced |
✓ |
Set advanced settings to change your index’s default analyzer, replication, and more. For more information about how to change advanced settings, see Set Search Index Advanced Settings. |
|
Synonym Sources |
✓ |
✓ |
Couchbase Server 8.0 As of Couchbase Server version 8.0 and later, you can add a Synonym Source to a Search index to use synonym searches on text fields. After you create a synonym collection and synonym documents, and add a synonym source, you can run a search for a term and return results that include terms with similar meanings. For example, you could run a search for You can also add Synonym Sources with the Quick Editor. For more information about synonym search for the Search Service, see Add Synonyms to a Search Index or Add Synonyms with the Quick Editor, based on your preferred editor. |
Custom Filters
Custom filters are components of a Search index analyzer.
Create and add these components to a custom analyzer to improve search results and performance for an index with the standard editor.
You can create the following custom filters:
Character Filters
Character filters remove unwanted characters from the input for a search. For example, the default html character filter removes HTML tags from your search content.
You can use a default character filter in an analyzer or create your own.
For more information about the available default character filters, see Default Character Filters.
For more information about how to create your own custom character filter, see Create a Custom Character Filter.
Tokenizers
Tokenizers separate input strings into individual tokens. These tokens are combined into token streams. The Search Service takes token streams from search queries to determine matches for token streams in search results.
You can use a default tokenizer in an analyzer or create your own.
For more information about the available default tokenizers, see Default Tokenizers.
For more information about how to create your own tokenizer, see Create a Custom Tokenizer.
Token Filters
Token filters take the token stream from a tokenizer and modify the tokens.
A token filter can create stems from tokens to increase the matches for a search term.
For example, if a token filter creates the stem play, a search can return matches for player, playing, and playable.
The Search Service has default tokenizers available. For a list of all available tokenizers, see Default Token Filters.
You can also create your own token filters. Custom token filters can use Wordlists to modify their tokens. For more information about how to create your own token filter, see Create a Custom Token Filter.
Wordlists
Wordlists define a list of words that you can use with a token filter to create tokens.
You can use a wordlist to find words and create tokens, or remove words from a tokenizer’s token stream.
When you create a custom token filter, the Search Service has a set of default wordlists. For more information about the available default wordlists, see Default Wordlists.
For more information about how to create your own wordlist, see Create a Custom Wordlist.