CBLManager.h

Go to the documentation of this file.

//
//  CBLManager.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 6/19/12.
//  Copyright (c) 2012-2013 Couchbase, Inc. All rights reserved.
//

#import "CBLBase.h"
@class CBLDatabase;

NS_ASSUME_NONNULL_BEGIN
typedef struct CBLManagerOptions {
    bool                 readOnly;          
    NSDataWritingOptions fileProtection;    
} CBLManagerOptions;




@interface CBLDatabaseOptions : NSObject
@property (nonatomic) BOOL create;                  
@property (nonatomic) BOOL readOnly;                
@property (nonatomic, copy, nullable) NSString* storageType;

@property (nonatomic, strong, nullable) id encryptionKey;
@end




@interface CBLManager : NSObject <NSCopying>

+ (instancetype) sharedInstance;

+ (BOOL) isValidDatabaseName: (NSString*)name;

+ (NSString*) defaultDirectory;

- (instancetype) init;

- (nullable instancetype) initWithDirectory: (NSString*)directory
                                    options: (const CBLManagerOptions* __nullable)options
                                      error: (NSError**)outError;

- (instancetype) copy;

- (void) close;

@property (copy, nonatomic) NSString* storageType;

@property (readonly) NSString* directory;

@property BOOL excludedFromBackup;

#pragma mark - DATABASES:

- (nullable CBLDatabase*) databaseNamed: (NSString*)name
                                  error: (NSError**)outError;

- (nullable CBLDatabase*) existingDatabaseNamed: (NSString*)name
                                          error: (NSError**)outError;

- (nullable CBLDatabase*) openDatabaseNamed: (NSString*)name
                                withOptions: (nullable CBLDatabaseOptions*)options
                                      error: (NSError**)outError;

- (BOOL) databaseExistsNamed: (NSString*)name;

- (nullable CBLDatabase*) objectForKeyedSubscript: (NSString*)key;

@property (readonly) CBLArrayOf(NSString*)* allDatabaseNames;


#ifdef CBL_DEPRECATED

- (BOOL) replaceDatabaseNamed: (NSString*)databaseName
             withDatabaseFile: (NSString*)databasePath
              withAttachments: (nullable NSString*)attachmentsPath
                        error: (NSError**)outError;
#endif

- (BOOL) replaceDatabaseNamed: (NSString*)databaseName
              withDatabaseDir: (NSString*)databaseDir
                        error: (NSError**)outError;

#pragma mark - CONCURRENCY:

@property (strong, nullable) dispatch_queue_t dispatchQueue;

- (void) doAsync: (void (^)())block;

- (void) backgroundTellDatabaseNamed: (NSString*)dbName to: (void (^)(CBLDatabase*))block;

#pragma mark - OTHER API:

@property (readonly) NSURL* internalURL;

+ (void) enableLogging: (nullable NSString*)type;

+ (void) redirectLogging: (nullable void (^)(NSString* type, NSString* message))callback;


@property (readonly, nonatomic, nullable) NSMutableDictionary* customHTTPHeaders;


- (BOOL) registerEncryptionKey: (nullable id)keyOrPassword
              forDatabaseNamed: (NSString*)name;

@end


extern NSString* CBLVersion( void );

extern NSString* const CBLHTTPErrorDomain;

extern NSString* const kCBLSQLiteStorage;

extern NSString* const kCBLForestDBStorage;

NS_ASSUME_NONNULL_END