Function

java.lang.Object
- org.h2.expression.Expression
- - org.h2.expression.function.Function

All Implemented Interfaces:

ExpressionWithFlags, FunctionCall

Direct Known Subclasses:

FunctionsMSSQLServer, FunctionsMySQL, FunctionsOracle, TableFunction
```
public class Function
extends Expression
implements FunctionCall, ExpressionWithFlags
```
This class implements most built-in functions of this database.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABS`
`static int`	`ACOS`
`static int`	`ADD_MONTHS`
`protected Expression[]`	`args`
`static int`	`ARRAY_APPEND`
`static int`	`ARRAY_CONCAT`
`static int`	`ARRAY_CONTAINS`
`static int`	`ARRAY_GET`
`static int`	`ARRAY_LENGTH`
`static int`	`ARRAY_SLICE`
`static int`	`ASCII`
`static int`	`ASIN`
`static int`	`ATAN`
`static int`	`ATAN2`
`static int`	`AUTOCOMMIT`
`static int`	`BIT_LENGTH`
`static int`	`BITAND`
`static int`	`BITGET`
`static int`	`BITNOT`
`static int`	`BITOR`
`static int`	`BITXOR`
`static int`	`CANCEL_SESSION`
`static int`	`CASE`
`static int`	`CASEWHEN`
`static int`	`CAST`
`static int`	`CEILING`
`static int`	`CENTURY` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`CHAR`
`static int`	`CHAR_LENGTH`
`static int`	`COALESCE`
`static int`	`COMPRESS`
`static int`	`CONCAT`
`static int`	`CONCAT_WS`
`static int`	`CONVERT`
`static int`	`COS`
`static int`	`COSH`
`static int`	`COT`
`static int`	`CSVREAD`
`static int`	`CSVWRITE`
`static int`	`CURRENT_CATALOG`
`static int`	`CURRENT_DATE`
`static int`	`CURRENT_SCHEMA`
`static int`	`CURRENT_TIME`
`static int`	`CURRENT_TIMESTAMP`
`static int`	`CURRENT_USER`
`static int`	`CURRVAL`
`static int`	`DATABASE_PATH`
`static int`	`DATE_TRUNC`
`static int`	`DATEADD`
`static int`	`DATEDIFF`
`static int`	`DAY_NAME`
`static int`	`DAY_OF_MONTH`
`static int`	`DAY_OF_WEEK`
`static int`	`DAY_OF_YEAR`
`static int`	`DECADE` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`DECODE`
`static int`	`DECRYPT`
`static int`	`DEGREES`
`static int`	`DIFFERENCE`
`static int`	`DISK_SPACE_USED`
`static int`	`DOW` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`ENCRYPT`
`static int`	`EPOCH` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`ESTIMATED_ENVELOPE`
`static int`	`EXP`
`static int`	`EXPAND`
`static int`	`EXTRACT`
`static int`	`FILE_READ`
`static int`	`FILE_WRITE`
`static int`	`FLOOR`
`static int`	`FORMATDATETIME`
`static int`	`GREATEST`
`static int`	`H2VERSION` This is called H2VERSION() and not VERSION(), because we return a fake value for VERSION() when running under the PostgreSQL ODBC driver.
`static int`	`HASH`
`static int`	`HEXTORAW`
`static int`	`HOUR`
`static int`	`IDENTITY`
`static int`	`IFNULL`
`protected FunctionInfo`	`info`
`static int`	`INSERT`
`static int`	`INSTR`
`static int`	`ISO_DAY_OF_WEEK`
`static int`	`ISO_WEEK`
`static int`	`ISO_YEAR`
`static int`	`JSON_ABSENT_ON_NULL` The ABSENT ON NULL flag for JSON_ARRAY and JSON_OBJECT functions.
`static int`	`JSON_ARRAY`
`static int`	`JSON_OBJECT`
`static int`	`JSON_WITH_UNIQUE_KEYS` The WITH UNIQUE KEYS flag for JSON_OBJECT function.
`static int`	`LCASE`
`static int`	`LEAST`
`static int`	`LEFT`
`static int`	`LENGTH`
`static int`	`LINK_SCHEMA`
`static int`	`LN`
`static int`	`LOCALTIME`
`static int`	`LOCALTIMESTAMP`
`static int`	`LOCATE`
`static int`	`LOCK_MODE`
`static int`	`LOCK_TIMEOUT`
`static int`	`LOG`
`static int`	`LOG10`
`static int`	`LOWER`
`static int`	`LPAD`
`static int`	`LSHIFT`
`static int`	`LTRIM`
`static int`	`MEMORY_FREE`
`static int`	`MEMORY_USED`
`static int`	`MICROSECOND` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`MILLENNIUM` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`MILLISECOND` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`MINUTE`
`static int`	`MOD`
`static int`	`MONTH`
`static int`	`MONTH_NAME`
`static int`	`NANOSECOND` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`NEXTVAL`
`static int`	`NULLIF`
`static int`	`NVL2`
`static int`	`OCTET_LENGTH`
`static int`	`ORA_HASH`
`static int`	`PARSEDATETIME`
`static int`	`PI`
`static int`	`POSITION`
`static int`	`POWER`
`static int`	`QUARTER`
`static int`	`QUOTE_IDENT`
`static int`	`RADIANS`
`static int`	`RAND`
`static int`	`RANDOM_UUID`
`static int`	`RAWTOHEX`
`static int`	`READONLY`
`static int`	`REGEXP_LIKE`
`static int`	`REGEXP_REPLACE`
`static int`	`REPEAT`
`static int`	`REPLACE`
`static int`	`RIGHT`
`static int`	`ROUND`
`static int`	`ROUNDMAGIC`
`static int`	`RPAD`
`static int`	`RSHIFT`
`static int`	`RTRIM`
`static int`	`SCOPE_IDENTITY`
`static int`	`SECOND`
`static int`	`SECURE_RAND`
`static int`	`SESSION_ID`
`static int`	`SET`
`static int`	`SIGN`
`static int`	`SIGNAL`
`static int`	`SIN`
`static int`	`SINH`
`static int`	`SOUNDEX`
`static int`	`SPACE`
`static int`	`SQRT`
`static int`	`STRINGDECODE`
`static int`	`STRINGENCODE`
`static int`	`STRINGTOUTF8`
`static int`	`SUBSTRING`
`static int`	`TABLE`
`static int`	`TABLE_DISTINCT`
`static int`	`TAN`
`static int`	`TANH`
`static int`	`TIMEZONE_HOUR` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`TIMEZONE_MINUTE` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`TIMEZONE_SECOND` Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
`static int`	`TO_CHAR`
`static int`	`TO_DATE`
`static int`	`TO_TIMESTAMP`
`static int`	`TO_TIMESTAMP_TZ`
`static int`	`TRANSACTION_ID`
`static int`	`TRANSLATE`
`static int`	`TRIM`
`static int`	`TRIM_LEADING` The flag for TRIM(LEADING ...) function.
`static int`	`TRIM_TRAILING` The flag for TRIM(TRAILING ...) function.
`static int`	`TRUNCATE`
`static int`	`TRUNCATE_VALUE`
`protected TypeInfo`	`type`
`static int`	`UCASE`
`static int`	`UNNEST`
`static int`	`UPPER`
`static int`	`USER`
`static int`	`UTF8TOSTRING`
`static int`	`VALUES` Used in MySQL-style INSERT ...
`protected static int`	`VAR_ARGS`
`static int`	`WEEK`
`static int`	`XMLATTR`
`static int`	`XMLCDATA`
`static int`	`XMLCOMMENT`
`static int`	`XMLNODE`
`static int`	`XMLSTARTDOC`
`static int`	`XMLTEXT`
`static int`	`YEAR`
`static int`	`ZERO`

Fields inherited from class org.h2.expression.Expression
MAP_IN_AGGREGATE, MAP_IN_WINDOW, MAP_INITIAL

Constructor Summary

Constructors
Constructor and Description
`Function(Database database, FunctionInfo info)` Creates a new instance of function.
`Function(Database database, FunctionInfo info, Expression[] arguments)` Creates a new instance of function.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addParameter(Expression param)` Adds the parameter expression.
`protected void`	`checkParameterCount(int len)` Check if the parameter count is correct.
`void`	`doneWithParameters()` This method is called after all the parameters have been set.
`Expression[]`	`getArgs()` Get the function arguments.
`int`	`getCost()` Estimate the cost to process the expression.
`int`	`getFlags()` Returns the flags.
`static Function`	`getFunction(Database database, int id)` Get an instance of the given function for this database.
`static Function`	`getFunction(Database database, java.lang.String name)` Get an instance of the given function for this database.
`static FunctionInfo`	`getFunctionInfo(java.lang.String upperName)` Returns function information for the specified function name.
`int`	`getFunctionType()`
`static Function`	`getFunctionWithArgs(Database database, int id, Expression... arguments)` Get an instance of the given function for this database.
`static void`	`getJsonFunctionFlagsSQL(java.lang.StringBuilder builder, int flags, boolean forArray)` Appends flags of a JSON function to the specified string builder.
`java.lang.String`	`getName()` Get the name of the function.
`protected static Value`	`getNullOrValue(Session session, Expression[] args, Value[] values, int i)` Get value transformed by expression, or null if i is out of range or the input value is null.
`java.lang.StringBuilder`	`getSQL(java.lang.StringBuilder builder, boolean alwaysQuote)` Appends the SQL statement of this expression to the specified builder.
`Expression`	`getSubexpression(int index)` Returns subexpression with specified index.
`int`	`getSubexpressionCount()` Returns count of subexpressions.
`TypeInfo`	`getType()` Returns the data type.
`Value`	`getValue(Session session)` Return the resulting value for the current row.
`ValueResultSet`	`getValueForColumnList(Session session, Expression[] argList)` Get an empty result set with the column names set.
`int`	`getValueType()` Get the data type.
`protected Value`	`getValueWithArgs(Session session, Expression[] args)` Return the resulting value for the given expression arguments.
`boolean`	`isDeterministic()` Whether the function always returns the same result for the same parameters.
`boolean`	`isEverything(ExpressionVisitor visitor)` Check if this expression and all sub-expressions can fulfill a criteria.
`static void`	`jsonArrayAppend(java.io.ByteArrayOutputStream baos, Value value, int flags)` Appends a value to a JSON array in the specified string builder.
`static void`	`jsonObjectAppend(java.io.ByteArrayOutputStream baos, java.lang.String key, Value value)` Appends a value to a JSON object in the specified string builder.
`static Value`	`jsonObjectFinish(java.io.ByteArrayOutputStream baos, int flags)` Appends trailing closing brace to the specified string builder with a JSON object, validates it, and converts to a JSON value.
`void`	`mapColumns(ColumnResolver resolver, int level, int state)` Map the columns of the resolver to expression columns.
`Expression`	`optimize(Session session)` Try to optimize the expression.
`void`	`setDataType(TypeInfo type)`
`void`	`setEvaluatable(TableFilter tableFilter, boolean b)` Tell the expression columns whether the table filter can return values now.
`void`	`setFlags(int flags)` Set the flags for this expression.
`void`	`updateAggregate(Session session, int stage)` Update an aggregate value.

