Classes
The following classes are available globally.
-
Authenticator objects provide server authentication credentials to the replicator. CBLAuthenticator is an abstract superclass; you must instantiate one of its subclasses. CBLAuthenticator is not meant to be subclassed by applications.
See moreDeclaration
Objective-C
@interface CBLAuthenticator : NSObject
Swift
class CBLAuthenticator : NSObject
-
The CBLBasicAuthenticator class is an authenticator that will authenticate using HTTP Basic auth with the given username and password. This should only be used over an SSL/TLS connection, as otherwise it’s very easy for anyone sniffing network traffic to read the password.
See moreDeclaration
Objective-C
@interface CBLBasicAuthenticator : CBLAuthenticator
Swift
class CBLBasicAuthenticator : CBLAuthenticator
-
A CBLBlob contains arbitrary binary data, tagged with a MIME type. Blobs can be arbitrarily large, and their data is loaded only on demand (when the
See morecontent
orcontentStream
properties are accessed), not when the document is loaded. The document’s raw JSON form only contains the CBLBlob’s metadata (type, length and a digest of the data) in a small object. The data itself is stored externally to the document, keyed by the digest.Declaration
Objective-C
@interface CBLBlob : NSObject
Swift
class CBLBlob : NSObject
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
CBLCoreMLPredictiveModel is a Core ML based implementation of the CBLPredictiveModel protocol. Basically the CBLCoreMLPredictiveModel used a Core ML model to return prediction results.
CBLCoreMLPredictiveModel automatically converts between Couchbase Lite data and Core ML data when calling into the MLModel object to return prediction results. All Core ML data types including Int64, Double, String, Dictionary, MultiArray, Image, and Sequence are supported.
When the MLObject has a single input and the input type is Image, CBLCoreMLPredictiveModel will use Vision framework via the VNCoreMLModel to process the input image and call into the MLModel object. The CBLCoreMLPredictiveModel supports all VNObservation types including VNClassificationObservation, VNCoreMLFeatureValueObservation, and VNPixelBufferObservation as mentioned in https://developer.apple.com/documentation/vision/vncoremlrequest.
However there is a compatibility limitation when the VNCoreMLModel returns VNCoreMLFeatureValueObservation or VNPixelBufferObservation results that the MLModel must return a single output, otherwise the observation outputs cannot be mapped to the MLModel outputs. When the VNCoreMLModel cannot be used to result the prediction result, CoreMLPredictiveModel will fall back to use the MLModel instead.
When converting from blob data to VNPixelBuffer for an input image, only ARGB pixel format is currently supported. However this limitation is applied only when the VNCoreMLModel cannot be used.
See moreDeclaration
Objective-C
@interface CBLCoreMLPredictiveModel : NSObject <CBLPredictiveModel>
Swift
class CBLCoreMLPredictiveModel : NSObject, CBLPredictiveModel
-
A Couchbase Lite database.
See moreDeclaration
Objective-C
@interface CBLDatabase : NSObject
Swift
class CBLDatabase : NSObject
-
Database Change information
See moreDeclaration
Objective-C
@interface CBLDatabaseChange : NSObject
Swift
class CBLDatabaseChange : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface CBLDatabaseConfiguration : NSObject /** Path to the directory to store the database in. If the directory doesn't already exist it will be created when the database is opened. The default directory will be in Application Support. You won't usually need to change this. */ @property (nonatomic, copy) NSString* directory; /** Initializes the CBLDatabaseConfiguration object. */ - (instancetype) init; /** Initializes the CBLDatabaseConfiguration object with the configuration object. @param config The configuration object. @return The CBLDatabaseConfiguration object. */ - (instancetype) initWithConfig: (nullable CBLDatabaseConfiguration*)config; @end
Swift
class CBLDatabaseConfiguration : NSObject
-
ENTERPRISE EDITION ONLY.
Database based replication target endpoint. Available in the Enterprise Edition only.
See moreDeclaration
Objective-C
@interface CBLDatabaseEndpoint : NSObject <CBLEndpoint>
Swift
class CBLDatabaseEndpoint : NSObject, CBLEndpoint
-
CBLDictionary provides read access to dictionary data.
See moreDeclaration
Objective-C
@interface CBLDictionary : NSObject <CBLDictionary, NSCopying, NSMutableCopying>
Swift
class CBLDictionary : NSObject, CBLDictionaryProtocol, NSCopying, NSMutableCopying
-
A Couchbase Lite document. The CBLDocument is immutable.
See moreDeclaration
Objective-C
@interface CBLDocument : NSObject <CBLDictionary, NSMutableCopying>
Swift
class CBLDocument : NSObject, CBLDictionaryProtocol, NSMutableCopying
-
Document change information
See moreDeclaration
Objective-C
@interface CBLDocumentChange : NSObject
Swift
class CBLDocumentChange : NSObject
-
CBLDocumentFragment provides access to a document object. CBLDocumentFragment also provides subscript access by either key or index to the data values of the document which are wrapped by CBLFragment objects.
See moreDeclaration
Objective-C
@interface CBLDocumentFragment : NSObject <CBLDictionaryFragment>
Swift
class CBLDocumentFragment : NSObject, CBLDictionaryFragment
-
Document replication event
See moreDeclaration
Objective-C
@interface CBLDocumentReplication : NSObject
Swift
class CBLDocumentReplication : NSObject
-
CBLReplicatedDocument contains the information of a document that has been replicated.
See moreDeclaration
Objective-C
@interface CBLReplicatedDocument : NSObject
Swift
class CBLReplicatedDocument : NSObject
-
ENTERPRISE EDITION ONLY.
An encryption key for a database. This is a symmetric key that be kept secret. It should be stored either in the Keychain, or in the user’s memory (hopefully not a sticky note.)
See moreDeclaration
Objective-C
@interface CBLEncryptionKey : NSObject
Swift
class CBLEncryptionKey : NSObject
-
File logger used for writing log messages to files. To enable the file logger, setup the log file configuration and specifiy the log level as desired.
It is important to configure your CBLLogFileConfiguration object appropriately before setting to a logger. Logger make a copy of the configuration settings you provide and use those settings to configure the logger. Once configured, the logger object ignores any changes you make to the CBLLogFileConfiguration object.
See more
-
CBLFragment provides read access to data value. CBLFragment also provides subscript access by either key or index to the nested values which are wrapped by the CBLFragment objects.
Declaration
Objective-C
@interface CBLFragment : NSObject <CBLFragment, CBLDictionaryFragment, CBLArrayFragment>
Swift
class CBLFragment : NSObject, CBLFragmentProtocol, CBLDictionaryFragment, CBLArrayFragment
-
Full-text Index Item.
See moreDeclaration
Objective-C
@interface CBLFullTextIndexItem : NSObject
Swift
class CBLFullTextIndexItem : NSObject
-
CBLIndex represents an index which could be a value index for regular queries or full-text index for full-text queries (using the match operator).
See moreDeclaration
Objective-C
@interface CBLIndex : NSObject
Swift
class CBLIndex : NSObject
-
IndexBuilder used for building database index objects.
See moreDeclaration
Objective-C
@interface CBLIndexBuilder : NSObject
Swift
class CBLIndexBuilder : NSObject
-
Log allows to configure console and file logger or to set a custom logger.
See moreDeclaration
Objective-C
@interface CBLLog : NSObject
Swift
class CBLLog : NSObject
-
Log file configuration.
See moreDeclaration
Objective-C
@interface CBLLogFileConfiguration : NSObject
Swift
class CBLLogFileConfiguration : NSObject
-
Declaration
Objective-C
@interface CBLMessage : NSObject
Swift
class CBLMessage : NSObject
-
Declaration
Objective-C
@interface CBLMessageEndpoint : NSObject <CBLEndpoint>
Swift
class CBLMessageEndpoint : NSObject, CBLEndpoint
-
Declaration
Objective-C
@interface CBLMessageEndpointListener : NSObject
Swift
class CBLMessageEndpointListener : NSObject
-
Declaration
Objective-C
@interface CBLMessageEndpointListenerConfiguration : NSObject
Swift
class CBLMessageEndpointListenerConfiguration : NSObject
-
Declaration
Objective-C
@interface CBLMessageEndpointListenerChange : NSObject
Swift
class CBLMessageEndpointListenerChange : NSObject
-
Declaration
Objective-C
@interface CBLMessagingError : NSObject
Swift
class CBLMessagingError : NSObject
-
CBLMutableArray provides access to array data.
See moreDeclaration
Objective-C
@interface CBLMutableArray : CBLArray <CBLMutableArray>
Swift
class CBLMutableArray : CBLArray, CBLMutableArrayProtocol
-
CBLMutableDictionary is a mutable version of the CBLDictionary.
See moreDeclaration
Objective-C
@interface CBLMutableDictionary : CBLDictionary <CBLMutableDictionary>
Swift
class CBLMutableDictionary : CBLDictionary, CBLMutableDictionaryProtocol
-
The mutable version of the CBLDocument.
See moreDeclaration
Objective-C
@interface CBLMutableDocument : CBLDocument <CBLMutableDictionary>
Swift
class CBLMutableDocument : CBLDocument, CBLMutableDictionaryProtocol
-
CBLMutableFragment provides read and write access to data value. CBLMutableFragment also provides subscript access by either key or index to the nested values which are wrapped by CBLMutableFragment objects.
Declaration
Objective-C
@interface CBLMutableFragment : CBLFragment <CBLMutableFragment, CBLMutableDictionaryFragment, CBLMutableArrayFragment>
Swift
class CBLMutableFragment : CBLFragment, CBLMutableFragmentProtocol, CBLMutableDictionaryFragment, CBLMutableArrayFragment
-
The prediction model manager for registering and unregistering predictive models.
See moreDeclaration
Objective-C
@interface CBLPrediction : NSObject
Swift
class CBLPrediction : NSObject
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
The predictive index used for querying with prediction function. The predictive index is different from the normal index in that the predictive index will cache the prediction result along with creating the value index of the prediction output properties.
The PredictiveIndex can be created by using IndexBuilder’s predictiveIndex() function. If the prediction output properties are not specified, the predictive index will only cache the predictive result so that the predictive model will not be called again after indexing.
See more
-
A database query. A CBLQuery instance can be constructed by calling one of the select methods.
See moreDeclaration
Objective-C
@interface CBLQuery : NSObject
Swift
class CBLQuery : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface CBLQueryArrayExpression : NSObject /** Creates a variable expression that represents an item in the array expression (ANY/ANY AND EVERY/EVERY <variable> IN <expr> SATISFIES <expr>). @param name The variable name. @return The variable expression. */ + (CBLQueryVariableExpression*) variableWithName: (NSString*)name; /** Creates an ANY quantified operator (ANY <variable> IN <expr> SATISFIES <expr>) to evaluate expressions over an array. The ANY operator returns TRUE if at least one of the items in the array satisfies the given satisfies expression. @param variable The variable expression. @param inExpression The IN expression that can be evaluated as an array value. @param satisfies The expression to be evaluated with. @return The ANY quantifies operator. */ + (CBLQueryExpression*) any: (CBLQueryVariableExpression*)variable in: (CBLQueryExpression*)inExpression satisfies: (CBLQueryExpression*)satisfies; /** Creates an ANY AND EVERY quantified operator (ANY AND EVERY <variable name> IN <expr> SATISFIES <expr>) to evaluate expressions over an array. The ANY AND EVERY operator returns TRUE if the array is NOT empty, and at least one of the items in the array satisfies the given satisfies expression. @param variable The variable expression. @param inExpression The IN expression that can be evaluated as an array value. @param satisfies The expression to be evaluated with. @return The ANY AND EVERY quantifies operator. */ + (CBLQueryExpression*) anyAndEvery: (CBLQueryVariableExpression*)variable in: (CBLQueryExpression*)inExpression satisfies: (CBLQueryExpression*)satisfies; /** Creates an EVERY quantified operator (ANY <variable name> IN <expr> SATISFIES <expr>) to evaluate expressions over an array. The EVERY operator returns TRUE if the array is empty OR every item in the array satisfies the given satisfies expression. @param variable The variable expression. @param inExpression The IN expression that can be evaluated as an array value. @param satisfies The expression to be evaluated with. @return The EVERY quantifies operator. */ + (CBLQueryExpression*) every: (CBLQueryVariableExpression*)variable in: (CBLQueryExpression*)inExpression satisfies: (CBLQueryExpression*)satisfies; /** Not available */ - (instancetype) init NS_UNAVAILABLE; @end
Swift
class CBLQueryArrayExpression : NSObject
-
CBLQueryArrayFunction provides array based functions.
See moreDeclaration
Objective-C
@interface CBLQueryArrayFunction : NSObject
Swift
class CBLQueryArrayFunction : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface CBLQueryBuilder : NSObject // SELECT > FROM /** Create a query from the select and from component. @param select The select component reresenting the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from; /** Create a distinct query from the select and from component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from; // SELECT > FROM > WHERE /** Create a query from the select, from, and where component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where; /** Create a distinct query from the select, from, and where component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where; // SELECT > FROM > WHERE > ORDER BY /** Create a query from the select, from, where, and order by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings; /** Create a distinct query from the select, from, where, and order by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings; // SELECT > FROM > WHERE > GROUP BY /** Create a query from the select, from, where, and group by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy; /** Create a distinct query from the select, from, where and group by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy; // SELECT > FROM > WHERE > GROUP BY > HAVING /** Create a query from the select, from, where, groupby and having component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having; /** Create a distinct query from the select, from, where, groupby and having component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having; // SELECT > FROM > WHERE > GROUP BY > HAVING > ORDER BY > LIMIT /** Create a query from the select, from, where, groupby, having, order by, and limit component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @param limit The limit component representing the LIMIT clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings limit: (nullable CBLQueryLimit*)limit; /** Create a distinct query from the select, from, where, groupby, having, order by, and limit component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @param limit The limit component representing the LIMIT clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings limit: (nullable CBLQueryLimit*)limit; // SELECT > FROM > JOIN /** Create a query from the select, from, and join component. @param select The select component reresenting the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join; /** Create a distinct query from the select from, and join component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join; // SELECT > FROM > JOIN > WHERE /** Create a query from the select, from, join and where component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where; /** Create a distinct query from the select, from, join and where component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where; // SELECT > FROM > JOIN > WHERE > GROUP BY /** Create a query from the select, from, join, where, and group by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy; /** Create a distinct query from the select, from, join, where, and groupby component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy; // SELECT > FROM > JOIN > WHERE > GROUP BY > HAVING /** Create a query from the select, from, join, where, grop by, and having component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having; /** Create a distinct query from the select, from, join, where, gropu by and having component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having; // SELECT > FROM > JOIN > WHERE > ORDER BY /** Create a query from the select, from, join, where and order by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings; /** Create a distinct query from the select, from, join, where, and order by component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings; // SELECT > FROM > JOIN > WHERE > GROUP BY > HAVING > ORDER BY > LIMIT /** Create a query from the select, from, join, where, group by, having, order by, and limit component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @param orderings The orderings components representing the ORDER BY clause of the query. @param limit The limit component representing the LIMIT clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) select: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings limit: (nullable CBLQueryLimit*)limit; /** Create a distinct query from the select, from, join, where, group by, having, order by and limit component. @param select The select component representing the SELECT clause of the query. @param from The from component representing the FROM clause of the query. @param join The join components representing the JOIN clause of the query. @param where The where component representing the WHERE clause of the query. @param groupBy The group by expressions representing the GROUP BY clause of the query. @param having The having component representing the HAVING clause of the query. @param orderings The ordering components representing the ORDER BY clause of the query. @param limit The limit component representing the LIMIT clause of the query. @return The CBLQuery instance. */ + (CBLQuery*) selectDistinct: (NSArray<CBLQuerySelectResult*>*)select from: (CBLQueryDataSource*)from join: (nullable NSArray<CBLQueryJoin*>*)join where: (nullable CBLQueryExpression*)where groupBy: (nullable NSArray<CBLQueryExpression*>*)groupBy having: (nullable CBLQueryExpression*)having orderBy: (nullable NSArray<CBLQueryOrdering*>*)orderings limit: (nullable CBLQueryLimit*)limit; /** Not available */ - (instancetype) init NS_UNAVAILABLE; @end
Swift
class CBLQueryBuilder : NSObject
-
CBLQueryChange contains the information about the query result changes reported by a live query object.
See moreDeclaration
Objective-C
@interface CBLQueryChange : NSObject
Swift
class CBLQueryChange : NSObject
-
CBLQueryCollation defines how strings are compared and is used when creating a COLLATE expression. The COLLATE expression can be used in the WHERE clause when comparing two strings or in the ORDER BY clause when specifying how the order of the query results. CouchbaseLite provides two types of the Collation, ASCII and Unicode. Without specifying the COLLATE expression Couchbase Lite will use the ASCII with case sensitive collation by default.
See moreDeclaration
Objective-C
@interface CBLQueryCollation : NSObject
Swift
class CBLQueryCollation : NSObject
-
A query data source. used for specifiying the data source for your query. The current data source supported is the database.
See moreDeclaration
Objective-C
@interface CBLQueryDataSource : NSObject
Swift
class CBLQueryDataSource : NSObject
-
A CBLQueryExpression represents an expression used for constructing a query statement.
See moreDeclaration
Objective-C
@interface CBLQueryExpression : NSObject
Swift
class CBLQueryExpression : NSObject
-
Full-text expression.
See moreDeclaration
Objective-C
@interface CBLQueryFullTextExpression : NSObject
Swift
class CBLQueryFullTextExpression : NSObject
-
Full-text function.
See moreDeclaration
Objective-C
@interface CBLQueryFullTextFunction : NSObject
Swift
class CBLQueryFullTextFunction : NSObject
-
CBLQueryFunction provides query functions.
See moreDeclaration
Objective-C
@interface CBLQueryFunction : NSObject
Swift
class CBLQueryFunction : NSObject
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
CBLQueryPredictionFunction that allows to create an expression that refers to one of the properties of the prediction result dictionary.
See moreDeclaration
Objective-C
@interface CBLQueryPredictionFunction : CBLQueryExpression
Swift
class CBLQueryPredictionFunction : CBLQueryExpression
-
A CBLQueryJoin represents the JOIN clause in the query statement.
See moreDeclaration
Objective-C
@interface CBLQueryJoin : NSObject
Swift
class CBLQueryJoin : NSObject
-
A CBLQueryLimit represents a query LIMIT clause used for constrainting the number of results returned by a query.
See moreDeclaration
Objective-C
@interface CBLQueryLimit : NSObject
Swift
class CBLQueryLimit : NSObject
-
CBLQueryMeta is a factory class for creating the expressions that refers to the metadata properties of the document.
See moreDeclaration
Objective-C
@interface CBLQueryMeta : NSObject
Swift
class CBLQueryMeta : NSObject
-
A CBLQueryOrdering represents a single ordering component in the query ORDER BY clause.
See moreDeclaration
Objective-C
@interface CBLQueryOrdering : NSObject
Swift
class CBLQueryOrdering : NSObject
-
CBLQuerySortOrder allows to specify the ordering direction which is an ascending or a descending order
See moreDeclaration
Objective-C
@interface CBLQuerySortOrder : CBLQueryOrdering
Swift
class CBLQuerySortOrder : CBLQueryOrdering
-
Query parameters used for setting values to the query parameters defined in the query.
See moreDeclaration
Objective-C
@interface CBLQueryParameters : NSObject
Swift
class CBLQueryParameters : NSObject
-
CBLQueryResult represents a single row in the query result. The projecting result value can be accessed either by using a zero based index or by a key corresponding to the CBLQuerySelectResult objects given when constructing the CBLQuery object.
A key used for accessing the projecting result value could be one of the followings:
- The alias name of the CBLQuerySelectResult object.
- The last component of the keypath or property name of the property expression used when creating the CBLQuerySelectResult object.
- The provision key in $1, $2, …$N format for the CBLQuerySelectResult that doesn’t have an alias name specified or is not a property expression such as an aggregate function expression (e.g. count(), avg(), min(), max(), sum() and etc). The number suffix after the ‘$’ character is a running number starting from one.
Declaration
Objective-C
@interface CBLQueryResult : NSObject <CBLArray, CBLDictionary>
Swift
class CBLQueryResult : NSObject, CBLArrayProtocol, CBLDictionaryProtocol
-
CBLQueryResultSet is a result returned from a query. The CBLQueryResultSet is an NSEnumerator of the CBLQueryResult objects, each of which represent a single row in the query result.
See moreDeclaration
Objective-C
@interface CBLQueryResultSet : NSEnumerator <CBLQueryResult *>
Swift
class CBLQueryResultSet : NSEnumerator
-
A CBLQuerySelectResult represents a returning value in each query result row.
See moreDeclaration
Objective-C
@interface CBLQuerySelectResult : NSObject
Swift
class CBLQuerySelectResult : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface CBLQueryVariableExpression : CBLQueryExpression
Swift
class CBLQueryVariableExpression : CBLQueryExpression
-
Combined activity level and progress of a replicator.
See moreDeclaration
Objective-C
@interface CBLReplicatorStatus : NSObject
Swift
class CBLReplicatorStatus : NSObject
-
A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-short or continuous. The replicator runs asynchronously, so observe the status property to be notified of progress.
See moreDeclaration
Objective-C
@interface CBLReplicator : NSObject
Swift
class CBLReplicator : NSObject
-
Replicator status change details.
See moreDeclaration
Objective-C
@interface CBLReplicatorChange : NSObject
Swift
class CBLReplicatorChange : NSObject
-
Replicator Configuration
See moreDeclaration
Objective-C
@interface CBLReplicatorConfiguration : NSObject
Swift
class CBLReplicatorConfiguration : NSObject
-
The CBLSessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway.
See moreDeclaration
Objective-C
@interface CBLSessionAuthenticator : CBLAuthenticator
Swift
class CBLSessionAuthenticator : CBLAuthenticator
-
URL based replication target endpoint.
See moreDeclaration
Objective-C
@interface CBLURLEndpoint : NSObject <CBLEndpoint>
Swift
class CBLURLEndpoint : NSObject, CBLEndpoint
-
Value Index Item.
See moreDeclaration
Objective-C
@interface CBLValueIndexItem : NSObject
Swift
class CBLValueIndexItem : NSObject