System (Built-in) Functions

Flink Table API & SQL provides users with a set of built-in functions for data transformations. This page gives a brief overview of them.If a function that you need is not supported yet, you can implement a user-defined function.If you think that the function is general enough, please open a Jira issue for it with a detailed description.

Scalar Functions

The scalar functions take zero, one or more values as the input and return a single value as the result.

Comparison Functions

Comparison functionsDescription
  1. value1 = value2
Returns TRUE if value1 is equal to value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value1 <> value2
Returns TRUE if value1 is not equal to value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value1 > value2
Returns TRUE if value1 is greater than value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value1 >= value2
Returns TRUE if value1 is greater than or equal to value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value1 < value2
Returns TRUE if value1 is less than value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value1 <= value2
Returns TRUE if value1 is less than or equal to value2; returns UNKNOWN if value1 or value2 is NULL.
  1. value IS NULL
Returns TRUE if value is NULL.
  1. value IS NOT NULL
Returns TRUE if value is not NULL.
  1. value1 IS DISTINCT FROM value2
Returns TRUE if two values are not equal. NULL values are treated as identical here.E.g., 1 IS DISTINCT FROM NULL returns TRUE; NULL IS DISTINCT FROM NULL returns FALSE.
  1. value1 IS NOT DISTINCT FROM value2
Returns TRUE if two values are equal. NULL values are treated as identical here.E.g., 1 IS NOT DISTINCT FROM NULL returns FALSE; NULL IS NOT DISTINCT FROM NULL returns TRUE.
  1. value1 BETWEEN [ ASYMMETRIC | SYMMETRIC ] value2 AND value3
By default (or with the ASYMMETRIC keyword), returns TRUE if value1 is greater than or equal to value2 and less than or equal to value3. With the SYMMETRIC keyword, returns TRUE if value1 is inclusively between value2 and value3. When either value2 or value3 is NULL, returns FALSE or UNKNOWN.E.g., 12 BETWEEN 15 AND 12 returns FALSE; 12 BETWEEN SYMMETRIC 15 AND 12 returns TRUE; 12 BETWEEN 10 AND NULL returns UNKNOWN; 12 BETWEEN NULL AND 10 returns FALSE; 12 BETWEEN SYMMETRIC NULL AND 12 returns UNKNOWN.
  1. value1 NOT BETWEEN [ ASYMMETRIC | SYMMETRIC ] value2 AND value3
By default (or with the ASYMMETRIC keyword), returns TRUE if value1 is less than value2 or greater than value3. With the SYMMETRIC keyword, returns TRUE if value1 is not inclusively between value2 and value3. When either value2 or value3 is NULL, returns TRUE or UNKNOWN.E.g., 12 NOT BETWEEN 15 AND 12 returns TRUE; 12 NOT BETWEEN SYMMETRIC 15 AND 12 returns FALSE; 12 NOT BETWEEN NULL AND 15 returns UNKNOWN; 12 NOT BETWEEN 15 AND NULL returns TRUE; 12 NOT BETWEEN SYMMETRIC 12 AND NULL returns UNKNOWN.
  1. string1 LIKE string2 [ ESCAPE char ]
Returns TRUE if string1 matches pattern string2; returns UNKNOWN if string1 or string2 is NULL. An escape character can be defined if necessary.Note: The escape character has not been supported yet.
  1. string1 NOT LIKE string2 [ ESCAPE char ]
Returns TRUE if string1 does not match pattern string2; returns UNKNOWN if string1 or string2 is NULL. An escape character can be defined if necessary.Note: The escape character has not been supported yet.
  1. string1 SIMILAR TO string2 [ ESCAPE char ]
Returns TRUE if string1 matches SQL regular expression string2; returns UNKNOWN if string1 or string2 is NULL. An escape character can be defined if necessary.Note: The escape character has not been supported yet.
  1. string1 NOT SIMILAR TO string2 [ ESCAPE char ]
Returns TRUE if string1 does not match SQL regular expression string2; returns UNKNOWN if string1 or string2 is NULL. An escape character can be defined if necessary.Note: The escape character has not been supported yet.
  1. value1 IN (value2 [, value3] )
 Returns TRUE if value1 exists in the given list (value2, value3, …). When (value2, value3, …). contains NULL, returns TRUE if the element can be found and UNKNOWN otherwise. Always returns UNKNOWN if value1 is NULL.E.g., 4 IN (1, 2, 3) returns FALSE; 1 IN (1, 2, NULL) returns TRUE; 4 IN (1, 2, NULL) returns UNKNOWN.
  1. value1 NOT IN (value2 [, value3] )
Returns TRUE if value1 does not exist in the given list (value2, value3, …). When (value2, value3, …). contains NULL, returns FALSE if value1 can be found and UNKNOWN otherwise. Always returns UNKNOWN if value1 is NULL.E.g., 4 NOT IN (1, 2, 3) returns TRUE; 1 NOT IN (1, 2, NULL) returns FALSE; 4 NOT IN (1, 2, NULL) returns UNKNOWN.
  1. EXISTS (sub-query)
Returns TRUE if sub-query returns at least one row. Only supported if the operation can be rewritten in a join and group operation.Note: For streaming queries the operation is rewritten in a join and group operation. The required state to compute the query result might grow infinitely depending on the number of distinct input rows. Please provide a query configuration with valid retention interval to prevent excessive state size. See Query Configuration for details.
  1. value IN (sub-query)
Returns TRUE if value is equal to a row returned by sub-query.Note: For streaming queries the operation is rewritten in a join and group operation. The required state to compute the query result might grow infinitely depending on the number of distinct input rows. Please provide a query configuration with valid retention interval to prevent excessive state size. See Query Configuration for details.
  1. value NOT IN (sub-query)
Returns TRUE if value is not equal to every row returned by sub-query.Note: For streaming queries the operation is rewritten in a join and group operation. The required state to compute the query result might grow infinitely depending on the number of distinct input rows. Please provide a query configuration with valid retention interval to prevent excessive state size. See Query Configuration for details.
Comparison functionsDescription
  1. ANY1 === ANY2
Returns TRUE if ANY1 is equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 !== ANY2
Returns TRUE if ANY1 is not equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 > ANY2
Returns TRUE if ANY1 is greater than ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 >= ANY2
Returns TRUE if ANY1 is greater than or equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 < ANY2
Returns TRUE if ANY1 is less than ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 <= ANY2
Returns TRUE if ANY1 is less than or equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY.isNull
Returns TRUE if ANY is NULL.
  1. ANY.isNotNull
Returns TRUE if ANY is not NULL.
  1. STRING1.like(STRING2)
Returns TRUE if STRING1 matches pattern STRING2; returns UNKNOWN if STRING1 or STRING2 is NULL.E.g., "JoKn".like("Jon%") returns TRUE.
  1. STRING1.similar(STRING2)
Returns TRUE if _STRING1 matches SQL regular expression STRING2; returns UNKNOWN if STRING1 or STRING2 is NULL.E.g., "A".similar("A+") returns TRUE.
  1. ANY1.in(ANY2, ANY3, …)
 Returns TRUE if ANY1 exists in a given list (ANY2, ANY3, …). When (ANY2, ANY3, …). contains NULL, returns TRUE if the element can be found and UNKNOWN otherwise. Always returns UNKNOWN if ANY1 is NULL.E.g., 4.in(1, 2, 3) returns FALSE.
  1. ANY.in(TABLE)
Returns TRUE if ANY is equal to a row returned by sub-query TABLE.Note: For streaming queries the operation is rewritten in a join and group operation. The required state to compute the query result might grow infinitely depending on the number of distinct input rows. Please provide a query configuration with valid retention interval to prevent excessive state size. See Query Configuration for details.
  1. ANY1.between(ANY2, ANY3)
Returns TRUE if ANY1 is greater than or equal to ANY2 and less than or equal to ANY3. When either ANY2 or ANY3 is NULL, returns FALSE or UNKNOWN.E.g., 12.between(15, 12) returns FALSE; 12.between(10, Null(INT)) returns UNKNOWN; 12.between(Null(INT), 10) returns FALSE.
  1. ANY1.notBetween(ANY2, ANY3)
Returns TRUE if ANY1 is less than ANY2 or greater than ANY3. When either ANY2 or ANY3 is NULL, returns TRUE or UNKNOWN.E.g., 12.notBetween(15, 12) returns TRUE; 12.notBetween(Null(INT), 15) returns UNKNOWN; 12.notBetween(15, Null(INT)) returns TRUE.
Comparison functionsDescription
  1. ANY1 === ANY2
Returns TRUE if ANY1 is equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 !== ANY2
Returns TRUE if ANY1 is not equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 > ANY2
Returns TRUE if ANY1 is greater than ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 >= ANY2
Returns TRUE if ANY1 is greater than or equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 < ANY2
Returns TRUE if ANY1 is less than ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY1 <= ANY2
Returns TRUE if ANY1 is less than or equal to ANY2; returns UNKNOWN if ANY1 or ANY2 is NULL.
  1. ANY.isNull
Returns TRUE if ANY is NULL.
  1. ANY.isNotNull
Returns TRUE if ANY is not NULL.
  1. STRING1.like(STRING2)
Returns TRUE if STRING1 matches pattern STRING2; returns UNKNOWN if STRING1 or STRING2 is NULL.E.g., "JoKn".like("Jon%") returns TRUE.
  1. STRING1.similar(STRING2)
Returns TRUE if _STRING1 matches SQL regular expression STRING2; returns UNKNOWN if STRING1 or STRING2 is NULL.E.g., "A".similar("A+") returns TRUE.
  1. ANY1.in(ANY2, ANY3, …)
 Returns TRUE if ANY1 exists in a given list (ANY2, ANY3, …). When (ANY2, ANY3, …). contains NULL, returns TRUE if the element can be found and UNKNOWN otherwise. Always returns UNKNOWN if ANY1 is NULL.E.g., 4.in(1, 2, 3) returns FALSE.
  1. ANY.in(TABLE)
Returns TRUE if ANY is equal to a row returned by sub-query TABLE.Note: For streaming queries the operation is rewritten in a join and group operation. The required state to compute the query result might grow infinitely depending on the number of distinct input rows. Please provide a query configuration with valid retention interval to prevent excessive state size. See Query Configuration for details.
  1. ANY1.between(ANY2, ANY3)