Methods inherited from class org.h2.expression.Expression
addFilterConditions, createIndexConditions, getAlias, getBooleanValue, getColumnName, getExpressionColumns, getExpressionColumns, getExpressionColumns, getNonAliasExpression, getNotIfPossible, getNullable, getSchemaName, getSQL, getTableAlias, getTableName, getUnenclosedSQL, isAutoIncrement, isConstant, isNullConstant, isValueSet, toString, writeExpressions, writeExpressions

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

Methods inherited from interface org.h2.expression.function.FunctionCall
getSQL

- Field Detail
  - ABS
```
public static final int ABS
```
    See Also:
    Constant Field Values
  - ACOS
```
public static final int ACOS
```
    See Also:
    Constant Field Values
  - ASIN
```
public static final int ASIN
```
    See Also:
    Constant Field Values
  - ATAN
```
public static final int ATAN
```
    See Also:
    Constant Field Values
  - ATAN2
```
public static final int ATAN2
```
    See Also:
    Constant Field Values
  - BITAND
```
public static final int BITAND
```
    See Also:
    Constant Field Values
  - BITOR
```
public static final int BITOR
```
    See Also:
    Constant Field Values
  - BITXOR
```
public static final int BITXOR
```
    See Also:
    Constant Field Values
  - CEILING
