c4Document.h

Go to the documentation of this file.

//
// c4Document.h
//
// Copyright 2015-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 "c4DocumentTypes.h"
 
#if LITECORE_CPP_API
#    include "c4Document.hh"  // C++ version of C4Document struct
#else
#    include "c4DocumentStruct.h"  // C version of C4Document struct
#endif
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
 
#define kC4GeneratedIDLength 23
 
CBL_CORE_API char* c4doc_generateID(char* buffer, size_t bufferSize) C4API;
 
 
#ifndef C4_STRICT_COLLECTION_API
 
NODISCARD CBL_CORE_API C4Document* c4db_getDoc(C4Database* database, C4String docID, bool mustExist,
                                               C4DocContentLevel content, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* c4doc_get(C4Database* database, C4String docID, bool mustExist,
                                             C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* c4doc_getBySequence(C4Database*         database, C4SequenceNumber,
                                                       C4Error* C4NULLABLE outError) C4API;
 
#endif
 
NODISCARD CBL_CORE_API bool c4doc_save(C4Document* doc, uint32_t maxRevTreeDepth, C4Error* C4NULLABLE outError) C4API;
 
 
 
/*** Returns whether the selected revision has been rejected by the remote
    \note The caller must use a lock for Document when this function is called. */
CBL_CORE_API bool c4doc_isRevRejected(C4Document* doc) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_selectRevision(C4Document* doc, C4String revID, bool withBody,
                                                 C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4doc_selectCurrentRevision(C4Document* doc) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_loadRevisionBody(C4Document* doc, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4doc_hasRevisionBody(C4Document* doc) C4API;
 
CBL_CORE_API C4Slice c4doc_getRevisionBody(C4Document* doc) C4API;
 
CBL_CORE_API C4SliceResult c4doc_getRevisionHistory(C4Document* doc, unsigned maxRevs,
                                                    const C4String backToRevs[C4NULLABLE],
                                                    unsigned       backToRevsCount) C4API;
 
CBL_CORE_API C4SliceResult c4doc_getSelectedRevIDGlobalForm(C4Document* doc) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_selectParentRevision(C4Document* doc) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_selectNextRevision(C4Document* doc) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_selectNextLeafRevision(C4Document* doc, bool includeDeleted, bool withBody,
                                                         C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_selectCommonAncestorRevision(C4Document* doc, C4String rev1ID, C4String rev2ID) C4API;
 
CBL_CORE_API C4RemoteID c4db_getRemoteDBID(C4Database* db, C4String remoteAddress, bool canCreate,
                                           C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4SliceResult c4db_getRemoteDBAddress(C4Database* db, C4RemoteID remoteID) C4API;
 
CBL_CORE_API C4SliceResult c4doc_getRemoteAncestor(C4Document* doc, C4RemoteID remoteDatabase) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_setRemoteAncestor(C4Document* doc, C4RemoteID remoteDatabase, C4String revID,
                                                    C4Error* C4NULLABLE error) C4API;
 
CBL_CORE_API unsigned c4rev_getGeneration(C4String revID) C4API;
 
CBL_CORE_API uint64_t c4rev_getTimestamp(C4String revID) C4API;
 
 
CBL_CORE_API bool c4rev_equal(C4Slice rev1, C4Slice rev2) C4API;
 
 
NODISCARD CBL_CORE_API int32_t c4doc_purgeRevision(C4Document* doc, C4String revID, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_resolveConflict(C4Document* doc, C4String winningRevID, C4String losingRevID,
                                                  C4Slice mergedBody, C4RevisionFlags mergedFlags,
                                                  C4Error* C4NULLABLE error) C4API;
 
 
 
#ifndef C4_STRICT_COLLECTION_API
 
CBL_CORE_API bool c4db_purgeDoc(C4Database* database, C4String docID, C4Error* C4NULLABLE outError) C4API;
 
 
CBL_CORE_API bool c4doc_setExpiration(C4Database* db, C4String docID, C4Timestamp timestamp,
                                      C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4Timestamp c4doc_getExpiration(C4Database* db, C4String docID, C4Error* C4NULLABLE outError) C4API;
 
#endif  // C4_STRICT_COLLECTION_API
 
 
 
#ifndef C4_STRICT_COLLECTION_API
 
CBL_CORE_API C4Document* c4doc_put(C4Database* database, const C4DocPutRequest* request,
                                   size_t* C4NULLABLE outCommonAncestorIndex, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4Document* c4doc_create(C4Database* db, C4String docID, C4Slice body, C4RevisionFlags revisionFlags,
                                      C4Error* C4NULLABLE error) C4API;
 
#endif  // C4_STRICT_COLLECTION_API
 
CBL_CORE_API C4Document* c4doc_update(C4Document* doc, C4Slice revisionBody, C4RevisionFlags revisionFlags,
                                      C4Error* C4NULLABLE error) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END