java.lang.Object
- org.teiid.query.function.FunctionMethods

```
public final class FunctionMethods
extends Object
```
Static method hooks for most of the function library.

Field Summary

Fields
Modifier and Type Field Description

static String AT

static String SPACE_CHAR

Constructor Summary

Constructors
Constructor Description

FunctionMethods()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static double`	`abs(double x)`
`static float`	`abs(float x)`
`static int`	`abs(int x)`
`static long`	`abs(long x)`
`static Object`	`abs(BigDecimal x)`
`static Object`	`abs(BigInteger x)`
`static Object`	`acos(Number number)`
`static BinaryType`	`aes_decrypt(BinaryType dataBytes, BinaryType keyBytes)`
`static BinaryType`	`aes_encrypt(BinaryType dataBytes, BinaryType keyBytes)`
`static Object`	`array_get(Object array, int index)`
`static int`	`array_length(Object array)`
`static Integer`	`ascii(Character ch)`
`static Integer`	`ascii(String ch)`
`static Object`	`asin(Number number)`
`static Object`	`atan(Number number)`
`static Object`	`atan2(Number number1, Number number2)`
`static Object`	`bitand(int x, int y)`
`static int`	`bitnot(int x)`
`static Object`	`bitor(int x, int y)`
`static Object`	`bitxor(int x, int y)`
`static Object`	`ceiling(Number x)`
`static Object`	`chr(int intValue)`
`static Object`	`coalesce(Object value, Object value1, Object... other)`
`static Object`	`commandPayload(CommandContext context)`
`static Object`	`commandPayload(CommandContext context, String param)`
`static String`	`concat(String str1, String str2)`
`static ClobType`	`concat(CommandContext context, ClobType str1, ClobType str2)`
`static String`	`concat2(String str1, String str2)`
`static ClobType`	`concat2(CommandContext context, ClobType str1, ClobType str2)`
`static Object`	`convert(CommandContext context, Object src, String type)`
`static Object`	`cos(Number number)`
`static Object`	`cot(Number number)`
`static Object`	`current_database(CommandContext context)`
`static Time`	`current_time(CommandContext context, int precision)`
`static Timestamp`	`current_timestamp(CommandContext context, int precision)`
`static Object`	`currentDate(CommandContext context)`
`static Object`	`currentTime(CommandContext context)`
`static Object`	`currentTimestamp(CommandContext context)`
`static Object`	`dayName(Date x)`
`static Object`	`dayOfMonth(Date x)`
`static int`	`dayOfWeek(Date x)`
`static Object`	`dayOfYear(Date x)`
`static Object`	`degrees(Number number)`
`static BinaryType`	`digest(byte[] plainText, String algorithm)`
`static double`	`divide(double x, double y)`
`static float`	`divide(float x, float y)`
`static int`	`divide(int x, int y)`
`static long`	`divide(long x, long y)`
`static Object`	`divide(BigDecimal x, BigDecimal y)`
`static Object`	`divide(BigInteger x, BigInteger y)`
`static Object`	`endsWith(String sub, String str)`
`static Object`	`env(String propertyName)`
`static Object`	`env_var(String propertyName)`
`static double`	`epoch(Timestamp date)`
`static Object`	`exp(Number x)`
`static Object`	`floor(Number x)`
`static String`	`format(CommandContext context, Number number, String format)`
`static String`	`format(CommandContext context, Date date, String format)`
`static Timestamp`	`from_millis(long millis)`
`static String`	`from_unixtime(long count)`
`static Object`	`hour(Date x)`
`static Object`	`ifnull(Object value, Object ifNullValue)`
`static Object`	`initCap(String s)`
`static Object`	`insert(String string1, Integer start, Integer length, String str2)`
`static int`	`integerRangeCheck(long result)`
`static Object`	`left(String string, Integer count)`
`static String`	`leftTrim(String string)`
`static String`	`leftTrim(String string, char trimChar)`
`static Object`	`length(String str)`
`static Object`	`locate(String sub, String str)`
`static Object`	`locate(String sub, String str, Integer start)`	TODO: The treatment of negative start indexes is inconsistent here.
`static Object`	`log(Number x)`
`static Object`	`log10(Number x)`
`static Object`	`lookup(Object codeTable, Object returnElement, Object keyElement, Object keyValue)`	This function should never actually be called - it is here solely so the lookup function can be resolved properly.
`static Object`	`lowerCase(String str)`
`static ClobType`	`lowerCase(ClobType str)`
`static Object`	`lpad(String inputString, Integer padLength)`
`static Object`	`lpad(String inputString, Integer padLength, String padStr)`
`static BinaryType`	`md5(String plainText)`
`static BinaryType`	`md5(BinaryType plainText)`
`static double`	`minus(double x, double y)`
`static float`	`minus(float x, float y)`
`static int`	`minus(int x, int y)`
`static long`	`minus(long x, long y)`
`static Object`	`minus(BigDecimal x, BigDecimal y)`
`static Object`	`minus(BigInteger x, BigInteger y)`
`static Object`	`minute(Date x)`
`static double`	`mod(double x, double y)`
`static float`	`mod(float x, float y)`
`static int`	`mod(int x, int y)`
`static long`	`mod(long x, long y)`
`static Object`	`mod(BigDecimal x, BigDecimal y)`
`static Object`	`mod(BigInteger x, BigInteger y)`
`static Object`	`modifyTimeZone(Timestamp value, String originalTimezoneString, String targetTimezoneString)`
`static Object`	`modifyTimeZone(CommandContext context, Timestamp value, String targetTimezoneString)`
`static Object`	`month(Date x)`
`static Object`	`monthName(Date x)`
`static double`	`multiply(double x, double y)`
`static float`	`multiply(float x, float y)`
`static int`	`multiply(int x, int y)`
`static long`	`multiply(long x, long y)`
`static Object`	`multiply(BigDecimal x, BigDecimal y)`
`static Object`	`multiply(BigInteger x, BigInteger y)`
`static int`	`mvstatus(CommandContext context, String schemaName, String viewName)`
`static String`	`node_id()`
`static Object`	`pad(String str, Integer padLength, String padStr, boolean left)`
`static BigDecimal`	`parseBigDecimal(CommandContext context, String number, String format)`
`static Object`	`parseBigInteger(CommandContext context, String number, String format)`
`static Object`	`parseDouble(CommandContext context, String number, String format)`
`static Object`	`parseFloat(CommandContext context, String number, String format)`
`static Object`	`parseInteger(CommandContext context, String number, String format)`
`static Object`	`parseLong(CommandContext context, String number, String format)`
`static Timestamp`	`parseTimestamp(CommandContext context, String timestamp, String format)`
`static Object`	`pi()`
`static double`	`plus(double x, double y)`
`static float`	`plus(float x, float y)`
`static int`	`plus(int x, int y)`
`static long`	`plus(long x, long y)`
`static Object`	`plus(BigDecimal x, BigDecimal y)`
`static Object`	`plus(BigInteger x, BigInteger y)`
`static double`	`power(double x, double y)`
`static BigDecimal`	`power(BigDecimal x, int y)`
`static BigInteger`	`power(BigInteger x, int y)`
`static Object`	`quarter(Date date)`
`static Object`	`radians(Number number)`
`static Object`	`rand(CommandContext context)`
`static Object`	`rand(CommandContext context, Integer seed)`
`static String`	`regexpReplace(CommandContext context, CharSequence source, String regex, String replacement, String flags)`	Perform find-replace operation on a string using regular expressions.
`static String`	`regexpReplace(CommandContext context, String source, String regex, String replacement)`	Perform find-replace operation on a string using regular expressions.
`static String`	`regexpReplace(CommandContext context, String source, String regex, String replacement, String flags)`
`static ClobType`	`regexpReplace(CommandContext context, ClobType source, String regex, String replacement)`
`static ClobType`	`regexpReplace(CommandContext context, ClobType source, String regex, String replacement, String flags)`
`static Object`	`repeat(String str, Integer count)`
`static Object`	`replace(String string, String subString, String replaceString)`
`static Object`	`right(String string, Integer count)`
`static Object`	`rightTrim(String string)`
`static String`	`rightTrim(String string, char trimChar)`
`static String`	`rightTrim(String string, char trimChar, boolean newString)`
`static double`	`round(double number, int places)`
`static float`	`round(float number, int places)`
`static int`	`round(int number, int places)`
`static BigDecimal`	`round(BigDecimal bigDecimalNumber, int places)`
`static Object`	`rpad(String inputString, Integer padLength)`
`static Object`	`rpad(String inputString, Integer padLength, String padStr)`
`static Object`	`second(Date x)`
`static Object`	`session_id(CommandContext context)`
`static BinaryType`	`sha1(String plainText)`
`static BinaryType`	`sha1(BinaryType plainText)`
`static BinaryType`	`sha2_256(String plainText)`
`static BinaryType`	`sha2_256(BinaryType plainText)`
`static BinaryType`	`sha2_512(String plainText)`
`static BinaryType`	`sha2_512(BinaryType plainText)`
`static Object`	`sign(double x)`
`static Object`	`sign(float x)`
`static Object`	`sign(int x)`
`static Object`	`sign(long x)`
`static Object`	`sign(BigDecimal x)`
`static Object`	`sign(BigInteger x)`
`static Object`	`sin(Number number)`
`static Object`	`sqrt(Number x)`
`static Object`	`substring(String string, Integer start)`
`static Object`	`substring(String string, Integer startVal, Integer lengthVal)`
`static Object`	`sys_prop(String propertyName)`
`static Object`	`tan(Number number)`
`static Object`	`timestampAdd(String intervalType, int count, Timestamp timestamp)`
`static Object`	`timestampAdd(String intervalType, long count, Timestamp timestamp)`
`static Object`	`timestampCreate(Date date, Time time)`
`static Long`	`timestampDiff(String intervalType, Timestamp ts1Obj, Timestamp ts2Obj)`
`static Long`	`timestampDiff(String intervalType, Timestamp ts1Obj, Timestamp ts2Obj, boolean calendarBased)`
`static Long`	`to_millis(Timestamp date)`
`static BlobType`	`toBytes(ClobType value, String encoding)`
`static BlobType`	`toBytes(ClobType value, String encoding, boolean wellFormed)`
`static ClobType`	`toChars(BlobType value, String encoding)`
`static ClobType`	`toChars(BlobType value, String encoding, boolean wellFormed)`
`static String[]`	`tokenize(String str, char delimiter)`
`static Object`	`translate(String str, String in, String out)`
`static String`	`trim(String trimSpec, String trimChar, String string)`
`static String`	`unescape(String string)`
`static Long`	`unix_timestamp(String date)`
`static Object`	`upperCase(String str)`
`static ClobType`	`upperCase(ClobType str)`
`static Object`	`user(CommandContext context)`
`static Object`	`user(CommandContext context, boolean includeSecurityDomain)`
`static String`	`uuid()`
`static int`	`week(Date x)`
`static Object`	`year(Date x)`

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

Field Detail
- AT
```
public static final String AT
```
  See Also:
  
  Constant Field Values
- SPACE_CHAR
```
public static final String SPACE_CHAR
```
  See Also:
  
  Constant Field Values

Constructor Detail
- FunctionMethods
```
public FunctionMethods()
```

Method Detail

plus

public static int plus(int x,
                       int y)
                throws FunctionExecutionException

Throws:: FunctionExecutionException

integerRangeCheck

public static int integerRangeCheck(long result)
                             throws FunctionExecutionException

Throws:: FunctionExecutionException

plus

public static long plus(long x,
                        long y)
                 throws FunctionExecutionException

Throws:: FunctionExecutionException

plus

public static float plus(float x,
                         float y)

plus

public static double plus(double x,
                          double y)

plus

public static Object plus(BigInteger x,
                          BigInteger y)

plus

public static Object plus(BigDecimal x,
                          BigDecimal y)

minus

public static int minus(int x,
                        int y)
                 throws FunctionExecutionException

Throws:: FunctionExecutionException

minus

public static long minus(long x,
                         long y)
                  throws FunctionExecutionException

Throws:: FunctionExecutionException

minus

public static float minus(float x,
                          float y)

minus

public static double minus(double x,
                           double y)

minus

public static Object minus(BigInteger x,
                           BigInteger y)

minus

public static Object minus(BigDecimal x,
                           BigDecimal y)

multiply

public static int multiply(int x,
                           int y)
                    throws FunctionExecutionException

Throws:: FunctionExecutionException

multiply

public static long multiply(long x,
                            long y)
                     throws FunctionExecutionException

Throws:: FunctionExecutionException

multiply

public static float multiply(float x,
                             float y)

multiply

public static double multiply(double x,
                              double y)

multiply

public static Object multiply(BigInteger x,
                              BigInteger y)

multiply

public static Object multiply(BigDecimal x,
                              BigDecimal y)

divide

public static int divide(int x,
                         int y)
                  throws FunctionExecutionException

Throws:: FunctionExecutionException

divide

public static long divide(long x,
                          long y)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

divide

public static float divide(float x,
                           float y)

divide

public static double divide(double x,
                            double y)

divide

public static Object divide(BigInteger x,
                            BigInteger y)

divide

public static Object divide(BigDecimal x,
                            BigDecimal y)

abs

public static int abs(int x)
               throws FunctionExecutionException

Throws:: FunctionExecutionException

abs

public static long abs(long x)
                throws FunctionExecutionException

Throws:: FunctionExecutionException

abs
```
public static float abs(float x)
```

abs

public static double abs(double x)

abs

public static Object abs(BigInteger x)

abs

public static Object abs(BigDecimal x)

ceiling

public static Object ceiling(Number x)

exp

public static Object exp(Number x)

floor

public static Object floor(Number x)

log

public static Object log(Number x)

log10

public static Object log10(Number x)

rand

public static Object rand(CommandContext context,
                          Integer seed)

rand

public static Object rand(CommandContext context)

mod

public static int mod(int x,
                      int y)

mod

public static long mod(long x,
                       long y)

mod

public static float mod(float x,
                        float y)

mod

public static double mod(double x,
                         double y)

mod

public static Object mod(BigInteger x,
                         BigInteger y)

mod

public static Object mod(BigDecimal x,
                         BigDecimal y)

power

public static double power(double x,
                           double y)

power

public static BigInteger power(BigInteger x,
                               int y)

power

public static BigDecimal power(BigDecimal x,
                               int y)

round

public static int round(int number,
                        int places)

round

public static float round(float number,
                          int places)

round

public static double round(double number,
                           int places)

round

public static BigDecimal round(BigDecimal bigDecimalNumber,
                               int places)

sign
```
public static Object sign(int x)
```

sign
```
public static Object sign(long x)
```

sign

public static Object sign(float x)

sign

public static Object sign(double x)

sign

public static Object sign(BigInteger x)

sign

public static Object sign(BigDecimal x)

sqrt

public static Object sqrt(Number x)

currentDate

public static Object currentDate(CommandContext context)

currentTime

public static Object currentTime(CommandContext context)

currentTimestamp

public static Object currentTimestamp(CommandContext context)

dayName

public static Object dayName(Date x)

dayOfMonth

public static Object dayOfMonth(Date x)

dayOfWeek

public static int dayOfWeek(Date x)

dayOfYear

public static Object dayOfYear(Date x)

hour
```
public static Object hour(Date x)
```

minute

public static Object minute(Date x)

month

public static Object month(Date x)

monthName

public static Object monthName(Date x)

second

public static Object second(Date x)

week
```
public static int week(Date x)
```

year
```
public static Object year(Date x)
```

quarter

public static Object quarter(Date date)

epoch

@TeiidFunction(category="Datetime",
               nullOnNull=true,
               pushdown=CAN_PUSHDOWN)
public static double epoch(Timestamp date)

from_unixtime

@TeiidFunction(category="Datetime",
               pushdown=CAN_PUSHDOWN)
public static String from_unixtime(long count)
                            throws FunctionExecutionException

Throws:: FunctionExecutionException

unix_timestamp

@TeiidFunction(category="Datetime",
               nullOnNull=true,
               pushdown=CAN_PUSHDOWN)
public static Long unix_timestamp(String date)

from_millis

@TeiidFunction(category="Datetime",
               pushdown=CAN_PUSHDOWN)
public static Timestamp from_millis(long millis)

to_millis

@TeiidFunction(category="Datetime",
               nullOnNull=true,
               pushdown=CAN_PUSHDOWN)
public static Long to_millis(Timestamp date)

timestampAdd

public static Object timestampAdd(String intervalType,
                                  int count,
                                  Timestamp timestamp)
                           throws FunctionExecutionException

Throws:: FunctionExecutionException

timestampAdd

public static Object timestampAdd(String intervalType,
                                  long count,
                                  Timestamp timestamp)
                           throws FunctionExecutionException

Throws:: FunctionExecutionException

timestampDiff

public static Long timestampDiff(String intervalType,
                                 Timestamp ts1Obj,
                                 Timestamp ts2Obj)
                          throws FunctionExecutionException

Throws:: FunctionExecutionException

timestampDiff

public static Long timestampDiff(String intervalType,
                                 Timestamp ts1Obj,
                                 Timestamp ts2Obj,
                                 boolean calendarBased)
                          throws FunctionExecutionException

Throws:: FunctionExecutionException

timestampCreate

public static Object timestampCreate(Date date,
                                     Time time)

length

public static Object length(String str)

concat

public static String concat(String str1,
                            String str2)

concat2

public static String concat2(String str1,
                             String str2)

concat

public static ClobType concat(CommandContext context,
                              ClobType str1,
                              ClobType str2)
                       throws IOException,
                              SQLException

Throws:: IOException; SQLException

concat2

public static ClobType concat2(CommandContext context,
                               ClobType str1,
                               ClobType str2)
                        throws IOException,
                               SQLException

Throws:: IOException; SQLException

substring

public static Object substring(String string,
                               Integer startVal,
                               Integer lengthVal)

substring

public static Object substring(String string,
                               Integer start)

left

public static Object left(String string,
                          Integer count)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

right

public static Object right(String string,
                           Integer count)
                    throws FunctionExecutionException

Throws:: FunctionExecutionException

lowerCase

public static Object lowerCase(String str)

lowerCase

public static ClobType lowerCase(ClobType str)

upperCase

public static Object upperCase(String str)

upperCase

public static ClobType upperCase(ClobType str)

locate

public static Object locate(String sub,
                            String str)

endsWith

public static Object endsWith(String sub,
                              String str)

locate

public static Object locate(String sub,
                            String str,
                            Integer start)

TODO: The treatment of negative start indexes is inconsistent here. We're treating the null value like Derby, but not throwing an exception if the value is less than 1 (less than 0 in DB2).

trim

public static String trim(String trimSpec,
                          String trimChar,
                          String string)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

leftTrim

public static String leftTrim(String string,
                              char trimChar)

leftTrim

public static String leftTrim(String string)

rightTrim

public static String rightTrim(String string,
                               char trimChar)

rightTrim

public static String rightTrim(String string,
                               char trimChar,
                               boolean newString)

rightTrim

public static Object rightTrim(String string)

replace

public static Object replace(String string,
                             String subString,
                             String replaceString)

insert

public static Object insert(String string1,
                            Integer start,
                            Integer length,
                            String str2)
                     throws FunctionExecutionException

Throws:: FunctionExecutionException

repeat

public static Object repeat(String str,
                            Integer count)

ascii

public static Integer ascii(String ch)

ascii

public static Integer ascii(Character ch)

chr

public static Object chr(int intValue)

initCap

public static Object initCap(String s)

lpad

public static Object lpad(String inputString,
                          Integer padLength,
                          String padStr)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

pad

public static Object pad(String str,
                         Integer padLength,
                         String padStr,
                         boolean left)
                  throws FunctionExecutionException

Throws:: FunctionExecutionException

lpad

public static Object lpad(String inputString,
                          Integer padLength)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

rpad

public static Object rpad(String inputString,
                          Integer padLength,
                          String padStr)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

rpad

public static Object rpad(String inputString,
                          Integer padLength)
                   throws FunctionExecutionException

Throws:: FunctionExecutionException

translate

public static Object translate(String str,
                               String in,
                               String out)
                        throws FunctionExecutionException

Throws:: FunctionExecutionException

convert

public static Object convert(CommandContext context,
                             Object src,
                             String type)
                      throws FunctionExecutionException

Throws:: FunctionExecutionException

lookup

public static Object lookup(Object codeTable,
                            Object returnElement,
                            Object keyElement,
                            Object keyValue)

This function should never actually be called - it is here solely so the lookup function can be resolved properly. The actual function is implemented in the ExpresionEvaluator

Parameters:: codeTable -; returnElement -; keyElement -; keyValue -
Returns:: Same as expression

ifnull

public static Object ifnull(Object value,
                            Object ifNullValue)

coalesce

public static Object coalesce(Object value,
                              Object value1,
                              Object... other)

format

public static String format(CommandContext context,
                            Date date,
                            String format)
                     throws FunctionExecutionException

Throws:: FunctionExecutionException

parseTimestamp

public static Timestamp parseTimestamp(CommandContext context,
                                       String timestamp,
                                       String format)
                                throws FunctionExecutionException

Throws:: FunctionExecutionException

format

public static String format(CommandContext context,
                            Number number,
                            String format)
                     throws FunctionExecutionException

Throws:: FunctionExecutionException

parseInteger

public static Object parseInteger(CommandContext context,
                                  String number,
                                  String format)
                           throws FunctionExecutionException

Throws:: FunctionExecutionException

parseLong

public static Object parseLong(CommandContext context,
                               String number,
                               String format)
                        throws FunctionExecutionException

Throws:: FunctionExecutionException

parseDouble

public static Object parseDouble(CommandContext context,
                                 String number,
                                 String format)
                          throws FunctionExecutionException

Throws:: FunctionExecutionException

parseFloat

public static Object parseFloat(CommandContext context,
                                String number,
                                String format)
                         throws FunctionExecutionException

Throws:: FunctionExecutionException

parseBigInteger

public static Object parseBigInteger(CommandContext context,
                                     String number,
                                     String format)
                              throws FunctionExecutionException

Throws:: FunctionExecutionException

parseBigDecimal

public static BigDecimal parseBigDecimal(CommandContext context,
                                         String number,
                                         String format)
                                  throws FunctionExecutionException

Throws:: FunctionExecutionException

acos

public static Object acos(Number number)

asin

public static Object asin(Number number)

atan

public static Object atan(Number number)

atan2

public static Object atan2(Number number1,
                           Number number2)

cos

public static Object cos(Number number)

cot

public static Object cot(Number number)

degrees

public static Object degrees(Number number)

pi
```
public static Object pi()
```

radians

public static Object radians(Number number)

sin

public static Object sin(Number number)

tan

public static Object tan(Number number)

bitand

public static Object bitand(int x,
                            int y)

bitor

public static Object bitor(int x,
                           int y)

bitxor

public static Object bitxor(int x,
                            int y)

bitnot
```
public static int bitnot(int x)
```

user

public static Object user(CommandContext context)

user

public static Object user(CommandContext context,
                          boolean includeSecurityDomain)

current_database

public static Object current_database(CommandContext context)

commandPayload

public static Object commandPayload(CommandContext context)

commandPayload

public static Object commandPayload(CommandContext context,
                                    String param)
                             throws ExpressionEvaluationException,
                                    FunctionExecutionException

Throws:: ExpressionEvaluationException; FunctionExecutionException

env

public static Object env(String propertyName)

sys_prop

public static Object sys_prop(String propertyName)

env_var

public static Object env_var(String propertyName)

session_id

public static Object session_id(CommandContext context)

node_id

@TeiidFunction(category="Miscellaneous",
               pushdown=CANNOT_PUSHDOWN)
public static String node_id()

modifyTimeZone

public static Object modifyTimeZone(Timestamp value,
                                    String originalTimezoneString,
                                    String targetTimezoneString)

modifyTimeZone

public static Object modifyTimeZone(CommandContext context,
                                    Timestamp value,
                                    String targetTimezoneString)

toChars

@TeiidFunction(category="Conversion",
               name="to_chars",
               nullOnNull=true)
public static ClobType toChars(BlobType value,
                               String encoding)
                        throws SQLException,
                               IOException

Throws:: SQLException; IOException

toChars

@TeiidFunction(category="Conversion",
               name="to_chars")
public static ClobType toChars(BlobType value,
                               String encoding,
                               boolean wellFormed)
                        throws SQLException,
                               IOException

Throws:: SQLException; IOException

toBytes

@TeiidFunction(category="Conversion",
               name="to_bytes",
               nullOnNull=true)
public static BlobType toBytes(ClobType value,
                               String encoding)
                        throws IOException,
                               SQLException

Throws:: IOException; SQLException

toBytes

@TeiidFunction(category="Conversion",
               name="to_bytes")
public static BlobType toBytes(ClobType value,
                               String encoding,
                               boolean wellFormed)
                        throws IOException,
                               SQLException

Throws:: IOException; SQLException

unescape

public static String unescape(String string)

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

array_get

public static Object array_get(Object array,
                               int index)
                        throws FunctionExecutionException,
                               SQLException

Throws:: FunctionExecutionException; SQLException

array_length

public static int array_length(Object array)
                        throws FunctionExecutionException,
                               SQLException

Throws:: FunctionExecutionException; SQLException

mvstatus

@TeiidFunction(category="System",
               determinism=COMMAND_DETERMINISTIC,
               pushdown=CANNOT_PUSHDOWN)
public static int mvstatus(CommandContext context,
                           String schemaName,
                           String viewName)
                    throws FunctionExecutionException,
                           SQLException,
                           QueryMetadataException,
                           TeiidComponentException

Throws:: FunctionExecutionException; SQLException; QueryMetadataException; TeiidComponentException

tokenize

@TeiidFunction(category="System")
public static String[] tokenize(String str,
                                char delimiter)

regexpReplace

@TeiidFunction(name="regexp_replace",
               category="String",
               nullOnNull=true)
public static String regexpReplace(CommandContext context,
                                   String source,
                                   String regex,
                                   String replacement)
                            throws FunctionExecutionException

Perform find-replace operation on a string using regular expressions. See Pattern for more information.

Parameters:: context -; source - Value to perform replacement on.; regex - Regular expression pattern.; replacement - Replacement string.
Returns:: Modified source if the pattern was matched, otherwise source.
Throws:: FunctionExecutionException - If regex pattern was invalid.

regexpReplace

@TeiidFunction(name="regexp_replace",
               category="String",
               nullOnNull=true)
public static ClobType regexpReplace(CommandContext context,
                                     ClobType source,
                                     String regex,
                                     String replacement)
                              throws FunctionExecutionException

Throws:: FunctionExecutionException

regexpReplace

@TeiidFunction(name="regexp_replace",
               category="String",
               nullOnNull=true)
public static String regexpReplace(CommandContext context,
                                   String source,
                                   String regex,
                                   String replacement,
                                   String flags)
                            throws FunctionExecutionException

Throws:: FunctionExecutionException

regexpReplace

@TeiidFunction(name="regexp_replace",
               category="String",
               nullOnNull=true)
public static ClobType regexpReplace(CommandContext context,
                                     ClobType source,
                                     String regex,
                                     String replacement,
                                     String flags)
                              throws FunctionExecutionException

Throws:: FunctionExecutionException

regexpReplace
```
public static String regexpReplace(CommandContext context,
                                   CharSequence source,
                                   String regex,
                                   String replacement,
                                   String flags)
                            throws FunctionExecutionException