```
public static final int CEILING
```
    See Also:
    Constant Field Values
  - COS
```
public static final int COS
```
    See Also:
    Constant Field Values
  - COT
```
public static final int COT
```
    See Also:
    Constant Field Values
  - DEGREES
```
public static final int DEGREES
```
    See Also:
    Constant Field Values
  - EXP
```
public static final int EXP
```
    See Also:
    Constant Field Values
  - FLOOR
```
public static final int FLOOR
```
    See Also:
    Constant Field Values
  - LOG
```
public static final int LOG
```
    See Also:
    Constant Field Values
  - LOG10
```
public static final int LOG10
```
    See Also:
    Constant Field Values
  - MOD
```
public static final int MOD
```
    See Also:
    Constant Field Values
  - PI
```
public static final int PI
```
    See Also:
    Constant Field Values
  - POWER
```
public static final int POWER
```
    See Also:
    Constant Field Values
  - RADIANS
```
public static final int RADIANS
```
    See Also:
    Constant Field Values
  - RAND
```
public static final int RAND
```
    See Also:
    Constant Field Values
  - ROUND
```
public static final int ROUND
```
    See Also:
    Constant Field Values
  - ROUNDMAGIC
```
public static final int ROUNDMAGIC
```
    See Also:
    Constant Field Values
  - SIGN
```
public static final int SIGN
```
    See Also:
    Constant Field Values
  - SIN
```
public static final int SIN
```
    See Also:
    Constant Field Values
  - SQRT
```
public static final int SQRT
```
    See Also:
    Constant Field Values
  - TAN
```
public static final int TAN
```
    See Also:
    Constant Field Values
  - TRUNCATE
```
public static final int TRUNCATE
```
    See Also:
    Constant Field Values
  - SECURE_RAND
```
public static final int SECURE_RAND
```
    See Also:
    Constant Field Values
  - HASH
```
public static final int HASH
```
    See Also:
    Constant Field Values
  - ENCRYPT
```
public static final int ENCRYPT
```
    See Also:
    Constant Field Values
  - DECRYPT
```
public static final int DECRYPT
```
    See Also:
    Constant Field Values
  - COMPRESS
```
public static final int COMPRESS
```
    See Also:
    Constant Field Values
  - EXPAND
```
public static final int EXPAND
```
    See Also:
    Constant Field Values
  - ZERO
```
public static final int ZERO
```
    See Also:
    Constant Field Values
  - RANDOM_UUID
```
public static final int RANDOM_UUID
```
    See Also:
    Constant Field Values
  - COSH
```
public static final int COSH
```
    See Also:
    Constant Field Values
  - SINH
```
public static final int SINH
```
    See Also:
    Constant Field Values
  - TANH
```
public static final int TANH
```
    See Also:
    Constant Field Values
  - LN
```
public static final int LN
```
    See Also:
    Constant Field Values
  - BITGET
```
public static final int BITGET
```
    See Also:
    Constant Field Values
  - ORA_HASH
```
public static final int ORA_HASH
```
    See Also:
    Constant Field Values
  - BITNOT
```
public static final int BITNOT
```
    See Also:
    Constant Field Values
  - LSHIFT
```
public static final int LSHIFT
```
    See Also:
    Constant Field Values
  - RSHIFT
