CBLQueryExpression

@interface CBLQueryExpression : NSObject

A CBLQueryExpression represents an expression used for constructing a query statement.

Property:

  • Create a property expression representing the value of the given property name. - parameter: property property name in the key path format. - returns: a property expression.

    Declaration

    Objective-C

    + (nonnull CBLQueryExpression *)property:(nonnull NSString *)property;

    Swift

    class func property(_ property: String) -> CBLQueryExpression

    Parameters

    property

    property name in the key path format.

    Return Value

    a property expression.

Unary operators:

  • Create a negated expression representing the negated result of the given expression. - parameter: expression the expression to be negated. - returns: a negated expression.

    Declaration

    Objective-C

    + (nonnull CBLQueryExpression *)negated:(nonnull id)expression;

    Swift

    class func negated(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be negated.

    Return Value

    a negated expression.

  • Create a negated expression representing the negated result of the given expression. - parameter: expression the expression to be negated. - returns: a negated expression

    Declaration

    Objective-C

    + (nonnull CBLQueryExpression *) not:(nonnull id)expression;

    Swift

    class func not(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be negated.

    Return Value

    a negated expression

Arithmetic Operators:

  • Create a concat expression to concatenate the current expression with the given expression. - parameter: expression the expression to be concatenated with. - returns: a concat expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)concat:(nonnull id)expression;

    Swift

    func concat(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be concatenated with.

    Return Value

    a concat expression.

  • Create a multiply expression to multiply the current expression by the given expression. - parameter: expression the expression to be multipled by. - returns: a multiply expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)multiply:(nonnull id)expression;

    Swift

    func multiply(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be multipled by.

    Return Value

    a multiply expression.

  • Create a divide expression to divide the current expression by the given expression. - parameter: expression the expression to be devided by. - returns: a divide expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)divide:(nonnull id)expression;

    Swift

    func divide(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be devided by.

    Return Value

    a divide expression.

  • Create a modulo expression to modulo the current expression by the given expression. - parameter: expression the expression to be moduloed by. - returns: a modulo expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)modulo:(nonnull id)expression;

    Swift

    func modulo(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be moduloed by.

    Return Value

    a modulo expression.

  • Create an add expression to add the given expression to the current expression. - parameter: expression the expression to add to the current expression. - returns: an add expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)add:(nonnull id)expression;

    Swift

    func add(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to add to the current expression.

    Return Value

    an add expression.

  • Create a subtract expression to subtract the given expression from the current expression. - parameter: expression the expression to substract from the current expression. - returns: a subtract expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)subtract:(nonnull id)expression;

    Swift

    func subtract(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to substract from the current expression.

    Return Value

    a subtract expression.

Comparison operators:

  • Create a less than expression that evaluates whether or not the current expression is less than the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a less than expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)lessThan:(nonnull id)expression;

    Swift

    func lessThan(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a less than expression.

  • Create a NOT less than expression that evaluates whether or not the current expression is not less than the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT less than expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notLessThan:(nonnull id)expression;

    Swift

    func notLessThan(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT less than expression.

  • Create a less than or equal to expression that evaluates whether or not the current expression is less than or equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a less than or equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)lessThanOrEqualTo:(nonnull id)expression;

    Swift

    func lessThanOrEqual(to expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a less than or equal to expression.

  • Create a NOT less than or equal to expression that evaluates whether or not the current expression is not less than or equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT less than or equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notLessThanOrEqualTo:(nonnull id)expression;

    Swift

    func notLessThanOrEqual(to expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT less than or equal to expression.

  • Create a greater than expression that evaluates whether or not the current expression is greater than the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a greater than expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)greaterThan:(nonnull id)expression;

    Swift

    func greaterThan(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a greater than expression.

  • Create a NOT greater than expression that evaluates whether or not the current expression is not greater than the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT greater than expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notGreaterThan:(nonnull id)expression;

    Swift

    func notGreaterThan(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT greater than expression.

  • Create a greater than or equal to expression that evaluates whether or not the current expression is greater than or equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a greater than or equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)greaterThanOrEqualTo:(nonnull id)expression;

    Swift

    func greaterThanOrEqual(to expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a greater than or equal to expression.

  • Create a NOT greater than or equal to expression that evaluates whether or not the current expression is not greater than or equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT greater than or equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notGreaterThanOrEqualTo:(nonnull id)expression;

    Swift

    func notGreaterThanOrEqual(to expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT greater than or equal to expression.

  • Create an equal to expression that evaluates whether or not the current expression is equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: an equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)equalTo:(nullable id)expression;

    Swift

    func equal(to expression: Any?) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    an equal to expression.

  • Create a NOT equal to expression that evaluates whether or not the current expression is not equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT equal to expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notEqualTo:(nullable id)expression;

    Swift

    func notEqual(to expression: Any?) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT equal to expression.

Bitwise operators:

  • Create a logical AND expression that performs logical AND operation with the current expression. - parameter: expression the expression to AND with the current expression. - returns: a logical AND expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *) and:(nonnull id)expression;

    Swift

    func and(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to AND with the current expression.

    Return Value

    a logical AND expression.

  • Create a logical OR expression that performs logical OR operation with the current expression. - parameter: expression the expression to OR with the current expression. - returns: a logical OR Expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *) or:(nonnull id)expression;

    Swift

    func or(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to OR with the current expression.

    Return Value

    a logical OR Expression.

Like operators:

  • Create a Like expression that evaluates whether or not the current expression is LIKE the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a Like expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)like:(nonnull id)expression;

    Swift

    func like(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a Like expression.

  • Create a NOT Like expression that evaluates whether or not the current expression is NOT LIKE the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a NOT Like expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notLike:(nonnull id)expression;

    Swift

    func notLike(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a NOT Like expression.

Regex like operators:

  • Create a regex match expression that evaluates whether or not the current expression regex matches the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a regex match expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)regex:(nonnull id)expression;

    Swift

    func regex(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a regex match expression.

  • Create a regex NOT match expression that evaluates whether or not the current expression regex NOT matches the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a regex NOT match expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notRegex:(nonnull id)expression;

    Swift

    func notRegex(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a regex NOT match expression.

Fulltext search operators:

  • Create a full text match expression that evaluates whether or not the current expression full text matches the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a full text match expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)match:(nonnull id)expression;

    Swift

    func match(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a full text match expression.

  • Create a full text NOT match expression that evaluates whether or not the current expression full text NOT matches the given expression. - parameter: expression the expression to be compared with the current expression. - returns: a full text NOT match expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notMatch:(nonnull id)expression;

    Swift

    func notMatch(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    a full text NOT match expression.

Null check operators:

  • Create an IS NULL expression that evaluates whether or not the current expression is null. - returns: an IS NULL expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)isNull;

    Swift

    func isNull() -> CBLQueryExpression

    Return Value

    an IS NULL expression.

  • Create an IS NOT NULL expression that evaluates whether or not the current expression is NOT null. - returns: an IS NOT NULL expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notNull;

    Swift

    func notNull() -> CBLQueryExpression

    Return Value

    an IS NOT NULL expression.

is operations:

  • Create an IS expression that evaluates whether or not the current expression is equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: an IS expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)is:(nonnull id)expression;

    Swift

    func `is`(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    an IS expression.

  • Create an IS NOT expression that evaluates whether or not the current expression is not equal to the given expression. - parameter: expression the expression to be compared with the current expression. - returns: an IS NOT expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)isNot:(nonnull id)expression;

    Swift

    func isNot(_ expression: Any) -> CBLQueryExpression

    Parameters

    expression

    the expression to be compared with the current expression.

    Return Value

    an IS NOT expression.

aggregate operators:

  • Create a between expression that evaluates whether or not the current expression is between the given expressions inclusively. - parameter: expression1 the inclusive lower bound expression. - parameter: expression2 the inclusive upper bound expression. - returns: a between expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)between:(nonnull id)expression1
                                    and:(nonnull id)expression2;

    Swift

    func between(_ expression1: Any, and expression2: Any) -> CBLQueryExpression

    Parameters

    expression1

    the inclusive lower bound expression.
    expression2

    the inclusive upper bound expression.

    Return Value

    a between expression.

  • Create a NOT between expression that evaluates whether or not the current expression is not between the given expressions inclusively. - parameter: expression1 the inclusive lower bound expression. - parameter: expression2 the inclusive upper bound expression. - returns: a NOT between expression.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notBetween:(nonnull id)expression1
                                       and:(nonnull id)expression2;

    Swift

    func notBetween(_ expression1: Any, and expression2: Any) -> CBLQueryExpression

    Parameters

    expression1

    the inclusive lower bound expression.
    expression2

    the inclusive upper bound expression.

    Return Value

    a NOT between expression.

  • Create an IN expression that evaluates whether or not the current expression is in the given expressions. - parameter: expressions the expression array to be evaluated with. - returns: an IN exprssion.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)in:(nonnull NSArray *)expressions;

    Swift

    func `in`(_ expressions: [Any]) -> CBLQueryExpression

    Parameters

    expressions

    the expression array to be evaluated with.

    Return Value

    an IN exprssion.

  • Create a NOT IN expression that evaluates whether or not the current expression is not in the given expressions. - parameter: expressions the expression array to be evaluated with. - returns: an IN exprssion.

    Declaration

    Objective-C

    - (nonnull CBLQueryExpression *)notIn:(nonnull NSArray *)expressions;

    Swift

    func not(in expressions: [Any]) -> CBLQueryExpression

    Parameters

    expressions

    the expression array to be evaluated with.

    Return Value

    an IN exprssion.

  • Not available.

    Declaration

    Objective-C

    - (nonnull instancetype)init;