Returns TRUE if ANY1 is greater than or equal to ANY2 and less than or equal to ANY3. When either ANY2 or ANY3 is NULL, returns FALSE or UNKNOWN.E.g., 12.between(15, 12) returns FALSE; 12.between(10, Null(Types.INT)) returns UNKNOWN; 12.between(Null(Types.INT), 10) returns FALSE.
  1. ANY1.notBetween(ANY2, ANY3)
Returns TRUE if ANY1 is less than ANY2 or greater than ANY3. When either ANY2 or ANY3 is NULL, returns TRUE or UNKNOWN.E.g., 12.notBetween(15, 12) returns TRUE; 12.notBetween(Null(Types.INT), 15) returns UNKNOWN; 12.notBetween(15, Null(Types.INT)) returns TRUE.

Logical Functions

Logical functionsDescription
  1. boolean1 OR boolean2
Returns TRUE if boolean1 is TRUE or boolean2 is TRUE. Supports three-valued logic.E.g., TRUE OR UNKNOWN returns TRUE.
  1. boolean1 AND boolean2
Returns TRUE if boolean1 and boolean2 are both TRUE. Supports three-valued logic.E.g., TRUE AND UNKNOWN returns UNKNOWN.
  1. NOT boolean
Returns TRUE if boolean is FALSE; returns FALSE if boolean is TRUE; returns UNKNOWN if boolean is UNKNOWN.
  1. boolean IS FALSE
Returns TRUE if boolean is FALSE; returns FALSE if boolean is TRUE or UNKNOWN.
  1. boolean IS NOT FALSE
Returns TRUE if boolean is TRUE or UNKNOWN; returns FALSE if boolean is FALSE.
  1. boolean IS TRUE
Returns TRUE if boolean is TRUE; returns FALSE if boolean is FALSE or UNKNOWN.
  1. boolean IS NOT TRUE
Returns TRUE if boolean is FALSE or UNKNOWN; returns FALSE if boolean is TRUE.
  1. boolean IS UNKNOWN
Returns TRUE if boolean is UNKNOWN; returns FALSE if boolean is TRUE or FALSE.
  1. boolean IS NOT UNKNOWN
Returns TRUE if boolean is TRUE or FALSE; returns FALSE if boolean is UNKNOWN.
Logical functionsDescription
  1. BOOLEAN1 || BOOLEAN2
Returns TRUE if BOOLEAN1 is TRUE or BOOLEAN2 is TRUE. Supports three-valued logic.E.g., true || Null(BOOLEAN) returns TRUE.
  1. BOOLEAN1 && BOOLEAN2
Returns TRUE if BOOLEAN1 and BOOLEAN2 are both TRUE. Supports three-valued logic.E.g., true && Null(BOOLEAN) returns UNKNOWN.
  1. !BOOLEAN
Returns TRUE if BOOLEAN is FALSE; returns FALSE if BOOLEAN is TRUE; returns UNKNOWN if BOOLEAN is UNKNOWN.
  1. BOOLEAN.isTrue
Returns TRUE if BOOLEAN is TRUE; returns FALSE if BOOLEAN is FALSE or UNKNOWN.
  1. BOOLEAN.isFalse
Returns TRUE if BOOLEAN is FALSE; returns FALSE if BOOLEAN is TRUE or UNKNOWN.
  1. BOOLEAN.isNotTrue
Returns TRUE if BOOLEAN is FALSE or UNKNOWN; returns FALSE if BOOLEAN is TRUE.
  1. BOOLEAN.isNotFalse
Returns TRUE if BOOLEAN is TRUE or UNKNOWN; returns FALSE if BOOLEAN is FALSE.
Logical functionsDescription
  1. BOOLEAN1 || BOOLEAN2
Returns TRUE if BOOLEAN1 is TRUE or BOOLEAN2 is TRUE. Supports three-valued logic.E.g., true || Null(Types.BOOLEAN) returns TRUE.
  1. BOOLEAN1 && BOOLEAN2
Returns TRUE if BOOLEAN1 and BOOLEAN2 are both TRUE. Supports three-valued logic.E.g., true && Null(Types.BOOLEAN) returns UNKNOWN.
  1. !BOOLEAN
Returns TRUE if BOOLEAN is FALSE; returns FALSE if BOOLEAN is TRUE; returns UNKNOWN if BOOLEAN is UNKNOWN.
  1. BOOLEAN.isTrue
Returns TRUE if BOOLEAN is TRUE; returns FALSE if BOOLEAN is FALSE or UNKNOWN.
  1. BOOLEAN.isFalse
Returns TRUE if BOOLEAN is FALSE; returns FALSE if BOOLEAN is TRUE or UNKNOWN.
  1. BOOLEAN.isNotTrue
Returns TRUE if BOOLEAN is FALSE or UNKNOWN; returns FALSE if BOOLEAN is TRUE.
  1. BOOLEAN.isNotFalse
Returns TRUE if BOOLEAN is TRUE or UNKNOWN; returns FALSE if BOOLEAN is FALSE.

Arithmetic Functions

Arithmetic functionsDescription
  1. + numeric
Returns numeric.
  1. - numeric
Returns negative numeric.
  1. numeric1 + numeric2
Returns numeric1 plus numeric2.
  1. numeric1 - numeric2
Returns numeric1 minus numeric2.
  1. numeric1  numeric2
Returns numeric1 multiplied by numeric2.
  1. numeric1 / numeric2
Returns numeric1 divided by numeric2.
  1. POWER(numeric1, numeric2)
Returns numeric1 raised to the power of numeric2.
  1. ABS(numeric)
Returns the absolute value of numeric.
  1. MOD(numeric1, numeric2)
Returns the remainder (modulus) of numeric1 divided by numeric2. The result is negative only if numeric1 is negative.
  1. SQRT(numeric)
Returns the square root of numeric.
  1. LN(numeric)
Returns the natural logarithm (base e) of numeric.
  1. LOG10(numeric)
Returns the base 10 logarithm of numeric.
  1. LOG2(numeric)
Returns the base 2 logarithm of numeric.
  1. LOG(numeric2)LOG(numeric1, numeric2)
When called with one argument, returns the natural logarithm of numeric2. When called with two arguments, this function returns the logarithm of numeric2 to the base numeric1.*Note: Currently, numeric2 must be greater than 0 and numeric1 must be greater than 1.
  1. EXP(numeric)
Returns e raised to the power of numeric.
  1. CEIL(numeric)CEILING(numeric)
Rounds numeric up, and returns the smallest number that is greater than or equal to numeric.
  1. FLOOR(numeric)
Rounds numeric down, and returns the largest number that is less than or equal to numeric.
  1. SIN(numeric)
Returns the sine of numeric.
  1. SINH(numeric)
Returns the hyperbolic sine of numeric.The return type is DOUBLE.
  1. COS(numeric)
Returns the cosine of numeric.
  1. TAN(numeric)
Returns the tangent of numeric.
  1. TANH(numeric)
Returns the hyperbolic tangent of numeric.The return type is DOUBLE.
  1. COT(numeric)
Returns the cotangent of a numeric.
  1. ASIN(numeric)
Returns the arc sine of numeric.
  1. ACOS(numeric)
Returns the arc cosine of numeric.
  1. ATAN(numeric)
Returns the arc tangent of numeric.
  1. ATAN2(numeric1, numeric2)
Returns the arc tangent of a coordinate (numeric1, numeric2).
  1. COSH(numeric)
Returns the hyperbolic cosine of NUMERIC.Return value type is DOUBLE.
  1. DEGREES(numeric)
Returns the degree representation of a radian numeric.
  1. RADIANS(numeric)
Returns the radian representation of a degree numeric.
  1. SIGN(numeric)
Returns the signum of numeric.
  1. ROUND(numeric, integer)
Returns a number rounded to integer decimal places for numeric.
  1. PI
Returns a value that is closer than any other values to pi.
  1. E()
Returns a value that is closer than any other values to e.
  1. RAND()
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive).
  1. RAND(integer)
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive) with an initial seed integer. Two RAND functions will return identical sequences of numbers if they have the same initial seed.
  1. RANDINTEGER(integer)
Returns a pseudorandom integer value between 0 (inclusive) and _integer (exclusive).
  1. RANDINTEGER(integer1, integer2)
Returns a pseudorandom integer value between 0 (inclusive) and the specified value (exclusive) with an initial seed. Two RAND_INTEGER functions will return identical sequences of numbers if they have the same initial seed and bound.
  1. UUID()
Returns an UUID (Universally Unique Identifier) string (e.g., "3d3c68f7-f608-473f-b60c-b0c44ad4cc4e") according to RFC 4122 type 4 (pseudo randomly generated) UUID. The UUID is generated using a cryptographically strong pseudo random number generator.
  1. BIN(integer)
Returns a string representation of _integer in binary format. Returns NULL if integer is NULL.E.g. BIN(4) returns '100' and BIN(12) returns '1100'.
  1. HEX(numeric)HEX(string)
Returns a string representation of an integer numeric value or a string in hex format. Returns NULL if the argument is NULL.E.g. a numeric 20 leads to "14", a numeric 100 leads to "64", a string "hello,world" leads to "68656C6C6F2C776F726C64".
  1. TRUNCATE(numeric1, integer2)
Returns a numeric of truncated to integer2 decimal places. Returns NULL if numeric1 or integer2 is NULL.If integer2 is 0,the result has no decimal point or fractional part.integer2 can be negative to cause integer2 digits left of the decimal point of the value to become zero.This function can also pass in only one numeric1 parameter and not set Integer2 to use.If Integer2 is not set, the function truncates as if Integer2 were 0.E.g. truncate(42.345, 2) to 42.34. and truncate(42.345) to 42.0.
  1. PI()
Returns the value of π (pi).Only supported in blink planner.
Arithmetic functionsDescription
  1. + NUMERIC
Returns NUMERIC.
  1. - NUMERIC
Returns negative NUMERIC.
  1. NUMERIC1 + NUMERIC2
Returns NUMERIC1 plus NUMERIC2.
  1. NUMERIC1 - NUMERIC2
Returns NUMERIC1 minus NUMERIC2.
  1. NUMERIC1  NUMERIC2
Returns NUMERIC1 multiplied by NUMERIC2.
  1. NUMERIC1 / NUMERIC2
Returns NUMERIC1 divided by NUMERIC2.
  1. NUMERIC1.power(NUMERIC2)