```
public static final int RSHIFT
```
    See Also:
    Constant Field Values
  - ASCII
```
public static final int ASCII
```
    See Also:
    Constant Field Values
  - BIT_LENGTH
```
public static final int BIT_LENGTH
```
    See Also:
    Constant Field Values
  - CHAR
```
public static final int CHAR
```
    See Also:
    Constant Field Values
  - CHAR_LENGTH
```
public static final int CHAR_LENGTH
```
    See Also:
    Constant Field Values
  - CONCAT
```
public static final int CONCAT
```
    See Also:
    Constant Field Values
  - DIFFERENCE
```
public static final int DIFFERENCE
```
    See Also:
    Constant Field Values
  - HEXTORAW
```
public static final int HEXTORAW
```
    See Also:
    Constant Field Values
  - INSERT
```
public static final int INSERT
```
    See Also:
    Constant Field Values
  - INSTR
```
public static final int INSTR
```
    See Also:
    Constant Field Values
  - LCASE
```
public static final int LCASE
```
    See Also:
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    See Also:
    Constant Field Values
  - LENGTH
```
public static final int LENGTH
```
    See Also:
    Constant Field Values
  - LOCATE
```
public static final int LOCATE
```
    See Also:
    Constant Field Values
  - LTRIM
```
public static final int LTRIM
```
    See Also:
    Constant Field Values
  - OCTET_LENGTH
```
public static final int OCTET_LENGTH
```
    See Also:
    Constant Field Values
  - RAWTOHEX
```
public static final int RAWTOHEX
```
    See Also:
    Constant Field Values
  - REPEAT
```
public static final int REPEAT
```
    See Also:
    Constant Field Values
  - REPLACE
```
public static final int REPLACE
```
    See Also:
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    See Also:
    Constant Field Values
  - RTRIM
```
public static final int RTRIM
```
    See Also:
    Constant Field Values
  - SOUNDEX
```
public static final int SOUNDEX
```
    See Also:
    Constant Field Values
  - SPACE
```
public static final int SPACE
```
    See Also:
    Constant Field Values
  - SUBSTRING
```
public static final int SUBSTRING
```
    See Also:
    Constant Field Values
  - UCASE
```
public static final int UCASE
```
    See Also:
    Constant Field Values
  - LOWER
```
public static final int LOWER
```
    See Also:
    Constant Field Values
  - UPPER
```
public static final int UPPER
```
    See Also:
    Constant Field Values
  - POSITION
```
public static final int POSITION
```
    See Also:
    Constant Field Values
  - TRIM
```
public static final int TRIM
```
    See Also:
    Constant Field Values
  - STRINGENCODE
```
public static final int STRINGENCODE
```
    See Also:
    Constant Field Values
  - STRINGDECODE
```
public static final int STRINGDECODE
```
    See Also:
    Constant Field Values
  - STRINGTOUTF8
```
public static final int STRINGTOUTF8
```
    See Also:
    Constant Field Values
  - UTF8TOSTRING
```
public static final int UTF8TOSTRING
```
    See Also:
    Constant Field Values
  - XMLATTR
```
public static final int XMLATTR
```
    See Also:
    Constant Field Values
  - XMLNODE
```
public static final int XMLNODE
```
    See Also:
    Constant Field Values
  - XMLCOMMENT
```
public static final int XMLCOMMENT
```
    See Also:
    Constant Field Values
  - XMLCDATA
```
public static final int XMLCDATA
```
    See Also:
    Constant Field Values
  - XMLSTARTDOC
```
public static final int XMLSTARTDOC
```
    See Also:
    Constant Field Values
  - XMLTEXT
```
public static final int XMLTEXT
```
    See Also:
    Constant Field Values
  - REGEXP_REPLACE
```
public static final int REGEXP_REPLACE
```
    See Also:
    Constant Field Values
  - RPAD
```
public static final int RPAD
```
    See Also:
    Constant Field Values
  - LPAD
```
public static final int LPAD
```
    See Also:
    Constant Field Values
  - CONCAT_WS
```
public static final int CONCAT_WS
```
    See Also:
    Constant Field Values
  - TO_CHAR
```
public static final int TO_CHAR
```
    See Also:
    Constant Field Values
  - TRANSLATE
```
public static final int TRANSLATE
```
    See Also:
    Constant Field Values
  - QUOTE_IDENT
```
public static final int QUOTE_IDENT
```
    See Also:
    Constant Field Values
  - TO_DATE
```
public static final int TO_DATE
```
    See Also:
    Constant Field Values
  - TO_TIMESTAMP
```
public static final int TO_TIMESTAMP
```
    See Also:
    Constant Field Values
  - ADD_MONTHS
```
public static final int ADD_MONTHS
```
    See Also:
    Constant Field Values
  - TO_TIMESTAMP_TZ
```
public static final int TO_TIMESTAMP_TZ
```
    See Also:
    Constant Field Values
  - CURRENT_DATE
```
public static final int CURRENT_DATE
```
    See Also:
    Constant Field Values
  - CURRENT_TIME
```
public static final int CURRENT_TIME
```
    See Also:
    Constant Field Values
  - LOCALTIME
```
public static final int LOCALTIME
```
    See Also:
    Constant Field Values
  - CURRENT_TIMESTAMP
