c4Index.h File Reference

#include "c4IndexTypes.h"

Go to the source code of this file.

Functions
NODISCARD CBL_CORE_API bool	c4coll_createIndex (C4Collection *collection, C4String name, C4String indexSpec, C4QueryLanguage queryLanguage, C4IndexType indexType, const C4IndexOptions *indexOptions, C4Error *outError)
	Creates a collection index, of the values of specific expressions across all documents.
CBL_CORE_API C4Index *	c4coll_getIndex (C4Collection *collection, C4String name, C4Error *outError)
	Returns an object representing an existing index.
NODISCARD CBL_CORE_API bool	c4coll_deleteIndex (C4Collection *collection, C4String name, C4Error *outError)
	Deletes an index that was created by c4coll_createIndex.
CBL_CORE_API C4SliceResult	c4coll_getIndexesInfo (C4Collection *collection, C4Error *outError)
	Returns information about all indexes in the collection.
CBL_CORE_API C4SliceResult	c4db_getIndexesInfo (C4Database *database, C4Error *outError)
	Returns information about all indexes in the database.
CBL_CORE_API C4Slice	c4index_getName (C4Index *index)
	Returns the name of this index.
CBL_CORE_API C4Collection *	c4index_getCollection (C4Index *index)
	Returns the collection this index belongs to.
CBL_CORE_API C4IndexType	c4index_getType (C4Index *)
	Returns the index's type.
CBL_CORE_API C4QueryLanguage	c4index_getQueryLanguage (C4Index *)
	Returns the index's query language (JSON or N1QL).
CBL_CORE_API C4String	c4index_getExpression (C4Index *)
	Returns the indexed expression.
CBL_CORE_API bool	c4index_getOptions (C4Index *index, C4IndexOptions *outOpts)
	Gets the index's FTS/vector options, if any.
NODISCARD CBL_CORE_API bool	c4db_createIndex (C4Database *database, C4String name, C4String indexSpecJSON, C4IndexType indexType, const C4IndexOptions *indexOptions, C4Error *outError)
NODISCARD CBL_CORE_API bool	c4db_createIndex2 (C4Database *database, C4String name, C4String indexSpec, C4QueryLanguage queryLanguage, C4IndexType indexType, const C4IndexOptions *indexOptions, C4Error *outError)
NODISCARD CBL_CORE_API bool	c4db_deleteIndex (C4Database *database, C4String name, C4Error *outError)
CBL_CORE_API bool	c4coll_isIndexTrained (C4Collection *collection, C4String name, C4Error *outError)
	Returns whether a vector index has been trained yet or not.