Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 54 lines (44 sloc) 2.964 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
// CouchDesignDocument_Embedded.h
// CouchCocoa
// Created by Jens Alfke on 10/3/11.
// Copyright (c) 2011 Couchbase, Inc. All rights reserved.

#import "CouchDesignDocument.h"
typedef id TDMapBlock;
typedef id TDReduceBlock;
typedef id TDFilterBlock;
typedef id TDValidationBlock;
#import <TouchDB/TDDatabase+Insertion.h>
#import <TouchDB/TDView.h>

#define MAPBLOCK(BLOCK) ^(NSDictionary* doc, void (^emit)(id key, id value)){BLOCK}
#define REDUCEBLOCK(BLOCK) ^id(NSArray* keys, NSArray* values, BOOL rereduce){BLOCK}
#define VALIDATIONBLOCK(BLOCK) ^BOOL(TDRevision* newRevision, id<TDValidationContext> context)\
#define FILTERBLOCK(BLOCK) ^BOOL(TDRevision* revision, NSDictionary* params) {BLOCK}

/** Optional support for native Objective-C map/reduce functions.
This is only available when talking to an embedded Couchbase database running in the same process as the app, e.g. Couchbase Mobile. */
@interface CouchDesignDocument (Embedded)

/** Defines or deletes a native view.
The view's definition is given as an Objective-C block (or NULL to delete the view). The body of the block should call the 'emit' block (passed in as a paramter) for every key/value pair it wants to write to the view.
Since the function itself is obviously not stored in the database (only a unique string idenfitying it), you must re-define the view on every launch of the app! If the database needs to rebuild the view but the function hasn't been defined yet, it will fail and the view will be empty, causing weird problems later on.
It is very important that this block be a law-abiding map function! As in other languages, it must be a "pure" function, with no side effects, that always emits the same values given the same input document. That means that it should not access or change any external state; be careful, since blocks make that so easy that you might do it inadvertently!
The block may be called on any thread, or on multiple threads simultaneously. This won't be a problem if the code is "pure" as described above, since it will as a consequence also be thread-safe. */
- (void) defineViewNamed: (NSString*)viewName
                mapBlock: (TDMapBlock)mapBlock
                 version: (NSString*)version;

/** Defines or deletes a native view with both a map and a reduce function.
For details, read the documentation of the -defineViewNamed:mapBlock: method.*/
- (void) defineViewNamed: (NSString*)viewName
                mapBlock: (TDMapBlock)mapBlock
             reduceBlock: (TDReduceBlock)reduceBlock
                 version: (NSString*)version;

- (void) defineFilterNamed: (NSString*)filterName
                     block: (TDFilterBlock)filterBlock;

/** An Objective-C block that can validate any document being added/updated/deleted in this database. */
- (void) setValidationBlock: (TDValidationBlock)validationBlock;

Something went wrong with that request. Please try again.