CBLQuery.h

Go to the documentation of this file.

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

#import "CBLBase.h"

@class CBLView, CBLDatabase, CBLDocument;
@class CBLLiveQuery, CBLQueryEnumerator, CBLQueryRow, CBLSavedRevision;

NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(unsigned, CBLAllDocsMode) {
    kCBLAllDocs,            
    kCBLIncludeDeleted,     
    kCBLShowConflicts,      
    kCBLOnlyConflicts,      
    kCBLBySequence          
};


typedef NS_ENUM(unsigned, CBLIndexUpdateMode) {
    kCBLUpdateIndexBefore,  
    kCBLUpdateIndexNever,   
    kCBLUpdateIndexAfter    
};


@interface CBLQuery : NSObject

@property (readonly, nullable) CBLView* view;

@property (readonly) CBLDatabase* database;

@property NSUInteger limit;

@property NSUInteger skip;

@property BOOL descending;

@property (copy, nullable) id startKey;

@property (copy, nullable) id endKey;

@property (copy, nullable) NSString* startKeyDocID;

@property (copy, nullable) NSString* endKeyDocID;

@property BOOL inclusiveStart;

@property BOOL inclusiveEnd;

@property NSUInteger prefixMatchLevel;

@property (copy, nullable) CBLArrayOf(NSSortDescriptor*)* sortDescriptors;

@property (strong, nullable) NSPredicate* postFilter;

@property CBLIndexUpdateMode indexUpdateMode;

@property (copy, nullable) NSArray* keys;

@property BOOL mapOnly;

@property NSUInteger groupLevel;

@property BOOL prefetch;

@property CBLAllDocsMode allDocsMode;

- (nullable CBLQueryEnumerator*) run: (NSError**)outError;

- (void) runAsync: (void (^)(CBLQueryEnumerator*, NSError*))onComplete   __attribute__((nonnull));

- (CBLLiveQuery*) asLiveQuery;

- (instancetype) init NS_UNAVAILABLE;

@end


@interface CBLLiveQuery : CBLQuery

@property (nonatomic) NSTimeInterval updateInterval;

- (void) start;

- (void) stop;

@property (readonly, strong, nullable) CBLQueryEnumerator* rows;

- (BOOL) waitForRows;

@property (readonly, nullable) NSError* lastError;

- (void) queryOptionsChanged;

@end


@interface CBLQueryEnumerator : NSEnumerator <NSCopying>

@property (readonly) NSUInteger count;

@property (readonly) UInt64 sequenceNumber;

@property (readonly) BOOL stale;

- (nullable CBLQueryRow*) nextObject;

- (nullable CBLQueryRow*) nextRow;

- (CBLQueryRow*) rowAtIndex: (NSUInteger)index;

- (void) sortUsingDescriptors: (NSArray*)sortDescriptors;

- (instancetype) init NS_UNAVAILABLE;
- (void) reset  __attribute__((deprecated("call allObjects and iterate that array multiple times")));

@end


@interface CBLQueryRow : NSObject

@property (readonly) id key;

@property (readonly, nullable) id value;

@property (readonly, nullable) NSString* documentID;

@property (readonly, nullable) NSString* sourceDocumentID;

@property (readonly) NSString* documentRevisionID;

@property (readonly) CBLDatabase* database;

@property (readonly, nullable) CBLDocument* document;

@property (readonly, nullable) CBLJSONDict* documentProperties;

- (nullable id) keyAtIndex: (NSUInteger)index;

//@property (readonly, nullable) id key0, key1, key2, key3;
@property (readonly, nullable) id key0;
@property (readonly, nullable) id key1;
@property (readonly, nullable) id key2;
@property (readonly, nullable) id key3;

@property (readonly) UInt64 sequenceNumber;

@property (readonly, nullable) CBLArrayOf(CBLSavedRevision*)* conflictingRevisions;

- (instancetype) init NS_UNAVAILABLE;

@end


NS_ASSUME_NONNULL_END