CBLView.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
@class CBLDatabase, CBLQuery;

NS_ASSUME_NONNULL_BEGIN


typedef enum {
    kCBLMapReduceIndex = 1, 
    kCBLFullTextIndex,  
    kCBLGeoIndex        
} CBLViewIndexType;


typedef void (^CBLMapEmitBlock)(id key, __nullable id value);


typedef void (^CBLMapBlock)(CBLJSONDict* doc, CBLMapEmitBlock emit);

typedef __nonnull id (^CBLReduceBlock)(NSArray* __nonnull keys,
                                       NSArray* __nonnull values,
                                       BOOL rereduce);


#define MAPBLOCK(BLOCK) ^(CBLJSONDict* doc, void (^emit)(id key, id value)){BLOCK}
#define REDUCEBLOCK(BLOCK) ^id(NSArray* keys, NSArray* values, BOOL rereduce){BLOCK}


FOUNDATION_EXTERN id CBLTextKey(NSString* text);

@protocol CBLViewCompiler <NSObject>
- (nullable CBLMapBlock) compileMapFunction: (NSString*)mapSource language: (NSString*)language;
- (nullable CBLReduceBlock) compileReduceFunction: (NSString*)reduceSource
                                         language: (NSString*)language;
@end


@interface CBLView : NSObject

@property (readonly) CBLDatabase* database;

@property (readonly) NSString* name;

@property (readonly, nullable) CBLMapBlock mapBlock;

@property (readonly, nullable) CBLReduceBlock reduceBlock;

- (BOOL) setMapBlock: (CBLMapBlock)mapBlock
         reduceBlock: (nullable CBLReduceBlock)reduceBlock
             version: (NSString*)version;

- (BOOL) setMapBlock: (CBLMapBlock)mapBlock
             version: (NSString*)version;

@property (copy) NSString* documentType;

@property (readonly) BOOL stale;

@property (readonly) SInt64 lastSequenceIndexed;

@property (readonly) NSUInteger totalRows;

- (void) updateIndex;

- (void) updateIndexAsync: (void (^)())onComplete;

- (void) deleteIndex;

- (void) deleteView;

- (CBLQuery*) createQuery;

+ (NSNumber*) totalValues: (NSArray*)values;

+ (void) setCompiler: (nullable id<CBLViewCompiler>)compiler;

+ (nullable id<CBLViewCompiler>) compiler;

- (instancetype) init NS_UNAVAILABLE;

@end


NS_ASSUME_NONNULL_END