```
public static final int CURRENT_TIMESTAMP
```
    See Also:
    Constant Field Values
  - LOCALTIMESTAMP
```
public static final int LOCALTIMESTAMP
```
    See Also:
    Constant Field Values
  - DATEADD
```
public static final int DATEADD
```
    See Also:
    Constant Field Values
  - DATEDIFF
```
public static final int DATEDIFF
```
    See Also:
    Constant Field Values
  - DAY_NAME
```
public static final int DAY_NAME
```
    See Also:
    Constant Field Values
  - DAY_OF_MONTH
```
public static final int DAY_OF_MONTH
```
    See Also:
    Constant Field Values
  - DAY_OF_WEEK
```
public static final int DAY_OF_WEEK
```
    See Also:
    Constant Field Values
  - DAY_OF_YEAR
```
public static final int DAY_OF_YEAR
```
    See Also:
    Constant Field Values
  - HOUR
```
public static final int HOUR
```
    See Also:
    Constant Field Values
  - MINUTE
```
public static final int MINUTE
```
    See Also:
    Constant Field Values
  - MONTH
```
public static final int MONTH
```
    See Also:
    Constant Field Values
  - MONTH_NAME
```
public static final int MONTH_NAME
```
    See Also:
    Constant Field Values
  - QUARTER
```
public static final int QUARTER
```
    See Also:
    Constant Field Values
  - SECOND
```
public static final int SECOND
```
    See Also:
    Constant Field Values
  - WEEK
```
public static final int WEEK
```
    See Also:
    Constant Field Values
  - YEAR
```
public static final int YEAR
```
    See Also:
    Constant Field Values
  - EXTRACT
```
public static final int EXTRACT
```
    See Also:
    Constant Field Values
  - FORMATDATETIME
```
public static final int FORMATDATETIME
```
    See Also:
    Constant Field Values
  - PARSEDATETIME
```
public static final int PARSEDATETIME
```
    See Also:
    Constant Field Values
  - ISO_YEAR
```
public static final int ISO_YEAR
```
    See Also:
    Constant Field Values
  - ISO_WEEK
```
public static final int ISO_WEEK
```
    See Also:
    Constant Field Values
  - ISO_DAY_OF_WEEK
```
public static final int ISO_DAY_OF_WEEK
```
    See Also:
    Constant Field Values
  - DATE_TRUNC
```
public static final int DATE_TRUNC
```
    See Also:
    Constant Field Values
  - MILLISECOND
```
public static final int MILLISECOND
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - EPOCH
```
public static final int EPOCH
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - MICROSECOND
```
public static final int MICROSECOND
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - NANOSECOND
```
public static final int NANOSECOND
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - TIMEZONE_HOUR
```
public static final int TIMEZONE_HOUR
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - TIMEZONE_MINUTE
```
public static final int TIMEZONE_MINUTE
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - TIMEZONE_SECOND
```
public static final int TIMEZONE_SECOND
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - DECADE
```
public static final int DECADE
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - CENTURY
```
public static final int CENTURY
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - MILLENNIUM
```
public static final int MILLENNIUM
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - DOW
```
public static final int DOW
```
    Pseudo functions for DATEADD, DATEDIFF, and EXTRACT.
    
    See Also:
    Constant Field Values
  - CURRENT_CATALOG
```
public static final int CURRENT_CATALOG
```
    See Also:
    Constant Field Values
  - USER
```
public static final int USER
```
    See Also:
    Constant Field Values
  - CURRENT_USER
```
public static final int CURRENT_USER
```
    See Also:
    Constant Field Values
  - IDENTITY
```
public static final int IDENTITY
```
    See Also:
    Constant Field Values
  - SCOPE_IDENTITY
```
public static final int SCOPE_IDENTITY
```
    See Also:
    Constant Field Values
  - AUTOCOMMIT
```
public static final int AUTOCOMMIT
```
    See Also:
    Constant Field Values
  - READONLY
```
public static final int READONLY
```
    See Also:
    Constant Field Values
  - DATABASE_PATH
```
public static final int DATABASE_PATH
```
    See Also:
    Constant Field Values
  - LOCK_TIMEOUT
```
public static final int LOCK_TIMEOUT
```
    See Also:
    Constant Field Values
  - DISK_SPACE_USED
```
public static final int DISK_SPACE_USED
```
    See Also:
    Constant Field Values
  - SIGNAL
```
public static final int SIGNAL
```
    See Also:
    Constant Field Values
  - ESTIMATED_ENVELOPE
```
public static final int ESTIMATED_ENVELOPE
```
    See Also:
    Constant Field Values
  - IFNULL
```
public static final int IFNULL
```
    See Also:
    Constant Field Values
  - CASEWHEN
```
public static final int CASEWHEN
```
    See Also:
    Constant Field Values
  - CONVERT
```
public static final int CONVERT
```
    See Also:
    Constant Field Values
  - CAST
```
public static final int CAST
```
    See Also:
    Constant Field Values
  - COALESCE
```
public static final int COALESCE
```
    See Also:
    Constant Field Values
  - NULLIF
```
public static final int NULLIF
```
    See Also:
    Constant Field Values
  - CASE
```
public static final int CASE
```
    See Also:
    Constant Field Values
  - NEXTVAL
