Couchbase Lite C++
Couchbase Lite C++ API
Loading...
Searching...
No Matches
cbl::ValueIndexConfiguration Struct Reference

Configuration for creating a value index, which indexes the values of one or more document properties. More...

#include <cbl++/Collection.hh>

Public Attributes

QueryLanguage expressionLanguage
 The language used in the expressions (Required).
std::string expressions
 The expressions describing each column of the index (Required).
std::string where
 A predicate expression defining conditions for indexing documents.

Detailed Description

Configuration for creating a value index, which indexes the values of one or more document properties.

Member Data Documentation

◆ expressionLanguage

QueryLanguage cbl::ValueIndexConfiguration::expressionLanguage

The language used in the expressions (Required).

◆ expressions

std::string cbl::ValueIndexConfiguration::expressions

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

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

◆ where

std::string cbl::ValueIndexConfiguration::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: