CBLDatabase.h

Go to the documentation of this file.

//
//  CBLDatabase.h
//  CouchbaseLite
//
//  Created by Pasin Suriyentrakorn on 12/15/16.
//  Copyright © 2016 Couchbase. All rights reserved.
//

#import <Foundation/Foundation.h>
@class CBLDocument, CBLQuery;
@protocol CBLConflictResolver;

NS_ASSUME_NONNULL_BEGIN

extern NSString* const kCBLDatabaseChangeNotification;
extern NSString* const kCBLDatabaseChangesUserInfoKey;
extern NSString* const kCBLDatabaseLastSequenceUserInfoKey;
extern NSString* const kCBLDatabaseIsExternalUserInfoKey;


typedef NS_ENUM(uint32_t, CBLIndexType) {
    kCBLValueIndex,         
    kCBLFullTextIndex,      
    kCBLGeoIndex,           
};


typedef struct {
    const char * _Nullable language;    
    BOOL ignoreDiacritics;              
} CBLIndexOptions;


@interface CBLDatabaseOptions : NSObject <NSCopying>

@property (nonatomic, copy, nullable) NSString* directory;

@property (nonatomic) NSDataWritingOptions fileProtection;

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

@property (nonatomic) BOOL readOnly;

+ (instancetype) defaultOptions;

@end


@interface CBLDatabase : NSObject

@property (readonly, nonatomic) NSString* name;

@property (readonly, nonatomic, nullable) NSString* path;

- (instancetype) initWithName: (NSString*)name
                        error: (NSError**)error;

- (instancetype) initWithName: (NSString*)name
                      options: (nullable CBLDatabaseOptions*)options
                        error: (NSError**)error
    NS_DESIGNATED_INITIALIZER;

- (instancetype) init NS_UNAVAILABLE;

- (BOOL) close: (NSError**)error;

- (BOOL) changeEncryptionKey: (nullable id)key error: (NSError**)error;

- (BOOL) deleteDatabase: (NSError**)error;

+ (BOOL) deleteDatabase: (NSString*)name
            inDirectory: (nullable NSString*)directory
                  error: (NSError**)error;

+ (BOOL) databaseExists: (NSString*)name
            inDirectory: (nullable NSString*)directory;

- (BOOL) inBatch: (NSError**)error do: (void (^)())block;

- (CBLDocument*) document;

- (CBLDocument*) documentWithID: (NSString*)docID;

- (CBLDocument*) objectForKeyedSubscript: (NSString*)docID;

- (BOOL) documentExists: (NSString*)docID;

@property (nonatomic, nullable) id<CBLConflictResolver> conflictResolver;


#pragma mark - QUERYING:


- (NSEnumerator<CBLDocument*>*) allDocuments;

- (CBLQuery*) createQueryWhere: (nullable id)where;

- (BOOL) createIndexOn: (NSArray*)expressions
                 error: (NSError**)error;

- (BOOL) createIndexOn: (NSArray*)expressions
                  type: (CBLIndexType)type
               options: (nullable const CBLIndexOptions*)options
                 error: (NSError**)error;

- (BOOL) deleteIndexOn: (NSArray*)expressions
                  type: (CBLIndexType)type
                 error: (NSError**)error;

@end

NS_ASSUME_NONNULL_END

// TODO:
// * Logging
// * Threading Support