Couchbase Lite C
Couchbase Lite C API
Data Fields
CBLFullTextIndexConfiguration Struct Reference

Full-Text Index Configuration. More...

#include <cbl/CBLQuery.h>

Data Fields

CBLQueryLanguage expressionLanguage
 The language used in the expressions. More...
 
FLString expressions
 The expressions describing each coloumn of the index. More...
 
bool ignoreAccents
 Should diacritical marks (accents) be ignored? Defaults to false. More...
 
FLString language
 The dominant language. More...
 

Detailed Description

Full-Text Index Configuration.

Field Documentation

◆ expressionLanguage

CBLQueryLanguage CBLFullTextIndexConfiguration::expressionLanguage

The language used in the expressions.

◆ expressions

FLString CBLFullTextIndexConfiguration::expressions

The expressions describing each coloumn of the index.

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

◆ ignoreAccents

bool CBLFullTextIndexConfiguration::ignoreAccents

Should diacritical marks (accents) be ignored? Defaults to false.

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

◆ language

FLString CBLFullTextIndexConfiguration::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.


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