SqlFunctions (Calcite Core 1.2.0-incubating 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.

Method Summary

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 Object`	`arrayItem(List list, int item)` Helper for "array element reference".
`static List`	`arrayToList(Array a)` Converts a JDBC array to a list.
`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 ByteString`	`concat(ByteString s0, ByteString s1)` SQL `binary \|\| binary` operator.
`static String`	`concat(String s0, String s1)` SQL `string \|\| string` operator.
`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 BigDecimal`	`divide(BigDecimal b0, BigDecimal b1)` SQL `/` operator applied to BigDecimal values.
`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, Integer b1)` SQL `/` operator applied to nullable long and int values.
`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 double`	`exp(double b0)` SQL `EXP` operator applied to double values.
`static double`	`exp(long b0)`
`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 long`	`floorDiv(long x, long y)` Divide, rounding towards negative infinity.
`static long`	`floorMod(long x, long y)` Modulo, always returning a non-negative result.
`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(ByteString b0, ByteString b1)` SQL ≥ operator applied to ByteString values.
`static boolean`	`ge(String b0, String b1)` SQL ≥ operator applied to String values.
`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(ByteString b0, ByteString b1)` SQL > operator applied to ByteString values.
`static boolean`	`gt(String b0, String b1)` SQL > operator applied to String values.
`static String`	`initcap(String s)` SQL INITCAP(string) function.
`static boolean`	`isNotFalse(Boolean b)` NULL → TRUE, FALSE → FALSE, TRUE → TRUE.
`static boolean`	`isTrue(Boolean b)` NULL → FALSE, FALSE → FALSE, TRUE → TRUE.
`static Object`	`item(Object object, Object index)` Implements the {@code [ ...
`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(ByteString b0, ByteString b1)` SQL ≤ operator applied to ByteString values.
`static boolean`	`le(String b0, String b1)` SQL ≤ operator applied to String values.
`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 <E> Function1<List<E>,Enumerable<E>>`	`listToEnumerable()` Returns a lambda that converts a list to an enumerable.
`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(ByteString b0, ByteString b1)` SQL < operator applied to ByteString values.
`static boolean`	`lt(String b0, String b1)` SQL < operator applied to String values.
`static String`	`ltrim(String s)` SQL `LTRIM` function.
`static Object`	`mapItem(Map map, Object item)` Helper for "map element reference".
`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 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 boolean`	`ne(BigDecimal b0, BigDecimal b1)` SQL <> operator applied to BigDecimal values.
`static boolean`	`ne(Object b0, Object b1)` SQL <> operator applied to Object values (including String; neither side may be null).
`static Boolean`	`not(Boolean b)` NULL → NULL, FALSE → TRUE, TRUE → FALSE.
`static ByteString`	`overlay(ByteString s, ByteString r, int start)` SQL `OVERLAY` function applied to binary strings.
`static ByteString`	`overlay(ByteString s, 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.
`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 int`	`position(ByteString seek, ByteString s)` SQL `POSITION(seek IN string)` function.
`static int`	`position(String seek, String s)` SQL `POSITION(seek IN string)` function.
`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 int`	`round(int v, int x)` Helper for rounding.
`static long`	`round(long v, long x)` Helper for rounding.
`static ByteString`	`rtrim(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 boolean`	`similar(String s, String pattern)` SQL `SIMILAR` function.
`static boolean`	`similar(String s, String pattern, String escape)` SQL `SIMILAR` function with escape.
`static List`	`slice(List list)` Support the SLICE function.
`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 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)`
`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)`
`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)`
`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 String`	`trim(boolean leading, boolean trailing, String seek, String s)` SQL {@code TRIM(...
`static ByteString`	`trim(ByteString s)` SQL `TRIM` function applied to binary string.
`static ByteString`	`truncate(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 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

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.

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 ByteString concat(ByteString s0,
                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

public static ByteString trim(ByteString s)

SQL TRIM function applied to binary string.

rtrim

public static ByteString rtrim(ByteString s)

Helper for CAST.

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 ByteString overlay(ByteString s,
                 ByteString r,
                 int start)

SQL OVERLAY function applied to binary strings.

overlay

public static ByteString overlay(ByteString s,
                 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(Object b0,
         Object b1)
```
SQL = operator applied to Object values (including String; neither side may be null).

eq

public static boolean eq(BigDecimal b0,
         BigDecimal b1)

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

ne
```
public static boolean ne(Object b0,
         Object b1)
```
SQL <> operator applied to Object values (including String; neither side may be null).

ne

public static boolean ne(BigDecimal b0,
         BigDecimal b1)

SQL <> operator applied to BigDecimal values.

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(ByteString b0,
         ByteString b1)

SQL < operator applied to ByteString values.

lt

public static boolean lt(BigDecimal b0,
         BigDecimal b1)

SQL < operator applied to BigDecimal 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(ByteString b0,
         ByteString b1)

SQL ≤ operator applied to ByteString values.

le

public static boolean le(BigDecimal b0,
         BigDecimal b1)

SQL ≤ operator applied to BigDecimal values.

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(ByteString b0,
         ByteString b1)

SQL > operator applied to ByteString values.

gt

public static boolean gt(BigDecimal b0,
         BigDecimal b1)

SQL > operator applied to BigDecimal values.

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(ByteString b0,
         ByteString b1)

SQL ≥ operator applied to ByteString values.

ge

public static boolean ge(BigDecimal b0,
         BigDecimal b1)

SQL ≥ operator applied to BigDecimal values.

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.

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.

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.

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.

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

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(long b0,
           long 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.

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.

floorDiv

public static long floorDiv(long x,
            long y)

Divide, rounding towards negative infinity.

floorMod

public static long floorMod(long x,
            long y)

Modulo, always returning a non-negative result.

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).

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)
```

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)
```

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)

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)

truncate

public static String truncate(String s,
              int maxLength)

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

truncate

public static ByteString truncate(ByteString s,
                  int maxLength)

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

position

public static int position(String seek,
           String s)

SQL POSITION(seek IN string) function.

position

public static int position(ByteString seek,
           ByteString s)

SQL POSITION(seek IN string) function.

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.

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.

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

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.

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

element

public static Object element(List list)

Support the ELEMENT function.

listToEnumerable

public static <E> Function1<List<E>,Enumerable<E>> listToEnumerable()

Returns a lambda that converts a list to an enumerable.

Class SqlFunctions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

substring

substring

upper

lower

initcap

charLength

concat

concat

rtrim

ltrim

trim

trim

rtrim

overlay

overlay

overlay

overlay

like

like

similar

similar

eq

eq

ne

ne

lt

lt

lt

lt

le

le

le

le

gt

gt

gt

gt

ge

ge

ge

ge

plus

plus

plus

plus

plus

plus

plus

minus

minus

minus

minus

minus

minus

minus

divide

divide

divide

divide

divide

divide

divide

multiply

multiply

multiply

multiply

multiply

multiply

multiply

exp

exp

power

power

power

ln

ln