```
Perform find-replace operation on a string using regular expressions. See Pattern for more information. Flags can be used to modify the matching behavior of the regular expression.
- g - Replaces all matches instead of just the first.
- i - Performs case insensitive pattern match.
- m - Changes behavior of "^" and "$" to match the beginning and end of the line instead of the entire string.
Parameters:

context -

source - Value to perform replacement on.

regex - Regular expression pattern.

replacement - Replacement string.

flags - Flags to modify behavior of the pattern.

Returns:

Modified source if the pattern was matched, otherwise source.

Throws:

FunctionExecutionException - If an invalid flag was supplied or if the regex pattern was invalid.

md5

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType md5(String plainText)
                      throws NoSuchAlgorithmException,
                             UnsupportedEncodingException

Throws:: NoSuchAlgorithmException; UnsupportedEncodingException

sha1

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha1(String plainText)
                       throws NoSuchAlgorithmException,
                              UnsupportedEncodingException

Throws:: NoSuchAlgorithmException; UnsupportedEncodingException

sha2_256

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha2_256(String plainText)
                           throws NoSuchAlgorithmException,
                                  UnsupportedEncodingException

Throws:: NoSuchAlgorithmException; UnsupportedEncodingException

sha2_512

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha2_512(String plainText)
                           throws NoSuchAlgorithmException,
                                  UnsupportedEncodingException

Throws:: NoSuchAlgorithmException; UnsupportedEncodingException

md5

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType md5(BinaryType plainText)
                      throws NoSuchAlgorithmException

Throws:: NoSuchAlgorithmException

sha1

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha1(BinaryType plainText)
                       throws NoSuchAlgorithmException

Throws:: NoSuchAlgorithmException

sha2_256

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha2_256(BinaryType plainText)
                           throws NoSuchAlgorithmException

Throws:: NoSuchAlgorithmException

sha2_512

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType sha2_512(BinaryType plainText)
                           throws NoSuchAlgorithmException

Throws:: NoSuchAlgorithmException

digest

public static BinaryType digest(byte[] plainText,
                                String algorithm)
                         throws NoSuchAlgorithmException

Throws:: NoSuchAlgorithmException

aes_encrypt

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType aes_encrypt(BinaryType dataBytes,
                                     BinaryType keyBytes)
                              throws FunctionExecutionException

Throws:: FunctionExecutionException

aes_decrypt

@TeiidFunction(category="Security",
               nullOnNull=true)
public static BinaryType aes_decrypt(BinaryType dataBytes,
                                     BinaryType keyBytes)
                              throws FunctionExecutionException

Throws:: FunctionExecutionException

current_time

@TeiidFunction(category="Datetime",
               pushdown=CAN_PUSHDOWN)
public static Time current_time(CommandContext context,
                                int precision)

current_timestamp

@TeiidFunction(category="Datetime",
               pushdown=CAN_PUSHDOWN)
public static Timestamp current_timestamp(CommandContext context,
                                          int precision)

Class FunctionMethods

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AT

SPACE_CHAR

Constructor Detail

FunctionMethods

Method Detail

plus

integerRangeCheck

plus

plus

plus

plus

plus

minus

minus

minus

minus

minus

minus

multiply

multiply

multiply

multiply

multiply

multiply

divide

divide

divide

divide

divide

divide

abs

abs

abs

abs

abs

abs

ceiling

exp

floor

log

log10

rand

rand

mod

mod

mod

mod

mod

mod

power

power

power

round

round

round

round

sign

sign

sign

sign

sign

sign

sqrt

currentDate

currentTime

currentTimestamp

dayName

dayOfMonth

dayOfWeek

dayOfYear

hour

minute

month

monthName