c4Index.h

Go to the documentation of this file.

//
// c4Index.h
//
// Copyright 2019-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#include "c4IndexTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
//======== C4Collection Methods:
 
NODISCARD CBL_CORE_API bool c4coll_createIndex(C4Collection* collection, C4String name, C4String indexSpec,
                                               C4QueryLanguage queryLanguage, C4IndexType indexType,
                                               const C4IndexOptions* C4NULLABLE indexOptions,
                                               C4Error* C4NULLABLE              outError) C4API;
 
CBL_CORE_API C4Index* C4NULLABLE c4coll_getIndex(C4Collection* collection, C4String name,
                                                 C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4coll_deleteIndex(C4Collection* collection, C4String name,
                                               C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4SliceResult c4coll_getIndexesInfo(C4Collection* collection, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4SliceResult c4db_getIndexesInfo(C4Database* database, C4Error* C4NULLABLE outError) C4API;
 
//======== C4Index Methods:
 
CBL_CORE_API C4Slice c4index_getName(C4Index* index) C4API;
 
CBL_CORE_API C4Collection* c4index_getCollection(C4Index* index) C4API;
 
CBL_CORE_API C4IndexType c4index_getType(C4Index*) C4API;
 
CBL_CORE_API C4QueryLanguage c4index_getQueryLanguage(C4Index*) C4API;
 
CBL_CORE_API C4String c4index_getExpression(C4Index*) C4API;
 
CBL_CORE_API bool c4index_getOptions(C4Index* index, C4IndexOptions* outOpts) C4API;
 
 
#ifdef COUCHBASE_ENTERPRISE
 
CBL_CORE_API bool c4index_isTrained(C4Index*, C4Error* C4NULLABLE outError) C4API;
 
 
//======== UPDATING LAZY INDEXES:
 
 
NODISCARD CBL_CORE_API C4IndexUpdater* C4NULLABLE c4index_beginUpdate(C4Index* index, size_t limit,
                                                                      C4Error* outError) C4API;
 
CBL_CORE_API size_t c4indexupdater_count(C4IndexUpdater* updater) C4API;
 
NODISCARD CBL_CORE_API FLValue C4NULLABLE c4indexupdater_valueAt(C4IndexUpdater* updater, size_t i) C4API;
 
NODISCARD CBL_CORE_API bool c4indexupdater_setVectorAt(C4IndexUpdater* updater, size_t i,
                                                       const float vector[C4NULLABLE], size_t dimension,
                                                       C4Error* outError) C4API;
 
CBL_CORE_API bool c4indexupdater_skipVectorAt(C4IndexUpdater* updater, size_t i) C4API;
 
CBL_CORE_API bool c4indexupdater_finish(C4IndexUpdater* updater, C4Error* outError) C4API;
 
#endif
 
 
#ifndef C4_STRICT_COLLECTION_API
//======== SEMI-DEPRECATED DATABASE METHODS:
NODISCARD CBL_CORE_API bool c4db_createIndex(C4Database* database, C4String name, C4String indexSpecJSON,
                                             C4IndexType indexType, const C4IndexOptions* C4NULLABLE indexOptions,
                                             C4Error* C4NULLABLE outError) C4API;
NODISCARD CBL_CORE_API bool c4db_createIndex2(C4Database* database, C4String name, C4String indexSpec,
                                              C4QueryLanguage queryLanguage, C4IndexType indexType,
                                              const C4IndexOptions* C4NULLABLE indexOptions,
                                              C4Error* C4NULLABLE              outError) C4API;
NODISCARD CBL_CORE_API bool c4db_deleteIndex(C4Database* database, C4String name, C4Error* C4NULLABLE outError) C4API;
#endif
 
CBL_CORE_API bool c4coll_isIndexTrained(C4Collection* collection, C4String name, C4Error* C4NULLABLE outError) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END