Chalk SDK Reference

Returns the absolute value of a number.

Calculates the inverse cosine in radians.

Calculates the inverse sine in radians.

Calculates the arctangent of a number in radians.

Calculates the arctangent of y/x in radians, handling quadrant correctly.

Either:

• Rounds a number using banker's rounding (round half to even).
• Rounds a number to specified decimal places using banker's rounding (round half to even).

Either:

• Calculates the cube root of a number.
• Calculates the cube root of an integer.

Returns the smallest integer greater than or equal to the given number.

Returns the smallest integer greater than or equal to the given number.

Either:

• Constrains a value between a minimum and maximum range.
• Constrains an integer value between a minimum and maximum range.

Calculates the cosine of an angle in radians.

Calculates the hyperbolic cosine of a number.

Converts radians to degrees.

Returns the mathematical constant e (Euler's number).

Calculates e raised to the power of a number.

Returns the largest integer less than or equal to the given number.

Converts a string representation of a number in a given base to an integer.

Checks if a floating-point number is finite (not NaN or infinite).

Checks if a floating-point number is infinite.

Checks if a floating-point number is NaN (Not a Number).

Calculates the natural logarithm of a number.

Calculates the natural logarithm of a number.

Calculates the base-10 logarithm of a number.

Calculates the base-2 logarithm of a number.

Returns a floating point NaN (Not a Number) value.

Returns the negative value of a number.

Returns the mathematical constant π (pi).

Raises a number to the power of another number.

Raises the first number to the power of the second number.

Converts degrees to radians.

Either:

• Rounds a floating point number to the nearest integer.
• Rounds a floating point number to the specified number of decimal places.

Either:

• Returns the sign of a number (-1, 0, or 1).
• Returns the sign of an integer (-1, 0, or 1).

Calculates the sine of an angle in radians.

Calculates the square root of a number.

Calculates the tangent of an angle in radians.

Calculates the hyperbolic tangent of a number.

Converts an integer to its string representation in the specified base.

Truncates a floating-point number to remove the decimal part.

Either:

• Calculates the modulo (remainder) of two integers.
• Calculates the modulo (remainder) of two floating-point numbers.

Either:

• basic binary * operation
• num * duration multiplication

basic binary ** operation

Either:

• number + number addition
• time + duration addition
• string or binary concatenation
• interval + interval addition
• timestamp + interval addition
• interval + timestamp addition

Either:

• time - duration subtraction
• basic binary - operation
• date(time) subtraction
• Returns the negative value of a number.
• interval - interval subtraction
• timestamp - interval subtraction

Either:

• basic binary float / operation
• duration / num division

floor division

Checks if a value is between two bounds (inclusive).

Checks if two values are distinct, treating NULL values as different from non-NULL values.

Either:

• eq
• Compares if two values are equal.

Either:

• gt
• Compares if the first value is greater than the second.

Either:

• gte
• Compares if the first value is greater than or equal to the second.

Either:

• lt
• Compares if the first value is less than the second.

Either:

• lte
• Compares if the first value is less than or equal to the second.

Either:

• neq
• Compares if two values are not equal.

Returns the maximum of two scalar values.

Returns the minimum of two scalar values.

basic binary != operation

basic binary < operation

basic binary <= operation

basic binary == operation

basic binary > operation

basic binary >= operation

Performs bitwise AND operation on two integer values.

Returns the arithmetic right shift operation on x in 2’s complement representation. shift must not be negative.

Returns the left shifted value of x.

Returns the logical right shift operation on x (treated as bits-bit integer) shifted by shift. shift must not be negative.

Performs bitwise NOT operation (complement) on an integer value.

Performs bitwise OR operation on two integer values.

Returns the logical right shifted value of x.

Returns the arithmetic right shift value of x.

Returns the left shift operation on x (treated as bits-bit integer) shifted by shift. shift must not be negative.

Performs bitwise XOR operation on two integer values.

boolean & operation

boolean | operation

boolean ~ operation

Returns element-wise sum of two arrays.

Calculates the average of numeric values in an array.

Creates an array from a variable number of arguments.

Checks if a list contains a specific element.

Calculates the cumulative sum of numeric values in an array.

Returns an array with duplicate elements removed, preserving order.

Returns an array containing only the duplicate elements from the input array.

Returns elements from the first array that are not present in the second array.

Filters an array using a callback function predicate.

Returns a map of elements to their frequency counts in an array.

Checks if an array contains duplicate elements.

Returns the 1-based position of the first occurrence of an element in an array.

Returns the intersection of two arrays (elements present in both arrays).

Either:

• Joins elements of an array into a string using a separator.
• Joins elements of a large array into a string using a separator.

Returns the number of elements in a list.

Returns the maximum element in an array.

Calculates the median value of numeric elements in an array.

Returns the minimum element in an array.

Either:

• Returns the most frequently occurring element in an array.
• Returns the most frequently occurring element in an array with mode selection option.

Returns all most frequently occurring elements in an array.

Computes the L_p normalization of a Vector.

Returns the 1-based position of the first occurrence of an element in an array.

Applies a reduce function to each element in an array and returns the accumulated value.

Removes all occurrences of a specified element from an array.

Either:

• Sorts an array in ascending order.
• Sorts an array using a key extraction function.

Sorts an array in descending order.

Calculates the standard deviation of numeric values in an array.

Calculates the sum of numeric values in an array.

Either:

• Joins elements of an array into a string using a separator.
• Joins elements of a large array into a string using a separator.

Applies a transformation function to each element in an array and returns a new array.

Returns an array with duplicate elements removed, preserving order.

Creates an array from a variable number of arguments.

Checks if two arrays have any elements in common.

Returns a list of the distinct elements of the common elements

Returns the number of elements in a list.

Checks if a list contains a specific element.

Either:

• Returns the element at the specified index in a list.
• Retrieves the value associated with a key from a map.

Returns the first element in an array that matches the given predicate function.

Returns the 1-based index of the first element in an array that matches the given predicate function.

Flattens a nested array by one level, combining all sub-arrays into a single array.

Returns the maximum value from a list of integer values.

Returns the minimum value from a list of float values.

Calculates the average of numeric values in an array.

Checks if a list contains a specific element.

Returns the number of elements in a list.

Returns an array with duplicate elements removed, preserving order.

Checks if a list contains a specific element.

Checks if two arrays have any elements in common.

Returns the intersection of two arrays (elements present in both arrays).

Returns the maximum element in an array.

Calculates the median value of numeric elements in an array.

Returns the minimum element in an array.

Either:

• Returns the most frequently occurring element in an array.
• Returns the most frequently occurring element in an array with mode selection option.

Creates an array from a variable number of arguments.

Returns the 1-based position of the first occurrence of an element in an array.

Either:

• Sorts an array in ascending order.
• Sorts an array using a key extraction function.

Calculates the standard deviation of numeric values in an array.

Calculates the sum of numeric values in an array.

Returns an array with duplicate elements removed, preserving order.

Creates an array from a variable number of arguments.

Returns the element at the specified Python-style index in a list.

Combines multiple lists element-wise into a list of paired structures with Python semantics.

Removes all null values from an array.

Randomly shuffles the elements of an array.

Either:

• Returns a slice of a list starting at the given position for the specified length.
• Returns a substring starting at the specified position with the given length.

Applies a transformation function to each element in an array and returns a new array.

Combines two lists element-wise into a list of paired structures.

Combines two lists element-wise using a callback function to transform paired elements.

Returns vector from binary.

Returns the cosine similarity between the vectors.

Returns the dot product between the vectors.

Returns a scaled vector.

Returns binary of vector.

Finds all matches of a regular expression pattern in a string and returns them as a list.

Converts an integer to its corresponding ASCII character.

Returns the Unicode code point of the only character of the string.

Either:

• Concatenates two or more strings together.
• Concatenates two or more lists together.

Checks if a string ends with a specified suffix.

Decodes UTF-8 encoded binary data into a string.

Returns the Hamming distance of string1 and string2, i.e. the number of positions at which the corresponding characters are different. Note that the two strings must have the same length.

Calculates the Jaccard similarity coefficient between two strings based on character sets.

Calculates the Jaro-Winkler distance between two strings.

Either:

• Returns the length of a string in characters.
• Returns the number of elements in a list.

Calculates the Levenshtein distance between two strings.

Checks if a string matches a pattern using SQL LIKE syntax with wildcards.

Calculates the longest common subsequence between two strings.

Converts a string to lowercase.

Pads a string with a specified padding string on the left to reach a target length.

Either:

• Removes whitespace from the left end of a string.
• Removes specified characters from the left end of a string.

Calculates the partial ratio similarity between two strings using fuzzy matching.

Either:

• Returns the first substring matched by the regular expression pattern in string.
• Returns the first substring matched by the regular expression pattern in string and returns the capturing group number group.

Either:

• Returns the substring(s) matched by the regular expression pattern in string.
• Returns the substring(s) matched by the regular expression pattern in string and returns the capturing group number group.

Checks if a string matches a regular expression pattern.

Checks if a string matches a regular expression pattern.

Either:

• Replaces all matches of a regular expression pattern with a replacement string.
• Removes all matches of a regular expression pattern from a string.

Splits a string by a regex pattern into a list of strings.

Replaces all occurrences of a substring with another string.