CBLCollection.h

Go to the documentation of this file.

//
//  CBLCollection.h
//
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
 
#pragma once
#include "CBLBase.h"
#include "CBLDocument.h"
#include "CBLQueryIndexTypes.h"
#include "CBLQueryTypes.h"
 
CBL_CAPI_BEGIN
 
CBL_REFCOUNTED(CBLCollection*, Collection);
 
CBL_PUBLIC extern const FLString kCBLDefaultCollectionName;
 
FLMutableArray _cbl_nullable CBLDatabase_ScopeNames(const CBLDatabase* db,
                                                    CBLError* _cbl_nullable outError) CBLAPI;
 
FLMutableArray _cbl_nullable CBLDatabase_CollectionNames(const CBLDatabase* db,
                                                         FLString scopeName,
                                                         CBLError* _cbl_nullable outError) CBLAPI;
 
CBLScope* _cbl_nullable CBLDatabase_Scope(const CBLDatabase* db,
                                          FLString scopeName,
                                          CBLError* _cbl_nullable outError) CBLAPI;
 
CBLCollection* _cbl_nullable CBLDatabase_Collection(const CBLDatabase* db,
                                                    FLString collectionName,
                                                    FLString scopeName,
                                                    CBLError* _cbl_nullable outError) CBLAPI;
 
CBLCollection* _cbl_nullable CBLDatabase_CreateCollection(CBLDatabase* db,
                                                          FLString collectionName,
                                                          FLString scopeName,
                                                          CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_DeleteCollection(CBLDatabase* db,
                                  FLString collectionName,
                                  FLString scopeName,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
CBLScope* CBLDatabase_DefaultScope(const CBLDatabase* db,
                                   CBLError* _cbl_nullable outError) CBLAPI;
 
CBLCollection* _cbl_nullable CBLDatabase_DefaultCollection(const CBLDatabase* db,
                                                           CBLError* _cbl_nullable outError) CBLAPI;
 
CBLScope* CBLCollection_Scope(const CBLCollection* collection) CBLAPI;
 
FLString CBLCollection_Name(const CBLCollection* collection) CBLAPI;
 
FLString CBLCollection_FullName(const CBLCollection* collection) CBLAPI;
 
CBLDatabase* CBLCollection_Database(const CBLCollection* collection) CBLAPI;
 
uint64_t CBLCollection_Count(const CBLCollection* collection) CBLAPI;
 
_cbl_warn_unused
const CBLDocument* _cbl_nullable CBLCollection_GetDocument(const CBLCollection* collection,
                                                           FLString docID,
                                                           CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_SaveDocument(CBLCollection* collection,
                                CBLDocument* doc,
                                CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_SaveDocumentWithConcurrencyControl(CBLCollection* collection,
                                                      CBLDocument* doc,
                                                      CBLConcurrencyControl concurrency,
                                                      CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_SaveDocumentWithConflictHandler(CBLCollection* collection,
                                                   CBLDocument* doc,
                                                   CBLConflictHandler conflictHandler,
                                                   void* _cbl_nullable context,
                                                   CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_DeleteDocument(CBLCollection *collection,
                                  const CBLDocument* document,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_DeleteDocumentWithConcurrencyControl(CBLCollection *collection,
                                                        const CBLDocument* document,
                                                        CBLConcurrencyControl concurrency,
                                                        CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_PurgeDocument(CBLCollection* collection,
                                 const CBLDocument* document,
                                 CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_PurgeDocumentByID(CBLCollection* collection,
                                     FLString docID,
                                     CBLError* _cbl_nullable outError) CBLAPI;
 
CBLTimestamp CBLCollection_GetDocumentExpiration(CBLCollection* collection,
                                                 FLSlice docID,
                                                 CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_SetDocumentExpiration(CBLCollection* collection,
                                         FLSlice docID,
                                         CBLTimestamp expiration,
                                         CBLError* _cbl_nullable outError) CBLAPI;
_cbl_warn_unused
CBLDocument* _cbl_nullable CBLCollection_GetMutableDocument(CBLCollection* collection,
                                                            FLString docID,
                                                            CBLError* _cbl_nullable outError) CBLAPI;
bool CBLCollection_CreateValueIndex(CBLCollection *collection,
                                    FLString name,
                                    CBLValueIndexConfiguration config,
                                    CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLCollection_CreateFullTextIndex(CBLCollection *collection,
                                       FLString name,
                                       CBLFullTextIndexConfiguration config,
                                       CBLError* _cbl_nullable outError) CBLAPI;
 
#ifdef COUCHBASE_ENTERPRISE
bool CBLCollection_CreateVectorIndex(CBLCollection *collection,
                                     FLString name,
                                     CBLVectorIndexConfiguration config,
                                     CBLError* _cbl_nullable outError) CBLAPI;
 
#endif
 
bool CBLCollection_DeleteIndex(CBLCollection *collection,
                               FLString name,
                               CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
FLMutableArray _cbl_nullable CBLCollection_GetIndexNames(CBLCollection *collection,
                                                         CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
CBLQueryIndex* _cbl_nullable CBLCollection_GetIndex(CBLCollection* collection,
                                                    FLString name,
                                                    CBLError* _cbl_nullable outError) CBLAPI;
 
typedef struct {
    const CBLCollection* collection;    
    unsigned numDocs;                   
    FLString *docIDs;                   
} CBLCollectionChange;
 
typedef void (*CBLCollectionChangeListener)(void* _cbl_nullable context,
                                            const CBLCollectionChange* change);
 
_cbl_warn_unused
CBLListenerToken* CBLCollection_AddChangeListener(const CBLCollection* collection,
                                                  CBLCollectionChangeListener listener,
                                                  void* _cbl_nullable context) CBLAPI;
 
typedef struct {
    const CBLCollection* collection;    
    FLString docID;                     
} CBLDocumentChange;
 
typedef void (*CBLCollectionDocumentChangeListener)(void *context, const CBLDocumentChange* change);
 
_cbl_warn_unused
CBLListenerToken* CBLCollection_AddDocumentChangeListener(const CBLCollection* collection,
                                                          FLString docID,
                                                          CBLCollectionDocumentChangeListener listener,
                                                          void* _cbl_nullable context) CBLAPI;
    // end of outer \defgroup
 
CBL_CAPI_END