CBLDatabase.h

Go to the documentation of this file.

//
// CBLDatabase.h
//
// Copyright (c) 2018 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 "CBLQueryIndexTypes.h"
 
CBL_CAPI_BEGIN
 
#ifdef COUCHBASE_ENTERPRISE
 
#ifdef __APPLE__
#pragma mark - Database Extension
#endif
 
bool CBL_EnableVectorSearch(FLString path, CBLError* _cbl_nullable outError) CBLAPI;
 
#endif
 
#ifdef __APPLE__
#pragma mark - CONFIGURATION
#endif
 
#ifdef COUCHBASE_ENTERPRISE
typedef CBL_ENUM(uint32_t, CBLEncryptionAlgorithm) {
    kCBLEncryptionNone = 0,         
    kCBLEncryptionAES256            
};
 
typedef CBL_ENUM(uint64_t, CBLEncryptionKeySize) {
    kCBLEncryptionKeySizeAES256 = 32,     
};
 
typedef struct {
    CBLEncryptionAlgorithm algorithm;       
    uint8_t bytes[32];                      
} CBLEncryptionKey;
#endif
 
typedef struct {
    FLString directory;                 
#ifdef COUCHBASE_ENTERPRISE
    CBLEncryptionKey encryptionKey;     
#endif
    bool fullSync;
    
    bool mmapDisabled;
} CBLDatabaseConfiguration;
 
CBLDatabaseConfiguration CBLDatabaseConfiguration_Default(void) CBLAPI;
 
#ifdef COUCHBASE_ENTERPRISE
bool CBLEncryptionKey_FromPassword(CBLEncryptionKey *key, FLString password) CBLAPI;
 
bool CBLEncryptionKey_FromPasswordOld(CBLEncryptionKey *key, FLString password) CBLAPI;
#endif
 
#ifdef __APPLE__
#pragma mark - FILE OPERATIONS
#endif
bool CBL_DatabaseExists(FLString name, FLString inDirectory) CBLAPI;
 
bool CBL_CopyDatabase(FLString fromPath,
                      FLString toName,
                      const CBLDatabaseConfiguration* _cbl_nullable config,
                      CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBL_DeleteDatabase(FLString name,
                        FLString inDirectory,
                        CBLError* _cbl_nullable outError) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - LIFECYCLE
#endif
_cbl_warn_unused
CBLDatabase* _cbl_nullable CBLDatabase_Open(FLSlice name,
                                            const CBLDatabaseConfiguration* _cbl_nullable config,
                                            CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_Close(CBLDatabase*,
                       CBLError* _cbl_nullable outError) CBLAPI;
 
CBL_REFCOUNTED(CBLDatabase*, Database);
 
bool CBLDatabase_Delete(CBLDatabase*,
                        CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_BeginTransaction(CBLDatabase*,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_EndTransaction(CBLDatabase*,
                                bool commit,
                                CBLError* _cbl_nullable outError) CBLAPI;
 
#ifdef COUCHBASE_ENTERPRISE
bool CBLDatabase_ChangeEncryptionKey(CBLDatabase*,
                                     const CBLEncryptionKey* _cbl_nullable newKey,
                                     CBLError* outError) CBLAPI;
#endif
 
typedef CBL_ENUM(uint32_t, CBLMaintenanceType) {
    kCBLMaintenanceTypeCompact = 0,
    
    kCBLMaintenanceTypeReindex,
    
    kCBLMaintenanceTypeIntegrityCheck,
    
    kCBLMaintenanceTypeOptimize,
    
    kCBLMaintenanceTypeFullOptimize
};
 
bool CBLDatabase_PerformMaintenance(CBLDatabase* db,
                                    CBLMaintenanceType type,
                                    CBLError* _cbl_nullable outError) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - ACCESSORS
#endif
FLString CBLDatabase_Name(const CBLDatabase*) CBLAPI;
 
_cbl_warn_unused
FLStringResult CBLDatabase_Path(const CBLDatabase*) CBLAPI;
 
uint64_t CBLDatabase_Count(const CBLDatabase*) CBLAPI;
 
const CBLDatabaseConfiguration CBLDatabase_Config(const CBLDatabase*) CBLAPI;
 
bool CBLDatabase_CreateValueIndex(CBLDatabase *db,
                                  FLString name,
                                  CBLValueIndexConfiguration config,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_CreateFullTextIndex(CBLDatabase *db,
                                     FLString name,
                                     CBLFullTextIndexConfiguration config,
                                     CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_DeleteIndex(CBLDatabase *db,
                             FLString name,
                             CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
FLArray CBLDatabase_GetIndexNames(CBLDatabase *db) CBLAPI;
 
 
#ifdef __APPLE__
#pragma mark - LISTENERS
#endif
typedef void (*CBLDatabaseChangeListener)(void* _cbl_nullable context,
                                          const CBLDatabase* db,
                                          unsigned numDocs,
                                          FLString docIDs[_cbl_nonnull]);
 
_cbl_warn_unused
CBLListenerToken* CBLDatabase_AddChangeListener(const CBLDatabase* db,
                                                CBLDatabaseChangeListener listener,
                                                void* _cbl_nullable context) CBLAPI;
    // end of outer \defgroup
 
 
#ifdef __APPLE__
#pragma mark - NOTIFICATION SCHEDULING
#endif
typedef void (*CBLNotificationsReadyCallback)(void* _cbl_nullable context,
                                              CBLDatabase* db);
 
void CBLDatabase_BufferNotifications(CBLDatabase *db,
                                     CBLNotificationsReadyCallback _cbl_nullable callback,
                                     void* _cbl_nullable context) CBLAPI;
 
void CBLDatabase_SendNotifications(CBLDatabase *db) CBLAPI;
                                         // end of outer \defgroup
 
CBL_CAPI_END