CBLQueryFunction

@interface CBLQueryFunction : NSObject

CBLQueryFunction provides query functions.

Aggregation


                    
                    
                    +avg:

Creates an AVG(expr) function expression that returns the average of all the number values in the group of the values expressed by the given expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)avg:(nonnull CBLQueryExpression *)expression;

Swift

class func avg(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The expression.

Return Value

The AVG(expr) function.


                    
                    
                    +count:

Creates a COUNT(expr) function expression that returns the count of all values in the group of the values expressed by the given expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)count:(nonnull CBLQueryExpression *)expression;

Swift

class func count(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The expression.

Return Value

The COUNT(expr) function.


                    
                    
                    +min:

Creates a MIN(expr) function expression that returns the minimum value in the group of the values expressed by the given expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)min:(nonnull CBLQueryExpression *)expression;

Swift

class func min(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The expression.

Return Value

The MIN(expr) function.


                    
                    
                    +max:

Creates a MAX(expr) function expression that returns the maximum value in the group of the values expressed by the given expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)max:(nonnull CBLQueryExpression *)expression;

Swift

class func max(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The expression.

Return Value

The MAX(expr) function.


                    
                    
                    +sum:

Creates a SUM(expr) function expression that return the sum of all number values in the group of the values expressed by the given expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)sum:(nonnull CBLQueryExpression *)expression;

Swift

class func sum(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The expression.

Return Value

The SUM(expr) function.

Math


                    
                    
                    +abs:

Creates an ABS(expr) function that returns the absolute value of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)abs:(nonnull CBLQueryExpression *)expression;

Swift

class func abs(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The ABS(expr) function.


                    
                    
                    +acos:

Creates an ACOS(expr) function that returns the inverse cosine of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)acos:(nonnull CBLQueryExpression *)expression;

Swift

class func acos(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The ACOS(expr) function.


                    
                    
                    +asin:

Creates an ASIN(expr) function that returns the inverse sin of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)asin:(nonnull CBLQueryExpression *)expression;

Swift

class func asin(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The ASIN(expr) function.


                    
                    
                    +atan:

Creates an ATAN(expr) function that returns the inverse tangent of the numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)atan:(nonnull CBLQueryExpression *)expression;

Swift

class func atan(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The ATAN(expr) function.


                    
                    
                    +atan2:y:

Creates an ATAN2(X, Y) function that returns the arctangent of y/x.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)atan2:(nonnull CBLQueryExpression *)x
                                    y:(nonnull CBLQueryExpression *)y;

Swift

class func atan2(_ x: CBLQueryExpression, y: CBLQueryExpression) -> CBLQueryExpression

Parameters

`x`	The expression to evaluate as the X coordinate.
`y`	The expression to evaluate as the Y coordinate.

Return Value

The ATAN2(X, Y) function.


                    
                    
                    +ceil:

Creates a CEIL(expr) function that returns the ceiling value of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)ceil:(nonnull CBLQueryExpression *)expression;

Swift

class func ceil(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The CEIL(expr) function.


                    
                    
                    +cos:

Creates a COS(expr) function that returns the cosine of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)cos:(nonnull CBLQueryExpression *)expression;

Swift

class func cos(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The COS(expr) function.


                    
                    
                    +degrees:

Creates a DEGREES(expr) function that returns the degrees value of the given radiants value expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)degrees:
    (nonnull CBLQueryExpression *)expression;

Swift

class func degrees(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression to evaluate as a radiants value.

Return Value

The DEGREES(expr) function.

+e
Creates a E() function that return the value of the mathemetical constant ‘e’.
Declaration
Objective-C

+ (nonnull CBLQueryExpression *)e;
Swift

class func e() -> CBLQueryExpression
Return Value

The E() constant function.


                    
                    
                    +exp:

Creates a EXP(expr) function that returns the value of ‘e’ power by the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)exp:(nonnull CBLQueryExpression *)expression;

Swift

class func exp(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The EXP(expr) function.


                    
                    
                    +floor:

Creates a FLOOR(expr) function that returns the floor value of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)floor:(nonnull CBLQueryExpression *)expression;

Swift

class func floor(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The FLOOR(expr) function.


                    
                    
                    +ln:

Creates a LN(expr) function that returns the natural log of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)ln:(nonnull CBLQueryExpression *)expression;

Swift

class func ln(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The LN(expr) function.


                    
                    
                    +log:

Creates a LOG(expr) function that returns the base 10 log of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)log:(nonnull CBLQueryExpression *)expression;

Swift

class func log(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The LOG(expr) function.

+pi
Creates a PI() function that returns the mathemetical constant Pi.
Declaration
Objective-C

+ (nonnull CBLQueryExpression *)pi;
Swift

class func pi() -> CBLQueryExpression
Return Value

The PI() constant function.


                    
                    
                    +power:exponent:

Creates a POWER(base, exponent) function that returns the value of the given base expression power the given exponent expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)power:(nonnull CBLQueryExpression *)base
                             exponent:(nonnull CBLQueryExpression *)exponent;

