Function

public class Function: Expression

Function represents a function expression.

Aggregation

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

    Declaration

    Swift

    public static func avg(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The AVG(expr) function.

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

    Declaration

    Swift

    public static func count(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The COUNT(expr) function.

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

    Declaration

    Swift

    public static func min(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The MIN(expr) function.

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

    Declaration

    Swift

    public static func max(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The MAX(expr) function.

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

    Declaration

    Swift

    public static func sum(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The SUM(expr) function.

Array

  • Creates an ARRAY_CONTAINS(expr, value) function that checks whether the given array expression contains the given value or not.

    Declaration

    Swift

    public static func arrayContains(_ expression: Any, value: Any?) -> Function

    Parameters

    expression

    The expression that evluates to an array.
    value

    The value to search for in the given array expression.

    Return Value

    The ARRAY_CONTAINS(expr, value) function.

  • Creates an ARRAY_LENGTH(expr) function that returns the length of the given array expression.

    Declaration

    Swift

    public static func arrayLength(_ expression: Any) -> Function

    Parameters

    expression

    The expression that evluates to an array.

    Return Value

    The ARRAY_LENGTH(expr) function.

Mathematics

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

    Declaration

    Swift

    public static func abs(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The ABS(expr) function.

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

    Declaration

    Swift

    public static func acos(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The ACOS(expr) function.

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

    Declaration

    Swift

    public static func asin(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The ASIN(expr) function.

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

    Declaration

    Swift

    public static func atan(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The ATAN(expr) function.

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

    Declaration

    Swift

    public static func atan2(x: Any, y: Any) -> Function

    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.

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

    Declaration

    Swift

    public static func ceil(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The CEIL(expr) function.

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

    Declaration

    Swift

    public static func cos(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The COS(expr) function.

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

    Declaration

    Swift

    public static func degrees(_ expression: Any) -> Function

    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

    Swift

    public static func e() -> Function

    Return Value

    The E() constant function.

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

    Declaration

    Swift

    public static func exp(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The EXP(expr) function.

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

    Declaration

    Swift

    public static func floor(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The FLOOR(expr) function.

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

    Declaration

    Swift

    public static func ln(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The LN(expr) function.

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

    Declaration

    Swift

    public static func log(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The LOG(expr) function.

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

    Declaration

    Swift

    public static func pi() -> Function

    Return Value

    The PI() constant function.

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

    Declaration

    Swift

    public static func power(base: Any, exponent: Any) -> Function

    Parameters

    base

    The base expression.
    exponent

    The exponent expression.

    Return Value

    The POWER(base, exponent) function.

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

    Declaration

    Swift

    public static func radians(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression to evaluate as a degrees value.

    Return Value

    The RADIANS(expr) function.

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

    Declaration

    Swift

    public static func round(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The ROUND(expr) function.

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

    Declaration

    Swift

    public static func round(_ expression: Any, digits: Int) -> Function

    Parameters

    expression

    The numeric expression.
    digits

    The number of digits.

    Return Value

    The ROUND(expr, digits) function.

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

    Declaration

    Swift

    public static func sign(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The SIGN(expr) function.

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

    Declaration

    Swift

    public static func sin(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The SIN(expr) function.

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

    Declaration

    Swift

    public static func sqrt(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The SQRT(expr) function.

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

    Declaration

    Swift

    public static func tan(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The TAN(expr) function.

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

    Declaration

    Swift

    public static func trunc(_ expression: Any) -> Function

    Parameters

    expression

    The numeric expression.

    Return Value

    The trunc function.

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

    Declaration

    Swift

    public static func trunc(_ expression: Any, digits: Int) -> Function

    Parameters

    expression

    The numeric expression.
    digits

    The number of digits to truncate.

    Return Value

    The TRUNC(expr, digits) function.

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

    Declaration

    Swift

    public static func contains(_ expression: Any, substring: Any) -> Function

    Parameters

    expression

    The string expression.
    substring

    The substring expression.

    Return Value

    The CONTAINS(expr, substr) function.

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

    Declaration

    Swift

    public static func length(_ expression: Any) -> Expression

    Parameters

    expression

    The string expression.

    Return Value

    The LENGTH(expr) function.

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

    Declaration

    Swift

    public static func lower(_ expression: Any) -> Function

    Parameters

    expression

    The string expression.

    Return Value

    The LOWER(expr) function.

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

    Declaration

    Swift

    public static func ltrim(_ expression: Any) -> Function

    Parameters

    expression

    The string expression.

    Return Value

    The LTRIM(expr) function.

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

    Declaration

    Swift

    public static func rtrim(_ expression: Any) -> Function

    Parameters

    expression

    The string expression.

    Return Value

    The RTRIM(expr) function.

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

    Declaration

    Swift

    public static func trim(_ expression: Any) -> Function

    Parameters

    expression

    The string expression.

    Return Value

    The TRIM(expr) function.

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

    Declaration

    Swift

    public static func upper(_ expression: Any) -> Function

    Parameters

    expression

    The string expression.

    Return Value

    The UPPER(expr) function.

  • Creates a ISARRAY(expr) function that evaluates whether the given expression is an array value of not.

    Declaration

    Swift

    public static func isArray(_ expression: Any) -> Function

    Parameters

    expression

    The expression

    Return Value

    The ISARRAY(expr) function.

  • Creates a ISNUMBER(expr) function that evaluates whether the given expression is a numeric value of not.

    Declaration

    Swift

    public static func isNumber(_ expression: Any) -> Function

    Parameters

    expression

    The expression

    Return Value

    The ISNUMBER(expr) function.

  • Creates a ISDICTIONARY(expr) function that evaluates whether the given expression is a dictionary of not.

    Declaration

    Swift

    public static func isDictionary(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The ISDICTIONARY(expr) function.

  • Creates a ISSTRING(expr) function that evaluates whether the given expression is a string of not.

    Declaration

    Swift

    public static func isString(_ expression: Any) -> Function

    Parameters

    expression

    The expression.

    Return Value

    The ISSTRING(expr) function.

  • Creates a full-text ranking value function indicating how well the current query result matches the full-text query when performing the match comparison.

    Declaration

    Swift

    public static func rank(_ property: Expression) -> Function

    Parameters

    property

    The property expression used in the full-text match expression.

    Return Value

    The full-text ranking value.