Returns NUMERIC1 raised to the power of NUMERIC2.
  1. NUMERIC.abs()
Returns the absolute value of NUMERIC.
  1. NUMERIC1 % NUMERIC2
Returns the remainder (modulus) of NUMERIC1 divided by NUMERIC2. The result is negative only if numeric1 is negative.
  1. NUMERIC.sqrt()
Returns the square root of NUMERIC.
  1. NUMERIC.ln()
Returns the natural logarithm (base e) of NUMERIC.
  1. NUMERIC.log10()
Returns the base 10 logarithm of NUMERIC.
  1. NUMERIC.log2()
Returns the base 2 logarithm of NUMERIC.
  1. NUMERIC1.log()NUMERIC1.log(NUMERIC2)
When called without argument, returns the natural logarithm of NUMERIC1. When called with an argument, returns the logarithm of NUMERIC1 to the base NUMERIC2.*Note: Currently, NUMERIC1 must be greater than 0 and NUMERIC2 must be greater than 1.
  1. NUMERIC.exp()
Returns e raised to the power of NUMERIC.
  1. NUMERIC.ceil()
Rounds NUMERIC up, and returns the smallest number that is greater than or equal to NUMERIC.
  1. NUMERIC.floor()
Rounds NUMERIC down, and returns the largest number that is less than or equal to NUMERIC.
  1. NUMERIC.sin()
Returns the sine of NUMERIC.
  1. NUMERIC.sinh()
Returns the hyperbolic sine of NUMERIC.The return type is DOUBLE.
  1. NUMERIC.cos()
Returns the cosine of NUMERIC.
  1. NUMERIC.tan()
Returns the tangent of NUMERIC.
  1. NUMERIC.tanh()
Returns the hyperbolic tangent of NUMERIC.The return type is DOUBLE.
  1. NUMERIC.cot()
Returns the cotangent of a NUMERIC.
  1. NUMERIC.asin()
Returns the arc sine of NUMERIC.
  1. NUMERIC.acos()
Returns the arc cosine of NUMERIC.
  1. NUMERIC.atan()
Returns the arc tangent of NUMERIC.
  1. atan2(NUMERIC1, NUMERIC2)
Returns the arc tangent of a coordinate (NUMERIC1, NUMERIC2).
  1. NUMERIC.cosh()
Returns the hyperbolic cosine of NUMERIC.Return value type is DOUBLE.
  1. NUMERIC.degrees()
Returns the degree representation of a radian NUMERIC.
  1. NUMERIC.radians()
Returns the radian representation of a degree NUMERIC.
  1. NUMERIC.sign()
Returns the signum of NUMERIC.
  1. NUMERIC.round(INT)
Returns a number rounded to INT decimal places for NUMERIC.
  1. pi()
Returns a value that is closer than any other values to pi.
  1. e()
Returns a value that is closer than any other values to e.
  1. rand()
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive).
  1. rand(INTEGER)
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive) with an initial seed INTEGER. Two RAND functions will return identical sequences of numbers if they have the same initial seed.
  1. randInteger(INTEGER)
Returns a pseudorandom integer value between 0 (inclusive) and INTEGER (exclusive).
  1. randInteger(INTEGER1, INTEGER2)
Returns a pseudorandom integer value between 0 (inclusive) and INTEGER2 (exclusive) with an initial seed INTEGER1. Two randInteger functions will return identical sequences of numbers if they have same initial seed and bound.
  1. uuid()
Returns an UUID (Universally Unique Identifier) string (e.g., "3d3c68f7-f608-473f-b60c-b0c44ad4cc4e") according to RFC 4122 type 4 (pseudo randomly generated) UUID. The UUID is generated using a cryptographically strong pseudo random number generator.
  1. INTEGER.bin()
Returns a string representation of INTEGER in binary format. Returns NULL if INTEGER is NULL.E.g., 4.bin() returns "100" and 12.bin() returns "1100".
  1. NUMERIC.hex()STRING.hex()
Returns a string representation of an integer NUMERIC value or a STRING in hex format. Returns NULL if the argument is NULL.E.g. a numeric 20 leads to "14", a numeric 100 leads to "64", a string "hello,world" leads to "68656C6C6F2C776F726C64".
  1. numeric1.truncate(INTEGER2)
Returns a numeric of truncated to integer2 decimal places. Returns NULL if numeric1 or integer2 is NULL.If integer2 is 0,the result has no decimal point or fractional part.integer2 can be negative to cause integer2 digits left of the decimal point of the value to become zero.This function can also pass in only one numeric1 parameter and not set Integer2 to use.If Integer2 is not set, the function truncates as if Integer2 were 0.E.g. 42.324.truncate(2) to 42.34. and 42.324.truncate() to 42.0.
Arithmetic functionsDescription
  1. + NUMERIC
Returns NUMERIC.
  1. - NUMERIC
Returns negative NUMERIC.
  1. NUMERIC1 + NUMERIC2
Returns NUMERIC1 plus NUMERIC2.
  1. NUMERIC1 - NUMERIC2
Returns NUMERIC1 minus NUMERIC2.
  1. NUMERIC1  NUMERIC2
Returns NUMERIC1 multiplied by NUMERIC2.
  1. NUMERIC1 / NUMERIC2
Returns NUMERIC1 divided by NUMERIC2.
  1. NUMERIC1.power(NUMERIC2)
Returns NUMERIC1 raised to the power of NUMERIC2.
  1. NUMERIC.abs()
Returns the absolute value of NUMERIC.
  1. NUMERIC1 % NUMERIC2
Returns the remainder (modulus) of NUMERIC1 divided by NUMERIC2. The result is negative only if numeric1 is negative.
  1. NUMERIC.sqrt()
Returns the square root of NUMERIC.
  1. NUMERIC.ln()
Returns the natural logarithm (base e) of NUMERIC.
  1. NUMERIC.log10()
Returns the base 10 logarithm of NUMERIC.
  1. NUMERIC.log2()
Returns the base 2 logarithm of NUMERIC.
  1. NUMERIC1.log()NUMERIC1.log(NUMERIC2)
When called without argument, returns the natural logarithm of NUMERIC1. When called with an argument, returns the logarithm of NUMERIC1 to the base NUMERIC2.*Note: Currently, NUMERIC1 must be greater than 0 and NUMERIC2 must be greater than 1.
  1. NUMERIC.exp()
Returns e raised to the power of NUMERIC.
  1. NUMERIC.ceil()
Rounds NUMERIC up, and returns the smallest number that is greater than or equal to NUMERIC.
  1. NUMERIC.floor()
Rounds NUMERIC down, and returns the largest number that is less than or equal to NUMERIC.
  1. NUMERIC.sin()
Returns the sine of NUMERIC.
  1. NUMERIC.sinh()
Returns the hyperbolic sine of NUMERIC.The return type is DOUBLE.
  1. NUMERIC.cos()
Returns the cosine of NUMERIC.
  1. NUMERIC.tan()
Returns the tangent of NUMERIC.
  1. NUMERIC.tanh()
Returns the hyperbolic tangent of NUMERIC.The return type is DOUBLE.
  1. NUMERIC.cot()
Returns the cotangent of a NUMERIC.
  1. NUMERIC.asin()
Returns the arc sine of NUMERIC.
  1. NUMERIC.acos()
Returns the arc cosine of NUMERIC.
  1. NUMERIC.atan()
Returns the arc tangent of NUMERIC.
  1. atan2(NUMERIC1, NUMERIC2)
Returns the arc tangent of a coordinate (NUMERIC1, NUMERIC2).
  1. NUMERIC.cosh()
Returns the hyperbolic cosine of NUMERIC.Return value type is DOUBLE.
  1. NUMERIC.degrees()
Returns the degree representation of a radian NUMERIC.
  1. NUMERIC.radians()
Returns the radian representation of a degree NUMERIC.
  1. NUMERIC.sign()
Returns the signum of NUMERIC.
  1. NUMERIC.round(INT)
Returns a number rounded to INT decimal places for NUMERIC.
  1. pi()
Returns a value that is closer than any other values to pi.
  1. e()
Returns a value that is closer than any other values to e.
  1. rand()
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive).
  1. rand(INTEGER)
Returns a pseudorandom double value between 0.0 (inclusive) and 1.0 (exclusive) with an initial seed INTEGER. Two RAND functions will return identical sequences of numbers if they have the same initial seed.
  1. randInteger(INTEGER)
Returns a pseudorandom integer value between 0 (inclusive) and INTEGER (exclusive).
  1. randInteger(INTEGER1, INTEGER2)
Returns a pseudorandom integer value between 0 (inclusive) and INTEGER2 (exclusive) with an initial seed INTEGER1. Two randInteger functions will return identical sequences of numbers if they have same initial seed and bound.
  1. uuid()
Returns an UUID (Universally Unique Identifier) string (e.g., "3d3c68f7-f608-473f-b60c-b0c44ad4cc4e") according to RFC 4122 type 4 (pseudo randomly generated) UUID. The UUID is generated using a cryptographically strong pseudo random number generator.
  1. INTEGER.bin()
Returns a string representation of INTEGER in binary format. Returns NULL if INTEGER is NULL.E.g., 4.bin() returns "100" and 12.bin() returns "1100".
  1. NUMERIC.hex()STRING.hex()
Returns a string representation of an integer NUMERIC value or a STRING in hex format. Returns NULL if the argument is NULL.E.g. a numeric 20 leads to "14", a numeric 100 leads to "64", a string "hello,world" leads to "68656C6C6F2C776F726C64".

String Functions

String functionsDescription
  1. string1 || string2
Returns the concatenation of string1 and string2.
  1. CHARLENGTH(string)CHARACTER_LENGTH(string)
Returns the number of characters in _string.
  1. UPPER(string)
Returns string in uppercase.
  1. LOWER(string)
Returns string in lowercase.
  1. POSITION(string1 IN string2)
Returns the position (start from 1) of the first occurrence of string1 in string2; returns 0 if string1 cannot be found in string2.
  1. TRIM([ BOTH | LEADING | TRAILING ] string1 FROM string2)
Returns a string that removes leading and/or trailing characters string1 from string2. By default, whitespaces at both sides are removed.
  1. LTRIM(string)
Returns a string that removes the left whitespaces from string.E.g., LTRIM(' This is a test String.') returns "This is a test String.".
  1. RTRIM(string)