```
public static final int NEXTVAL
```
    See Also:
    Constant Field Values
  - CURRVAL
```
public static final int CURRVAL
```
    See Also:
    Constant Field Values
  - ARRAY_GET
```
public static final int ARRAY_GET
```
    See Also:
    Constant Field Values
  - CSVREAD
```
public static final int CSVREAD
```
    See Also:
    Constant Field Values
  - CSVWRITE
```
public static final int CSVWRITE
```
    See Also:
    Constant Field Values
  - MEMORY_FREE
```
public static final int MEMORY_FREE
```
    See Also:
    Constant Field Values
  - MEMORY_USED
```
public static final int MEMORY_USED
```
    See Also:
    Constant Field Values
  - LOCK_MODE
```
public static final int LOCK_MODE
```
    See Also:
    Constant Field Values
  - CURRENT_SCHEMA
```
public static final int CURRENT_SCHEMA
```
    See Also:
    Constant Field Values
  - SESSION_ID
```
public static final int SESSION_ID
```
    See Also:
    Constant Field Values
  - ARRAY_LENGTH
```
public static final int ARRAY_LENGTH
```
    See Also:
    Constant Field Values
  - LINK_SCHEMA
```
public static final int LINK_SCHEMA
```
    See Also:
    Constant Field Values
  - GREATEST
```
public static final int GREATEST
```
    See Also:
    Constant Field Values
  - LEAST
```
public static final int LEAST
```
    See Also:
    Constant Field Values
  - CANCEL_SESSION
```
public static final int CANCEL_SESSION
```
    See Also:
    Constant Field Values
  - SET
```
public static final int SET
```
    See Also:
    Constant Field Values
  - TABLE
```
public static final int TABLE
```
    See Also:
    Constant Field Values
  - TABLE_DISTINCT
```
public static final int TABLE_DISTINCT
```
    See Also:
    Constant Field Values
  - FILE_READ
```
public static final int FILE_READ
```
    See Also:
    Constant Field Values
  - TRANSACTION_ID
```
public static final int TRANSACTION_ID
```
    See Also:
    Constant Field Values
  - TRUNCATE_VALUE
```
public static final int TRUNCATE_VALUE
```
    See Also:
    Constant Field Values
  - NVL2
```
public static final int NVL2
```
    See Also:
    Constant Field Values
  - DECODE
```
public static final int DECODE
```
    See Also:
    Constant Field Values
  - ARRAY_CONTAINS
```
public static final int ARRAY_CONTAINS
```
    See Also:
    Constant Field Values
  - FILE_WRITE
```
public static final int FILE_WRITE
```
    See Also:
    Constant Field Values
  - UNNEST
```
public static final int UNNEST
```
    See Also:
    Constant Field Values
  - ARRAY_CONCAT
```
public static final int ARRAY_CONCAT
```
    See Also:
    Constant Field Values
  - ARRAY_APPEND
```
public static final int ARRAY_APPEND
```
    See Also:
    Constant Field Values
  - ARRAY_SLICE
```
public static final int ARRAY_SLICE
```
    See Also:
    Constant Field Values
  - REGEXP_LIKE
```
public static final int REGEXP_LIKE
```
    See Also:
    Constant Field Values
  - VALUES
```
public static final int VALUES
```
    Used in MySQL-style INSERT ... ON DUPLICATE KEY UPDATE ... VALUES
    
    See Also:
    Constant Field Values
  - JSON_OBJECT
```
public static final int JSON_OBJECT
```
    See Also:
    Constant Field Values
  - JSON_ARRAY
```
public static final int JSON_ARRAY
```
    See Also:
    Constant Field Values
  - H2VERSION
```
public static final int H2VERSION
```
    This is called H2VERSION() and not VERSION(), because we return a fake value for VERSION() when running under the PostgreSQL ODBC driver.
    
    See Also:
    Constant Field Values
  - TRIM_LEADING
```
public static final int TRIM_LEADING
```
    The flag for TRIM(LEADING ...) function.
    
    See Also:
    Constant Field Values
  - TRIM_TRAILING
```
public static final int TRIM_TRAILING
```
    The flag for TRIM(TRAILING ...) function.
    
    See Also:
    Constant Field Values
  - JSON_ABSENT_ON_NULL
```
public static final int JSON_ABSENT_ON_NULL
```
    The ABSENT ON NULL flag for JSON_ARRAY and JSON_OBJECT functions.
    
    See Also:
    Constant Field Values
  - JSON_WITH_UNIQUE_KEYS
```
public static final int JSON_WITH_UNIQUE_KEYS
```
    The WITH UNIQUE KEYS flag for JSON_OBJECT function.
    
    See Also:
    Constant Field Values
  - VAR_ARGS
```
protected static final int VAR_ARGS
```
    See Also:
    Constant Field Values
  - args
```
protected Expression[] args
```
  - info
```
protected final FunctionInfo info
```
  - type
```
protected TypeInfo type
```
- Constructor Detail
  - Function
```
public Function(Database database,
        FunctionInfo info)
```
    Creates a new instance of function.
    
    Parameters:
    database - database
    info - function information
  - Function
```
public Function(Database database,
        FunctionInfo info,
        Expression[] arguments)
```
    Creates a new instance of function.
    
    Parameters:
    database - database
    info - function information
    arguments - the arguments
