c4Database.h

Go to the documentation of this file.

//
// c4Database.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 "c4DatabaseTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
 
NODISCARD CBL_CORE_API bool c4key_setPassword(C4EncryptionKey* encryptionKey, C4String password,
                                              C4EncryptionAlgorithm alg) C4API;
 
NODISCARD CBL_CORE_API bool c4key_setPasswordSHA1(C4EncryptionKey* encryptionKey, C4String password,
                                                  C4EncryptionAlgorithm alg) C4API;
 
// Deprecated in favor of c4_enableExtension
CBL_CORE_API void c4_setExtensionPath(C4String path) C4API;
 
CBL_CORE_API bool c4_enableExtension(C4String name, C4String extensionPath, C4Error* outError) C4API;
 
 
 
CBL_CORE_API bool c4db_exists(C4String name, C4String inDirectory) C4API;
 
 
NODISCARD CBL_CORE_API C4Database* c4db_openNamed(C4String name, const C4DatabaseConfig2* config,
                                                  C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Database* c4db_openAgain(C4Database* db, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4db_copyNamed(C4String sourcePath, C4String destinationName,
                                           const C4DatabaseConfig2* config, C4Error* C4NULLABLE error) C4API;
 
NODISCARD CBL_CORE_API bool c4db_close(C4Database* C4NULLABLE database, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4db_delete(C4Database* database, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4db_deleteNamed(C4String dbName, C4String inDirectory, C4Error* C4NULLABLE outError) C4API;
 
 
NODISCARD CBL_CORE_API bool c4db_rekey(C4Database* database, const C4EncryptionKey* C4NULLABLE newKey,
                                       C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4_shutdown(C4Error* C4NULLABLE outError) C4API;
 
 
CBL_CORE_API C4String c4db_getName(C4Database*) C4API;
 
CBL_CORE_API C4StringResult c4db_getPath(C4Database*) C4API;
 
CBL_CORE_API const C4DatabaseConfig2* c4db_getConfig2(C4Database* database) C4API C4_RETURNS_NONNULL;
 
#ifndef C4_STRICT_COLLECTION_API
 
CBL_CORE_API uint64_t c4db_getDocumentCount(C4Database* database) C4API;
 
CBL_CORE_API C4SequenceNumber c4db_getLastSequence(C4Database* database) C4API;
 
CBL_CORE_API C4Timestamp c4db_nextDocExpiration(C4Database* database) C4API;
 
NODISCARD CBL_CORE_API int64_t c4db_purgeExpiredDocs(C4Database* db, C4Error* C4NULLABLE) C4API;
 
#endif  // C4_STRICT_COLLECTION_API
 
NODISCARD CBL_CORE_API bool c4db_getUUIDs(C4Database* database, C4UUID* C4NULLABLE publicUUID,
                                          C4UUID* C4NULLABLE privateUUID, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API void c4db_setExtraInfo(C4Database* database, C4ExtraInfo) C4API;
 
CBL_CORE_API C4ExtraInfo c4db_getExtraInfo(C4Database* database) C4API;
 
 
NODISCARD CBL_CORE_API bool c4db_maintenance(C4Database* database, C4MaintenanceType type,
                                             C4Error* C4NULLABLE outError) C4API;
 
 
NODISCARD CBL_CORE_API bool c4db_beginTransaction(C4Database* database, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4db_endTransaction(C4Database* database, bool commit, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4db_isInTransaction(C4Database* database) C4API;
 
 
 
 
NODISCARD CBL_CORE_API C4RawDocument* c4raw_get(C4Database* database, C4String storeName, C4String docID,
                                                C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4raw_put(C4Database* database, C4String storeName, C4String key, C4String meta,
                                      C4String body, C4Error* C4NULLABLE outError) C4API;
 
// Store used for database metadata.
#define kC4InfoStore C4STR("info")
 
// Store used for local (non-replicated) documents.
#define kC4LocalDocStore C4STR("_local")
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END