Configuration for creating a full-text index, which enables full-text search in queries. More...

#include <cbl++/Collection.hh>

Public Attributes
QueryLanguage	expressionLanguage
	The language used in the expressions (Required).
std::string	expressions
	The expressions describing each coloumn of the index (Required).
bool	ignoreAccents
	Should diacritical marks (accents) be ignored?
std::string	language
	The dominant language.
std::string	where
	A predicate expression defining conditions for indexing documents.

Detailed Description

Configuration for creating a full-text index, which enables full-text search in queries.

Member Data Documentation

◆ expressionLanguage

QueryLanguage cbl::FullTextIndexConfiguration::expressionLanguage

The language used in the expressions (Required).

◆ expressions

std::string cbl::FullTextIndexConfiguration::expressions

The expressions describing each coloumn of the index (Required).

The expressions could be specified in a JSON Array or in N1QL syntax using comma delimiter, depending on expressionLanguage.

◆ ignoreAccents

bool cbl::FullTextIndexConfiguration::ignoreAccents

Should diacritical marks (accents) be ignored?

Defaults to kCBLDefaultFullTextIndexIgnoreAccents. Generally this should be left false for non-English text.

◆ language

std::string cbl::FullTextIndexConfiguration::language

The dominant language.

Setting this enables word stemming, i.e. matching different cases of the same word ("big" and "bigger", for instance) and ignoring common "stop-words" ("the", "a", "of", etc.)

Can be an ISO-639 language code or a lowercase (English) language name; supported languages are: da/danish, nl/dutch, en/english, fi/finnish, fr/french, de/german, hu/hungarian, it/italian, no/norwegian, pt/portuguese, ro/romanian, ru/russian, es/spanish, sv/swedish, tr/turkish.

If left null, or set to an unrecognized language, no language-specific behaviors such as stemming and stop-word removal occur.

◆ where

std::string cbl::FullTextIndexConfiguration::where

A predicate expression defining conditions for indexing documents.

Only documents satisfying the predicate are included, enabling partial indexes. The expression can be JSON or N1QL/SQL++ syntax, depending on expressionLanguage.

The documentation for this struct was generated from the following file:

include/cbl++/Collection.hh