- Method Detail
  - getFunction
```
public static Function getFunction(Database database,
                   int id)
```
    Get an instance of the given function for this database.
    
    Parameters:
    database - the database
    id - the function number
    
    Returns:
    the function object
  - getFunctionWithArgs
```
public static Function getFunctionWithArgs(Database database,
                           int id,
                           Expression... arguments)
```
    Get an instance of the given function for this database.
    
    Parameters:
    database - the database
    id - the function number
    arguments - the arguments
    
    Returns:
    the function object
  - getFunction
```
public static Function getFunction(Database database,
                   java.lang.String name)
```
    Get an instance of the given function for this database. If no function with this name is found, null is returned.
    
    Parameters:
    database - the database
    name - the function name
    
    Returns:
    the function object or null
  - getFunctionInfo
```
public static FunctionInfo getFunctionInfo(java.lang.String upperName)
```
    Returns function information for the specified function name.
    
    Parameters:
    upperName - the function name in upper case
    
    Returns:
    the function information or null
  - addParameter
```
public void addParameter(Expression param)
```
    Adds the parameter expression.
    
    Parameters:
    param - the expression
  - setFlags
```
public void setFlags(int flags)
```
    Description copied from interface: ExpressionWithFlags
    
    Set the flags for this expression.
    
    Specified by:
    
    setFlags in interface ExpressionWithFlags
    
    Parameters:
    flags - the flags to set
  - getFlags
```
public int getFlags()
```
    Description copied from interface: ExpressionWithFlags
    
    Returns the flags.
    
    Specified by:
    
    getFlags in interface ExpressionWithFlags
    
    Returns:
    the flags
  - getValue
```
public Value getValue(Session session)
```
    Description copied from class: Expression
    
    Return the resulting value for the current row.
    
    Specified by:
    
    getValue in class Expression
    
    Parameters:
    session - the session
    
    Returns:
    the result
  - getNullOrValue
```
protected static Value getNullOrValue(Session session,
                   Expression[] args,
                   Value[] values,
                   int i)
```
    Get value transformed by expression, or null if i is out of range or the input value is null.
    
    Parameters:
    session - database session
    args - expressions
    values - array of input values
    i - index of value of transform
    
    Returns:
    value or null
  - getValueWithArgs
```
protected Value getValueWithArgs(Session session,
                     Expression[] args)
```
    Return the resulting value for the given expression arguments.
    
    Parameters:
    session - the session
    args - argument expressions
    
    Returns:
    the result
  - jsonObjectAppend
```
public static void jsonObjectAppend(java.io.ByteArrayOutputStream baos,
                    java.lang.String key,
                    Value value)
```
    Appends a value to a JSON object in the specified string builder.
    
    Parameters:
    baos - the output stream to append to
    key - the name of the property
    value - the value of the property
  - jsonObjectFinish
```
public static Value jsonObjectFinish(java.io.ByteArrayOutputStream baos,
                     int flags)
```
    Appends trailing closing brace to the specified string builder with a JSON object, validates it, and converts to a JSON value.
    
    Parameters:
    baos - the output stream with the object
    flags - the flags (JSON_WITH_UNIQUE_KEYS)
    
    Returns:
    the JSON value
    
    Throws:
    
    DbException - if JSON_WITH_UNIQUE_KEYS is specified and keys are not unique
  - jsonArrayAppend
```
public static void jsonArrayAppend(java.io.ByteArrayOutputStream baos,
                   Value value,
                   int flags)
```
    Appends a value to a JSON array in the specified string builder.
    
    Parameters:
    baos - the output stream to append to
    value - the value
    flags - the flags (JSON_ABSENT_ON_NULL)
  - getType
```
public TypeInfo getType()
```
    Description copied from class: Expression
    
    Returns the data type. The data type may not be known before the optimization phase.
    
    Specified by:
    
    getType in class Expression
    
    Returns:
    the data type
  - getValueType
```
public int getValueType()
```
    Description copied from interface: FunctionCall
    
    Get the data type.
    
    Specified by:
    
    getValueType in interface FunctionCall
    
    Returns:
    the data type
  - mapColumns
```
public void mapColumns(ColumnResolver resolver,
              int level,
              int state)
```
    Description copied from class: Expression
    
    Map the columns of the resolver to expression columns.
    
    Specified by:
    
    mapColumns in class Expression
    
    Parameters:
    resolver - the column resolver
    level - the subquery nesting level
    state - current state for nesting checks, initial value is Expression.MAP_INITIAL
  - checkParameterCount
```
protected void checkParameterCount(int len)
```
    Check if the parameter count is correct.
    
    Parameters:
    len - the number of parameters set
    
    Throws:
    
    DbException - if the parameter count is incorrect
  - doneWithParameters
```
public void doneWithParameters()
```
    This method is called after all the parameters have been set. It checks if the parameter count is correct.
    
    Throws:
    
    DbException - if the parameter count is incorrect.
  - setDataType
```
public void setDataType(TypeInfo type)
```
  - optimize
```
public Expression optimize(Session session)
```
    Description copied from class: Expression
    
    Try to optimize the expression.
    
    Specified by:
    
    optimize in interface FunctionCall
    
    Specified by:
    
    optimize in class Expression
    
    Parameters:
    session - the session
    
    Returns:
    the optimized expression
  - setEvaluatable
