c4Collection.h

Go to the documentation of this file.

//
//  c4Collection.h
//
// Copyright 2021-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 "c4DatabaseTypes.h"
#include "c4DocumentTypes.h"
#include "fleece/Fleece.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
 
/* NOTE:
    Enumeration-related functions are in c4DocEnumerator.h:
    - c4coll_enumerateChanges
    - c4coll_enumerateAllDocs
    Observer-related functions are in c4Observer.h:
    - c4dbobs_createOnCollection
    - c4docobs_createWithCollection
    Index-related functions are in c4Index.h:
    - c4coll_createIndex
    - c4coll_deleteIndex
    - c4coll_getIndex
    - c4coll_getIndexesInfo
*/
 
 
CBL_CORE_API C4Collection* c4db_getDefaultCollection(C4Database* db, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4db_hasCollection(C4Database* db, C4CollectionSpec spec) C4API;
 
CBL_CORE_API bool c4db_hasScope(C4Database* db, C4String name) C4API;
 
CBL_CORE_API C4Collection* C4NULLABLE c4db_getCollection(C4Database* db, C4CollectionSpec spec,
                                                         C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Collection* C4NULLABLE c4db_createCollection(C4Database* db, C4CollectionSpec spec,
                                                                      C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4db_deleteCollection(C4Database* db, C4CollectionSpec spec,
                                                  C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API FLMutableArray c4db_collectionNames(C4Database* db, C4String inScope,
                                                           C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API FLMutableArray c4db_scopeNames(C4Database* db, C4Error* C4NULLABLE outError) C4API;
 
 
CBL_CORE_API bool c4coll_isValid(C4Collection* C4NULLABLE) C4API;
 
CBL_CORE_API C4CollectionSpec c4coll_getSpec(C4Collection*) C4API;
 
CBL_CORE_API C4Database* c4coll_getDatabase(C4Collection*) C4API;
 
CBL_CORE_API uint64_t c4coll_getDocumentCount(C4Collection*) C4API;
 
CBL_CORE_API C4SequenceNumber c4coll_getLastSequence(C4Collection*) C4API;
 
 
NODISCARD CBL_CORE_API C4Document* C4NULLABLE c4coll_getDoc(C4Collection* collection, C4String docID, bool mustExist,
                                                            C4DocContentLevel   content,
                                                            C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* C4NULLABLE c4coll_getDocBySequence(C4Collection*       collection, C4SequenceNumber,
                                                                      C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* C4NULLABLE c4coll_putDoc(C4Collection* collection, const C4DocPutRequest* request,
                                                            size_t* C4NULLABLE  outCommonAncestorIndex,
                                                            C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* C4NULLABLE c4coll_createDoc(C4Collection* collection, C4String docID, C4Slice body,
                                                               C4RevisionFlags     revisionFlags,
                                                               C4Error* C4NULLABLE error) C4API;
 
NODISCARD CBL_CORE_API bool c4coll_moveDoc(C4Collection* collection, C4String docID, C4Collection* toCollection,
                                           C4String newDocID, C4Error* C4NULLABLE error) C4API;
 
 
 
 
NODISCARD CBL_CORE_API bool c4coll_purgeDoc(C4Collection* collection, C4String docID,
                                            C4Error* C4NULLABLE outError) C4API;
 
 
NODISCARD CBL_CORE_API bool c4coll_setDocExpiration(C4Collection* collection, C4String docID, C4Timestamp timestamp,
                                                    C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4Timestamp c4coll_getDocExpiration(C4Collection* collection, C4String docID,
                                                 C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4Timestamp c4coll_nextDocExpiration(C4Collection*) C4API;
 
NODISCARD CBL_CORE_API int64_t c4coll_purgeExpiredDocs(C4Collection*, C4Error* C4NULLABLE) C4API;
 
 
  // end Collections group
 
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END