A query result enumerator. More...

#include <c4QueryTypes.h>

Data Fields
FLArrayIterator	columns
	The columns of this result, in the same order as in the query's `WHAT` clause.

uint64_t	missingColumns
	A bitmap where a 1 bit represents a column whose value is MISSING.

uint32_t	fullTextMatchCount
	The number of full-text matches (i.e.

const C4FullTextMatch *	fullTextMatches
	Array with details of each full-text match.

Detailed Description

A query result enumerator.

Created by c4db_query. Must be freed with c4queryenum_release. The fields of this struct represent the current matched index row, and are valid until the next call to c4queryenum_next or c4queryenum_release.

Field Documentation

◆ columns

FLArrayIterator C4QueryEnumerator::columns

The columns of this result, in the same order as in the query's WHAT clause.

◆ fullTextMatchCount

uint32_t C4QueryEnumerator::fullTextMatchCount

The number of full-text matches (i.e.

the number of items in fullTextMatches)

◆ fullTextMatches

const C4FullTextMatch* C4QueryEnumerator::fullTextMatches

Array with details of each full-text match.

◆ missingColumns

uint64_t C4QueryEnumerator::missingColumns

A bitmap where a 1 bit represents a column whose value is MISSING.

This is how you tell a missing property value from a value that's JSON 'null', since the value in the columns array will be a Fleece null either way.

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