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

Value Index Configuration. More...

#include <cbl/CBLQueryIndexTypes.h>

Data Fields

CBLQueryLanguage expressionLanguage
 The language used in the expressions (Required). More...
 
FLString expressions
 The expressions describing each coloumn of the index (Required). More...
 
FLString where
 A predicate expression defining conditions for indexing documents. More...
 

Detailed Description

Value Index Configuration.

Field Documentation

◆ expressionLanguage

CBLQueryLanguage CBLValueIndexConfiguration::expressionLanguage

The language used in the expressions (Required).

◆ expressions

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

◆ where

FLString CBLValueIndexConfiguration::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: