README.md

Formula Language Reference

Welcome to the Formula Language Reference! This documentation is automatically generated from the compiler metadata to ensure accuracy and completeness.

Quick Navigation

• Functions by Category
• All Functions A-Z
• Data Types - Complete type reference
• Operators

Functions by Category

Math Functions

• ROUND(number, decimals) - Rounds a number to specified decimal places
• ABS(number) - Returns the absolute value of a number
• CEILING(number) - Rounds a number up to the nearest integer
• FLOOR(number) - Rounds a number down to the nearest integer
• POWER(base, exponent) - Raises a number to a power
• SQRT(value) - Returns the square root of a number
• LOG(value) - Returns the natural logarithm of a number
• LOG10(value) - Returns the base-10 logarithm of a number
• EXP(value) - Returns e raised to the power of a number
• SIN(angle) - Returns the sine of an angle in radians
• COS(angle) - Returns the cosine of an angle in radians
• TAN(angle) - Returns the tangent of an angle in radians
• RANDOM() - Returns a random number between 0 and 1
• MIN(num1, num2) - Returns the minimum of two numbers
• MAX(num1, num2) - Returns the maximum of two numbers
• MOD(dividend, divisor) - Returns the remainder of division
• SIGN(value) - Returns the sign of a number (-1, 0, or 1)

String Functions

• LEN(requires string argument) - Returns the length of a string
• UPPER(requires string argument) - Converts a string to uppercase
• LOWER(requires string argument) - Converts a string to lowercase
• TRIM(requires string argument) - Removes whitespace from both ends of a string
• LEFT(first argument, second argument) - Returns the leftmost characters from a string
• RIGHT(first argument, numChars) - Returns the rightmost characters from a string
• MID(first argument, start, length) - Returns characters from the middle of a string
• SUBSTITUTE(first argument, second argument, third argument) - Replaces occurrences of a substring with another string
• CONTAINS(text, second argument) - Checks if a string contains a substring
• STARTS_WITH(text, prefix) - Checks if a string starts with a substring
• ENDS_WITH(text, suffix) - Checks if a string ends with a substring

Date Functions

• NOW() - Returns the current date and time
• TODAY() - Returns the current date (without time)
• YEAR(date) - Extracts the year from a date
• MONTH(date) - Extracts the month from a date (1-12)
• DAY(date) - Extracts the day from a date (1-31)
• HOUR(date) - Extracts the hour from a date (0-23)
• MINUTE(date) - Extracts the minute from a date (0-59)
• SECOND(date) - Extracts the second from a date (0-59)
• FORMAT_DATE(date, format) - Formats a date as a string
• WEEKDAY(date) - Returns the day of the week as a number (1=Sunday)
• ADDMONTHS(date, months) - Adds months to a date
• ADDDAYS(date, days) - Adds days to a date
• DATEDIF(date1, date2, unit) - Returns the difference between two dates in specified units

Core Functions

• ME() - Returns the current user identifier
• STRING(value) - Converts a value to a string
• DATE(dateString) - Creates a date from a string literal
• IF(condition, trueValue, falseValue) - Returns one value if condition is true, another if false
• EVAL(relationshipRef) - Evaluates an expression from another table

Logical Functions

• AND(argument...) - Returns true if all arguments are true
• OR(argument...) - Returns true if any argument is true
• NOT(requires boolean argument) - Returns the opposite of a boolean value

Null handling Functions

• ISNULL(value) - Returns true if the value is null
• ISBLANK(value) - Returns true if the value is null or empty string
• NULLVALUE(value, defaultValue) - Returns the first value if not null, otherwise returns the second value
• COALESCE(values...) - Returns the first non-null value from a list of expressions

Aggregate Functions

• COUNT(relationship, value) - Counts the number of non-null values
• SUM(relationship, value) - Sums numeric values
• AVG(relationship, value) - Calculates the average of numeric values
• MIN_AGG(relationship, value) - Finds the minimum value
• MAX_AGG(relationship, value) - Finds the maximum value
• STRING_AGG(relationship, value, separator) - Concatenates string values with a separator
• STRING_AGG_DISTINCT(relationship, value, separator) - Concatenates unique string values with a separator
• SUM_AGG(relationship, value) - Sums numeric values
• COUNT_AGG(relationship, value) - Counts the number of non-null values
• AVG_AGG(relationship, value) - Calculates the average of numeric values
• AND_AGG(relationship, value) - Returns true if all boolean values are true
• OR_AGG(relationship, value) - Returns true if any boolean value is true

All Functions A-Z

• ABS(number) - Returns the absolute value of a number
• ADDDAYS(date, days) - Adds days to a date
• ADDMONTHS(date, months) - Adds months to a date
• AND(argument...) - Returns true if all arguments are true
• AND_AGG(relationship, value) - Returns true if all boolean values are true
• AVG(relationship, value) - Calculates the average of numeric values
• AVG_AGG(relationship, value) - Calculates the average of numeric values
• CEILING(number) - Rounds a number up to the nearest integer
• [COALESCE(values...)](./functions/Null Handling.md#coalesce) - Returns the first non-null value from a list of expressions
• CONTAINS(text, second argument) - Checks if a string contains a substring
• COS(angle) - Returns the cosine of an angle in radians
• COUNT(relationship, value) - Counts the number of non-null values
• COUNT_AGG(relationship, value) - Counts the number of non-null values
• DATE(dateString) - Creates a date from a string literal
• DATEDIF(date1, date2, unit) - Returns the difference between two dates in specified units
• DAY(date) - Extracts the day from a date (1-31)
• ENDS_WITH(text, suffix) - Checks if a string ends with a substring
• EVAL(relationshipRef) - Evaluates an expression from another table
• EXP(value) - Returns e raised to the power of a number
• FLOOR(number) - Rounds a number down to the nearest integer
• FORMAT_DATE(date, format) - Formats a date as a string
• HOUR(date) - Extracts the hour from a date (0-23)
• IF(condition, trueValue, falseValue) - Returns one value if condition is true, another if false
• [ISBLANK(value)](./functions/Null Handling.md#isblank) - Returns true if the value is null or empty string
• [ISNULL(value)](./functions/Null Handling.md#isnull) - Returns true if the value is null
• LEFT(first argument, second argument) - Returns the leftmost characters from a string
• LEN(requires string argument) - Returns the length of a string
• LOG(value) - Returns the natural logarithm of a number
• LOG10(value) - Returns the base-10 logarithm of a number
• LOWER(requires string argument) - Converts a string to lowercase
• MAX(num1, num2) - Returns the maximum of two numbers
• MAX_AGG(relationship, value) - Finds the maximum value
• ME() - Returns the current user identifier
• MID(first argument, start, length) - Returns characters from the middle of a string
• MIN(num1, num2) - Returns the minimum of two numbers
• MINUTE(date) - Extracts the minute from a date (0-59)
• MIN_AGG(relationship, value) - Finds the minimum value
• MOD(dividend, divisor) - Returns the remainder of division
• MONTH(date) - Extracts the month from a date (1-12)
• NOT(requires boolean argument) - Returns the opposite of a boolean value
• NOW() - Returns the current date and time
• [NULLVALUE(value, defaultValue)](./functions/Null Handling.md#nullvalue) - Returns the first value if not null, otherwise returns the second value
• OR(argument...) - Returns true if any argument is true
• OR_AGG(relationship, value) - Returns true if any boolean value is true
• POWER(base, exponent) - Raises a number to a power
• RANDOM() - Returns a random number between 0 and 1
• RIGHT(first argument, numChars) - Returns the rightmost characters from a string
• ROUND(number, decimals) - Rounds a number to specified decimal places
• SECOND(date) - Extracts the second from a date (0-59)
• SIGN(value) - Returns the sign of a number (-1, 0, or 1)
• SIN(angle) - Returns the sine of an angle in radians
• SQRT(value) - Returns the square root of a number
• STARTS_WITH(text, prefix) - Checks if a string starts with a substring
• STRING(value) - Converts a value to a string
• STRING_AGG(relationship, value, separator) - Concatenates string values with a separator
• STRING_AGG_DISTINCT(relationship, value, separator) - Concatenates unique string values with a separator
• SUBSTITUTE(first argument, second argument, third argument) - Replaces occurrences of a substring with another string
• SUM(relationship, value) - Sums numeric values
• SUM_AGG(relationship, value) - Sums numeric values
• TAN(angle) - Returns the tangent of an angle in radians
• TODAY() - Returns the current date (without time)
• TRIM(requires string argument) - Removes whitespace from both ends of a string
• UPPER(requires string argument) - Converts a string to uppercase
• WEEKDAY(date) - Returns the day of the week as a number (1=Sunday)
• YEAR(date) - Extracts the year from a date

Data Types

The formula language supports several data types including basic types (string, number, boolean, date, null) and special types (expression, inverse_relationship).

📖 Complete Data Types Reference - Detailed information about all types, their operations, conversions, and compatibility rules.

Operators

Arithmetic Operators

• + - Addition (numbers) or date arithmetic
• - - Subtraction (numbers) or date arithmetic
• * - Multiplication (numbers)
• / - Division (numbers)

String Operators

• & - String concatenation (both sides must be strings)

Comparison Operators

• = - Equal to
• != or <> - Not equal to
• > - Greater than
• >= - Greater than or equal to
• < - Less than
• <= - Less than or equal to

Logical Functions

Logical operations are implemented as functions rather than operators:

• AND(condition1, condition2, ...) - All conditions must be true
• OR(condition1, condition2, ...) - Any condition must be true
• NOT(condition) - Negates the condition

Documentation generated on 2025-06-27T07:39:53.064Z