CBLDatabase.h

Go to the documentation of this file.

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

#import "CBLBase.h"
#import "CBLView.h"
@class CBLManager, CBLDocument, CBLRevision, CBLSavedRevision, CBLView, CBLQuery, CBLReplication;
@protocol CBLValidationContext;

NS_ASSUME_NONNULL_BEGIN

typedef void (^CBLValidationBlock) (CBLRevision* newRevision,
                                    id<CBLValidationContext> context);

#define VALIDATIONBLOCK(BLOCK) ^void(CBLRevision* newRevision, id<CBLValidationContext> context)\
                                    {BLOCK}

typedef BOOL (^CBLFilterBlock) (CBLSavedRevision* revision, NSDictionary* __nullable  params);

#define FILTERBLOCK(BLOCK) ^BOOL(CBLSavedRevision* revision, NSDictionary* params) {BLOCK}


@protocol CBLFilterCompiler <NSObject>
- (CBLFilterBlock) compileFilterFunction: (NSString*)filterSource language: (NSString*)language;
@end


@interface CBLDatabase : NSObject

@property (readonly) NSString* name;

@property (readonly) CBLManager* manager;

@property (readonly) NSUInteger documentCount;

@property (readonly) SInt64 lastSequenceNumber;

@property (readonly) NSURL* internalURL;


#pragma mark - HOUSEKEEPING:

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

- (BOOL) compact: (NSError**)outError;

@property NSUInteger maxRevTreeDepth;

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

- (BOOL) replaceUUIDs: (NSError**)outError;

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

#pragma mark - DOCUMENT ACCESS:

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

- (nullable CBLDocument*) existingDocumentWithID: (NSString*)docID;

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

- (CBLDocument*) createDocument;


#pragma mark - LOCAL DOCUMENTS:


- (nullable CBLJSONDict*) existingLocalDocumentWithID: (NSString*)localDocID;

- (BOOL) putLocalDocument: (nullable CBLJSONDict*)properties
                   withID: (NSString*)localDocID
                    error: (NSError**)outError;

- (BOOL) deleteLocalDocumentWithID: (NSString*)localDocID
                             error: (NSError**)outError ;


#pragma mark - VIEWS AND OTHER CALLBACKS:

- (CBLQuery*) createAllDocumentsQuery;

- (CBLQuery*) slowQueryWithMap: (CBLMapBlock)mapBlock;

- (CBLView*) viewNamed: (NSString*)name;

- (nullable CBLView*) existingViewNamed: (NSString*)name;

- (void) setValidationNamed: (NSString*)validationName
                    asBlock: (nullable CBLValidationBlock)validationBlock;

- (nullable CBLValidationBlock) validationNamed: (NSString*)validationName;

- (void) setFilterNamed: (NSString*)filterName asBlock: (nullable CBLFilterBlock)filterBlock;

- (nullable CBLFilterBlock) filterNamed: (NSString*)filterName;

+ (void) setFilterCompiler: (nullable id<CBLFilterCompiler>)compiler;

+ (nullable id<CBLFilterCompiler>) filterCompiler;


#pragma mark - TRANSACTIONS / THREADING:

- (BOOL) inTransaction: (BOOL(^)(void))block;

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

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


#pragma mark - REPLICATION:

- (CBLArrayOf(CBLReplication*)*) allReplications;

- (CBLReplication*) createPushReplication: (NSURL*)url;

- (CBLReplication*) createPullReplication: (NSURL*)url;


- (instancetype) init NS_UNAVAILABLE;

@end




extern NSString* const kCBLDatabaseChangeNotification;




typedef BOOL (^CBLChangeEnumeratorBlock) (NSString* key,
                                          __nullable id oldValue,
                                          __nullable id newValue);



@protocol CBLValidationContext <NSObject>

@property (readonly, nullable) CBLSavedRevision* currentRevision;

@property (readonly, nonatomic) NSURL* source;

- (void) reject;

- (void) rejectWithMessage: (NSString*)message;


#pragma mark - CONVENIENCE METHODS:

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

- (BOOL) validateChanges: (CBLChangeEnumeratorBlock)enumerator;

@end


NS_ASSUME_NONNULL_END