SqlFunctions (Calcite Core 1.16.0 API)

java.lang.Object
- org.apache.calcite.runtime.SqlFunctions

```
public class SqlFunctions
extends Object
```
Helper methods to implement SQL functions in generated code.
Not present: and, or, not (builtin operators are better, because they use lazy evaluation. Implementations do not check for null values; the calling code must do that.

Many of the functions do not check for null values. This is intentional. If null arguments are possible, the code-generation framework checks for nulls before calling the functions.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlFunctions.FlatProductInputType` Type of argument passed into `flatProduct(int[], boolean, org.apache.calcite.runtime.SqlFunctions.FlatProductInputType[])`.
`private static class`	`SqlFunctions.ProductComparableListEnumerator<E extends Comparable>` Enumerates over the cartesian product of the given lists, returning a comparable list for each row.

Field Summary

Fields
Modifier and Type	Field and Description
`private static Function1<Object[],Enumerable<Object[]>>`	`ARRAY_CARTESIAN_PRODUCT`
`private static DecimalFormat`	`DOUBLE_FORMAT`
`private static Function1<List<Object>,Enumerable<Object>>`	`LIST_AS_ENUMERABLE`
`private static TimeZone`	`LOCAL_TZ`
`private static ThreadLocal<Map<String,AtomicLong>>`	`THREAD_SEQUENCES` Holds, for each thread, a map from sequence name to sequence current value.

Constructor Summary

Constructors
Modifier Constructor and Description

private SqlFunctions()

Constructors
Modifier	Constructor and Description
`private`	`SqlFunctions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BigDecimal`	`abs(BigDecimal b0)` SQL `ABS` operator applied to BigDecimal values.
`static byte`	`abs(byte b0)` SQL `ABS` operator applied to byte values.
`static double`	`abs(double b0)` SQL `ABS` operator applied to double values.
`static float`	`abs(float b0)` SQL `ABS` operator applied to float values.
`static int`	`abs(int b0)` SQL `ABS` operator applied to int values.
`static long`	`abs(long b0)` SQL `ABS` operator applied to long values.
`static short`	`abs(short b0)` SQL `ABS` operator applied to short values.
`static double`	`acos(BigDecimal b0)` SQL `ACOS` operator applied to BigDecimal values.
`static double`	`acos(double b0)` SQL `ACOS` operator applied to double values.
`static double`	`acos(long b0)` SQL `ACOS` operator applied to long values.
`static int`	`addMonths(int date, int m)` Adds a given number of months to a date, represented as the number of days since the epoch.
`static long`	`addMonths(long timestamp, int m)` Adds a given number of months to a timestamp, represented as the number of milliseconds since the epoch.
`private static boolean`	`allAssignable(Class clazz, Object o0, Object o1)` Returns whether two objects can both be assigned to a given class.
`static Object[]`	`array(Object... args)`
`static Object`	`arrayItem(List list, int item)` Helper for "array element reference".
`static Object`	`arrayItemOptional(List list, int item)` As `arrayItem(java.util.List, int)` method, but allows array to be nullable.
`static List`	`arrayToList(Array a)` Converts a JDBC array to a list.
`static double`	`asin(BigDecimal b0)` SQL `ASIN` operator applied to BigDecimal values.
`static double`	`asin(double b0)` SQL `ASIN` operator applied to double values.
`static double`	`asin(long b0)` SQL `ASIN` operator applied to long values.
`static double`	`atan(BigDecimal b0)` SQL `ATAN` operator applied to BigDecimal values.
`static double`	`atan(double b0)` SQL `ATAN` operator applied to double values.
`static double`	`atan(long b0)` SQL `ATAN` operator applied to long values.
`static double`	`atan2(BigDecimal b0, BigDecimal b1)` SQL `ATAN2` operator applied to BigDecimal values.
`static double`	`atan2(double b0, double b1)` SQL `ATAN2` operator applied to double values.
`static double`	`atan2(long b0, BigDecimal b1)` SQL `ATAN2` operator applied to long/BigDecimal values.
`static double`	`atan2(long b0, long b1)` SQL `ATAN2` operator applied to long values.
`private static Object`	`cannotConvert(Object o, Class toType)`
`static BigDecimal`	`ceil(BigDecimal b0)`
`static BigDecimal`	`ceil(BigDecimal b0, BigDecimal b1)`
`static BigDecimal`	`ceil(BigDecimal b0, int b1)`
`static byte`	`ceil(byte b0, byte b1)` SQL `CEIL` operator applied to byte values.
`static double`	`ceil(double b0)`
`static float`	`ceil(float b0)`
`static int`	`ceil(int b0, BigDecimal b1)`
`static int`	`ceil(int b0, int b1)` SQL `CEIL` operator applied to int values.
`static long`	`ceil(long b0, long b1)` SQL `CEIL` operator applied to long values.
`static short`	`ceil(short b0, short b1)` SQL `CEIL` operator applied to short values.
`static int`	`charLength(String s)` SQL CHARACTER_LENGTH(string) function.
`static int`	`compare(boolean x, boolean y)` Boolean comparison.
`static org.apache.calcite.avatica.util.ByteString`	`concat(org.apache.calcite.avatica.util.ByteString s0, org.apache.calcite.avatica.util.ByteString s1)` SQL `binary \|\| binary` operator.
`static String`	`concat(String s0, String s1)` SQL `string \|\| string` operator.
`static double`	`cos(BigDecimal b0)` SQL `COS` operator applied to BigDecimal values.
`static double`	`cos(double b0)` SQL `COS` operator applied to double values.
`static double`	`cos(long b0)` SQL `COS` operator applied to long values.
`static double`	`cot(BigDecimal b0)` SQL `COT` operator applied to BigDecimal values.
`static double`	`cot(double b0)` SQL `COT` operator applied to double values.
`static double`	`cot(long b0)` SQL `COT` operator applied to long values.
`static int`	`currentDate(DataContext root)` SQL `CURRENT_DATE` function.
`static int`	`currentTime(DataContext root)` SQL `CURRENT_TIME` function.
`static long`	`currentTimestamp(DataContext root)` SQL `CURRENT_TIMESTAMP` function.
`static double`	`degrees(BigDecimal b0)` SQL `DEGREES` operator applied to BigDecimal values.
`static double`	`degrees(double b0)` SQL `DEGREES` operator applied to double values.
`static double`	`degrees(long b0)` SQL `DEGREES` operator applied to long values.
`static BigDecimal`	`divide(BigDecimal b0, BigDecimal b1)` SQL `/` operator applied to BigDecimal values.
`static int`	`divide(int b0, BigDecimal b1)`
`static Integer`	`divide(Integer b0, int b1)` SQL `/` operator applied to int values; left side may be null.
`static Integer`	`divide(Integer b0, Integer b1)` SQL `/` operator applied to nullable int values.
`static Long`	`divide(Integer b0, Long b1)` SQL `/` operator applied to nullable int and long values.
`static int`	`divide(int b0, int b1)` SQL `/` operator applied to int values.
`static Integer`	`divide(int b0, Integer b1)` SQL `/` operator applied to int values; right side may be null.
`static long`	`divide(long b0, BigDecimal b1)`
`static Long`	`divide(Long b0, Integer b1)` SQL `/` operator applied to nullable long and int values.
`static Object`	`divideAny(Object b0, Object b1)` SQL `/` operator applied to Object values (at least one operand has ANY type; either may be null).
`static Object`	`element(List list)` Support the ELEMENT function.
`static boolean`	`eq(BigDecimal b0, BigDecimal b1)` SQL `=` operator applied to BigDecimal values (neither may be null).
`static boolean`	`eq(Object b0, Object b1)` SQL `=` operator applied to Object values (including String; neither side may be null).
`static boolean`	`eqAny(Object b0, Object b1)` SQL `=` operator applied to Object values (at least one operand has ANY type; neither may be null).
`static double`	`exp(BigDecimal b0)`
`static double`	`exp(double b0)` SQL `EXP` operator applied to double values.
`static double`	`exp(long b0)`
`static Function1<Object,Enumerable<FlatLists.ComparableList<Comparable>>>`	`flatProduct(int[] fieldCounts, boolean withOrdinality, SqlFunctions.FlatProductInputType[] inputTypes)`
`static BigDecimal`	`floor(BigDecimal b0)`
`static BigDecimal`	`floor(BigDecimal b0, BigDecimal b1)`
`static BigDecimal`	`floor(BigDecimal b0, int b1)`
`static byte`	`floor(byte b0, byte b1)` SQL `FLOOR` operator applied to byte values.
`static double`	`floor(double b0)`
`static float`	`floor(float b0)`
`static int`	`floor(int b0, BigDecimal b1)`
`static int`	`floor(int b0, int b1)` SQL `FLOOR` operator applied to int values.
`static long`	`floor(long b0, long b1)` SQL `FLOOR` operator applied to long values.
`static short`	`floor(short b0, short b1)` SQL `FLOOR` operator applied to short values.
`static boolean`	`ge(BigDecimal b0, BigDecimal b1)` SQL `≥` operator applied to BigDecimal values.
`static boolean`	`ge(boolean b0, boolean b1)` SQL `≥` operator applied to boolean values.
`static boolean`	`ge(org.apache.calcite.avatica.util.ByteString b0, org.apache.calcite.avatica.util.ByteString b1)` SQL `≥` operator applied to ByteString values.
`static boolean`	`ge(String b0, String b1)` SQL `≥` operator applied to String values.
`static boolean`	`geAny(Object b0, Object b1)` SQL `≥` operator applied to Object values (at least one operand has ANY type; neither may be null).
`private static AtomicLong`	`getAtomicLong(String key)`
`static boolean`	`greater(boolean b0, boolean b1)`
`static byte`	`greater(byte b0, byte b1)`
`static char`	`greater(char b0, char b1)`
`static double`	`greater(double b0, double b1)`
`static float`	`greater(float b0, float b1)`
`static int`	`greater(int b0, int b1)`
`static long`	`greater(long b0, long b1)`
`static short`	`greater(short b0, short b1)`
`static <T extends Comparable<T>> T`	`greater(T b0, T b1)` Helper for implementing MAX.
`static <T extends Comparable<T>> T`	`greatest(T b0, T b1)` GREATEST operator.
`static boolean`	`gt(BigDecimal b0, BigDecimal b1)` SQL `>` operator applied to BigDecimal values.
`static boolean`	`gt(boolean b0, boolean b1)` SQL `>` operator applied to boolean values.
`static boolean`	`gt(org.apache.calcite.avatica.util.ByteString b0, org.apache.calcite.avatica.util.ByteString b1)` SQL `>` operator applied to ByteString values.
`static boolean`	`gt(String b0, String b1)` SQL `>` operator applied to String values.
`static boolean`	`gtAny(Object b0, Object b1)` SQL `>` operator applied to Object values (at least one operand has ANY type; neither may be null).
`static String`	`initcap(String s)` SQL INITCAP(string) function.
`static Date`	`internalToDate(int v)` Converts the internal representation of a SQL DATE (int) to the Java type used for UDF parameters (`Date`).
`static Date`	`internalToDate(Integer v)` As `internalToDate(int)` but allows nulls.
`static Time`	`internalToTime(int v)` Converts the internal representation of a SQL TIME (int) to the Java type used for UDF parameters (`Time`).
`static Time`	`internalToTime(Integer v)`
`static Timestamp`	`internalToTimestamp(long v)` Converts the internal representation of a SQL TIMESTAMP (long) to the Java type used for UDF parameters (`Timestamp`).
`static Timestamp`	`internalToTimestamp(Long v)`
`static boolean`	`isFalse(Boolean b)` NULL → FALSE, FALSE → TRUE, TRUE → FALSE.
`static boolean`	`isNotFalse(Boolean b)` NULL → TRUE, FALSE → FALSE, TRUE → TRUE.
`static boolean`	`isNotTrue(Boolean b)` NULL → TRUE, FALSE → TRUE, TRUE → FALSE.
`static boolean`	`isTrue(Boolean b)` NULL → FALSE, FALSE → FALSE, TRUE → TRUE.
`static Object`	`item(Object object, Object index)` Implements the {@code [ ...
`static Object`	`itemOptional(Object object, Object index)` As `item(java.lang.Object, java.lang.Object)` method, but allows object to be nullable.
`private static int`	`lastDay(int y, int m)`
`static boolean`	`le(BigDecimal b0, BigDecimal b1)` SQL `≤` operator applied to BigDecimal values.
`static boolean`	`le(boolean b0, boolean b1)` SQL `≤` operator applied to boolean values.
`static boolean`	`le(org.apache.calcite.avatica.util.ByteString b0, org.apache.calcite.avatica.util.ByteString b1)` SQL `≤` operator applied to ByteString values.
`static boolean`	`le(String b0, String b1)` SQL `≤` operator applied to String values.
`static boolean`	`leAny(Object b0, Object b1)` SQL `≤` operator applied to Object values (at least one operand has ANY type; neither may be null).
`static <T extends Comparable<T>> T`	`least(T b0, T b1)` LEAST operator.
`static boolean`	`lesser(boolean b0, boolean b1)`
`static byte`	`lesser(byte b0, byte b1)`
`static char`	`lesser(char b0, char b1)`
`static double`	`lesser(double b0, double b1)`
`static float`	`lesser(float b0, float b1)`
`static int`	`lesser(int b0, int b1)`
`static long`	`lesser(long b0, long b1)`
`static short`	`lesser(short b0, short b1)`
`static <T extends Comparable<T>> T`	`lesser(T b0, T b1)` Helper for implementing MIN.
`static boolean`	`like(String s, String pattern)` SQL `LIKE` function.
`static boolean`	`like(String s, String pattern, String escape)` SQL `LIKE` function with escape.
`static double`	`ln(BigDecimal d)` SQL `LN(number)` function applied to BigDecimal values.
`static double`	`ln(double d)` SQL `LN(number)` function applied to double values.
`static double`	`ln(long b0)` SQL `LN(number)` function applied to long values.
`static int`	`localTime(DataContext root)` SQL `LOCAL_TIME` function.
`static long`	`localTimestamp(DataContext root)` SQL `LOCAL_TIMESTAMP` function.
`static double`	`log10(BigDecimal d)` SQL `LOG10(number)` function applied to BigDecimal values.
`static double`	`log10(double b0)` SQL `LOG10(numeric)` operator applied to double values.
`static double`	`log10(long b0)` SQL `LOG10(number)` function applied to long values.
`static String`	`lower(String s)` SQL LOWER(string) function.
`static boolean`	`lt(BigDecimal b0, BigDecimal b1)` SQL `<` operator applied to BigDecimal values.
`static boolean`	`lt(boolean b0, boolean b1)` SQL `<` operator applied to boolean values.
`static boolean`	`lt(org.apache.calcite.avatica.util.ByteString b0, org.apache.calcite.avatica.util.ByteString b1)` SQL `<` operator applied to ByteString values.
`static boolean`	`lt(String b0, String b1)` SQL `<` operator applied to String values.
`static boolean`	`ltAny(Object b0, Object b1)` SQL `<` operator applied to Object values.
`static String`	`ltrim(String s)` SQL `LTRIM` function.
`static Object`	`mapItem(Map map, Object item)` Helper for "map element reference".
`static Object`	`mapItemOptional(Map map, Object item)` As `mapItem(java.util.Map, java.lang.Object)` method, but allows map to be nullable.
`static BigDecimal`	`minus(BigDecimal b0, BigDecimal b1)` SQL `-` operator applied to BigDecimal values.
`static Integer`	`minus(Integer b0, int b1)` SQL `-` operator applied to int values; left side may be null.
`static Integer`	`minus(Integer b0, Integer b1)` SQL `-` operator applied to nullable int values.
`static Long`	`minus(Integer b0, Long b1)` SQL `-` operator applied to nullable int and long values.
`static int`	`minus(int b0, int b1)` SQL `-` operator applied to int values.
`static Integer`	`minus(int b0, Integer b1)` SQL `-` operator applied to int values; right side may be null.
`static Long`	`minus(Long b0, Integer b1)` SQL `-` operator applied to nullable long and int values.
`static Object`	`minusAny(Object b0, Object b1)` SQL `-` operator applied to Object values (at least one operand has ANY type; either may be null).
`static BigDecimal`	`mod(BigDecimal b0, BigDecimal b1)`
`static BigDecimal`	`mod(BigDecimal b0, int b1)`
`static byte`	`mod(byte b0, byte b1)` SQL `MOD` operator applied to byte values.
`static int`	`mod(int b0, BigDecimal b1)`
`static int`	`mod(int b0, int b1)` SQL `MOD` operator applied to int values.
`static long`	`mod(long b0, long b1)` SQL `MOD` operator applied to long values.
`static short`	`mod(short b0, short b1)` SQL `MOD` operator applied to short values.
`static BigDecimal`	`multiply(BigDecimal b0, BigDecimal b1)` SQL `*` operator applied to BigDecimal values.
`static Integer`	`multiply(Integer b0, int b1)` SQL `*` operator applied to int values; left side may be null.
`static Integer`	`multiply(Integer b0, Integer b1)` SQL `*` operator applied to nullable int values.
`static Long`	`multiply(Integer b0, Long b1)` SQL `*` operator applied to nullable int and long values.
`static int`	`multiply(int b0, int b1)` SQL `*` operator applied to int values.
`static Integer`	`multiply(int b0, Integer b1)` SQL `*` operator applied to int values; right side may be null.
`static Long`	`multiply(Long b0, Integer b1)` SQL `*` operator applied to nullable long and int values.
`static Object`	`multiplyAny(Object b0, Object b1)` SQL `*` operator applied to Object values (at least one operand has ANY type; either may be null).
`static boolean`	`ne(BigDecimal b0, BigDecimal b1)` SQL `<gt;` operator applied to BigDecimal values.
`static boolean`	`ne(Object b0, Object b1)` SQL `<gt;` operator applied to Object values (including String; neither side may be null).
`static boolean`	`neAny(Object b0, Object b1)` SQL `<gt;` operator applied to Object values (at least one operand has ANY type, including String; neither may be null).
`static Boolean`	`not(Boolean b)` NULL → NULL, FALSE → TRUE, TRUE → FALSE.
`private static IllegalArgumentException`	`notArithmetic(String op, Object b0, Object b1)`
`private static IllegalArgumentException`	`notComparable(String op, Object b0, Object b1)`
`static org.apache.calcite.avatica.util.ByteString`	`overlay(org.apache.calcite.avatica.util.ByteString s, org.apache.calcite.avatica.util.ByteString r, int start)` SQL `OVERLAY` function applied to binary strings.
`static org.apache.calcite.avatica.util.ByteString`	`overlay(org.apache.calcite.avatica.util.ByteString s, org.apache.calcite.avatica.util.ByteString r, int start, int length)` SQL `OVERLAY` function applied to binary strings.
`static String`	`overlay(String s, String r, int start)` SQL `OVERLAY` function.
`static String`	`overlay(String s, String r, int start, int length)` SQL `OVERLAY` function.
`private static Enumerable<FlatLists.ComparableList<Comparable>>`	`p2(Object[] lists, int[] fieldCounts, boolean withOrdinality, SqlFunctions.FlatProductInputType[] inputTypes)`
`static BigDecimal`	`plus(BigDecimal b0, BigDecimal b1)` SQL `+` operator applied to BigDecimal values.
`static Integer`	`plus(Integer b0, int b1)` SQL `+` operator applied to int values; left side may be null.
`static Integer`	`plus(Integer b0, Integer b1)` SQL `+` operator applied to nullable int values.
`static Long`	`plus(Integer b0, Long b1)` SQL `+` operator applied to nullable int and long values.
`static int`	`plus(int b0, int b1)` SQL `+` operator applied to int values.
`static Integer`	`plus(int b0, Integer b1)` SQL `+` operator applied to int values; right side may be null.
`static Long`	`plus(Long b0, Integer b1)` SQL `+` operator applied to nullable long and int values.
`static Object`	`plusAny(Object b0, Object b1)` SQL `+` operator applied to Object values (at least one operand has ANY type; either may be null).
`static int`	`position(org.apache.calcite.avatica.util.ByteString seek, org.apache.calcite.avatica.util.ByteString s)` SQL `POSITION(seek IN string)` function for byte strings.
`static int`	`position(org.apache.calcite.avatica.util.ByteString seek, org.apache.calcite.avatica.util.ByteString s, int from)` SQL `POSITION(seek IN string FROM integer)` function for byte strings.
`static int`	`position(String seek, String s)` SQL `POSITION(seek IN string)` function.
`static int`	`position(String seek, String s, int from)` SQL `POSITION(seek IN string FROM integer)` function.
`static double`	`power(BigDecimal b0, BigDecimal b1)`
`static double`	`power(double b0, BigDecimal b1)`
`static double`	`power(double b0, double b1)` SQL `POWER` operator applied to double values.
`static double`	`power(long b0, BigDecimal b1)`
`static double`	`power(long b0, long b1)`
`static <E extends Comparable> Enumerable<FlatLists.ComparableList<E>>`	`product(List<Enumerator<List<E>>> enumerators, int fieldCount, boolean withOrdinality)` Similar to `Linq4j.product(Iterable)` but each resulting list implements `FlatLists.ComparableList`.
`static double`	`radians(BigDecimal b0)` SQL `RADIANS` operator applied to BigDecimal values.
`static double`	`radians(double b0)` SQL `RADIANS` operator applied to double values.
`static double`	`radians(long b0)` SQL `RADIANS` operator applied to long values.
`static String`	`replace(String s, String search, String replacement)` SQL `REPLACE(string, search, replacement)` function.
`static int`	`round(int v, int x)` Helper for rounding.
`static long`	`round(long v, long x)` Helper for rounding.
`static org.apache.calcite.avatica.util.ByteString`	`rtrim(org.apache.calcite.avatica.util.ByteString s)` Helper for CAST.
`static String`	`rtrim(String s)` SQL `RTRIM` function applied to string.
`static long`	`sequenceCurrentValue(String key)` Support the `CURRENT VALUE OF sequence` operator.
`static long`	`sequenceNextValue(String key)` Support the `NEXT VALUE OF sequence` operator.
`static BigDecimal`	`sign(BigDecimal b0)` SQL `SIGN` operator applied to BigDecimal values.
`static double`	`sign(double b0)` SQL `SIGN` operator applied to double values.
`static int`	`sign(int b0)` SQL `SIGN` operator applied to int values.
`static long`	`sign(long b0)` SQL `SIGN` operator applied to long values.
`static boolean`	`similar(String s, String pattern)` SQL `SIMILAR` function.
`static boolean`	`similar(String s, String pattern, String escape)` SQL `SIMILAR` function with escape.
`static double`	`sin(BigDecimal b0)` SQL `SIN` operator applied to BigDecimal values.
`static double`	`sin(double b0)` SQL `SIN` operator applied to double values.
`static double`	`sin(long b0)` SQL `SIN` operator applied to long values.
`static List`	`slice(List list)` Support the SLICE function.
`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 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 BigDecimal`	`struncate(BigDecimal b0)` SQL `TRUNCATE` operator applied to BigDecimal values.
`static BigDecimal`	`struncate(BigDecimal b0, int b1)`
`static double`	`struncate(double b0)` SQL `TRUNCATE` operator applied to double values.
`static double`	`struncate(double b0, int b1)`
`static int`	`struncate(int b0)` SQL `TRUNCATE` operator applied to int values.
`static int`	`struncate(int b0, int b1)`
`static long`	`struncate(long b0)` SQL `TRUNCATE` operator applied to long values.
`static long`	`struncate(long b0, int b1)`
`static org.apache.calcite.avatica.util.ByteString`	`substring(org.apache.calcite.avatica.util.ByteString b, int from)` SQL SUBSTRING(binary FROM ...) function.
`static org.apache.calcite.avatica.util.ByteString`	`substring(org.apache.calcite.avatica.util.ByteString b, int from, int for_)` SQL SUBSTRING(binary FROM ...
`static String`	`substring(String s, int from)` SQL SUBSTRING(string FROM ...) function.
`static String`	`substring(String s, int from, int for_)` SQL SUBSTRING(string FROM ...
`static int`	`subtractMonths(int date0, int date1)` Finds the number of months between two dates, each represented as the number of days since the epoch.
`static int`	`subtractMonths(long t0, long t1)`
`static double`	`tan(BigDecimal b0)` SQL `TAN` operator applied to BigDecimal values.
`static double`	`tan(double b0)` SQL `TAN` operator applied to double values.
`static double`	`tan(long b0)` SQL `TAN` operator applied to long values.
`static int`	`timestampWithLocalTimeZoneToDate(long v, TimeZone timeZone)`
`static String`	`timestampWithLocalTimeZoneToString(long v, TimeZone timeZone)`
`static int`	`timestampWithLocalTimeZoneToTime(long v, TimeZone timeZone)`
`static long`	`timestampWithLocalTimeZoneToTimestamp(long v, TimeZone timeZone)`
`static int`	`timestampWithLocalTimeZoneToTimeWithLocalTimeZone(long v)`
`static String`	`timeWithLocalTimeZoneToString(int v, TimeZone timeZone)`
`static int`	`timeWithLocalTimeZoneToTime(int v, TimeZone timeZone)`
`static long`	`timeWithLocalTimeZoneToTimestamp(String date, int v, TimeZone timeZone)`
`static long`	`timeWithLocalTimeZoneToTimestampWithLocalTimeZone(String date, int v)`
`static TimeZone`	`timeZone(DataContext root)`
`static BigDecimal`	`toBigDecimal(Number number)`
`static BigDecimal`	`toBigDecimal(Object o)`
`static BigDecimal`	`toBigDecimal(String s)`
`static boolean`	`toBoolean(Number number)`
`static boolean`	`toBoolean(Object o)`
`static boolean`	`toBoolean(String s)` CAST(VARCHAR AS BOOLEAN).
`static byte`	`toByte(Number number)`
`static byte`	`toByte(Object o)`
`static char`	`toChar(String s)`
`static Character`	`toCharBoxed(String s)`
`static double`	`toDouble(Number number)`
`static double`	`toDouble(Object o)`
`static double`	`toDouble(String s)`
`static float`	`toFloat(Number number)`
`static float`	`toFloat(Object o)`
`static float`	`toFloat(String s)`
`static int`	`toInt(Date v)` Converts the Java type used for UDF parameters of SQL DATE type (`Date`) to internal representation (int).
`static int`	`toInt(Date v, TimeZone timeZone)`
`static int`	`toInt(Number number)`
`static int`	`toInt(Object o)`
`static int`	`toInt(String s)`
`static int`	`toInt(Time v)` Converts the Java type used for UDF parameters of SQL TIME type (`Time`) to internal representation (int).
`static Integer`	`toIntOptional(Date v)`
`static Integer`	`toIntOptional(Date v, TimeZone timeZone)`
`static Integer`	`toIntOptional(Time v)`
`static long`	`toLong(Date v)`
`static long`	`toLong(Date v, TimeZone timeZone)`
`static long`	`toLong(Number number)`
`static long`	`toLong(Object o)`
`static long`	`toLong(String s)`
`static long`	`toLong(Timestamp v)` Converts the Java type used for UDF parameters of SQL TIMESTAMP type (`Timestamp`) to internal representation (long).
`static Long`	`toLongOptional(Date v)`
`static Long`	`toLongOptional(Timestamp v, TimeZone timeZone)`
`static short`	`toShort(Number number)`
`static short`	`toShort(Object o)`
`static short`	`toShort(String s)`
`static String`	`toString(BigDecimal x)` CAST(DECIMAL AS VARCHAR).
`static String`	`toString(boolean x)` CAST(BOOLEAN AS VARCHAR).
`static String`	`toString(double x)` CAST(DOUBLE AS VARCHAR).
`static String`	`toString(float x)` CAST(FLOAT AS VARCHAR).
`static Long`	`toTimestampWithLocalTimeZone(String v)`
`static Long`	`toTimestampWithLocalTimeZone(String v, TimeZone timeZone)`
`static Integer`	`toTimeWithLocalTimeZone(String v)`
`static Integer`	`toTimeWithLocalTimeZone(String v, TimeZone timeZone)`
`static String`	`translate3(String s, String search, String replacement)` SQL `TRANSLATE(string, search_chars, replacement_chars)` function.
`private static org.apache.calcite.avatica.util.ByteString`	`trim_(org.apache.calcite.avatica.util.ByteString s, boolean left, boolean right)` SQL `TRIM` function applied to binary string.
`private static String`	`trim_(String s, boolean left, boolean right, char c)` SQL `TRIM` function.
`static String`	`trim(boolean leading, boolean trailing, String seek, String s)` SQL {@code TRIM(...
`static org.apache.calcite.avatica.util.ByteString`	`trim(org.apache.calcite.avatica.util.ByteString s)` SQL `TRIM` function applied to binary string.
`static org.apache.calcite.avatica.util.ByteString`	`truncate(org.apache.calcite.avatica.util.ByteString s, int maxLength)` Helper for CAST(...
`static int`	`truncate(int v, int x)` Helper for rounding.
`static long`	`truncate(long v, long x)` Helper for rounding.
`static String`	`truncate(String s, int maxLength)` Helper for CAST(...
`static org.apache.calcite.avatica.util.ByteString`	`truncateOrPad(org.apache.calcite.avatica.util.ByteString s, int maxLength)` Helper for CAST(...
`static String`	`truncateOrPad(String s, int maxLength)` Helper for CAST(...
`static String`	`upper(String s)` SQL UPPER(string) function.

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

Field Detail
- DOUBLE_FORMAT
```
private static final DecimalFormat DOUBLE_FORMAT
```
- LOCAL_TZ
```
private static final TimeZone LOCAL_TZ
```
- LIST_AS_ENUMERABLE
```
private static final Function1<List<Object>,Enumerable<Object>> LIST_AS_ENUMERABLE
```
- ARRAY_CARTESIAN_PRODUCT
```
private static final Function1<Object[],Enumerable<Object[]>> ARRAY_CARTESIAN_PRODUCT
```
- THREAD_SEQUENCES
```
private static final ThreadLocal<Map<String,AtomicLong>> THREAD_SEQUENCES
```
  Holds, for each thread, a map from sequence name to sequence current value.
  This is a straw man of an implementation whose main goal is to prove that sequences can be parsed, validated and planned. A real application will want persistent values for sequences, shared among threads.

Constructor Detail
- SqlFunctions
```
private SqlFunctions()
```

Method Detail

substring

public static String substring(String s,
                               int from,
                               int for_)

SQL SUBSTRING(string FROM ... FOR ...) function.

substring

public static String substring(String s,
                               int from)

SQL SUBSTRING(string FROM ...) function.

substring

public static org.apache.calcite.avatica.util.ByteString substring(org.apache.calcite.avatica.util.ByteString b,
                                                                   int from,
                                                                   int for_)

SQL SUBSTRING(binary FROM ... FOR ...) function.

substring

public static org.apache.calcite.avatica.util.ByteString substring(org.apache.calcite.avatica.util.ByteString b,
                                                                   int from)

SQL SUBSTRING(binary FROM ...) function.

upper
```
public static String upper(String s)
```
SQL UPPER(string) function.

lower
```
public static String lower(String s)
```
SQL LOWER(string) function.

initcap

public static String initcap(String s)

SQL INITCAP(string) function.

charLength
```
public static int charLength(String s)
```
SQL CHARACTER_LENGTH(string) function.

concat

public static String concat(String s0,
                            String s1)

SQL string || string operator.

concat

public static org.apache.calcite.avatica.util.ByteString concat(org.apache.calcite.avatica.util.ByteString s0,
                                                                org.apache.calcite.avatica.util.ByteString s1)

SQL binary || binary operator.

rtrim
```
public static String rtrim(String s)
```
SQL RTRIM function applied to string.

ltrim
```
public static String ltrim(String s)
```
SQL LTRIM function.

trim

public static String trim(boolean leading,
                          boolean trailing,
                          String seek,
                          String s)

SQL TRIM(... seek FROM s) function.

trim_

private static String trim_(String s,
                            boolean left,
                            boolean right,
                            char c)

SQL TRIM function.

trim

public static org.apache.calcite.avatica.util.ByteString trim(org.apache.calcite.avatica.util.ByteString s)

SQL TRIM function applied to binary string.

rtrim

public static org.apache.calcite.avatica.util.ByteString rtrim(org.apache.calcite.avatica.util.ByteString s)

Helper for CAST.

trim_

private static org.apache.calcite.avatica.util.ByteString trim_(org.apache.calcite.avatica.util.ByteString s,
                                                                boolean left,
                                                                boolean right)

SQL TRIM function applied to binary string.

overlay

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

SQL OVERLAY function.

overlay

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

SQL OVERLAY function.

overlay

public static org.apache.calcite.avatica.util.ByteString overlay(org.apache.calcite.avatica.util.ByteString s,
                                                                 org.apache.calcite.avatica.util.ByteString r,
                                                                 int start)

SQL OVERLAY function applied to binary strings.

overlay

public static org.apache.calcite.avatica.util.ByteString overlay(org.apache.calcite.avatica.util.ByteString s,
                                                                 org.apache.calcite.avatica.util.ByteString r,
                                                                 int start,
                                                                 int length)

SQL OVERLAY function applied to binary strings.

like

public static boolean like(String s,
                           String pattern)

SQL LIKE function.

like

public static boolean like(String s,
                           String pattern,
                           String escape)

SQL LIKE function with escape.

similar

public static boolean similar(String s,
                              String pattern)

SQL SIMILAR function.

similar

public static boolean similar(String s,
                              String pattern,
                              String escape)

SQL SIMILAR function with escape.

eq

public static boolean eq(BigDecimal b0,
                         BigDecimal b1)

SQL = operator applied to BigDecimal values (neither may be null).

eq

public static boolean eq(Object b0,
                         Object b1)

SQL = operator applied to Object values (including String; neither side may be null).

eqAny

public static boolean eqAny(Object b0,
                            Object b1)

SQL = operator applied to Object values (at least one operand has ANY type; neither may be null).

allAssignable

private static boolean allAssignable(Class clazz,
                                     Object o0,
                                     Object o1)

Returns whether two objects can both be assigned to a given class.

ne

public static boolean ne(BigDecimal b0,
                         BigDecimal b1)

SQL <gt; operator applied to BigDecimal values.

ne

public static boolean ne(Object b0,
                         Object b1)

SQL <gt; operator applied to Object values (including String; neither side may be null).

neAny
```
public static boolean neAny(Object b0,
                            Object b1)
```
SQL <gt; operator applied to Object values (at least one operand has ANY type, including String; neither may be null).

lt

public static boolean lt(boolean b0,
                         boolean b1)

SQL < operator applied to boolean values.

lt

public static boolean lt(String b0,
                         String b1)

SQL < operator applied to String values.

lt

public static boolean lt(org.apache.calcite.avatica.util.ByteString b0,
                         org.apache.calcite.avatica.util.ByteString b1)

SQL < operator applied to ByteString values.

lt

public static boolean lt(BigDecimal b0,
                         BigDecimal b1)

SQL < operator applied to BigDecimal values.

ltAny

public static boolean ltAny(Object b0,
                            Object b1)

SQL < operator applied to Object values.

le

public static boolean le(boolean b0,
                         boolean b1)

SQL ≤ operator applied to boolean values.

le

public static boolean le(String b0,
                         String b1)

SQL ≤ operator applied to String values.

le

public static boolean le(org.apache.calcite.avatica.util.ByteString b0,
                         org.apache.calcite.avatica.util.ByteString b1)

SQL ≤ operator applied to ByteString values.

le

public static boolean le(BigDecimal b0,
                         BigDecimal b1)

SQL ≤ operator applied to BigDecimal values.

leAny

public static boolean leAny(Object b0,
                            Object b1)

SQL ≤ operator applied to Object values (at least one operand has ANY type; neither may be null).

gt

public static boolean gt(boolean b0,
                         boolean b1)

SQL > operator applied to boolean values.

gt

public static boolean gt(String b0,
                         String b1)

SQL > operator applied to String values.

gt

public static boolean gt(org.apache.calcite.avatica.util.ByteString b0,
                         org.apache.calcite.avatica.util.ByteString b1)

SQL > operator applied to ByteString values.

gt

public static boolean gt(BigDecimal b0,
                         BigDecimal b1)

SQL > operator applied to BigDecimal values.

gtAny

public static boolean gtAny(Object b0,
                            Object b1)

SQL > operator applied to Object values (at least one operand has ANY type; neither may be null).

ge

public static boolean ge(boolean b0,
                         boolean b1)

SQL ≥ operator applied to boolean values.

ge

public static boolean ge(String b0,
                         String b1)

SQL ≥ operator applied to String values.

ge

public static boolean ge(org.apache.calcite.avatica.util.ByteString b0,
                         org.apache.calcite.avatica.util.ByteString b1)

SQL ≥ operator applied to ByteString values.

ge

public static boolean ge(BigDecimal b0,
                         BigDecimal b1)

SQL ≥ operator applied to BigDecimal values.

geAny

public static boolean geAny(Object b0,
                            Object b1)

SQL ≥ operator applied to Object values (at least one operand has ANY type; neither may be null).

plus

public static int plus(int b0,
                       int b1)

SQL + operator applied to int values.

plus

public static Integer plus(Integer b0,
                           int b1)

SQL + operator applied to int values; left side may be null.

plus

public static Integer plus(int b0,
                           Integer b1)

SQL + operator applied to int values; right side may be null.

plus

public static Integer plus(Integer b0,
                           Integer b1)

SQL + operator applied to nullable int values.

plus

public static Long plus(Long b0,
                        Integer b1)

SQL + operator applied to nullable long and int values.

plus

public static Long plus(Integer b0,
                        Long b1)

SQL + operator applied to nullable int and long values.

plus

public static BigDecimal plus(BigDecimal b0,
                              BigDecimal b1)

SQL + operator applied to BigDecimal values.

plusAny

public static Object plusAny(Object b0,
                             Object b1)

SQL + operator applied to Object values (at least one operand has ANY type; either may be null).

minus

public static int minus(int b0,
                        int b1)

SQL - operator applied to int values.

minus

public static Integer minus(Integer b0,
                            int b1)

SQL - operator applied to int values; left side may be null.

minus

public static Integer minus(int b0,
                            Integer b1)

SQL - operator applied to int values; right side may be null.

minus

public static Integer minus(Integer b0,
                            Integer b1)

SQL - operator applied to nullable int values.

minus

public static Long minus(Long b0,
                         Integer b1)

SQL - operator applied to nullable long and int values.

minus

public static Long minus(Integer b0,
                         Long b1)

SQL - operator applied to nullable int and long values.

minus

public static BigDecimal minus(BigDecimal b0,
                               BigDecimal b1)

SQL - operator applied to BigDecimal values.

minusAny

public static Object minusAny(Object b0,
                              Object b1)

SQL - operator applied to Object values (at least one operand has ANY type; either may be null).

divide

public static int divide(int b0,
                         int b1)

SQL / operator applied to int values.

divide

public static Integer divide(Integer b0,
                             int b1)

SQL / operator applied to int values; left side may be null.

divide

public static Integer divide(int b0,
                             Integer b1)

SQL / operator applied to int values; right side may be null.

divide

public static Integer divide(Integer b0,
                             Integer b1)

SQL / operator applied to nullable int values.

divide

public static Long divide(Long b0,
                          Integer b1)

SQL / operator applied to nullable long and int values.

divide

public static Long divide(Integer b0,
                          Long b1)

SQL / operator applied to nullable int and long values.

divide

public static BigDecimal divide(BigDecimal b0,
                                BigDecimal b1)

SQL / operator applied to BigDecimal values.

divideAny

public static Object divideAny(Object b0,
                               Object b1)

SQL / operator applied to Object values (at least one operand has ANY type; either may be null).

divide

public static int divide(int b0,
                         BigDecimal b1)

divide

public static long divide(long b0,
                          BigDecimal b1)

multiply

public static int multiply(int b0,
                           int b1)

SQL * operator applied to int values.

multiply

public static Integer multiply(Integer b0,
                               int b1)

SQL * operator applied to int values; left side may be null.

multiply

public static Integer multiply(int b0,
                               Integer b1)

SQL * operator applied to int values; right side may be null.

multiply

public static Integer multiply(Integer b0,
                               Integer b1)

SQL * operator applied to nullable int values.

multiply

public static Long multiply(Long b0,
                            Integer b1)

SQL * operator applied to nullable long and int values.

multiply

public static Long multiply(Integer b0,
                            Long b1)

SQL * operator applied to nullable int and long values.

multiply

public static BigDecimal multiply(BigDecimal b0,
                                  BigDecimal b1)

SQL * operator applied to BigDecimal values.

multiplyAny

public static Object multiplyAny(Object b0,
                                 Object b1)

SQL * operator applied to Object values (at least one operand has ANY type; either may be null).

notArithmetic

private static IllegalArgumentException notArithmetic(String op,
                                                      Object b0,
                                                      Object b1)

notComparable

private static IllegalArgumentException notComparable(String op,
                                                      Object b0,
                                                      Object b1)

exp
```
public static double exp(double b0)
```
SQL EXP operator applied to double values.

exp

public static double exp(BigDecimal b0)

exp
```
public static double exp(long b0)
```

power

public static double power(double b0,
                           double b1)

SQL POWER operator applied to double values.

power

public static double power(double b0,
                           BigDecimal b1)

power

public static double power(long b0,
                           long b1)

power

public static double power(BigDecimal b0,
                           BigDecimal b1)

power

public static double power(long b0,
                           BigDecimal b1)

ln
```
public static double ln(double d)
```
SQL LN(number) function applied to double values.

ln
```
public static double ln(long b0)
```
SQL LN(number) function applied to long values.

ln
```
public static double ln(BigDecimal d)
```
SQL LN(number) function applied to BigDecimal values.

log10
```
public static double log10(double b0)
```
SQL LOG10(numeric) operator applied to double values.

log10
```
public static double log10(long b0)
```
SQL LOG10(number) function applied to long values.

log10
```
public static double log10(BigDecimal d)
```
SQL LOG10(number) function applied to BigDecimal values.

mod

public static byte mod(byte b0,
                       byte b1)

SQL MOD operator applied to byte values.

mod

public static short mod(short b0,
                        short b1)

SQL MOD operator applied to short values.

mod

public static int mod(int b0,
                      int b1)

SQL MOD operator applied to int values.

mod

public static long mod(long b0,
                       long b1)

SQL MOD operator applied to long values.

mod

public static BigDecimal mod(BigDecimal b0,
                             int b1)

mod

public static int mod(int b0,
                      BigDecimal b1)

mod

public static BigDecimal mod(BigDecimal b0,
                             BigDecimal b1)

floor

public static double floor(double b0)

floor
```
public static float floor(float b0)
```

floor

public static BigDecimal floor(BigDecimal b0)

floor

public static byte floor(byte b0,
                         byte b1)

SQL FLOOR operator applied to byte values.

floor

public static short floor(short b0,
                          short b1)

SQL FLOOR operator applied to short values.

floor

public static int floor(int b0,
                        int b1)

SQL FLOOR operator applied to int values.

floor

public static long floor(long b0,
                         long b1)

SQL FLOOR operator applied to long values.

floor

public static BigDecimal floor(BigDecimal b0,
                               int b1)

floor

public static int floor(int b0,
                        BigDecimal b1)

floor

public static BigDecimal floor(BigDecimal b0,
                               BigDecimal b1)

ceil
```
public static double ceil(double b0)
```

ceil
```
public static float ceil(float b0)
```

ceil

public static BigDecimal ceil(BigDecimal b0)

ceil

public static byte ceil(byte b0,
                        byte b1)

SQL CEIL operator applied to byte values.

ceil

public static short ceil(short b0,
                         short b1)

SQL CEIL operator applied to short values.

ceil

public static int ceil(int b0,
                       int b1)

SQL CEIL operator applied to int values.

ceil

public static long ceil(long b0,
                        long b1)

SQL CEIL operator applied to long values.

ceil

public static BigDecimal ceil(BigDecimal b0,
                              int b1)

ceil

public static int ceil(int b0,
                       BigDecimal b1)

ceil

public static BigDecimal ceil(BigDecimal b0,
                              BigDecimal b1)

abs
```
public static byte abs(byte b0)
```
SQL ABS operator applied to byte values.

abs
```
public static short abs(short b0)
```
SQL ABS operator applied to short values.

abs
```
public static int abs(int b0)
```
SQL ABS operator applied to int values.

abs
```
public static long abs(long b0)
```
SQL ABS operator applied to long values.

abs
```
public static float abs(float b0)
```
SQL ABS operator applied to float values.

abs
```
public static double abs(double b0)
```
SQL ABS operator applied to double values.

abs

public static BigDecimal abs(BigDecimal b0)

SQL ABS operator applied to BigDecimal values.

acos
```
public static double acos(long b0)
```
SQL ACOS operator applied to long values.

acos
```
public static double acos(BigDecimal b0)
```
SQL ACOS operator applied to BigDecimal values.

acos
```
public static double acos(double b0)
```
SQL ACOS operator applied to double values.

asin
```
public static double asin(long b0)
```
SQL ASIN operator applied to long values.

asin
```
public static double asin(BigDecimal b0)
```
SQL ASIN operator applied to BigDecimal values.

asin
```
public static double asin(double b0)
```
SQL ASIN operator applied to double values.

atan
```
public static double atan(long b0)
```
SQL ATAN operator applied to long values.

atan
```
public static double atan(BigDecimal b0)
```
SQL ATAN operator applied to BigDecimal values.

atan
```
public static double atan(double b0)
```
SQL ATAN operator applied to double values.

atan2

public static double atan2(long b0,
                           long b1)

SQL ATAN2 operator applied to long values.

atan2

public static double atan2(long b0,
                           BigDecimal b1)

SQL ATAN2 operator applied to long/BigDecimal values.

atan2

public static double atan2(BigDecimal b0,
                           BigDecimal b1)

SQL ATAN2 operator applied to BigDecimal values.

atan2

public static double atan2(double b0,
                           double b1)

SQL ATAN2 operator applied to double values.

cos
```
public static double cos(long b0)
```
SQL COS operator applied to long values.

cos
```
public static double cos(BigDecimal b0)
```
SQL COS operator applied to BigDecimal values.

cos
```
public static double cos(double b0)
```
SQL COS operator applied to double values.

cot
```
public static double cot(long b0)
```
SQL COT operator applied to long values.

cot
```
public static double cot(BigDecimal b0)
```
SQL COT operator applied to BigDecimal values.

cot
```
public static double cot(double b0)
```
SQL COT operator applied to double values.

degrees
```
public static double degrees(long b0)
```
SQL DEGREES operator applied to long values.

degrees
```
public static double degrees(BigDecimal b0)
```
SQL DEGREES operator applied to BigDecimal values.

degrees
```
public static double degrees(double b0)
```
SQL DEGREES operator applied to double values.

radians
```
public static double radians(long b0)
```
SQL RADIANS operator applied to long values.

radians
```
public static double radians(BigDecimal b0)
```
SQL RADIANS operator applied to BigDecimal values.

radians
```
public static double radians(double b0)
```
SQL RADIANS operator applied to double values.

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.

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

struncate

public static int struncate(int b0,
                            int b1)

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

struncate

public static long struncate(long b0,
                             int b1)

struncate

public static BigDecimal struncate(BigDecimal b0)

SQL TRUNCATE operator applied to BigDecimal values.

struncate

public static BigDecimal struncate(BigDecimal b0,
                                   int b1)

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

struncate

public static double struncate(double b0,
                               int b1)

sign
```
public static int sign(int b0)
```
SQL SIGN operator applied to int values.

sign
```
public static long sign(long b0)
```
SQL SIGN operator applied to long values.

sign

public static BigDecimal sign(BigDecimal b0)

SQL SIGN operator applied to BigDecimal values.

sign
```
public static double sign(double b0)
```
SQL SIGN operator applied to double values.

sin
```
public static double sin(long b0)
```
SQL SIN operator applied to long values.

sin
```
public static double sin(BigDecimal b0)
```
SQL SIN operator applied to BigDecimal values.

sin
```
public static double sin(double b0)
```
SQL SIN operator applied to double values.

tan
```
public static double tan(long b0)
```
SQL TAN operator applied to long values.

tan
```
public static double tan(BigDecimal b0)
```
SQL TAN operator applied to BigDecimal values.

tan
```
public static double tan(double b0)
```
SQL TAN operator applied to double values.

lesser

public static <T extends Comparable<T>> T lesser(T b0,
                                                 T b1)

Helper for implementing MIN. Somewhat similar to LEAST operator.

least

public static <T extends Comparable<T>> T least(T b0,
                                                T b1)

LEAST operator.

greater

public static boolean greater(boolean b0,
                              boolean b1)

lesser

public static boolean lesser(boolean b0,
                             boolean b1)

greater

public static byte greater(byte b0,
                           byte b1)

lesser

public static byte lesser(byte b0,
                          byte b1)

greater

public static char greater(char b0,
                           char b1)

lesser

public static char lesser(char b0,
                          char b1)

greater

public static short greater(short b0,
                            short b1)

lesser

public static short lesser(short b0,
                           short b1)

greater

public static int greater(int b0,
                          int b1)

lesser

public static int lesser(int b0,
                         int b1)

greater

public static long greater(long b0,
                           long b1)

lesser

public static long lesser(long b0,
                          long b1)

greater

public static float greater(float b0,
                            float b1)

lesser

public static float lesser(float b0,
                           float b1)

greater

public static double greater(double b0,
                             double b1)

lesser

public static double lesser(double b0,
                            double b1)

greater

public static <T extends Comparable<T>> T greater(T b0,
                                                  T b1)

Helper for implementing MAX. Somewhat similar to GREATEST operator.

greatest

public static <T extends Comparable<T>> T greatest(T b0,
                                                   T b1)

GREATEST operator.

compare

public static int compare(boolean x,
                          boolean y)

Boolean comparison.

toString

public static String toString(float x)

CAST(FLOAT AS VARCHAR).

toString

public static String toString(double x)

CAST(DOUBLE AS VARCHAR).

toString

public static String toString(BigDecimal x)

CAST(DECIMAL AS VARCHAR).

toString

public static String toString(boolean x)

CAST(BOOLEAN AS VARCHAR).

cannotConvert

private static Object cannotConvert(Object o,
                                    Class toType)

toBoolean

public static boolean toBoolean(String s)

CAST(VARCHAR AS BOOLEAN).

toBoolean

public static boolean toBoolean(Number number)

toBoolean

public static boolean toBoolean(Object o)

toByte
```
public static byte toByte(Object o)
```

toByte

public static byte toByte(Number number)

toChar
```
public static char toChar(String s)
```

toCharBoxed

public static Character toCharBoxed(String s)

toShort

public static short toShort(String s)

toShort

public static short toShort(Number number)

toShort

public static short toShort(Object o)

toInt
```
public static int toInt(Date v)
```
Converts the Java type used for UDF parameters of SQL DATE type (Date) to internal representation (int).
Converse of internalToDate(int).

toInt

public static int toInt(Date v,
                        TimeZone timeZone)

toIntOptional

public static Integer toIntOptional(Date v)

toIntOptional

public static Integer toIntOptional(Date v,
                                    TimeZone timeZone)

toLong
```
public static long toLong(Date v)
```

toInt
```
public static int toInt(Time v)
```
Converts the Java type used for UDF parameters of SQL TIME type (Time) to internal representation (int).
Converse of internalToTime(int).

toIntOptional

public static Integer toIntOptional(Time v)

toInt
```
public static int toInt(String s)
```

toInt

public static int toInt(Number number)

toInt
```
public static int toInt(Object o)
```

toLong
```
public static long toLong(Timestamp v)
```
Converts the Java type used for UDF parameters of SQL TIMESTAMP type (Timestamp) to internal representation (long).
Converse of internalToTimestamp(long).

toLong

public static long toLong(Date v,
                          TimeZone timeZone)

toLongOptional

public static Long toLongOptional(Date v)

toLongOptional

public static Long toLongOptional(Timestamp v,
                                  TimeZone timeZone)

toLong
```
public static long toLong(String s)
```

toLong

public static long toLong(Number number)

toLong
```
public static long toLong(Object o)
```

toFloat

public static float toFloat(String s)

toFloat

public static float toFloat(Number number)

toFloat

public static float toFloat(Object o)

toDouble

public static double toDouble(String s)

toDouble

public static double toDouble(Number number)

toDouble

public static double toDouble(Object o)

toBigDecimal

public static BigDecimal toBigDecimal(String s)

toBigDecimal

public static BigDecimal toBigDecimal(Number number)

toBigDecimal

public static BigDecimal toBigDecimal(Object o)

internalToDate
```
public static Date internalToDate(int v)
```
Converts the internal representation of a SQL DATE (int) to the Java type used for UDF parameters (Date).

internalToDate

public static Date internalToDate(Integer v)

As internalToDate(int) but allows nulls.

internalToTime
```
public static Time internalToTime(int v)
```
Converts the internal representation of a SQL TIME (int) to the Java type used for UDF parameters (Time).

internalToTime

public static Time internalToTime(Integer v)

toTimeWithLocalTimeZone

public static Integer toTimeWithLocalTimeZone(String v)

toTimeWithLocalTimeZone

public static Integer toTimeWithLocalTimeZone(String v,
                                              TimeZone timeZone)

timeWithLocalTimeZoneToTime

public static int timeWithLocalTimeZoneToTime(int v,
                                              TimeZone timeZone)

timeWithLocalTimeZoneToTimestamp

public static long timeWithLocalTimeZoneToTimestamp(String date,
                                                    int v,
                                                    TimeZone timeZone)

timeWithLocalTimeZoneToTimestampWithLocalTimeZone

public static long timeWithLocalTimeZoneToTimestampWithLocalTimeZone(String date,
                                                                     int v)

timeWithLocalTimeZoneToString

public static String timeWithLocalTimeZoneToString(int v,
                                                   TimeZone timeZone)

internalToTimestamp
```
public static Timestamp internalToTimestamp(long v)
```
Converts the internal representation of a SQL TIMESTAMP (long) to the Java type used for UDF parameters (Timestamp).

internalToTimestamp

public static Timestamp internalToTimestamp(Long v)

timestampWithLocalTimeZoneToDate

public static int timestampWithLocalTimeZoneToDate(long v,
                                                   TimeZone timeZone)

timestampWithLocalTimeZoneToTime

public static int timestampWithLocalTimeZoneToTime(long v,
                                                   TimeZone timeZone)

timestampWithLocalTimeZoneToTimestamp

public static long timestampWithLocalTimeZoneToTimestamp(long v,
                                                         TimeZone timeZone)

timestampWithLocalTimeZoneToString

public static String timestampWithLocalTimeZoneToString(long v,
                                                        TimeZone timeZone)

timestampWithLocalTimeZoneToTimeWithLocalTimeZone

public static int timestampWithLocalTimeZoneToTimeWithLocalTimeZone(long v)

toTimestampWithLocalTimeZone

public static Long toTimestampWithLocalTimeZone(String v)

toTimestampWithLocalTimeZone

public static Long toTimestampWithLocalTimeZone(String v,
                                                TimeZone timeZone)

truncate

public static String truncate(String s,
                              int maxLength)

Helper for CAST(... AS VARCHAR(maxLength)).

truncateOrPad

public static String truncateOrPad(String s,
                                   int maxLength)

Helper for CAST(... AS CHAR(maxLength)).

truncate

public static org.apache.calcite.avatica.util.ByteString truncate(org.apache.calcite.avatica.util.ByteString s,
                                                                  int maxLength)

Helper for CAST(... AS VARBINARY(maxLength)).

truncateOrPad

public static org.apache.calcite.avatica.util.ByteString truncateOrPad(org.apache.calcite.avatica.util.ByteString s,
                                                                       int maxLength)

Helper for CAST(... AS BINARY(maxLength)).

position

public static int position(String seek,
                           String s)

SQL POSITION(seek IN string) function.

position

public static int position(org.apache.calcite.avatica.util.ByteString seek,
                           org.apache.calcite.avatica.util.ByteString s)

SQL POSITION(seek IN string) function for byte strings.

position

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

SQL POSITION(seek IN string FROM integer) function.

position

public static int position(org.apache.calcite.avatica.util.ByteString seek,
                           org.apache.calcite.avatica.util.ByteString s,
                           int from)

SQL POSITION(seek IN string FROM integer) function for byte strings.

round

public static long round(long v,
                         long x)

Helper for rounding. Truncate(12345, 1000) returns 12000.

truncate

public static long truncate(long v,
                            long x)

Helper for rounding. Truncate(12345, 1000) returns 12000.

round

public static int round(int v,
                        int x)

Helper for rounding. Truncate(12345, 1000) returns 12000.

truncate

public static int truncate(int v,
                           int x)

Helper for rounding. Truncate(12345, 1000) returns 12000.

currentTimestamp

public static long currentTimestamp(DataContext root)

SQL CURRENT_TIMESTAMP function.

currentTime

public static int currentTime(DataContext root)

SQL CURRENT_TIME function.

currentDate

public static int currentDate(DataContext root)

SQL CURRENT_DATE function.

localTimestamp

public static long localTimestamp(DataContext root)

SQL LOCAL_TIMESTAMP function.

localTime

public static int localTime(DataContext root)

SQL LOCAL_TIME function.

timeZone

public static TimeZone timeZone(DataContext root)

translate3

public static String translate3(String s,
                                String search,
                                String replacement)

SQL TRANSLATE(string, search_chars, replacement_chars) function.

replace

public static String replace(String s,
                             String search,
                             String replacement)

SQL REPLACE(string, search, replacement) function.

arrayItem
```
public static Object arrayItem(List list,
                               int item)
```
Helper for "array element reference". Caller has already ensured that array and index are not null. Index is 1-based, per SQL.

mapItem
```
public static Object mapItem(Map map,
                             Object item)
```
Helper for "map element reference". Caller has already ensured that array and index are not null. Index is 1-based, per SQL.

item

public static Object item(Object object,
                          Object index)

Implements the [ ... ] operator on an object whose type is not known until runtime.

arrayItemOptional

public static Object arrayItemOptional(List list,
                                       int item)

As arrayItem(java.util.List, int) method, but allows array to be nullable.

mapItemOptional

public static Object mapItemOptional(Map map,
                                     Object item)

As mapItem(java.util.Map, java.lang.Object) method, but allows map to be nullable.

itemOptional

public static Object itemOptional(Object object,
                                  Object index)

As item(java.lang.Object, java.lang.Object) method, but allows object to be nullable.

isTrue
```
public static boolean isTrue(Boolean b)
```
NULL → FALSE, FALSE → FALSE, TRUE → TRUE.

isFalse
```
public static boolean isFalse(Boolean b)
```
NULL → FALSE, FALSE → TRUE, TRUE → FALSE.

isNotTrue
```
public static boolean isNotTrue(Boolean b)
```
NULL → TRUE, FALSE → TRUE, TRUE → FALSE.

isNotFalse
```
public static boolean isNotFalse(Boolean b)
```
NULL → TRUE, FALSE → FALSE, TRUE → TRUE.

not
```
public static Boolean not(Boolean b)
```
NULL → NULL, FALSE → TRUE, TRUE → FALSE.

arrayToList

public static List arrayToList(Array a)

Converts a JDBC array to a list.

sequenceCurrentValue
```
public static long sequenceCurrentValue(String key)
```
Support the CURRENT VALUE OF sequence operator.

sequenceNextValue
```
public static long sequenceNextValue(String key)
```
Support the NEXT VALUE OF sequence operator.

getAtomicLong

private static AtomicLong getAtomicLong(String key)

slice
```
public static List slice(List list)
```
Support the SLICE function.

element

public static Object element(List list)

Support the ELEMENT function.

flatProduct

public static Function1<Object,Enumerable<FlatLists.ComparableList<Comparable>>> flatProduct(int[] fieldCounts,
                                                                                             boolean withOrdinality,
                                                                                             SqlFunctions.FlatProductInputType[] inputTypes)

p2

private static Enumerable<FlatLists.ComparableList<Comparable>> p2(Object[] lists,
                                                                   int[] fieldCounts,
                                                                   boolean withOrdinality,
                                                                   SqlFunctions.FlatProductInputType[] inputTypes)

array

public static Object[] array(Object... args)

product

public static <E extends Comparable> Enumerable<FlatLists.ComparableList<E>> product(List<Enumerator<List<E>>> enumerators,
                                                                                     int fieldCount,
                                                                                     boolean withOrdinality)

Similar to Linq4j.product(Iterable) but each resulting list implements FlatLists.ComparableList.

addMonths
```
public static long addMonths(long timestamp,
                             int m)
```
Adds a given number of months to a timestamp, represented as the number of milliseconds since the epoch.

addMonths
```
public static int addMonths(int date,
                            int m)
```
Adds a given number of months to a date, represented as the number of days since the epoch.

lastDay

private static int lastDay(int y,
                           int m)

subtractMonths
```
public static int subtractMonths(int date0,
                                 int date1)
```
Finds the number of months between two dates, each represented as the number of days since the epoch.

subtractMonths

public static int subtractMonths(long t0,
                                 long t1)

Class SqlFunctions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOUBLE_FORMAT

LOCAL_TZ

LIST_AS_ENUMERABLE

ARRAY_CARTESIAN_PRODUCT

THREAD_SEQUENCES

Constructor Detail

SqlFunctions

Method Detail

substring

substring

substring

substring

upper

lower

initcap

charLength

concat

concat

rtrim

ltrim

trim

trim_

trim

rtrim

trim_

overlay

overlay

overlay

overlay

like

like

similar

similar

eq

eq

eqAny

allAssignable

ne

ne

neAny

lt

lt

lt

lt

ltAny

le

le

le

le

leAny

gt

gt

gt

gt

gtAny

ge

ge

ge

ge

geAny

plus

plus

plus

plus

plus

plus

plus

plusAny

minus

minus

minus

minus

minus