```
public void setEvaluatable(TableFilter tableFilter,
                  boolean b)
```
    Description copied from class: Expression
    
    Tell the expression columns whether the table filter can return values now. This is used when optimizing the query.
    
    Specified by:
    
    setEvaluatable in class Expression
    
    Parameters:
    tableFilter - the table filter
    b - true if the table filter can return value
  - getSQL
```
public java.lang.StringBuilder getSQL(java.lang.StringBuilder builder,
                             boolean alwaysQuote)
```
    Description copied from class: Expression
    
    Appends the SQL statement of this expression to the specified builder. This may not always be the original SQL statement, specially after optimization.
    
    Specified by:
    
    getSQL in class Expression
    
    Parameters:
    builder - string builder
    alwaysQuote - quote all identifiers
    
    Returns:
    the specified string builder
  - getJsonFunctionFlagsSQL
```
public static void getJsonFunctionFlagsSQL(java.lang.StringBuilder builder,
                           int flags,
                           boolean forArray)
```
    Appends flags of a JSON function to the specified string builder.
    
    Parameters:
    builder - string builder to append to
    flags - flags to append
    forArray - whether the function is an array function
  - updateAggregate
```
public void updateAggregate(Session session,
                   int stage)
```
    Description copied from class: Expression
    
    Update an aggregate value. This method is called at statement execution time. It is usually called once for each row, but if the expression is used multiple times (for example in the column list, and as part of the HAVING expression) it is called multiple times - the row counter needs to be used to make sure the internal state is only updated once.
    
    Specified by:
    
    updateAggregate in class Expression
    
    Parameters:
    session - the session
    stage - select stage
  - getFunctionType
```
public int getFunctionType()
```
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: FunctionCall
    
    Get the name of the function.
    
    Specified by:
    
    getName in interface FunctionCall
    
    Returns:
    the name
  - getValueForColumnList
```
public ValueResultSet getValueForColumnList(Session session,
                                   Expression[] argList)
```
    Description copied from interface: FunctionCall
    
    Get an empty result set with the column names set.
    
    Specified by:
    
    getValueForColumnList in interface FunctionCall
    
    Parameters:
    session - the session
    argList - the argument list (some arguments may be null)
    
    Returns:
    the empty result set
  - getArgs
```
public Expression[] getArgs()
```
    Description copied from interface: FunctionCall
    
    Get the function arguments.
    
    Specified by:
    
    getArgs in interface FunctionCall
    
    Returns:
    argument list
  - isEverything
```
public boolean isEverything(ExpressionVisitor visitor)
```
    Description copied from class: Expression
    
    Check if this expression and all sub-expressions can fulfill a criteria. If any part returns false, the result is false.
    
    Specified by:
    
    isEverything in class Expression
    
    Parameters:
    visitor - the visitor
    
    Returns:
    if the criteria can be fulfilled
  - getCost
```
public int getCost()
```
    Description copied from class: Expression
    
    Estimate the cost to process the expression. Used when optimizing the query, to calculate the query plan with the lowest estimated cost.
    
    Specified by:
    
    getCost in class Expression
    
    Returns:
    the estimated cost
  - isDeterministic
```
public boolean isDeterministic()
```
    Description copied from interface: FunctionCall
    
    Whether the function always returns the same result for the same parameters.
    
    Specified by:
    
    isDeterministic in interface FunctionCall
    
    Returns:
    true if it does
  - getSubexpressionCount
```
public int getSubexpressionCount()
```
    Description copied from class: Expression
    
    Returns count of subexpressions.
    
    Overrides:
    
    getSubexpressionCount in class Expression
    
    Returns:
    count of subexpressions
  - getSubexpression
```
public Expression getSubexpression(int index)
```
    Description copied from class: Expression
    
    Returns subexpression with specified index.
    
    Overrides:
    
    getSubexpression in class Expression
    
    Parameters:
    index - 0-based index
    
    Returns:
    subexpression with specified index, may be null

Class Function

Field Summary

Fields inherited from class org.h2.expression.Expression

Constructor Summary

Method Summary

Methods inherited from class org.h2.expression.Expression

Methods inherited from class java.lang.Object

Methods inherited from interface org.h2.expression.function.FunctionCall

Field Detail

ABS

ACOS

ASIN

ATAN

ATAN2

BITAND

BITOR

BITXOR

CEILING

COS

COT

DEGREES

EXP

FLOOR

LOG

LOG10

MOD

PI

POWER

RADIANS

RAND

ROUND

ROUNDMAGIC

SIGN

SIN

SQRT

TAN

TRUNCATE

SECURE_RAND

HASH

ENCRYPT

DECRYPT

COMPRESS

EXPAND

ZERO

RANDOM_UUID

COSH

SINH

TANH

LN

BITGET

ORA_HASH

BITNOT

LSHIFT

RSHIFT

ASCII

BIT_LENGTH

CHAR

CHAR_LENGTH

CONCAT

DIFFERENCE

HEXTORAW

INSERT

INSTR

LCASE

LEFT

LENGTH

LOCATE

LTRIM

OCTET_LENGTH

RAWTOHEX

REPEAT

REPLACE

RIGHT

RTRIM

SOUNDEX

SPACE

SUBSTRING

UCASE

LOWER

UPPER