SqlFunctionUtils (flink 1.11-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.runtime.functions.SqlFunctionUtils

```
public class SqlFunctionUtils
extends Object
```
Built-in scalar runtime functions.
NOTE: Before you add functions here, check if Calcite provides it in org.apache.calcite.runtime.SqlFunctions. Furthermore, make sure to implement the function efficiently. Sometimes it makes sense to create a org.apache.flink.table.codegen.calls.CallGenerator instead to avoid massive object creation and reuse instances.

Constructor Summary

Constructors
Constructor and Description

SqlFunctionUtils()

Constructors
Constructor and Description
`SqlFunctionUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DecimalData`	`abs(DecimalData a)`
`static double`	`acos(DecimalData a)`
`static int`	`addMonths(int date, int m)`
`static long`	`addMonths(long timestamp, int m)` TODO: remove addMonths and subtractMonths if CALCITE-3881 fixed.
`static double`	`asin(DecimalData a)`
`static double`	`atan(DecimalData a)`
`static double`	`atan2(DecimalData y, DecimalData x)`
`static Byte`	`bitAnd(Byte a, Byte b)`
`static Integer`	`bitAnd(Integer a, Integer b)`
`static Long`	`bitAnd(Long a, Long b)`
`static Short`	`bitAnd(Short a, Short b)`
`static Byte`	`bitNot(Byte a)`
`static Integer`	`bitNot(Integer a)`
`static Long`	`bitNot(Long a)`
`static Short`	`bitNot(Short a)`
`static Byte`	`bitOr(Byte a, Byte b)`
`static Integer`	`bitOr(Integer a, Integer b)`
`static Long`	`bitOr(Long a, Long b)`
`static Short`	`bitOr(Short a, Short b)`
`static Byte`	`bitXor(Byte a, Byte b)`
`static Integer`	`bitXor(Integer a, Integer b)`
`static Long`	`bitXor(Long a, Long b)`
`static Short`	`bitXor(Short a, Short b)`
`static int`	`byteArrayCompare(byte[] array1, byte[] array2)` Compares two byte arrays in lexicographical order.
`static DecimalData`	`ceil(DecimalData a)`
`static String`	`chr(long chr)`
`static double`	`cos(DecimalData a)`
`static double`	`cosh(DecimalData x)`
`static double`	`cot(DecimalData a)`
`static double`	`degrees(DecimalData angrad)`
`static int`	`divideInt(int a, int b)`
`static double`	`exp(DecimalData d)`
`static DecimalData`	`floor(DecimalData a)`
`static BinaryStringData`	`fromBase64(BinaryStringData bs)`
`static BinaryStringData`	`fromBase64(byte[] bytes)`
`static String`	`hash(String algorithm, String str)` Calculate the hash value of a given string.
`static String`	`hash(String algorithm, String str, String charsetName)` Calculate the hash value of a given string.
`static Integer`	`hashCode(String str)`
`static String`	`hex(long x)` Returns the hex string of a long argument.
`static String`	`hex(String x)` Returns the hex string of a string argument.
`static int`	`instr(BinaryStringData str, BinaryStringData subString, int startPosition, int nthAppearance)`
`static boolean`	`isAlpha(Object obj)`
`static boolean`	`isDecimal(Object obj)`
`static boolean`	`isDigit(Object obj)`
`static String`	`jsonValue(String jsonString, String pathString)`
`static BinaryStringData`	`keyValue(BinaryStringData str, BinaryStringData pairSeparator, BinaryStringData kvSeparator, BinaryStringData keyName)` Parse string as key-value string and return the value matches key name.
`static double`	`log(DecimalData x)`
`static double`	`log(DecimalData base, DecimalData x)`
`static double`	`log(DecimalData base, double x)`
`static double`	`log(double x)` Returns the natural logarithm of "x".
`static double`	`log(double base, DecimalData x)`
`static double`	`log(double base, double x)` Returns the logarithm of "x" with base "base".
`static double`	`log10(DecimalData x)`
`static double`	`log10(double x)`
`static double`	`log2(DecimalData x)`
`static double`	`log2(double x)` Returns the logarithm of "a" with base 2.
`static String`	`lpad(String base, int len, String pad)` Returns the string str left-padded with the string pad to a length of len characters.
`static String`	`overlay(String s, String r, long start)`
`static String`	`overlay(String s, String r, long start, long length)`
`static String`	`parseUrl(String urlStr, String partToExtract)` Parse url and return various components of the URL.
`static String`	`parseUrl(String urlStr, String partToExtract, String key)` Parse url and return various parameter of the URL.
`static int`	`position(BinaryStringData seek, BinaryStringData s)`
`static int`	`position(BinaryStringData seek, BinaryStringData s, int from)`
`static double`	`power(DecimalData base, DecimalData exponent)`
`static double`	`power(DecimalData base, double exponent)`
`static double`	`power(double base, DecimalData exponent)`
`static double`	`radians(DecimalData angdeg)`
`static Boolean`	`regExp(String s, String regex)`
`static String`	`regexpExtract(String str, String regex)` Returns the first string extracted with a specified regular expression.
`static String`	`regexpExtract(String str, String regex, int extractIndex)` Returns a string extracted with a specified regular expression and a regex match group index.
`static String`	`regexpExtract(String str, String regex, long extractIndex)`
`static String`	`regexpReplace(String str, String regex, String replacement)` Returns a string resulting from replacing all substrings that match the regular expression with replacement.
`static String`	`repeat(String str, int repeat)` Returns a string that repeats the base string n times.
`static String`	`replace(String str, String oldStr, String replacement)` Replaces all the old strings with the replacement string.
`static String`	`rpad(String base, int len, String pad)` Returns the string str right-padded with the string pad to a length of len characters.
`static DecimalData`	`sign(DecimalData b0)`
`static double`	`sin(DecimalData a)`
`static double`	`sinh(DecimalData a)`
`static String`	`splitIndex(String str, int character, int index)` Split target string with custom separator and pick the index-th(start with 0) result.
`static String`	`splitIndex(String str, String separator, int index)` Split target string with custom separator and pick the index-th(start with 0) result.
`static BigDecimal`	`sround(BigDecimal b0)` SQL `ROUND` operator applied to BigDecimal values.
`static BigDecimal`	`sround(BigDecimal b0, int b1)` SQL `ROUND` operator applied to BigDecimal values.
`static DecimalData`	`sround(DecimalData b0)` SQL `ROUND` operator applied to DecimalData values.
`static DecimalData`	`sround(DecimalData b0, int b1)` SQL `ROUND` operator applied to DecimalData values.
`static double`	`sround(double b0)` SQL `ROUND` operator applied to double values.
`static double`	`sround(double b0, int b1)` SQL `ROUND` operator applied to double values.
`static int`	`sround(int b0)` SQL `ROUND` operator applied to int values.
`static int`	`sround(int b0, int b1)` SQL `ROUND` operator applied to int values.
`static long`	`sround(long b0)` SQL `ROUND` operator applied to long values.
`static long`	`sround(long b0, int b1)` SQL `ROUND` operator applied to long values.
`static Map<String,String>`	`strToMap(String text)` Creates a map by parsing text.
`static Map<String,String>`	`strToMap(String text, String listDelimiter, String keyValueDelimiter)` Creates a map by parsing text.
`static DecimalData`	`struncate(DecimalData b0)` SQL `TRUNCATE` operator applied to BigDecimal values.
`static DecimalData`	`struncate(DecimalData b0, int b1)`
`static float`	`struncate(float b0)` SQL `TRUNCATE` operator applied to double values.
`static float`	`struncate(float b0, int b1)`
`static String`	`subString(String str, long start)`
`static String`	`subString(String str, long start, long len)`
`static int`	`subtractMonths(int date0, int date1)`
`static int`	`subtractMonths(long t0, long t1)`
`static double`	`tan(DecimalData a)`
`static double`	`tanh(DecimalData a)` Calculates the hyperbolic tangent of a big decimal number.
`static String`	`toBase64(BinaryStringData bs)`
`static String`	`toBase64(byte[] bytes)`
`static String`	`uuid()`
`static String`	`uuid(byte[] b)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SqlFunctionUtils
```
public SqlFunctionUtils()
```

Method Detail

exp

public static double exp(DecimalData d)

power

public static double power(double base,
                           DecimalData exponent)

power

public static double power(DecimalData base,
                           DecimalData exponent)

power

public static double power(DecimalData base,
                           double exponent)

cosh

public static double cosh(DecimalData x)

acos

public static double acos(DecimalData a)

asin

public static double asin(DecimalData a)

atan

public static double atan(DecimalData a)

atan2

public static double atan2(DecimalData y,
                           DecimalData x)

sin

public static double sin(DecimalData a)

sinh

public static double sinh(DecimalData a)

cos

public static double cos(DecimalData a)

tan

public static double tan(DecimalData a)

tanh
```
public static double tanh(DecimalData a)
```
Calculates the hyperbolic tangent of a big decimal number.

cot

public static double cot(DecimalData a)

degrees

public static double degrees(DecimalData angrad)

radians

public static double radians(DecimalData angdeg)

abs

public static DecimalData abs(DecimalData a)

floor

public static DecimalData floor(DecimalData a)

ceil

public static DecimalData ceil(DecimalData a)

log
```
public static double log(double x)
```
Returns the natural logarithm of "x".

log

public static double log(DecimalData x)

log

public static double log(double base,
                         double x)

Returns the logarithm of "x" with base "base".

log

public static double log(double base,
                         DecimalData x)

log

public static double log(DecimalData base,
                         double x)

log

public static double log(DecimalData base,
                         DecimalData x)

log2
```
public static double log2(double x)
```
Returns the logarithm of "a" with base 2.

log2

public static double log2(DecimalData x)

log10
```
public static double log10(double x)
```

log10

public static double log10(DecimalData x)

lpad
```
public static String lpad(String base,
                          int len,
                          String pad)
```
Returns the string str left-padded with the string pad to a length of len characters. If str is longer than len, the return value is shortened to len characters.

rpad
```
public static String rpad(String base,
                          int len,
                          String pad)
```
Returns the string str right-padded with the string pad to a length of len characters. If str is longer than len, the return value is shortened to len characters.

repeat

public static String repeat(String str,
                            int repeat)

Returns a string that repeats the base string n times.

replace

public static String replace(String str,
                             String oldStr,
                             String replacement)

Replaces all the old strings with the replacement string.

splitIndex
```
public static String splitIndex(String str,
                                String separator,
                                int index)
```
Split target string with custom separator and pick the index-th(start with 0) result.

Parameters:

str - target string.

separator - custom separator.

index - index of the result which you want.

Returns:

the string at the index of split results.

splitIndex
```
public static String splitIndex(String str,
                                int character,
                                int index)
```
Split target string with custom separator and pick the index-th(start with 0) result.

Parameters:

str - target string.

character - int value of the separator character

index - index of the result which you want.

Returns:

the string at the index of split results.

regexpReplace

public static String regexpReplace(String str,
                                   String regex,
                                   String replacement)

Returns a string resulting from replacing all substrings that match the regular expression with replacement.

regexpExtract

public static String regexpExtract(String str,
                                   String regex,
                                   int extractIndex)

Returns a string extracted with a specified regular expression and a regex match group index.

regexpExtract

public static String regexpExtract(String str,
                                   String regex,
                                   long extractIndex)

regexpExtract

public static String regexpExtract(String str,
                                   String regex)

Returns the first string extracted with a specified regular expression.

keyValue

public static BinaryStringData keyValue(BinaryStringData str,
                                        BinaryStringData pairSeparator,
                                        BinaryStringData kvSeparator,
                                        BinaryStringData keyName)

Parse string as key-value string and return the value matches key name. example: keyvalue('k1=v1;k2=v2', ';', '=', 'k2') = 'v2' keyvalue('k1:v1,k2:v2', ',', ':', 'k3') = NULL

Parameters:: str - target string.; pairSeparator - separator between key-value tuple.; kvSeparator - separator between key and value.; keyName - name of the key whose value you want return.
Returns:: target value.

hash
```
public static String hash(String algorithm,
                          String str)
```
Calculate the hash value of a given string.

Parameters:

algorithm - message digest algorithm.

str - string to hash.

Returns:

hash value of string.

hash

public static String hash(String algorithm,
                          String str,
                          String charsetName)

Calculate the hash value of a given string.

Parameters:: algorithm - message digest algorithm.; str - string to hash.; charsetName - charset of string.
Returns:: hash value of string.

parseUrl
```
public static String parseUrl(String urlStr,
                              String partToExtract)
```
Parse url and return various components of the URL. If accept any null arguments, return null.

Parameters:

urlStr - URL string.

partToExtract - determines which components would return. accept values: HOST,PATH,QUERY,REF, PROTOCOL,FILE,AUTHORITY,USERINFO

Returns:

target value.

parseUrl
```
public static String parseUrl(String urlStr,
                              String partToExtract,
                              String key)
```
Parse url and return various parameter of the URL. If accept any null arguments, return null.

Parameters:

urlStr - URL string.

partToExtract - must be QUERY, or return null.

key - parameter name.

Returns:

target value.

divideInt

public static int divideInt(int a,
                            int b)

subString

public static String subString(String str,
                               long start,
                               long len)

subString

public static String subString(String str,
                               long start)

chr
```
public static String chr(long chr)
```

overlay

public static String overlay(String s,
                             String r,
                             long start,
                             long length)

overlay

public static String overlay(String s,
                             String r,
                             long start)

position

public static int position(BinaryStringData seek,
                           BinaryStringData s)

position

public static int position(BinaryStringData seek,
                           BinaryStringData s,
                           int from)

instr

public static int instr(BinaryStringData str,
                        BinaryStringData subString,
                        int startPosition,
                        int nthAppearance)

hex
```
public static String hex(long x)
```
Returns the hex string of a long argument.

hex
```
public static String hex(String x)
```
Returns the hex string of a string argument.

strToMap
```
public static Map<String,String> strToMap(String text)
```
Creates a map by parsing text. Split text into key-value pairs using two delimiters. The first delimiter separates pairs, and the second delimiter separates key and value. If only one parameter is given, default delimiters are used: ',' as delimiter1 and '=' as delimiter2.

Parameters:

text - the input text

Returns:

the map

strToMap
```
public static Map<String,String> strToMap(String text,
                                          String listDelimiter,
                                          String keyValueDelimiter)
```
Creates a map by parsing text. Split text into key-value pairs using two delimiters. The first delimiter separates pairs, and the second delimiter separates key and value.

Parameters:

text - the input text

listDelimiter - the delimiter to separates pairs

keyValueDelimiter - the delimiter to separates key and value

Returns:

the map

jsonValue

public static String jsonValue(String jsonString,
                               String pathString)

sround
```
public static int sround(int b0)
```
SQL ROUND operator applied to int values.

sround

public static int sround(int b0,
                         int b1)

SQL ROUND operator applied to int values.

sround
```
public static long sround(long b0)
```
SQL ROUND operator applied to long values.

sround

public static long sround(long b0,
                          int b1)

SQL ROUND operator applied to long values.

sround

public static BigDecimal sround(BigDecimal b0)

SQL ROUND operator applied to BigDecimal values.

sround

public static BigDecimal sround(BigDecimal b0,
                                int b1)

SQL ROUND operator applied to BigDecimal values.

sround
```
public static double sround(double b0)
```
SQL ROUND operator applied to double values.

sround

public static double sround(double b0,
                            int b1)

SQL ROUND operator applied to double values.

sround

public static DecimalData sround(DecimalData b0)

SQL ROUND operator applied to DecimalData values.

sround

public static DecimalData sround(DecimalData b0,
                                 int b1)

SQL ROUND operator applied to DecimalData values.

sign

public static DecimalData sign(DecimalData b0)

isDecimal

public static boolean isDecimal(Object obj)

isDigit

public static boolean isDigit(Object obj)

isAlpha

public static boolean isAlpha(Object obj)

hashCode

public static Integer hashCode(String str)

regExp

public static Boolean regExp(String s,
                             String regex)

bitAnd

public static Byte bitAnd(Byte a,
                          Byte b)

bitAnd

public static Short bitAnd(Short a,
                           Short b)

bitAnd

public static Integer bitAnd(Integer a,
                             Integer b)

bitAnd

public static Long bitAnd(Long a,
                          Long b)

bitNot
```
public static Byte bitNot(Byte a)
```

bitNot
```
public static Short bitNot(Short a)
```

bitNot

public static Integer bitNot(Integer a)

bitNot
```
public static Long bitNot(Long a)
```

bitOr

public static Byte bitOr(Byte a,
                         Byte b)

bitOr

public static Short bitOr(Short a,
                          Short b)

bitOr

public static Integer bitOr(Integer a,
                            Integer b)

bitOr

public static Long bitOr(Long a,
                         Long b)

bitXor

public static Byte bitXor(Byte a,
                          Byte b)

bitXor

public static Short bitXor(Short a,
                           Short b)

bitXor

public static Integer bitXor(Integer a,
                             Integer b)

bitXor

public static Long bitXor(Long a,
                          Long b)

toBase64

public static String toBase64(BinaryStringData bs)

toBase64

public static String toBase64(byte[] bytes)

fromBase64

public static BinaryStringData fromBase64(BinaryStringData bs)

fromBase64

public static BinaryStringData fromBase64(byte[] bytes)

uuid
```
public static String uuid()
```

uuid
```
public static String uuid(byte[] b)
```

struncate

public static DecimalData struncate(DecimalData b0)

SQL TRUNCATE operator applied to BigDecimal values.

struncate

public static DecimalData struncate(DecimalData b0,
                                    int b1)

struncate
```
public static float struncate(float b0)
```
SQL TRUNCATE operator applied to double values.

struncate

public static float struncate(float b0,
                              int b1)

addMonths
```
public static long addMonths(long timestamp,
                             int m)
```
TODO: remove addMonths and subtractMonths if CALCITE-3881 fixed. https://issues.apache.org/jira/browse/CALCITE-3881

addMonths

public static int addMonths(int date,
                            int m)

subtractMonths

public static int subtractMonths(int date0,
                                 int date1)

subtractMonths

public static int subtractMonths(long t0,
                                 long t1)

byteArrayCompare
```
public static int byteArrayCompare(byte[] array1,
                                   byte[] array2)
```
Compares two byte arrays in lexicographical order.
The result is positive if array1 is great than array2, negative if array1 is less than array2 and 0 if array1 is equal to array2.
Note: Currently, this is used in ScalarOperatorGens for comparing two fields of binary or varbinary type.

Parameters:

array1 - byte array to compare.

array2 - byte array to compare.

Returns:

an Integer indicating which one is bigger

Back to Flink Website

Class SqlFunctionUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlFunctionUtils

Method Detail

exp

power

power

power

cosh

acos

asin

atan

atan2

sin

sinh

cos

tan

tanh

cot

degrees

radians

abs

floor

ceil

log

log

log

log

log

log

log2

log2

log10

log10

lpad

rpad

repeat

replace

splitIndex

splitIndex

regexpReplace

regexpExtract

regexpExtract

regexpExtract

keyValue

hash

hash

parseUrl

parseUrl

divideInt

subString

subString

chr

overlay

overlay

position

position

instr

hex

hex

strToMap

strToMap

jsonValue

sround

sround

sround

sround

sround

sround

sround

sround

sround

sround

sign

isDecimal

isDigit