Swift

class func power(_ base: CBLQueryExpression, exponent: CBLQueryExpression) -> CBLQueryExpression

Parameters

`base`	The base expression.
`exponent`	The exponent expression.

Return Value

The POWER(base, exponent) function.


                    
                    
                    +radians:

Creates a RADIANS(expr) function that returns the radians value of the given degrees value expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)radians:
    (nonnull CBLQueryExpression *)expression;

Swift

class func radians(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression to evaluate as a degrees value.

Return Value

The RADIANS(expr) function.


                    
                    
                    +round:

Creates a ROUND(expr) function that returns the rounded value of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)round:(nonnull CBLQueryExpression *)expression;

Swift

class func round(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The ROUND(expr) function.


                    
                    
                    +round:digits:

Creates a ROUND(expr, digits) function that returns the rounded value to the given number of digits of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)round:(nonnull CBLQueryExpression *)expression
                               digits:(nonnull CBLQueryExpression *)digits;

Swift

class func round(_ expression: CBLQueryExpression, digits: CBLQueryExpression) -> CBLQueryExpression

Parameters

`expression`	The numeric expression.
`digits`	The number of digits.

Return Value

The ROUND(expr, digits) function.


                    
                    
                    +sign:

Creates a SIGN(expr) function that returns the sign (1: positive, -1: negative, 0: zero) of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)sign:(nonnull CBLQueryExpression *)expression;

Swift

class func sign(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The SIGN(expr) function.


                    
                    
                    +sin:

Creates a SIN(expr) function that returns the sin of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)sin:(nonnull CBLQueryExpression *)expression;

Swift

class func sin(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The SIN(expr) function.


                    
                    
                    +sqrt:

Creates a SQRT(expr) function that returns the square root of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)sqrt:(nonnull CBLQueryExpression *)expression;

Swift

class func sqrt(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The SQRT(expr) function.


                    
                    
                    +tan:

Creates a TAN(expr) function that returns the tangent of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)tan:(nonnull CBLQueryExpression *)expression;

Swift

class func tan(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The TAN(expr) function.


                    
                    
                    +trunc:

Creates a TRUNC(expr) function that truncates all of the digits after the decimal place of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)trunc:(nonnull CBLQueryExpression *)expression;

Swift

class func trunc(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The numeric expression.

Return Value

The trunc function.


                    
                    
                    +trunc:digits:

Creates a TRUNC(expr, digits) function that truncates the number of the digits after the decimal place of the given numeric expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)trunc:(nonnull CBLQueryExpression *)expression
                               digits:(nonnull CBLQueryExpression *)digits;

Swift

class func trunc(_ expression: CBLQueryExpression, digits: CBLQueryExpression) -> CBLQueryExpression

Parameters

`expression`	The numeric expression.
`digits`	The number of digits.

Return Value

The TRUNC(expr, digits) function.

String


                    
                    
                    +contains:substring:

Creates a CONTAINS(expr, substr) function that evaluates whether the given string expression conatins the given substring expression or not.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)
 contains:(nonnull CBLQueryExpression *)expression
substring:(nonnull CBLQueryExpression *)substring;

Swift

class func contains(_ expression: CBLQueryExpression, substring: CBLQueryExpression) -> CBLQueryExpression

Parameters

`expression`	The string expression.
`substring`	The substring expression.

Return Value

The CONTAINS(expr, substr) function.


                    
                    
                    +length:

Creates a LENGTH(expr) function that returns the length of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)length:(nonnull CBLQueryExpression *)expression;

Swift

class func length(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The LENGTH(expr) function.


                    
                    
                    +lower:

Creates a LOWER(expr) function that returns the lowercase string of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)lower:(nonnull CBLQueryExpression *)expression;

Swift

class func lower(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The LOWER(expr) function.


                    
                    
                    +ltrim:

Creates a LTRIM(expr) function that removes the whitespace from the beginning of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)ltrim:(nonnull CBLQueryExpression *)expression;

Swift

class func ltrim(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The LTRIM(expr) function.


                    
                    
                    +rtrim:

Creates a RTRIM(expr) function that removes the whitespace from the end of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)rtrim:(nonnull CBLQueryExpression *)expression;

Swift

class func rtrim(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The RTRIM(expr) function.


                    
                    
                    +trim:

Creates a TRIM(expr) function that removes the whitespace from the beginning and ‘ the end of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)trim:(nonnull CBLQueryExpression *)expression;

Swift

class func trim(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The TRIM(expr) function.


                    
                    
                    +upper:

Creates a UPPER(expr) function that returns the uppercase string of the given string expression.

Declaration

Objective-C

+ (nonnull CBLQueryExpression *)upper:(nonnull CBLQueryExpression *)expression;

Swift

class func upper(_ expression: CBLQueryExpression) -> CBLQueryExpression

Parameters


                                expression

The string expression.

Return Value

The UPPER(expr) function.

-init
Not available
Declaration
Objective-C

- (nonnull instancetype)init;