CBLQuery.h

Go to the documentation of this file.

//
//  CBLQuery.h
//  Couchbase Lite
//
//  Created by Jens Alfke on 11/30/16.
//  Copyright © 2016 Couchbase. All rights reserved.
//

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

NS_ASSUME_NONNULL_BEGIN


@interface CBLQuery : NSObject

@property (nonatomic, readonly) CBLDatabase* database;

@property (copy, nullable, nonatomic) id where;

@property (copy, nullable, nonatomic) NSArray* orderBy;

@property (copy, nullable, nonatomic) NSArray* returning;

@property (copy, nullable, nonatomic) NSArray* groupBy;

@property (copy, nullable, nonatomic) id having;

@property (nonatomic) BOOL distinct;

@property (nonatomic) NSUInteger offset;

@property (nonatomic) NSUInteger limit;

@property (copy, nullable, nonatomic) NSDictionary* parameters;

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

- (nullable NSString*) explain: (NSError**)outError;

- (nullable NSEnumerator<CBLQueryRow*>*) run: (NSError**)error;

- (nullable NSEnumerator<CBLDocument*>*) allDocuments: (NSError**)error;

- (instancetype) init NS_UNAVAILABLE;

@end


NS_ASSUME_NONNULL_END