CBLQueryIndex.h File Reference

#include "CBLBase.h"
#include "CBLQueryTypes.h"

Go to the source code of this file.

Functions
CBLQueryIndex
CBLQueryIndex represents an existing index in a collection. Available in the enterprise edition, the CBLQueryIndex can be used to obtain a CBLIndexUpdater object for updating the vector index in lazy mode.
CBLINLINE const CBLQueryIndex *	CBLQueryIndex_Retain (const CBLQueryIndex *_cbl_nullable t)
CBLINLINE void	CBLQueryIndex_Release (const CBLQueryIndex *_cbl_nullable t)
FLString	CBLQueryIndex_Name (const CBLQueryIndex *index)
	Returns the index's name.
CBLCollection *	CBLQueryIndex_Collection (const CBLQueryIndex *index)
	Returns the collection that the index belongs to.
CBLINLINE const CBLIndexUpdater *	CBLIndexUpdater_Retain (const CBLIndexUpdater *_cbl_nullable t)
CBLINLINE void	CBLIndexUpdater_Release (const CBLIndexUpdater *_cbl_nullable t)
_cbl_warn_unused CBLIndexUpdater *_cbl_nullable	CBLQueryIndex_BeginUpdate (CBLQueryIndex *index, size_t limit, CBLError *_cbl_nullable outError)
	ENTERPRISE EDITION ONLY.
IndexUpdater
CBLIndexUpdater used for updating the index in lazy mode. Currently, the vector index is the only index type that can be updated lazily.
size_t	CBLIndexUpdater_Count (const CBLIndexUpdater *updater)
	ENTERPRISE EDITION ONLY.
FLValue	CBLIndexUpdater_Value (CBLIndexUpdater *updater, size_t index)
	ENTERPRISE EDITION ONLY.
bool	CBLIndexUpdater_SetVector (CBLIndexUpdater *updater, size_t index, const float vector[_cbl_nullable], size_t dimension, CBLError *_cbl_nullable outError)
	ENTERPRISE EDITION ONLY.
void	CBLIndexUpdater_SkipVector (CBLIndexUpdater *updater, size_t index)
	ENTERPRISE EDITION ONLY.
bool	CBLIndexUpdater_Finish (CBLIndexUpdater *updater, CBLError *_cbl_nullable outError)
	ENTERPRISE EDITION ONLY.