Returns a string that removes the right whitespaces from string.E.g., RTRIM('This is a test String. ') returns "This is a test String.".
  1. REPEAT(string, integer)
Returns a string that repeats the base string__integer times.E.g., REPEAT('This is a test String.', 2) returns "This is a test String.This is a test String.".
  1. REGEXPREPLACE(string1, string2, string3)
Returns a string from _string1 with all the substrings that match a regular expression string2 consecutively being replaced with string3.E.g., REGEXPREPLACE('foobar', 'oo|ar', '') returns "fb".
  1. OVERLAY(string1 PLACING string2 FROM integer1 [ FOR integer2 ])
Returns a string that replaces _integer2 (string2's length by default) characters of string1 with string2 from position integer1.E.g., OVERLAY('This is an old string' PLACING ' new' FROM 10 FOR 5) returns "This is a new string"
  1. SUBSTRING(string FROM integer1 [ FOR integer2 ])
Returns a substring of string starting from position integer1 with length integer2 (to the end by default).
  1. REPLACE(string1, string2, string3)
Returns a new string which replaces all the occurrences of string2 with string3 (non-overlapping) from string1E.g., REPLACE('hello world', 'world', 'flink') returns "hello flink"; REPLACE('ababab', 'abab', 'z') returns "zab".
  1. REGEXPEXTRACT(string1, string2[, integer])
Returns a string from _string1 which extracted with a specified regular expression string2 and a regex match group index integer.Note: The regex match group index starts from 1 and 0 means matching the whole regex. In addition, the regex match group index should not exceed the number of the defined groups.E.g. REGEXPEXTRACT('foothebar', 'foo(.*?)(bar)', 2)" returns "bar".
  1. INITCAP(string)
Returns a new form of _string with the first character of each word converted to uppercase and the rest characters to lowercase. Here a word means a sequences of alphanumeric characters.
  1. CONCAT(string1, string2,…)
Returns a string that concatenates string1, string2, …. Returns NULL if any argument is NULL.E.g., CONCAT('AA', 'BB', 'CC') returns "AABBCC".
  1. CONCATWS(string1, string2, string3,…)
Returns a string that concatenates _string2, string3, … with a separator string1. The separator is added between the strings to be concatenated. Returns NULL If string1 is NULL. Compared with CONCAT(), CONCATWS() automatically skips NULL arguments.E.g., CONCAT_WS('~', 'AA', NULL, 'BB', '', 'CC') returns "AA~BB~~CC".
  1. LPAD(string1, integer, string2)
Returns a new string from _string1 left-padded with string2 to a length of integer characters. If the length of string1 is shorter than integer, returns string1 shortened to integer characters.E.g., LPAD('hi',4,'??') returns "??hi"; LPAD('hi',1,'??') returns "h".
  1. RPAD(string1, integer, string2)
Returns a new string from string1 right-padded with string2 to a length of integer characters. If the length of string1 is shorter than integer, returns string1 shortened to integer characters.E.g., RPAD('hi',4,'??') returns "hi??", RPAD('hi',1,'??') returns "h".
  1. FROMBASE64(string)
Returns the base64-decoded result from _string; returns NULL if string is NULL.E.g., FROMBASE64('aGVsbG8gd29ybGQ=') returns "hello world".
  1. TO_BASE64(string)
Returns the base64-encoded result from _string; returns NULL if string is NULL.E.g., TOBASE64('hello world') returns "aGVsbG8gd29ybGQ=".
  1. ASCII(string)
Returns the numeric value of the first character of _string. Returns NULL if string is NULL.Only supported in blink planner.E.g., ascii('abc') returns 97, and ascii(CAST(NULL AS VARCHAR)) returns NULL.
  1. CHR(integer)
Returns the ASCII character having the binary equivalent to integer. If integer is larger than 255, we will get the modulus of integer divided by 255 first, and returns CHR of the modulus. Returns NULL if integer is NULL.Only supported in blink planner.E.g., chr(97) returns a, chr(353) returns a, and ascii(CAST(NULL AS VARCHAR)) returns NULL.
  1. DECODE(binary, string)
Decodes the first argument into a String using the provided character set (one of 'US-ASCII', 'ISO-8859-1', 'UTF-8', 'UTF-16BE', 'UTF-16LE', 'UTF-16'). If either argument is null, the result will also be null.Only supported in blink planner.
  1. ENCODE(string1, string2)
Encodes the string1 into a BINARY using the provided string2 character set (one of 'US-ASCII', 'ISO-8859-1', 'UTF-8', 'UTF-16BE', 'UTF-16LE', 'UTF-16'). If either argument is null, the result will also be null.Only supported in blink planner.
  1. INSTR(string1, string2)
 Returns the position of the first occurrence of string2 in string1. Returns NULL if any of arguments is NULL.</p>Only supported in blink planner.
  1. LEFT(string, integer)
Returns the leftmost integer characters from the string. Returns EMPTY String if integer is negative. Returns NULL if any argument is NULL.Only supported in blink planner.
  1. RIGHT(string, integer)
Returns the rightmost integer characters from the string. Returns EMPTY String if integer is negative. Returns NULL if any argument is NULL.Only supported in blink planner.
  1. LOCATE(string1, string2[, integer])
Returns the position of the first occurrence of string1 in string2 after position integer. Returns 0 if not found. Returns NULL if any of arguments is NULL.Only supported in blink planner.
  1. PARSEURL(string1, string2[, string3])
Returns the specified part from the URL. Valid values for _string2 include 'HOST', 'PATH', 'QUERY', 'REF', 'PROTOCOL', 'AUTHORITY', 'FILE', and 'USERINFO'. Returns NULL if any of arguments is NULL.E.g., parseurl('http://facebook.com/path1/p.php?k1=v1&k2=v2#Ref1&#39;, 'HOST'), returns 'facebook.com'.Also a value of a particular key in QUERY can be extracted by providing the key as the third argument _string3.E.g., parseurl('http://facebook.com/path1/p.php?k1=v1&k2=v2#Ref1&#39;, 'QUERY', 'k1') returns 'v1'.Only supported in blink planner.
  1. REGEXP(string1, string2)
Returns TRUE if any (possibly empty) substring of _string1 matches the Java regular expression string2, otherwise FALSE. Returns NULL if any of arguments is NULL.Only supported in blink planner.
  1. REVERSE(string)
Returns the reversed string. Returns NULL if string is NULL.Only supported in blink planner.
  1. SPLITINDEX(string1, string2, integer1)
Splits _string1 by the delimiter string2, returns the integer_th (zero-based) string of the split strings. Returns NULL if _integer is negative. Returns NULL if any of arguments is NULL.Only supported in blink planner.
  1. STRTO_MAP(string1[, string2, string3]])
Returns a map after splitting the _string1 into key/value pairs using delimiters. string2 is the pair delimiter, default is ','. And string3 is the key-value delimiter, default is '='.Only supported in blink planner.
  1. SUBSTR(string[, integer1[, integer2]])
Returns a substring of string starting from position integer1 with length integer2 (to the end by default).Only supported in blink planner.
String functionsDescription
  1. STRING1 + STRING2
Returns the concatenation of STRING1 and STRING2.
  1. STRING.charLength()
Returns the number of characters in STRING.
  1. STRING.upperCase()
Returns STRING in uppercase.
  1. STRING.lowerCase()
Returns STRING in lowercase.
  1. STRING1.position(STRING2)
Returns the position (start from 1) of the first occurrence of STRING1 in STRING2; returns 0 if STRING1 cannot be found in STRING2.
  1. STRING1.trim(LEADING, STRING2)STRING1.trim(TRAILING, STRING2)STRING1.trim(BOTH, STRING2)STRING1.trim(BOTH)STRING1.trim()
Returns a string that removes leading and/or trailing characters STRING2 from STRING1. By default, whitespaces at both sides are removed.
  1. STRING.ltrim()
Returns a string that removes the left whitespaces from STRING.E.g., ' This is a test String.'.ltrim() returns "This is a test String.".
  1. STRING.rtrim()
Returns a string that removes the right whitespaces from STRING.E.g., 'This is a test String. '.rtrim() returns "This is a test String.".
  1. STRING.repeat(INT)
Returns a string that repeats the base STRING__INT times.E.g., 'This is a test String.'.repeat(2) returns "This is a test String.This is a test String.".
  1. STRING1.regexpReplace(STRING2, STRING3)
Returns a string from STRING1 with all the substrings that match a regular expression STRING2 consecutively being replaced with STRING3.E.g., 'foobar'.regexpReplace('oo|ar', '') returns "fb".
  1. STRING1.overlay(STRING2, INT1)STRING1.overlay(STRING2, INT1, INT2)
Returns a string that replaces INT2 (STRING2's length by default) characters of STRING1 with STRING2 from position INT1.E.g., 'xxxxxtest'.overlay('xxxx', 6) returns "xxxxxxxxx"; 'xxxxxtest'.overlay('xxxx', 6, 2) returns "xxxxxxxxxst".
  1. STRING.substring(INT1)STRING.substring(INT1, INT2)
Returns a substring of STRING starting from position INT1 with length INT2 (to the end by default).
  1. STRING1.replace(STRING2, STRING3)
Returns a new string which replaces all the occurrences of STRING2 with STRING3 (non-overlapping) from STRING1.E.g., 'hello world'.replace('world', 'flink') returns 'hello flink'; 'ababab'.replace('abab', 'z') returns 'zab'.
  1. STRING1.regexpExtract(STRING2[, INTEGER1])
Returns a string from STRING1 which extracted with a specified regular expression STRING2 and a regex match group index INTEGER1.Note: The regex match group index starts from 1 and 0 means matching the whole regex. In addition, the regex match group index should not exceed the number of the defined groups.E.g., 'foothebar'.regexpExtract('foo(.*?)(bar)', 2) returns "bar".
  1. STRING.initCap()
Returns a new form of STRING with the first character of each word converted to uppercase and the rest characters to lowercase. Here a word means a sequences of alphanumeric characters.
  1. concat(STRING1, STRING2, …)
Returns a string that concatenates STRING1, STRING2, …. Returns NULL if any argument is NULL.E.g., concat('AA', 'BB', 'CC') returns "AABBCC".
  1. concatws(STRING1, STRING2, STRING3, …)
Returns a string that concatenates _STRING2, STRING3, … with a separator STRING1. The separator is added between the strings to be concatenated. Returns NULL If STRING1 is NULL. Compared with concat(), concatws() automatically skips NULL arguments.E.g., concat_ws('~', 'AA', Null(STRING), 'BB', '', 'CC') returns "AA~BB~~CC".
  1. STRING1.lpad(INT, STRING2)
Returns a new string from _STRING1 left-padded with STRING2 to a length of INT characters. If the length of STRING1 is shorter than INT, returns STRING1 shortened to INT characters.E.g., 'hi'.lpad(4, '??') returns "??hi"; 'hi'.lpad(1, '??') returns "h".
  1. STRING1.rpad(INT, STRING2)
Returns a new string from STRING1 right-padded with STRING2 to a length of INT characters. If the length of STRING1 is shorter than INT, returns STRING1 shortened to INT characters.E.g., 'hi'.rpad(4, '??') returns "hi??"; 'hi'.rpad(1, '??') returns "h".
  1. STRING.fromBase64()
Returns the base64-decoded result from STRING; returns NULL if STRING is NULL.E.g., 'aGVsbG8gd29ybGQ='.fromBase64() returns "hello world".
  1. STRING.toBase64()
Returns the base64-encoded result from STRING; returns NULL if STRING is NULL.E.g., 'hello world'.toBase64() returns "aGVsbG8gd29ybGQ=".
String functionsDescription
  1. STRING1 + STRING2
Returns the concatenation of STRING1 and STRING2.
  1. STRING.charLength()
Returns the number of characters in STRING.
  1. STRING.upperCase()
Returns STRING in uppercase.
  1. STRING.lowerCase()
Returns STRING in lowercase.
  1. STRING1.position(STRING2)
Returns the position (start from 1) of the first occurrence of STRING1 in STRING2; returns 0 if STRING1 cannot be found in STRING2.
  1. STRING.trim(  leading = true,  trailing = true,  character = " ")
Returns a string that removes leading and/or trailing characters from STRING.
  1. STRING.ltrim()
Returns a string that removes the left whitespaces from STRING.E.g., " This is a test String.".ltrim() returns "This is a test String.".
  1. STRING.rtrim()
Returns a string that removes the right whitespaces from STRING.E.g., "This is a test String. ".rtrim() returns "This is a test String.".
  1. STRING.repeat(INT)
Returns a string that repeats the base STRING__INT times.E.g., "This is a test String.".repeat(2) returns "This is a test String.This is a test String.".
  1. STRING1.regexpReplace(STRING2, STRING3)
Returns a string from STRING1 with all the substrings that match a regular expression STRING2 consecutively being replaced with STRING3.E.g. "foobar".regexpReplace("oo|ar", "") returns "fb".
  1. STRING1.overlay(STRING2, INT1)STRING1.overlay(STRING2, INT1, INT2)
Returns a string that replaces INT2 (STRING2's length by default) characters of STRING1 with STRING2 from position INT1.E.g., "xxxxxtest".overlay("xxxx", 6) returns "xxxxxxxxx"; "xxxxxtest".overlay("xxxx", 6, 2) returns "xxxxxxxxxst".
  1. STRING.substring(INT1)STRING.substring(INT1, INT2)
Returns a substring of STRING starting from position INT1 with length INT2 (to the end by default).
  1. STRING1.replace(STRING2, STRING3)
Returns a new string which replaces all the occurrences of STRING2 with STRING3 (non-overlapping) from STRING1.E.g., "hello world".replace("world", "flink") returns "hello flink"; "ababab".replace("abab", "z") returns "zab".
  1. STRING1.regexpExtract(STRING2[, INTEGER1])
Returns a string from STRING1 which extracted with a specified regular expression STRING2 and a regex match group index INTEGER1.Note: The regex match group index starts from 1 and 0 means matching the whole regex. In addition, the regex match group index should not exceed the number of the defined groups.E.g. "foothebar".regexpExtract("foo(.*?)(bar)", 2)" returns "bar".
  1. STRING.initCap()
Returns a new form of STRING with the first character of each word converted to uppercase and the rest characters to lowercase. Here a word means a sequences of alphanumeric characters.
  1. concat(STRING1, STRING2, …)
Returns a string that concatenates STRING1, STRING2, …. Returns NULL if any argument is NULL.E.g., concat("AA", "BB", "CC") returns "AABBCC".
  1. concatws(STRING1, STRING2, STRING3, …)
Returns a string that concatenates _STRING2, STRING3, … with a separator STRING1. The separator is added between the strings to be concatenated. Returns NULL If STRING1 is NULL. Compared with concat(), concatws() automatically skips NULL arguments.E.g., concat_ws("~", "AA", Null(Types.STRING), "BB", "", "CC") returns "AA~BB~~CC".
  1. STRING1.lpad(INT, STRING2)
Returns a new string from _STRING1 left-padded with STRING2 to a length of INT characters. If the length of STRING1 is shorter than INT, returns STRING1 shortened to INT characters.E.g., "hi".lpad(4, "??") returns "??hi"; "hi".lpad(1, "??") returns "h".
  1. STRING1.rpad(INT, STRING2)
Returns a new string from STRING1 right-padded with STRING2 to a length of INT characters. If the length of STRING1 is shorter than INT, returns STRING1 shortened to INT characters.E.g., "hi".rpad(4, "??") returns "hi??"; "hi".rpad(1, "??") returns "h".
  1. STRING.fromBase64()
Returns the base64-decoded result from STRING; returns null If STRING is NULL.E.g., "aGVsbG8gd29ybGQ=".fromBase64() returns "hello world".
  1. STRING.toBase64()
Returns the base64-encoded result from STRING; returns NULL if STRING is NULL.E.g., "hello world".toBase64() returns "aGVsbG8gd29ybGQ=".

Temporal Functions

Temporal functionsDescription
  1. DATE string
Returns a SQL date parsed from string in form of "yyyy-MM-dd".
  1. TIME string
Returns a SQL time parsed from string in form of "HH:mm:ss".
  1. TIMESTAMP string
Returns a SQL timestamp parsed from string in form of "yyyy-MM-dd HH:mm:ss[.SSS]".
  1. INTERVAL string range
Parses an interval string in the form "dd hh:mm:ss.fff" for SQL intervals of milliseconds or "yyyy-mm" for SQL intervals of months. An interval range might be DAY, MINUTE, DAY TO HOUR, or DAY TO SECOND for intervals of milliseconds; YEAR or YEAR TO MONTH for intervals of months.E.g., INTERVAL '10 00:00:00.004' DAY TO SECOND, INTERVAL '10' DAY, or INTERVAL '2-10' YEAR TO MONTH return intervals.
  1. CURRENTDATE
Returns the current SQL date in the UTC time zone.
  1. CURRENT_TIME
Returns the current SQL time in the UTC time zone.
  1. CURRENT_TIMESTAMP
Returns the current SQL timestamp in the UTC time zone.
  1. LOCALTIME
Returns the current SQL time in local time zone.
  1. LOCALTIMESTAMP
Returns the current SQL timestamp in local time zone.
  1. EXTRACT(timeintervalunit FROM temporal)
Returns a long value extracted from the _timeintervalunit part of temporal.E.g., EXTRACT(DAY FROM DATE '2006-06-05') returns 5.
  1. YEAR(date)
Returns the year from SQL date date. Equivalent to EXTRACT(YEAR FROM date).E.g., YEAR(DATE '1994-09-27') returns 1994.
  1. QUARTER(date)
Returns the quarter of a year (an integer between 1 and 4) from SQL date date. Equivalent to EXTRACT(QUARTER FROM date).E.g., QUARTER(DATE '1994-09-27') returns 3.
  1. MONTH(date)
Returns the month of a year (an integer between 1 and 12) from SQL date date. Equivalent to EXTRACT(MONTH FROM date).E.g., MONTH(DATE '1994-09-27') returns 9.
  1. WEEK(date)
Returns the week of a year (an integer between 1 and 53) from SQL date date. Equivalent to EXTRACT(WEEK FROM date).E.g., WEEK(DATE '1994-09-27') returns 39.
  1. DAYOFYEAR(date)
Returns the day of a year (an integer between 1 and 366) from SQL date date. Equivalent to EXTRACT(DOY FROM date).E.g., DAYOFYEAR(DATE '1994-09-27') returns 270.
  1. DAYOFMONTH(date)
Returns the day of a month (an integer between 1 and 31) from SQL date date. Equivalent to EXTRACT(DAY FROM date).E.g., DAYOFMONTH(DATE '1994-09-27') returns 27.
  1. DAYOFWEEK(date)
Returns the day of a week (an integer between 1 and 7; Sunday = 1) from SQL date date.Equivalent to EXTRACT(DOW FROM date).E.g., DAYOFWEEK(DATE '1994-09-27') returns 3.
  1. HOUR(timestamp)
Returns the hour of a day (an integer between 0 and 23) from SQL timestamp timestamp. Equivalent to EXTRACT(HOUR FROM timestamp).E.g., HOUR(TIMESTAMP '1994-09-27 13:14:15') returns 13.
  1. MINUTE(timestamp)
Returns the minute of an hour (an integer between 0 and 59) from SQL timestamp timestamp. Equivalent to EXTRACT(MINUTE FROM timestamp).E.g., MINUTE(TIMESTAMP '1994-09-27 13:14:15') returns 14.
  1. SECOND(timestamp)
Returns the second of a minute (an integer between 0 and 59) from SQL timestamp. Equivalent to EXTRACT(SECOND FROM timestamp).E.g., SECOND(TIMESTAMP '1994-09-27 13:14:15') returns 15.
  1. FLOOR(timepoint TO timeintervalunit)
Returns a value that rounds timepoint down to the time unit timeintervalunit.E.g., FLOOR(TIME '12:44:31' TO MINUTE) returns 12:44:00.
  1. CEIL(timepoint TO timeintervalunit)
Returns a value that rounds timepoint up to the time unit timeintervalunit.E.g., CEIL(TIME '12:44:31' TO MINUTE) returns 12:45:00.
  1. (timepoint1, temporal1) OVERLAPS (timepoint2, temporal2)
Returns TRUE if two time intervals defined by (timepoint1, temporal1) and (timepoint2, temporal2) overlap. The temporal values could be either a time point or a time interval.E.g., (TIME '2:55:00', INTERVAL '1' HOUR) OVERLAPS (TIME '3:30:00', INTERVAL '2' HOUR) returns TRUE; (TIME '9:00:00', TIME '10:00:00') OVERLAPS (TIME '10:15:00', INTERVAL '3' HOUR) returns FALSE.
  1. DATEFORMAT(timestamp, string)
Attention for old planner This function has serious bugs and should not be used for now. Please implement a custom UDF instead or use EXTRACT as a workaround.For blink planner, this converts _timestamp to a value of string in the format specified by the date format string. The format string is compatible with Java's SimpleDateFormat.
  1. TIMESTAMPADD(timeintervalunit, interval, timepoint)
Returns a new time value that adds a (signed) integer interval to timepoint. The unit for interval is given by the unit argument, which should be one of the following values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, or YEAR.E.g., TIMESTAMPADD(WEEK, 1, DATE '2003-01-02') returns 2003-01-09.
  1. TIMESTAMPDIFF(timepointunit, timepoint1, timepoint2)
Returns the (signed) number of timepointunit between timepoint1 and timepoint2. The unit for the interval is given by the first argument, which should be one of the following values: SECOND, MINUTE, HOUR, DAY, MONTH, or YEAR. See also the Time Interval and Point Unit Specifiers table.E.g., TIMESTAMPDIFF(DAY, TIMESTAMP '2003-01-02 10:00:00', TIMESTAMP '2003-01-03 10:00:00') leads to 1.
  1. CONVERTTZ(string1, string2, string3)
Converts a datetime _string1 (with default ISO timestamp format 'yyyy-MM-dd HH:mm:ss') from time zone string2 to time zone string3. The format of time zone should be either an abbreviation such as "PST", a full name such as "America/LosAngeles", or a custom ID such as "GMT-8:00".E.g., CONVERT('1970-01-01 00:00:00', 'UTC', 'America/Los_Angeles') returns '1969-12-31 16:00:00'.Only supported in blink planner.
  1. FROM_UNIXTIME(numeric[, string])
Returns a representation of the _numeric argument as a value in string format (default is 'YYYY-MM-DD hh:mm:ss'). numeric is an internal timestamp value representing seconds since '1970-01-01 00:00:00' UTC, such as produced by the UNIXTIMESTAMP() function. The return value is expressed in the session time zone (specified in TableConfig).E.g., FROM_UNIXTIME(44) returns '1970-01-01 09:00:44' if in UTC time zone, but returns '1970-01-01 09:00:44' if in 'Asia/Tokyo' time zone.Only supported in blink planner.
  1. UNIX_TIMESTAMP()
Gets current Unix timestamp in seconds. This function is not deterministic.Only supported in blink planner.
  1. UNIX_TIMESTAMP(string1[, string2])
Converts date time string _string1 in format string2 (by default: yyyy-MM-dd HH:mm:ss if not specified) to Unix timestamp (in seconds), using the specified timezone in table config.Only supported in blink planner.
  1. TODATE(string1[, string2])
Converts a date string _string1 with format string2 (by default 'yyyy-MM-dd') to a date.Only supported in blink planner.
  1. TOTIMESTAMP(string1[, string2])
Converts date time string _string1 with format string2 (by default: 'yyyy-MM-dd HH:mm:ss') under the session time zone (specified by TableConfig) to a timestamp.Only supported in blink planner.
  1. NOW()
Returns the current SQL timestamp in the UTC time zone. This function is not deterministic.Only supported in blink planner.
Temporal functionsDescription
  1. STRING.toDate()
Returns a SQL date parsed from STRING in form of "yyyy-MM-dd".
  1. STRING.toTime()
Returns a SQL time parsed from STRING in form of "HH:mm:ss".
  1. STRING.toTimestamp()
Returns a SQL timestamp parsed from STRING in form of "yyyy-MM-dd HH:mm:ss[.SSS]".
  1. NUMERIC.yearNUMERIC.years
Creates an interval of months for NUMERIC years.
  1. NUMERIC.quarterNUMERIC.quarters
Creates an interval of months for NUMERIC quarters.E.g., 2.quarters returns 6.
  1. NUMERIC.monthNUMERIC.months
Creates an interval of NUMERIC months.
  1. NUMERIC.weekNUMERIC.weeks
Creates an interval of milliseconds for NUMERIC weeks.E.g., 2.weeks returns 1209600000.
  1. NUMERIC.dayNUMERIC.days
Creates an interval of milliseconds for NUMERIC days.
  1. NUMERIC.hourNUMERIC.hours
Creates an interval of milliseconds for NUMERIC hours.
  1. NUMERIC.minuteNUMERIC.minutes
Creates an interval of milliseconds for NUMERIC minutes.
  1. NUMERIC.secondNUMERIC.seconds
Creates an interval of milliseconds for NUMERIC seconds.
  1. NUMERIC.milliNUMERIC.millis
Creates an interval of NUMERIC milliseconds.
  1. currentDate()
Returns the current SQL date in the UTC time zone.
  1. currentTime()
Returns the current SQL time in the UTC time zone.
  1. currentTimestamp()
Returns the current SQL timestamp in the UTC time zone.
  1. localTime()
Returns the current SQL time in local time zone.
  1. localTimestamp()
Returns the current SQL timestamp in local time zone.
  1. TEMPORAL.extract(TIMEINTERVALUNIT)
Returns a long value extracted from the TIMEINTERVALUNIT part of temporal.E.g., '2006-06-05'.toDate.extract(DAY) returns 5; '2006-06-05'.toDate.extract(QUARTER) returns 2.
  1. TIMEPOINT.floor(TIMEINTERVALUNIT)
Returns a value that rounds TIMEPOINT down to the time unit TIMEINTERVALUNIT.E.g., '12:44:31'.toDate.floor(MINUTE) returns 12:44:00.
  1. TIMEPOINT.ceil(TIMEINTERVALUNIT)
Returns a value that rounds TIMEPOINT up to the time unit TIMEINTERVALUNIT.E.g., '12:44:31'.toTime.floor(MINUTE) returns 12:45:00.
  1. temporalOverlaps(TIMEPOINT1, TEMPORAL1, TIMEPOINT2, TEMPORAL2)
Returns TRUE if two time intervals defined by (TIMEPOINT1, TEMPORAL1) and (TIMEPOINT2, TEMPORAL2) overlap. The temporal values could be either a time point or a time interval.E.g., temporalOverlaps('2:55:00'.toTime, 1.hour, '3:30:00'.toTime, 2.hour) returns TRUE.
  1. dateFormat(TIMESTAMP, STRING)
Attention This function has serious bugs and should not be used for now. Please implement a custom UDF instead or use extract() as a workaround.
  1. timestampDiff(TIMEPOINTUNIT, TIMEPOINT1, TIMEPOINT2)
Returns the (signed) number of TIMEPOINTUNIT between TIMEPOINT1 and TIMEPOINT2. The unit for the interval is given by the first argument, which should be one of the following values: SECOND, MINUTE, HOUR, DAY, MONTH, or YEAR. See also the Time Interval and Point Unit Specifiers table.E.g., timestampDiff(DAY, '2003-01-02 10:00:00'.toTimestamp, '2003-01-03 10:00:00'.toTimestamp) leads to 1.
Temporal functionsDescription
  1. STRING.toDate
Returns a SQL date parsed from STRING in form of "yyyy-MM-dd".
  1. STRING.toTime
Returns a SQL time parsed from STRING in form of "HH:mm:ss".
  1. STRING.toTimestamp
Returns a SQL timestamp parsed from STRING in form of "yyyy-MM-dd HH:mm:ss[.SSS]".
  1. NUMERIC.yearNUMERIC.years
Creates an interval of months for NUMERIC years.
  1. NUMERIC.quarterNUMERIC.quarters
Creates an interval of months for NUMERIC quarters.E.g., 2.quarters returns 6.
  1. NUMERIC.monthNUMERIC.months
Creates an interval of NUMERIC months.
  1. NUMERIC.weekNUMERIC.weeks
Creates an interval of milliseconds for NUMERIC weeks.E.g., 2.weeks returns 1209600000.
  1. NUMERIC.dayNUMERIC.days
Creates an interval of milliseconds for NUMERIC days.
  1. NUMERIC.hourNUMERIC.hours
Creates an interval of milliseconds for NUMERIC hours.
  1. NUMERIC.minuteNUMERIC.minutes
Creates an interval of milliseconds for NUMERIC minutes.
  1. NUMERIC.secondNUMERIC.seconds
Creates an interval of milliseconds for NUMERIC seconds.
  1. NUMERIC.milliNUMERIC.millis
Creates an interval of NUMERIC milliseconds.
  1. currentDate()
Returns the current SQL date in the UTC time zone.
  1. currentTime()
Returns the current SQL time in the UTC time zone.
  1. currentTimestamp()
Returns the current SQL timestamp in the UTC time zone.
  1. localTime()
Returns the current SQL time in local time zone.
  1. localTimestamp()
Returns the current SQL timestamp in local time zone.
  1. TEMPORAL.extract(TIMEINTERVALUNIT)
Returns a long value extracted from the TIMEINTERVALUNIT part of temporal.E.g., "2006-06-05".toDate.extract(TimeIntervalUnit.DAY) returns 5; "2006-06-05".toDate.extract(QUARTER) returns 2.
  1. TIMEPOINT.floor(TIMEINTERVALUNIT)
Returns a value that rounds TIMEPOINT down to the time unit TIMEINTERVALUNIT.E.g., "12:44:31".toDate.floor(TimeIntervalUnit.MINUTE) returns 12:44:00.
  1. TIMEPOINT.ceil(TIMEINTERVALUNIT)
Returns a value that rounds TIMEPOINT up to the time unit TIMEINTERVALUNIT.E.g., "12:44:31".toTime.floor(TimeIntervalUnit.MINUTE) returns 12:45:00.
  1. temporalOverlaps(TIMEPOINT1, TEMPORAL1, TIMEPOINT2, TEMPORAL2)
Returns TRUE if two time intervals defined by (TIMEPOINT1, TEMPORAL1) and (TIMEPOINT2, TEMPORAL2) overlap. The temporal values could be either a time point or a time interval.E.g., temporalOverlaps("2:55:00".toTime, 1.hour, "3:30:00".toTime, 2.hour) returns TRUE.
  1. dateFormat(TIMESTAMP, STRING)
Attention This function has serious bugs and should not be used for now. Please implement a custom UDF instead or use extract() as a workaround.
  1. timestampDiff(TIMEPOINTUNIT, TIMEPOINT1, TIMEPOINT2)
Returns the (signed) number of TIMEPOINTUNIT between TIMEPOINT1 and TIMEPOINT2. The unit for the interval is given by the first argument, which should be one of the following values: SECOND, MINUTE, HOUR, DAY, MONTH, or YEAR. See also the Time Interval and Point Unit Specifiers table.E.g., timestampDiff(TimePointUnit.DAY, '2003-01-02 10:00:00'.toTimestamp, '2003-01-03 10:00:00'.toTimestamp) leads to 1.

Conditional Functions

Conditional functionsDescription
  1. CASE valueWHEN value11 [, value1_2 ] THEN result1[ WHEN value2_1 [, value2_2 ] THEN result2 ]*[ ELSE resultZ ]END
Returns _resultX when the first time value is contained in (valueX_1, valueX_2, …). When no value matches, returns resultZ if it is provided and returns NULL otherwise.
  1. CASEWHEN condition1 THEN result1[ WHEN condition2 THEN result2 ][ ELSE resultZ ]END
Returns resultX when the first conditionX is met. When no condition is met, returns resultZ if it is provided and returns NULL otherwise.
  1. NULLIF(value1, value2)
Returns NULL if value1 is equal to value2; returns value1 otherwise.E.g., NULLIF(5, 5) returns NULL; NULLIF(5, 0) returns 5.
  1. COALESCE(value1, value2 [, value3 ] )
Returns the first value that is not NULL from value1, value2, ….E.g., COALESCE(NULL, 5) returns 5.
  1. IF(condition, truevalue, false_value)
Returns the _true_value if condition is met, otherwise false_value.Only supported in blink planner.E.g., IF(5 > 3, 5, 3) returns 5.
  1. ISALPHA(string)
Returns true if all characters in _string are letter, otherwise false.Only supported in blink planner.
  1. ISDECIMAL(string)
Returns true if _string can be parsed to a valid numeric, otherwise false.Only supported in blink planner.
  1. ISDIGIT(string)
Returns true if all characters in _string are digit, otherwise false.Only supported in blink planner.
Conditional functionsDescription
  1. BOOLEAN.?(VALUE1, VALUE2)
Returns VALUE1 if BOOLEAN evaluates to TRUE; returns VALUE2 otherwise.E.g., (42 > 5).?('A', 'B') returns "A".
Conditional functionsDescription
  1. BOOLEAN.?(VALUE1, VALUE2)
Returns VALUE1 if BOOLEAN evaluates to TRUE; returns VALUE2 otherwise.E.g., (42 > 5).?("A", "B") returns "A".

Type Conversion Functions

Type conversion functionsDescription
  1. CAST(value AS type)
Returns a new value being cast to type type. See the supported types here.E.g., CAST('42' AS INT) returns 42; CAST(NULL AS VARCHAR) returns NULL of type VARCHAR.
Type conversion functionsDescription
  1. ANY.cast(TYPE)
Returns a new ANY being cast to type TYPE. See the supported types here.E.g., '42'.cast(INT) returns 42; Null(STRING) returns NULL of type STRING.
Type conversion functionsDescription
  1. ANY.cast(TYPE)
Returns a new ANY being cast to type TYPE. See the supported types here.E.g., "42".cast(Types.INT) returns 42; Null(Types.STRING) returns NULL of type STRING.

Collection Functions

Collection functionsDescription
  1. CARDINALITY(array)
Returns the number of elements in array.
  1. array ‘[’ integer ‘]’
Returns the element at position integer in array. The index starts from 1.
  1. ELEMENT(array)
Returns the sole element of array (whose cardinality should be one); returns NULL if array is empty. Throws an exception if array has more than one element.
  1. CARDINALITY(map)
Returns the number of entries in map.
  1. map ‘[’ value ‘]’
Returns the value specified by key value in map.
Collection functionsDescription
  1. ARRAY.cardinality()
Returns the number of elements in ARRAY.
  1. ARRAY.at(INT)
Returns the element at position INT in ARRAY. The index starts from 1.
  1. ARRAY.element()
Returns the sole element of ARRAY (whose cardinality should be one); returns NULL if ARRAY is empty. Throws an exception if ARRAY has more than one element.
  1. MAP.cardinality()
Returns the number of entries in MAP.
  1. MAP.at(ANY)
Returns the value specified by key ANY in MAP.
Collection functionsDescription
  1. ARRAY.cardinality()
Returns the number of elements in ARRAY.
  1. ARRAY.at(INT)
Returns the element at position INT in ARRAY. The index starts from 1.
  1. ARRAY.element()
Returns the sole element of ARRAY (whose cardinality should be one); returns NULL if ARRAY is empty. Throws an exception if ARRAY has more than one element.
  1. MAP.cardinality()
Returns the number of entries in MAP.
  1. MAP.at(ANY)
Returns the value specified by key ANY in MAP.

Value Construction Functions

Value construction functionsDescription
  1. ROW(value1, [, value2])(value1, [, value2])
Returns a row created from a list of values (value1, value2,…).
  1. ARRAY ‘[’ value1 [, value2 ] ‘]’
Returns an array created from a list of values (value1, value2, …).
  1. MAP ‘[’ value1, value2 [, value3, value4 ] ‘]’
Returns a map created from a list of key-value pairs ((value1, value2), (value3, value4), …).
Value constructor functionsDescription
  1. row(ANY1, ANY2, …)
Returns a row created from a list of object values (ANY1, ANY2, …). Row is composite type that can be access via value access functions.
  1. array(ANY1, ANY2, …)
Returns an array created from a list of object values (ANY1, ANY2, …).
  1. map(ANY1, ANY2, ANY3, ANY4, …)
Returns a map created from a list of key-value pairs ((ANY1, ANY2), (ANY3, ANY4), …).
  1. NUMERIC.rows
Creates a NUMERIC interval of rows (commonly used in window creation).
Value constructor functionsDescription
  1. row(ANY1, ANY2, …)
Returns a row created from a list of object values (ANY1, ANY2, …). Row is composite type that can be access via value access functions.
  1. array(ANY1, ANY2, …)
Returns an array created from a list of object values (ANY1, ANY2, …).
  1. map(ANY1, ANY2, ANY3, ANY4, …)
Returns a map created from a list of key-value pairs ((ANY1, ANY2), (ANY3, ANY4), …).
  1. NUMERIC.rows
Creates a NUMERIC interval of rows (commonly used in window creation).

Value Access Functions

Value access functionsDescription
  1. tableName.compositeType.field
Returns the value of a field from a Flink composite type (e.g., Tuple, POJO) by name.
  1. tableName.compositeType.*
Returns a flat representation of a Flink composite type (e.g., Tuple, POJO) that converts each of its direct subtype into a separate field. In most cases the fields of the flat representation are named similarly to the original fields but with a dollar separator (e.g., mypojo$mytuple$f0).
Value access functionsDescription
  1. COMPOSITE.get(STRING)COMPOSITE.get(INT)
Returns the value of a field from a Flink composite type (e.g., Tuple, POJO) by name or index.E.g., pojo.get('myField') or tuple.get(0).
  1. ANY.flatten()
Returns a flat representation of a Flink composite type (e.g., Tuple, POJO) that converts each of its direct subtype into a separate field. In most cases the fields of the flat representation are named similarly to the original fields but with a dollar separator (e.g., mypojo$mytuple$f0).
Value access functionsDescription
  1. COMPOSITE.get(STRING)COMPOSITE.get(INT)
Returns the value of a field from a Flink composite type (e.g., Tuple, POJO) by name or index.E.g., 'pojo.get("myField") or 'tuple.get(0).
  1. ANY.flatten()
Returns a flat representation of a Flink composite type (e.g., Tuple, POJO) that converts each of its direct subtype into a separate field. In most cases the fields of the flat representation are named similarly to the original fields but with a dollar separator (e.g., mypojo$mytuple$f0).

Grouping Functions

Grouping functionsDescription
  1. GROUP_ID()
Returns an integer that uniquely identifies the combination of grouping keys.
  1. GROUPING(expression1 [, expression2] )GROUPING_ID(expression1 [, expression2] )
Returns a bit vector of the given grouping expressions.
Grouping functionsDescription
Grouping functionsDescription

Hash Functions

Hash functionsDescription
  1. MD5(string)
Returns the MD5 hash of string as a string of 32 hexadecimal digits; returns NULL if string is NULL.
  1. SHA1(string)
Returns the SHA-1 hash of string as a string of 40 hexadecimal digits; returns NULL if string is NULL.
  1. SHA224(string)
Returns the SHA-224 hash of string as a string of 56 hexadecimal digits; returns NULL if string is NULL.
  1. SHA256(string)
Returns the SHA-256 hash of string as a string of 64 hexadecimal digits; returns NULL if string is NULL.
  1. SHA384(string)
Returns the SHA-384 hash of string as a string of 96 hexadecimal digits; returns NULL if string is NULL.
  1. SHA512(string)
Returns the SHA-512 hash of string as a string of 128 hexadecimal digits; returns NULL if string is NULL.
  1. SHA2(string, hashLength)
Returns the hash using the SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, or SHA-512). The first argument string is the string to be hashed and the second argument hashLength is the bit length of the result (224, 256, 384, or 512). Returns NULL if string or hashLength is NULL.
Hash functionsDescription
  1. STRING.md5()
Returns the MD5 hash of STRING as a string of 32 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha1()
Returns the SHA-1 hash of STRING as a string of 40 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha224()
Returns the SHA-224 hash of STRING as a string of 56 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha256()
Returns the SHA-256 hash of STRING as a string of 64 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha384()
Returns the SHA-384 hash of STRING as a string of 96 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha512()
Returns the SHA-512 hash of STRING as a string of 128 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha2(INT)
Returns the SHA-2 family (SHA-224, SHA-256, SHA-384, or SHA-512) hashed value specified by INT (which could be 224, 256, 384, or 512) for STRING. Returns NULL if STRING or INT is NULL.
Hash functionsDescription
  1. STRING.md5()
Returns the MD5 hash of STRING as a string of 32 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha1()
Returns the SHA-1 hash of STRING as a string of 40 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha224()
Returns the SHA-224 hash of STRING as a string of 56 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha256()
Returns the SHA-256 hash of STRING as a string of 64 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha384()
Returns the SHA-384 hash of STRING as a string of 96 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha512()
Returns the SHA-512 hash of STRING as a string of 128 hexadecimal digits; returns NULL if STRING is NULL.
  1. STRING.sha2(INT)
Returns the SHA-2 family (SHA-224, SHA-256, SHA-384, or SHA-512) hashed value specified by INT (which could be 224, 256, 384, or 512) for STRING. Returns NULL if STRING or INT is NULL.

Auxiliary Functions

Auxiliary functionsDescription
Auxiliary functionsDescription
  1. ANY.as(NAME1, NAME2, …)
Specifies a name for ANY (a field). Additional names can be specified if the expression expands to multiple fields.
Auxiliary functionsDescription
  1. ANY.as(NAME1, NAME2, …)
Specifies a name for ANY (a field). Additional names can be specified if the expression expands to multiple fields.

Aggregate Functions

The aggregate functions take an expression across all the rows as the input and return a single aggregated value as the result.

Aggregate functionsDescription
  1. COUNT([ ALL ] expression | DISTINCT expression1 [, expression2])
By default or with ALL, returns the number of input rows for which expression is not NULL. Use DISTINCT for one unique instance of each value.
  1. COUNT()COUNT(1)
Returns the number of input rows.
  1. AVG([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the average (arithmetic mean) of expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. SUM([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the sum of expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. MAX([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the maximum value of expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. MIN([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the minimum value of expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. STDDEVPOP([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the population standard deviation of _expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. STDDEVSAMP([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the sample standard deviation of _expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. VARPOP([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the population variance (square of the population standard deviation) of _expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. VARSAMP([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns the sample variance (square of the sample standard deviation) of _expression across all input rows. Use DISTINCT for one unique instance of each value.
  1. COLLECT([ ALL | DISTINCT ] expression)
By default or with keyword ALL, returns a multiset of expression across all input rows. NULL values will be ignored. Use DISTINCT for one unique instance of each value.
  1. VARIANCE([ ALL | DISTINCT ] expression)
Synonyms for VARSAMP().Only supported in blink planner.
  1. RANK()
Returns the rank of a value in a group of values. The result is one plus the number of rows preceding or equal to the current row in the ordering of the partition. The values will produce gaps in the sequence.Only supported in blink planner.
  1. DENSE_RANK()
Returns the rank of a value in a group of values. The result is one plus the previously assigned rank value. Unlike the function rank, dense_rank will not produce gaps in the ranking sequence.Only supported in blink planner.
  1. ROW_NUMBER()
Assigns a unique, sequential number to each row, starting with one, according to the ordering of rows within the window partition.ROW_NUMBER and RANK are similar. ROW_NUMBER numbers all rows sequentially (for example 1, 2, 3, 4, 5). RANK provides the same numeric value for ties (for example 1, 2, 2, 4, 5).Only supported in blink planner.
  1. LEAD(expression [, offset] [, default] )
Returns the value of _expression at the offset_th row after the current row in the window. The default value of _offset is 1 and the default value of default is NULL.Only supported in blink planner.
  1. LAG(expression [, offset] [, default])
Returns the value of expression at the offset_th row after the current row in the window. The default value of _offset is 1 and the default value of default is NULL.Only supported in blink planner.
  1. FIRSTVALUE(expression)
Returns the first value in an ordered set of values.Only supported in blink planner.
  1. LAST_VALUE(expression)
Returns the last value in an ordered set of values.Only supported in blink planner.
  1. LISTAGG(expression [, separator])
Concatenates the values of string expressions and places separator values between them. The separator is not added at the end of string. The default value of _separator is ','.Only supported in blink planner.
Aggregate functionsDescription
  1. FIELD.count
Returns the number of input rows for which FIELD is not NULL.
  1. FIELD.avg
Returns the average (arithmetic mean) of FIELD across all input rows.
  1. FIELD.sum
Returns the sum of numeric field FIELD across all input rows. If all values are NULL, returns NULL.
  1. FIELD.sum0
Returns the sum of numeric field FIELD across all input rows. If all values are NULL, returns 0.
  1. FIELD.max
Returns the maximum value of numeric field FIELD across all input rows.
  1. FIELD.min
Returns the minimum value of numeric field FIELD across all input rows.
  1. FIELD.stddevPop
Returns the population standard deviation of numeric field FIELD across all input rows.
  1. FIELD.stddevSamp
Returns the sample standard deviation of numeric field FIELD across all input rows.
  1. FIELD.varPop
Returns the population variance (square of the population standard deviation) of numeric field FIELD across all input rows.
  1. FIELD.varSamp
Returns the sample variance (square of the sample standard deviation) of numeric field FIELD across all input rows.
  1. FIELD.collect
Returns a multiset of FIELD across all input rows.
Aggregate functionsDescription
  1. FIELD.count
Returns the number of input rows for which FIELD is not NULL.
  1. FIELD.avg
Returns the average (arithmetic mean) of FIELD across all input rows.
  1. FIELD.sum
Returns the sum of numeric field FIELD across all input rows. If all values are NULL, returns NULL.
  1. FIELD.sum0
Returns the sum of numeric field FIELD across all input rows. If all values are NULL, returns 0.
  1. FIELD.max
Returns the maximum value of numeric field FIELD across all input rows.
  1. FIELD.min
Returns the minimum value of numeric field FIELD across all input rows.
  1. FIELD.stddevPop
Returns the population standard deviation of numeric field FIELD across all input rows.
  1. FIELD.stddevSamp
Returns the sample standard deviation of numeric field FIELD across all input rows.
  1. FIELD.varPop
Returns the population variance (square of the population standard deviation) of numeric field FIELD across all input rows.
  1. FIELD.varSamp
Returns the sample variance (square of the sample standard deviation) of numeric field FIELD across all input rows.
  1. FIELD.collect
Returns a multiset of FIELD across all input rows.

Time Interval and Point Unit Specifiers

The following table lists specifiers for time interval and time point units.

For Table API, please use _ for spaces (e.g., DAY_TO_HOUR).

Time Interval UnitTime Point Unit
MILLENIUM (SQL-only)
CENTURY (SQL-only)
YEARYEAR
YEAR TO MONTH
QUARTERQUARTER
MONTHMONTH
WEEKWEEK
DAYDAY
DAY TO HOUR
DAY TO MINUTE
DAY TO SECOND
HOURHOUR
HOUR TO MINUTE
HOUR TO SECOND
MINUTEMINUTE
MINUTE TO SECOND
SECONDSECOND
MILLISECOND
MICROSECOND
DOY (SQL-only)
DOW (SQL-only)
SQLTSI_YEAR (SQL-only)
SQL_TSI_QUARTER (SQL-only)
SQL_TSI_MONTH (SQL-only)
SQL_TSI_WEEK (SQL-only)
SQL_TSI_DAY (SQL-only)
SQL_TSI_HOUR (SQL-only)
SQL_TSI_MINUTE (SQL-only)
SQL_TSI_SECOND (SQL-only)_

Column Functions

The column functions are used to select or deselect table columns.

SYNTAXDESC
withColumns(…)select the specified columns
withoutColumns(…)deselect the columns specified

The detailed syntax is as follows:

  1. columnFunction:
  2.     withColumns(columnExprs)
  3.     withoutColumns(columnExprs)
  5. columnExprs:
  6.     columnExpr [, columnExpr]*
  8. columnExpr:
  9.     columnRef | columnIndex to columnIndex | columnName to columnName
  11. columnRef:
  12.     columnName(The field name that exists in the table) | columnIndex(a positive integer starting from 1)

The usage of the column function is illustrated in the following table. (Suppose we have a table with 5 columns: (a: Int, b: Long, c: String, d:String, e: String)):

ApiUsageDescription
withColumns()| 
  1. select("withColumns()") | select("") = select("a, b, c, d, e")
 all the columns
withColumns(m to n) 
  1. select("withColumns(2 to 4)") = select("b, c, d")
 columns from m to n
withColumns(m, n, k) 
  1. select("withColumns(1, 3, e)") = select("a, c, e")
 columns m, n, k
withColumns(m, n to k) 
  1. select("withColumns(1, 3 to 5)") = select("a, c, d ,e")
 mixing of the above two representation
withoutColumns(m to n) 
  1. select("withoutColumns(2 to 4)") = select("a, e")
 deselect columns from m to n
withoutColumns(m, n, k) 
  1. select("withoutColumns(1, 3, 5)") = select("b, d")
 deselect columns m, n, k
withoutColumns(m, n to k) 
  1. select("withoutColumns(1, 3 to 5)") = select("b")
 mixing of the above two representation
ApiUsageDescription
withColumns()| 
  1. select(withColumns(')) | select(') = select('a, 'b, 'c, 'd, 'e)
 all the columns
withColumns(m to n) 
  1. select(withColumns(2 to 4)) = select('b, 'c, 'd)
 columns from m to n
withColumns(m, n, k) 
  1. select(withColumns(1, 3, 'e)) = select('a, 'c, 'e)
 columns m, n, k
withColumns(m, n to k) 
  1. select(withColumns(1, 3 to 5)) = select('a, 'c, 'd, 'e)
 mixing of the above two representation
withoutColumns(m to n) 
  1. select(withoutColumns(2 to 4)) = select('a, 'e)
 deselect columns from m to n
withoutColumns(m, n, k) 
  1. select(withoutColumns(1, 3, 5)) = select('b, 'd)
 deselect columns m, n, k
withoutColumns(m, n to k) 
  1. select(withoutColumns(1, 3 to 5)) = select('b)
 mixing of the above two representation

The column functions can be used in all places where column fields are expected, such as select, groupBy, orderBy, UDFs etc. e.g.:

  1. table
  2.    .groupBy("withColumns(1 to 3)")
  3.    .select("withColumns(a to b), myUDAgg(myUDF(withColumns(5 to 20)))")
  1. table
  2.    .groupBy(withColumns(1 to 3))
  3.    .select(withColumns('a to 'b), myUDAgg(myUDF(withColumns(5 to 20))))
  1. table \
  2.     .group_by("withColumns(1 to 3)") \
  3.     .select("withColumns(a to b), myUDAgg(myUDF(withColumns(5 to 20)))")

Note Column functions are only used in Table API.