CBLArrayIndexConfiguration Struct Reference

Array Index Configuration for indexing property values within arrays in documents, intended for use with the UNNEST query. More...

#include <cbl/CBLQueryIndexTypes.h>

Data Fields
CBLQueryLanguage	expressionLanguage
	The language used in the expressions (Required). More...
FLString	path
	Path to the array, which can be nested to be indexed (Required). More...
FLString	expressions
	Optional expressions representing the values within the array to be indexed. More...

Detailed Description

Array Index Configuration for indexing property values within arrays in documents, intended for use with the UNNEST query.

Field Documentation

expressionLanguage

CBLQueryLanguage CBLArrayIndexConfiguration::expressionLanguage

The language used in the expressions (Required).

expressions

FLString CBLArrayIndexConfiguration::expressions

Optional expressions representing the values within the array to be indexed.

The expressions could be specified in a JSON Array or in N1QL syntax using comma delimiter. If the array specified by the path contains scalar values, the expressions should be left unset or set to null.

path

FLString CBLArrayIndexConfiguration::path

Path to the array, which can be nested to be indexed (Required).

Use "[]" to represent a property that is an array of each nested array level. For a single array or the last level array, the "[]" is optional. For instance, use "contacts[].phones" to specify an array of phones within each contact.

---

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

• include/cbl/CBLQueryIndexTypes.h