Function

Create 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.

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

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

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

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

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

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

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

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

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

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

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

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

Creates a E() function that return the value of the mathemetical constant ‘e’.

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

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

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

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

Creates a PI() function that returns the mathemetical constant Pi.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Creates a STR_TO_MILLIS(expr) function that returns the number of milliseconds since the unix epoch of the given ISO 8601 date string expression.

Times can be of the form HH:MM, HH:MM:SS, or HH:MM:SS.FFF. Leading zero is not optional (i.e. 02 is ok, 2 is not). Hours are in 24-hour format. FFF represents milliseconds, and trailing zeros are optional (i.e. 5 == 500).

Time zones can be in one of three forms: (+/-)HH:MM (+/-)HHMM Z (which represents UTC)

No time zone present will default to the device local time zone.

Creates a STR_TO_UTC(expr) function that returns the ISO 8601 UTC datetime string of the given ISO 8601 date string expression.

Times can be of the form HH:MM, HH:MM:SS, or HH:MM:SS.FFF. Leading zero is not optional (i.e. 02 is ok, 2 is not). Hours are in 24-hour format. FFF represents milliseconds, and trailing zeros are optional (i.e. 5 == 500).

Time zones can be in one of three forms: (+/-)HH:MM (+/-)HHMM Z (which represents UTC)

No time zone present will default to the device local time zone.

Creates a MILLIS_TO_STR(expr) function that returns a ISO 8601 date time string in device local timezone of the given number of milliseconds since the unix epoch expression.

Creates a MILLIS_TO_UTC(expr) function that returns the UTC ISO 8601 date time string of the given number of milliseconds since the unix epoch expression.

ENTERPRISE EDITION ONLY

Creates prediction function with the given model name and input. When running a query with the prediction function, the corresponding predictive model registered to CouchbaseLite Database class will be called with the given input to predict the result.

The prediction result returned by the predictive model will be in a form dictionary object. To create an expression that refers to a property in the prediction result, the property(_ keypath: String) method of the created PredictionFunction object can be used.

ENTERPRISE EDITION ONLY

Creates a function that returns the euclidean distance between the two input vectors. The result is a non-negative floating-point number. The expression1 and expression2 must be arrays of numbers, and must be the same length.

ENTERPRISE EDITION ONLY

Creates a function that returns the squared euclidean distance between the two input vectors. The result is a non-negative floating-point number. The expression1 and expression2 must be arrays of numbers, and must be the same length.

ENTERPRISE EDITION ONLY

Creates a function that returns the cosine distance which one minus the cosine similarity between the two input vectors. The result is a floating-point number ranges from −1.0 to 1.0. The expression1 and expression2 must be arrays of numbers, and must be the same length.