API 4.10-SNAPSHOT¶
Base Package: net.sf.jsqlparser
Base¶
JSQLParserException¶
extends: Exception
JSQLParserException ()
JSQLParserException (message, cause)
String message
Throwable cause
JSQLParserException (message)
String message
JSQLParserException (cause)
Throwable cause
Model¶
implements: Serializable provides: Expression, Statement,
A marker interface for jsqlparser-model-classes.
The datastructure where the sql syntax is represented by a tree consists of Model’s
expression¶
AnalyticType¶
[OVER, WITHIN_GROUP, WITHIN_GROUP_OVER, FILTER_ONLY]
AnyType¶
[ANY, SOME, ALL]
CastExpression.DataType¶
[ARRAY, BIT, BITSTRING, BLOB, BYTEA, BINARY, VARBINARY, BYTES, BOOLEAN, BOOL, ENUM, INTERVAL, LIST, MAP, STRUCT, TINYINT, INT1, SMALLINT, INT2, SHORT, INTEGER, INT4, INT, SIGNED, BIGINT, INT8, LONG, HUGEINT, UTINYINT, USMALLINT, UINTEGER, UBIGINT, UHUGEINT, DECIMAL, NUMBER, NUMERIC, REAL, FLOAT4, FLOAT, DOUBLE, DOUBLE_PRECISION, FLOAT8, FLOAT64, UUID, VARCHAR, NVARCHAR, CHAR, NCHAR, BPCHAR, STRING, TEXT, CLOB, DATE, TIME, TIME_WITHOUT_TIME_ZONE, TIMETZ, TIME_WITH_TIME_ZONE, TIMESTAMP_NS, TIMESTAMP, TIMESTAMP_WITHOUT_TIME_ZONE, DATETIME, TIMESTAMP_MS, TIMESTAMP_S, TIMESTAMPTZ, TIMESTAMP_WITH_TIME_ZONE, UNKNOWN, VARBYTE]
DateTimeLiteralExpression.DateTime¶
[DATE, DATETIME, TIME, TIMESTAMP, TIMESTAMPTZ]
Function.NullHandling¶
[IGNORE_NULLS, RESPECT_NULLS]
JsonAggregateOnNullType¶
[NULL, ABSENT]
JsonAggregateUniqueKeysType¶
[WITH, WITHOUT]
JsonFunctionType¶
[OBJECT, ARRAY, POSTGRES_OBJECT, MYSQL_OBJECT]
SpannerInterleaveIn.OnDelete¶
[CASCADE, NO_ACTION]
StructType.Dialect¶
[BIG_QUERY, DUCKDB]
TrimFunction.TrimSpecification¶
[LEADING, TRAILING, BOTH]
WindowElement.Type¶
[ROWS, RANGE]
WindowOffset.Type¶
[PRECEDING, FOLLOWING, CURRENT, EXPR]
Alias¶
extends: Object implements: Serializable
Alias (name)
String name
Alias (name, useAs)
String name
boolean useAs
getName () → String
returns String
setName (name)
String name
isUseAs () → boolean
returns boolean
setUseAs (useAs)
boolean useAs
getAliasColumns () → List
returns List
setAliasColumns (aliasColumns)
List aliasColumns
@Override
toString () → String
returns String
addAliasColumns (aliasColumns) → Alias
AliasColumn aliasColumns
returns Alias
Alias.AliasColumn¶
extends: Object implements: Serializable
AliasColumn (name, colDataType)
String name
ColDataType colDataType
AliasColumn (name)
String name
AllValue¶
extends: ASTNodeAccessImpl implements: Expression
AllValue ()
@Override
toString () → String
returns String
AnalyticExpression¶
extends: ASTNodeAccessImpl implements: Expression
Analytic function. The name of the function is variable but the parameters following the special analytic function path. e.g. row_number() over (order by test). Additionally, there can be an expression for an analytical aggregate like sum(col) or the “all columns” wildcard like count(*).
AnalyticExpression ()
AnalyticExpression (function)
Function function
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getKeep () → KeepExpression
returns KeepExpression
setKeep (keep)
KeepExpression keep
getPartitionExpressionList () → ExpressionList
returns ExpressionList
setPartitionExpressionList (partitionExpressionList)
ExpressionList partitionExpressionList
setPartitionExpressionList (partitionExpressionList, brackets)
ExpressionList partitionExpressionList
boolean brackets
isPartitionByBrackets () → boolean
returns boolean
getName () → String
returns String
setName (name)
String name
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
getOffset () → Expression
returns Expression
setOffset (offset)
Expression offset
getDefaultValue () → Expression
returns Expression
setDefaultValue (defaultValue)
Expression defaultValue
getWindowElement () → WindowElement
returns WindowElement
setWindowElement (windowElement)
WindowElement windowElement
getType () → AnalyticType
returns AnalyticType
setType (type)
AnalyticType type
isDistinct () → boolean
returns boolean
setDistinct (distinct)
boolean distinct
isUnique () → boolean
returns boolean
setUnique (unique)
boolean unique
isIgnoreNulls () → boolean
returns boolean
setIgnoreNulls (ignoreNulls)
boolean ignoreNulls
isIgnoreNullsOutside () → boolean
returns boolean
setIgnoreNullsOutside (ignoreNullsOutside)
boolean ignoreNullsOutside
getWindowName () → String
returns String
setWindowName (windowName)
String windowName
getWindowDefinition () → WindowDefinition
returns WindowDefinition
setWindowDefinition (windowDef)
WindowDefinition windowDef
getHavingClause () → HavingClause
returns HavingClause
setHavingClause (havingClause) → AnalyticExpression
HavingClause havingClause
returns AnalyticExpression
setHavingClause (havingType, expression) → AnalyticExpression
getNullHandling () → NullHandling
returns NullHandling
setNullHandling (nullHandling) → AnalyticExpression
NullHandling nullHandling
returns AnalyticExpression
setLimit (limit) → AnalyticExpression
Limit limit
returns AnalyticExpression
@Override,| @SuppressWarnings
toString () → String
returns String
isAllColumns () → boolean
returns boolean
setAllColumns (allColumns)
boolean allColumns
getFilterExpression () → Expression
returns Expression
setFilterExpression (filterExpression)
Expression filterExpression
withName (name) → AnalyticExpression
String name
returns AnalyticExpression
withExpression (expression) → AnalyticExpression
Expression expression
returns AnalyticExpression
withOffset (offset) → AnalyticExpression
Expression offset
returns AnalyticExpression
withDefaultValue (defaultValue) → AnalyticExpression
Expression defaultValue
returns AnalyticExpression
withAllColumns (allColumns) → AnalyticExpression
boolean allColumns
returns AnalyticExpression
withKeep (keep) → AnalyticExpression
KeepExpression keep
returns AnalyticExpression
withType (type) → AnalyticExpression
AnalyticType type
returns AnalyticExpression
withDistinct (distinct) → AnalyticExpression
boolean distinct
returns AnalyticExpression
withUnique (unique) → AnalyticExpression
boolean unique
returns AnalyticExpression
withIgnoreNulls (ignoreNulls) → AnalyticExpression
boolean ignoreNulls
returns AnalyticExpression
withFilterExpression (filterExpression) → AnalyticExpression
Expression filterExpression
returns AnalyticExpression
withWindowElement (windowElement) → AnalyticExpression
WindowElement windowElement
returns AnalyticExpression
getExpression (type) → E
Class type
returns E
getOffset (type) → E
Class type
returns E
getDefaultValue (type) → E
Class type
returns E
getFilterExpression (type) → E
Class type
returns E
getFuncOrderBy () → List
returns List
setFuncOrderBy (funcOrderBy)
List funcOrderBy
AnyComparisonExpression¶
extends: ASTNodeAccessImpl implements: Expression
Combines ANY and SOME expressions.
AnyComparisonExpression (anyType, select)
AnyType anyType
Select select
getAnyType () → AnyType
returns AnyType
@Override
toString () → String
returns String
ArrayConstructor¶
extends: ASTNodeAccessImpl implements: Expression
ArrayConstructor (expressions, arrayKeyword)
ExpressionList expressions
boolean arrayKeyword
getExpressions () → ExpressionList
returns ExpressionList
setExpressions (expressions)
ExpressionList expressions
isArrayKeyword () → boolean
returns boolean
setArrayKeyword (arrayKeyword)
boolean arrayKeyword
@Override
toString () → String
returns String
ArrayExpression¶
extends: ASTNodeAccessImpl implements: Expression
ArrayExpression ()
ArrayExpression (objExpression, indexExpression, startIndexExpression, stopIndexExpression)
Expression objExpression
Expression indexExpression
Expression startIndexExpression
Expression stopIndexExpression
ArrayExpression (objExpression, indexExpression)
Expression objExpression
Expression indexExpression
ArrayExpression (objExpression, startIndexExpression, stopIndexExpression)
getObjExpression () → Expression
returns Expression
setObjExpression (objExpression)
Expression objExpression
getIndexExpression () → Expression
returns Expression
setIndexExpression (indexExpression)
Expression indexExpression
getStartIndexExpression () → Expression
returns Expression
setStartIndexExpression (startIndexExpression)
Expression startIndexExpression
getStopIndexExpression () → Expression
returns Expression
setStopIndexExpression (stopIndexExpression)
Expression stopIndexExpression
@Override
toString () → String
returns String
withObjExpression (objExpression) → ArrayExpression
Expression objExpression
returns ArrayExpression
withIndexExpression (indexExpression) → ArrayExpression
Expression indexExpression
returns ArrayExpression
withRangeExpression (startIndexExpression, stopIndexExpression) → ArrayExpression
getObjExpression (type) → E
Class type
returns E
getIndexExpression (type) → E
Class type
returns E
BinaryExpression¶
extends: ASTNodeAccessImpl implements: Expression provides: Addition, AndExpression, BitwiseAnd, BitwiseLeftShift, BitwiseOr, BitwiseRightShift, BitwiseXor, Concat, Division, IntegerDivision, IsDistinctExpression, JsonOperator, LikeExpression, Modulo, Multiplication, OldOracleJoinBinaryExpression, OrExpression, RegExpMatchOperator, SimilarToExpression, Subtraction, XorExpression
A basic class for binary expressions, that is expressions having a left member and a right member which are in turn expressions.
BinaryExpression ()
BinaryExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
build (clz, expressions) → Expression
add (expressions) → Expression
Expression expressions
returns Expression
bitAnd (expressions) → Expression
Expression expressions
returns Expression
bitShiftLeft (expressions) → Expression
Expression expressions
returns Expression
multiply (expressions) → Expression
Expression expressions
returns Expression
bitOr (expressions) → Expression
Expression expressions
returns Expression
bitShiftRight (expressions) → Expression
Expression expressions
returns Expression
bitXor (expressions) → Expression
Expression expressions
returns Expression
concat (expressions) → Expression
Expression expressions
returns Expression
divide (expressions) → Expression
Expression expressions
returns Expression
divideInt (expressions) → Expression
Expression expressions
returns Expression
modulo (expressions) → Expression
Expression expressions
returns Expression
subtract (expressions) → Expression
Expression expressions
returns Expression
or (expressions) → Expression
Expression expressions
returns Expression
xor (expressions) → Expression
Expression expressions
returns Expression
and (expressions) → Expression
Expression expressions
returns Expression
getLeftExpression () → Expression
returns Expression
getRightExpression () → Expression
returns Expression
withLeftExpression (expression) → BinaryExpression
Expression expression
returns BinaryExpression
setLeftExpression (expression)
Expression expression
withRightExpression (expression) → BinaryExpression
Expression expression
returns BinaryExpression
setRightExpression (expression)
Expression expression
@Override
toString () → String
returns String
getStringExpression () → String
returns String
getLeftExpression (type) → E
Class type
returns E
getRightExpression (type) → E
Class type
returns E
CaseExpression¶
extends: ASTNodeAccessImpl implements: Expression
CASE/WHEN expression. Syntax:
`CASE WHEN condition THEN expression [WHEN condition THEN expression]... [ELSE expression] END`or
`CASE expression WHEN condition THEN expression [WHEN condition THEN expression]... [ELSE expression] END`CaseExpression ()
CaseExpression (whenClauses)
WhenClause whenClauses
CaseExpression (elseExpression, whenClauses)
Expression elseExpression
WhenClause whenClauses
getSwitchExpression () → Expression
returns Expression
setSwitchExpression (switchExpression)
Expression switchExpression
getElseExpression () → Expression
returns Expression | Returns the elseExpression.
setElseExpression (elseExpression)
Expression elseExpression | elseExpression The elseExpression to set.
getWhenClauses () → List
returns List | Returns the whenClauses.
setWhenClauses (whenClauses)
List whenClauses | whenClauses The whenClauses to set.
@Override
toString () → String
returns String
withSwitchExpression (switchExpression) → CaseExpression
Expression switchExpression
returns CaseExpression
withWhenClauses (whenClauses) → CaseExpression
WhenClause whenClauses
returns CaseExpression
withWhenClauses (whenClauses) → CaseExpression
List whenClauses
returns CaseExpression
withElseExpression (elseExpression) → CaseExpression
Expression elseExpression
returns CaseExpression
addWhenClauses (whenClauses) → CaseExpression
WhenClause whenClauses
returns CaseExpression
addWhenClauses (whenClauses) → CaseExpression
Collection whenClauses
returns CaseExpression
getSwitchExpression (type) → E
Class type
returns E
getElseExpression (type) → E
Class type
returns E
isUsingBrackets () → boolean
returns boolean | the usingBrackets
setUsingBrackets (usingBrackets)
boolean usingBrackets | usingBrackets the usingBrackets to set
withUsingBrackets (usingBrackets) → CaseExpression
boolean usingBrackets | usingBrackets the usingBrackets to set
returns CaseExpression
CastExpression¶
extends: ASTNodeAccessImpl implements: Expression
CastExpression (keyword, leftExpression, dataType)
CastExpression (dataType, value)
String dataType
String value
CastExpression (colDataType, value)
ColDataType colDataType
String value
CastExpression (colDataType, value)
ColDataType colDataType
Long value
CastExpression (colDataType, value)
ColDataType colDataType
Double value
CastExpression (leftExpression, dataType)
Expression leftExpression
String dataType
CastExpression (keyword)
String keyword
CastExpression ()
getColDataType () → ColDataType
returns ColDataType
getColumnDefinitions () → ArrayList
returns ArrayList
setColDataType (colDataType)
ColDataType colDataType
addColumnDefinition (columnDefinition)
ColumnDefinition columnDefinition
getLeftExpression () → Expression
returns Expression
setLeftExpression (expression)
Expression expression
isImplicitCast () → boolean
returns boolean
setImplicitCast (implicitCast) → CastExpression
boolean implicitCast
returns CastExpression
@Deprecated
isUseCastKeyword () → boolean
returns boolean
@Deprecated
setUseCastKeyword (useCastKeyword)
boolean useCastKeyword
getFormat () → String
returns String
setFormat (format) → CastExpression
String format
returns CastExpression
@Override
toString () → String
returns String
withType (type) → CastExpression
ColDataType type
returns CastExpression
withUseCastKeyword (useCastKeyword) → CastExpression
boolean useCastKeyword
returns CastExpression
withLeftExpression (leftExpression) → CastExpression
Expression leftExpression
returns CastExpression
getLeftExpression (type) → E
Class type
returns E
isOf (anotherCast) → boolean
CastExpression anotherCast
returns boolean
isOf (colDataType, types) → boolean
isOf (types) → boolean
DataType types
returns boolean
isTime (colDataType) → boolean
ColDataType colDataType
returns boolean
isTime () → boolean
returns boolean
isTimeStamp (colDataType) → boolean
ColDataType colDataType
returns boolean
isTimeStamp () → boolean
returns boolean
isDate (colDataType) → boolean
ColDataType colDataType
returns boolean
isDate () → boolean
returns boolean
isBLOB (colDataType) → boolean
ColDataType colDataType
returns boolean
isBLOB () → boolean
returns boolean
isFloat (colDataType) → boolean
ColDataType colDataType
returns boolean
isFloat () → boolean
returns boolean
isInteger (colDataType) → boolean
ColDataType colDataType
returns boolean
isInteger () → boolean
returns boolean
isDecimal (colDataType) → boolean
ColDataType colDataType
returns boolean
isDecimal () → boolean
returns boolean
isText (colDataType) → boolean
ColDataType colDataType
returns boolean
isText () → boolean
returns boolean
CollateExpression¶
extends: ASTNodeAccessImpl implements: Expression
CollateExpression ()
CollateExpression (leftExpression, collate)
Expression leftExpression
String collate
getLeftExpression () → Expression
returns Expression
setLeftExpression (leftExpression)
Expression leftExpression
getCollate () → String
returns String
setCollate (collate)
String collate
@Override
toString () → String
returns String
withLeftExpression (leftExpression) → CollateExpression
Expression leftExpression
returns CollateExpression
withCollate (collate) → CollateExpression
String collate
returns CollateExpression
getLeftExpression (type) → E
Class type
returns E
ConnectByRootOperator¶
extends: ASTNodeAccessImpl implements: Expression
ConnectByRootOperator (column)
Column column
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
DateTimeLiteralExpression¶
extends: ASTNodeAccessImpl implements: Expression
DateTimeLiteralExpression ()
getValue () → String
returns String
setValue (value)
String value
getType () → DateTime
returns DateTime
setType (type)
DateTime type
@Override
toString () → String
returns String
withValue (value) → DateTimeLiteralExpression
String value
returns DateTimeLiteralExpression
withType (type) → DateTimeLiteralExpression
DateTime type
returns DateTimeLiteralExpression
DateValue¶
extends: ASTNodeAccessImpl implements: Expression
A Date in the form {d ‘yyyy-mm-dd’}
DateValue ()
DateValue (value)
Date value
DateValue (value)
A Date in the form {d ‘yyyy-mm-dd’}
String value | value The text presentation of the Date to be parsed.
getValue () → Date
returns Date
setValue (d)
Date d
@Override
toString () → String
returns String
DoubleValue¶
extends: ASTNodeAccessImpl implements: Expression
Every number with a point or a exponential format is a DoubleValue
DoubleValue ()
DoubleValue (value)
String value
DoubleValue (value)
double value
getValue () → double
returns double
setValue (d)
Double d
@Override
toString () → String
returns String
withValue (value) → DoubleValue
Double value
returns DoubleValue
ExpressionVisitorAdapter¶
extends: Object implements: ExpressionVisitor, PivotVisitor, SelectItemVisitor
ExpressionVisitorAdapter ()
getSelectVisitor () → SelectVisitor
returns SelectVisitor
setSelectVisitor (selectVisitor)
SelectVisitor selectVisitor
visit (overlapsCondition)
OverlapsCondition overlapsCondition
BinaryExpression exprreturns void@Override
visit (jsonExpr)
JsonExpression jsonExpr
@Override
visit (oracleNamedFunctionParameter)
OracleNamedFunctionParameter oracleNamedFunctionParameter
ExtractExpression¶
extends: ASTNodeAccessImpl implements: Expression
Extract value from date/time expression. The name stores the part - name to get from the following date/time expression.
ExtractExpression ()
getName () → String
returns String
setName (name)
String name
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withName (name) → ExtractExpression
String name
returns ExtractExpression
withExpression (expression) → ExtractExpression
Expression expression
returns ExtractExpression
getExpression (type) → E
Class type
returns E
FilterOverImpl¶
extends: ASTNodeAccessImpl provides: JsonAggregateFunction
FilterOverImpl ()
getAnalyticType () → AnalyticType
returns AnalyticType
setAnalyticType (analyticType)
AnalyticType analyticType
withAnalyticType (analyticType) → FilterOverImpl
AnalyticType analyticType
returns FilterOverImpl
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
withOrderByElements (orderByElements) → FilterOverImpl
List orderByElements
returns FilterOverImpl
getPartitionExpressionList () → ExpressionList
returns ExpressionList
setPartitionExpressionList (partitionExpressionList)
ExpressionList partitionExpressionList
setPartitionExpressionList (partitionExpressionList, brackets)
ExpressionList partitionExpressionList
boolean brackets
isPartitionByBrackets () → boolean
returns boolean
getFilterExpression () → Expression
returns Expression
setFilterExpression (filterExpression)
Expression filterExpression
withFilterExpression (filterExpression) → FilterOverImpl
Expression filterExpression
returns FilterOverImpl
getWindowElement () → WindowElement
returns WindowElement
setWindowElement (windowElement)
WindowElement windowElement
withWindowElement (windowElement) → FilterOverImpl
WindowElement windowElement
returns FilterOverImpl
@SuppressWarnings
append (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override,| @SuppressWarnings
toString () → String
returns String
Function¶
extends: ASTNodeAccessImpl implements: Expression provides: TableFunction
A function as MAX,COUNT…
Function ()
Function (name, parameters)
String name
Expression parameters
getName () → String
returns String
getMultipartName () → List
returns List
setName (string)
String string
setName (string)
List string
isAllColumns () → boolean
returns boolean
setAllColumns (b)
boolean b
getNullHandling () → NullHandling
returns NullHandling
isIgnoreNulls () → boolean
returns boolean
setIgnoreNulls (ignoreNulls)
This is at the moment only necessary for AnalyticExpression initialization and not for normal functions. Therefore there is no deparsing for it for normal functions.
boolean ignoreNulls
getHavingClause () → HavingClause
returns HavingClause
setHavingClause (havingClause) → Function
HavingClause havingClause
returns Function
setHavingClause (havingType, expression) → Function
isDistinct () → boolean
true if the function is “distinct”
returns boolean | true if the function is “distinct”
setDistinct (b)
boolean b
isUnique () → boolean
true if the function is “unique”
returns boolean | true if the function is “unique”
setUnique (b)
boolean b
getParameters () → ExpressionList
The list of parameters of the function (if any, else null) If the parameter is “*”, allColumns is set to true
returns ExpressionList | the list of parameters of the function (if any, else null)
setParameters (expressions)
Expression expressions
setParameters (list)
ExpressionList list
getNamedParameters () → NamedExpressionList
the parameters might be named parameters, e.g. substring(‘foobar’ from 2 for 3)
returns NamedExpressionList | the list of named parameters of the function (if any, else null)
setNamedParameters (list)
NamedExpressionList list
isEscaped () → boolean
Return true if it’s in the form “{fn function_body() }”
returns boolean | true if it’s java-escaped
setEscaped (isEscaped)
boolean isEscaped
getAttribute () → Object
returns Object
setAttribute (attributeExpression)
Expression attributeExpression
@Deprecated
getAttributeName () → String
returns String
setAttributeName (attributeName)
String attributeName
setAttribute (attributeColumn)
Column attributeColumn
getKeep () → KeepExpression
returns KeepExpression
setKeep (keep)
KeepExpression keep
@Override,| @SuppressWarnings
toString () → String
returns String
withAttribute (attribute) → Function
Expression attribute
returns Function
withKeep (keep) → Function
KeepExpression keep
returns Function
withParameters (parameters) → Function
ExpressionList parameters
returns Function
withParameters (parameters) → Function
Expression parameters
returns Function
withNamedParameters (namedParameters) → Function
NamedExpressionList namedParameters
returns Function
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getAttribute (type) → E
Class type
returns E
Function.HavingClause¶
extends: ASTNodeAccessImpl implements: Expression
HavingClause (havingType, expression)
HavingType havingType
Expression expression
getHavingType () → HavingType
returns HavingType
setHavingType (havingType) → HavingClause
HavingType havingType
returns HavingClause
getExpression () → Expression
returns Expression
setExpression (expression) → HavingClause
Expression expression
returns HavingClause
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
HexValue¶
extends: ASTNodeAccessImpl implements: Expression
HexValue ()
HexValue (value)
String value
getValue () → String
returns String
setValue (value)
String value
@Override
toString () → String
returns String
getDigits () → String
returns String
getLong () → Long
returns Long
hexStringToByteArray (s) → byte
String s
returns byte
getStringValue () → StringValue
returns StringValue
getBlob () → StringValue
returns StringValue
IntervalExpression¶
extends: ASTNodeAccessImpl implements: Expression
IntervalExpression ()
IntervalExpression (intervalKeyword)
boolean intervalKeyword
isUsingIntervalKeyword () → boolean
returns boolean
getParameter () → String
returns String
setParameter (parameter)
String parameter
getIntervalType () → String
returns String
setIntervalType (intervalType)
String intervalType
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withParameter (parameter) → IntervalExpression
String parameter
returns IntervalExpression
withIntervalType (intervalType) → IntervalExpression
String intervalType
returns IntervalExpression
withExpression (expression) → IntervalExpression
Expression expression
returns IntervalExpression
getExpression (type) → E
Class type
returns E
JdbcNamedParameter¶
extends: ASTNodeAccessImpl implements: Expression
JdbcNamedParameter ()
JdbcNamedParameter (name)
String name
getParameterCharacter () → String
returns String
setParameterCharacter (parameterCharacter) → JdbcNamedParameter
String parameterCharacter
returns JdbcNamedParameter
getName () → String
returns String
setName (name)
String name
@Override
toString () → String
returns String
withName (name) → JdbcNamedParameter
String name
returns JdbcNamedParameter
JdbcParameter¶
extends: ASTNodeAccessImpl implements: Expression
A ‘?’ in a statement or a ?<number> e.g. ?4
JdbcParameter ()
JdbcParameter (index, useFixedIndex, parameterCharacter)
Integer index
boolean useFixedIndex
String parameterCharacter
getParameterCharacter () → String
returns String
setParameterCharacter (parameterCharacter) → JdbcParameter
String parameterCharacter
returns JdbcParameter
getIndex () → Integer
returns Integer
setIndex (index)
Integer index
isUseFixedIndex () → boolean
returns boolean
setUseFixedIndex (useFixedIndex)
boolean useFixedIndex
@Override
toString () → String
returns String
withIndex (index) → JdbcParameter
Integer index
returns JdbcParameter
withUseFixedIndex (useFixedIndex) → JdbcParameter
boolean useFixedIndex
returns JdbcParameter
JsonAggregateFunction¶
extends: FilterOverImpl implements: Expression
JsonAggregateFunction ()
getOnNullType () → JsonAggregateOnNullType
returns JsonAggregateOnNullType
setOnNullType (onNullType)
JsonAggregateOnNullType onNullType
withOnNullType (onNullType) → JsonAggregateFunction
JsonAggregateOnNullType onNullType
returns JsonAggregateFunction
getUniqueKeysType () → JsonAggregateUniqueKeysType
returns JsonAggregateUniqueKeysType
setUniqueKeysType (uniqueKeysType)
JsonAggregateUniqueKeysType uniqueKeysType
withUniqueKeysType (uniqueKeysType) → JsonAggregateFunction
JsonAggregateUniqueKeysType uniqueKeysType
returns JsonAggregateFunction
getType () → JsonFunctionType
returns JsonFunctionType
setType (type)
JsonFunctionType type
withType (type) → JsonAggregateFunction
JsonFunctionType type
returns JsonAggregateFunction
setType (typeName)
String typeName
withType (typeName) → JsonAggregateFunction
String typeName
returns JsonAggregateFunction
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
withExpression (expression) → JsonAggregateFunction
Expression expression
returns JsonAggregateFunction
isUsingKeyKeyword () → boolean
returns boolean
setUsingKeyKeyword (usingKeyKeyword)
boolean usingKeyKeyword
withUsingKeyKeyword (usingKeyKeyword) → JsonAggregateFunction
boolean usingKeyKeyword
returns JsonAggregateFunction
getKey () → String
returns String
setKey (key)
String key
withKey (key) → JsonAggregateFunction
String key
returns JsonAggregateFunction
isUsingValueKeyword () → boolean
returns boolean
setUsingValueKeyword (usingValueKeyword)
boolean usingValueKeyword
withUsingValueKeyword (usingValueKeyword) → JsonAggregateFunction
boolean usingValueKeyword
returns JsonAggregateFunction
getValue () → Object
returns Object
setValue (value)
Object value
withValue (value) → JsonAggregateFunction
Object value
returns JsonAggregateFunction
isUsingFormatJson () → boolean
returns boolean
setUsingFormatJson (usingFormatJson)
boolean usingFormatJson
withUsingFormatJson (usingFormatJson) → JsonAggregateFunction
boolean usingFormatJson
returns JsonAggregateFunction
getExpressionOrderByElements () → List
returns List
setExpressionOrderByElements (orderByElements)
List orderByElements
withExpressionOrderByElements (orderByElements) → JsonAggregateFunction
List orderByElements
returns JsonAggregateFunction
@Override
append (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendObject (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendArray (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
JsonExpression¶
extends: ASTNodeAccessImpl implements: Expression
JsonExpression ()
JsonExpression (expr)
Expression expr
JsonExpression (expr, idents)
Expression expr
List idents
getExpression () → Expression
returns Expression
setExpression (expr)
Expression expr
addIdent (ident, operator)
String ident
String operator
addAllIdents (idents)
Collection idents
getIdentList () → List
returns List
getIdent (index) → Entry
int index
returns Entry
@Deprecated
getIdents () → List
returns List
@Deprecated
getOperators () → List
returns List
@Override
toString () → String
returns String
withExpression (expr) → JsonExpression
Expression expr
returns JsonExpression
JsonFunction¶
extends: ASTNodeAccessImpl implements: Expression
JsonFunction ()
getKeyValuePairs () → ArrayList
returns ArrayList
getExpressions () → ArrayList
returns ArrayList
getKeyValuePair (i) → JsonKeyValuePair
int i
returns JsonKeyValuePair
getExpression (i) → JsonFunctionExpression
int i
returns JsonFunctionExpression
add (keyValuePair) → boolean
JsonKeyValuePair keyValuePair
returns boolean
add (i, keyValuePair)
int i
JsonKeyValuePair keyValuePair
add (expression) → boolean
JsonFunctionExpression expression
returns boolean
add (i, expression)
int i
JsonFunctionExpression expression
isEmpty () → boolean
returns boolean
getOnNullType () → JsonAggregateOnNullType
returns JsonAggregateOnNullType
setOnNullType (onNullType)
JsonAggregateOnNullType onNullType
withOnNullType (onNullType) → JsonFunction
JsonAggregateOnNullType onNullType
returns JsonFunction
getUniqueKeysType () → JsonAggregateUniqueKeysType
returns JsonAggregateUniqueKeysType
setUniqueKeysType (uniqueKeysType)
JsonAggregateUniqueKeysType uniqueKeysType
withUniqueKeysType (uniqueKeysType) → JsonFunction
JsonAggregateUniqueKeysType uniqueKeysType
returns JsonFunction
getType () → JsonFunctionType
returns JsonFunctionType
setType (type)
JsonFunctionType type
withType (type) → JsonFunction
JsonFunctionType type
returns JsonFunction
setType (typeName)
String typeName
withType (typeName) → JsonFunction
String typeName
returns JsonFunction
append (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendObject (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendPostgresObject (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
appendMySqlObject (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendArray (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
JsonFunctionExpression¶
extends: Object implements: Serializable
JsonFunctionExpression (expression)
Expression expression
getExpression () → Expression
returns Expression
isUsingFormatJson () → boolean
returns boolean
setUsingFormatJson (usingFormatJson)
boolean usingFormatJson
withUsingFormatJson (usingFormatJson) → JsonFunctionExpression
boolean usingFormatJson
returns JsonFunctionExpression
append (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
JsonKeyValuePair¶
extends: Object implements: Serializable
JsonKeyValuePair (key, value, usingKeyKeyword, usingValueKeyword)
String key
Object value
boolean usingKeyKeyword
boolean usingValueKeyword
isUsingKeyKeyword () → boolean
returns boolean
setUsingKeyKeyword (usingKeyKeyword)
boolean usingKeyKeyword
withUsingKeyKeyword (usingKeyKeyword) → JsonKeyValuePair
boolean usingKeyKeyword
returns JsonKeyValuePair
isUsingValueKeyword () → boolean
returns boolean
setUsingValueKeyword (usingValueKeyword)
boolean usingValueKeyword
withUsingValueKeyword (usingValueKeyword) → JsonKeyValuePair
boolean usingValueKeyword
returns JsonKeyValuePair
isUsingFormatJson () → boolean
returns boolean
setUsingFormatJson (usingFormatJson)
boolean usingFormatJson
withUsingFormatJson (usingFormatJson) → JsonKeyValuePair
boolean usingFormatJson
returns JsonKeyValuePair
@Override
hashCode () → int
returns int
@Override
equals (obj) → boolean
Object obj
returns boolean
getKey () → String
returns String
getValue () → Object
returns Object
append (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
KeepExpression¶
extends: ASTNodeAccessImpl implements: Expression
KeepExpression ()
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getName () → String
returns String
setName (name)
String name
isFirst () → boolean
returns boolean
setFirst (first)
boolean first
@Override
toString () → String
returns String
withName (name) → KeepExpression
String name
returns KeepExpression
withOrderByElements (orderByElements) → KeepExpression
List orderByElements
returns KeepExpression
withFirst (first) → KeepExpression
boolean first
returns KeepExpression
addOrderByElements (orderByElements) → KeepExpression
OrderByElement orderByElements
returns KeepExpression
addOrderByElements (orderByElements) → KeepExpression
Collection orderByElements
returns KeepExpression
LambdaExpression¶
extends: ASTNodeAccessImpl implements: Expression
LambdaExpression (identifier, expression)
String identifier
Expression expression
LambdaExpression (identifiers, expression)
List identifiers
Expression expression
getIdentifiers () → List
returns List
setIdentifiers (identifiers) → LambdaExpression
List identifiers
returns LambdaExpression
getExpression () → Expression
returns Expression
setExpression (expression) → LambdaExpression
Expression expression
returns LambdaExpression
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
LongValue¶
extends: ASTNodeAccessImpl implements: Expression
Every number without a point or an exponential format is a LongValue.
LongValue ()
LongValue (value)
String value
LongValue (value)
long value
getValue () → long
returns long
getBigIntegerValue () → BigInteger
returns BigInteger
setValue (d)
long d
getStringValue () → String
returns String
setStringValue (string)
String string
@Override
toString () → String
returns String
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
MySQLGroupConcat¶
extends: ASTNodeAccessImpl implements: Expression
MySQLGroupConcat ()
getExpressionList () → ExpressionList
returns ExpressionList
setExpressionList (expressionList)
ExpressionList expressionList
isDistinct () → boolean
returns boolean
setDistinct (distinct)
boolean distinct
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getSeparator () → String
returns String
setSeparator (separator)
String separator
@Override
toString () → String
returns String
withExpressionList (expressionList) → MySQLGroupConcat
ExpressionList expressionList
returns MySQLGroupConcat
withDistinct (distinct) → MySQLGroupConcat
boolean distinct
returns MySQLGroupConcat
withOrderByElements (orderByElements) → MySQLGroupConcat
List orderByElements
returns MySQLGroupConcat
withSeparator (separator) → MySQLGroupConcat
String separator
returns MySQLGroupConcat
addOrderByElements (orderByElements) → MySQLGroupConcat
OrderByElement orderByElements
returns MySQLGroupConcat
addOrderByElements (orderByElements) → MySQLGroupConcat
Collection orderByElements
returns MySQLGroupConcat
MySQLIndexHint¶
extends: Object implements: Serializable
MySQLIndexHint (action, indexQualifier, indexNames)
String action
String indexQualifier
List indexNames
getAction () → String
returns String
getIndexQualifier () → String
returns String
getIndexNames () → List
returns List
@Override
toString () → String
returns String
NextValExpression¶
extends: ASTNodeAccessImpl implements: Expression
NextValExpression (nameList, image)
List nameList
String image
isUsingNextValueFor () → boolean
returns boolean
setUsingNextValueFor (usingNextValueFor)
boolean usingNextValueFor
withNextValueFor (usingNextValueFor) → NextValExpression
boolean usingNextValueFor
returns NextValExpression
getNameList () → List
returns List
getName () → String
returns String
@Override
toString () → String
returns String
NotExpression¶
extends: ASTNodeAccessImpl implements: Expression
It represents a “not “ or “!” before an expression.
NotExpression ()
NotExpression (expression)
Expression expression
NotExpression (expression, useExclamationMark)
Expression expression
boolean useExclamationMark
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
isExclamationMark () → boolean
returns boolean
setExclamationMark (exclamationMark)
boolean exclamationMark
withExpression (expression) → NotExpression
Expression expression
returns NotExpression
withExclamationMark (exclamationMark) → NotExpression
boolean exclamationMark
returns NotExpression
getExpression (type) → E
Class type
returns E
NullValue¶
extends: ASTNodeAccessImpl implements: Expression
NullValue ()
@Override
toString () → String
returns String
NumericBind¶
extends: ASTNodeAccessImpl implements: Expression
NumericBind ()
getBindId () → int
returns int
setBindId (bindId)
int bindId
@Override
toString () → String
returns String
withBindId (bindId) → NumericBind
int bindId
returns NumericBind
OracleHierarchicalExpression¶
extends: ASTNodeAccessImpl implements: Expression
OracleHierarchicalExpression ()
getStartExpression () → Expression
returns Expression
setStartExpression (startExpression)
Expression startExpression
getConnectExpression () → Expression
returns Expression
setConnectExpression (connectExpression)
Expression connectExpression
isNoCycle () → boolean
returns boolean
setNoCycle (noCycle)
boolean noCycle
isConnectFirst () → boolean
returns boolean
setConnectFirst (connectFirst)
boolean connectFirst
@Override
toString () → String
returns String
withStartExpression (startExpression) → OracleHierarchicalExpression
Expression startExpression
returns OracleHierarchicalExpression
withConnectExpression (connectExpression) → OracleHierarchicalExpression
Expression connectExpression
returns OracleHierarchicalExpression
withNoCycle (noCycle) → OracleHierarchicalExpression
boolean noCycle
returns OracleHierarchicalExpression
withConnectFirst (connectFirst) → OracleHierarchicalExpression
boolean connectFirst
returns OracleHierarchicalExpression
getStartExpression (type) → E
Class type
returns E
getConnectExpression (type) → E
Class type
returns E
OracleHint¶
extends: ASTNodeAccessImpl implements: Expression
Oracle Hint Expression
OracleHint ()
isHintMatch (comment) → boolean
String comment
returns boolean
setComment (comment)
String comment
getValue () → String
returns String
setValue (value)
String value
isSingleLine () → boolean
returns boolean
setSingleLine (singleLine)
boolean singleLine
@Override
toString () → String
returns String
withValue (value) → OracleHint
String value
returns OracleHint
withSingleLine (singleLine) → OracleHint
boolean singleLine
returns OracleHint
getHintFromSelectBody (selectBody) → OracleHint
Select selectBody
returns OracleHint
OracleNamedFunctionParameter¶
extends: ASTNodeAccessImpl implements: Expression
OracleNamedFunctionParameter (name, expression)
String name
Expression expression
getName () → String
returns String
getExpression () → Expression
returns Expression
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
OrderByClause¶
extends: Object implements: Serializable
OrderByClause ()
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
toStringOrderByElements (b)
StringBuilder b
withOrderByElements (orderByElements) → OrderByClause
List orderByElements
returns OrderByClause
addOrderByElements (orderByElements) → OrderByClause
OrderByElement orderByElements
returns OrderByClause
addOrderByElements (orderByElements) → OrderByClause
Collection orderByElements
returns OrderByClause
OverlapsCondition¶
extends: ASTNodeAccessImpl implements: Expression
OverlapsCondition (left, right)
ExpressionList left
ExpressionList right
getLeft () → ExpressionList
returns ExpressionList
getRight () → ExpressionList
returns ExpressionList
@Override
toString () → String
returns String
Parenthesis¶
extends: ParenthesedExpressionList
Parenthesis ()
getExpression () → Expression
returns Expression
setExpression (expression) → Parenthesis
Expression expression
returns Parenthesis
withExpression (expression) → Parenthesis
Expression expression
returns Parenthesis
getExpression (type) → E
Class type
returns E
PartitionByClause¶
extends: Object implements: Serializable
PartitionByClause ()
getPartitionExpressionList () → ExpressionList
returns ExpressionList
setPartitionExpressionList (partitionExpressionList)
ExpressionList partitionExpressionList
setPartitionExpressionList (partitionExpressionList, brackets)
ExpressionList partitionExpressionList
boolean brackets
toStringPartitionBy (b)
StringBuilder b
isBrackets () → boolean
returns boolean
withPartitionExpressionList (partitionExpressionList) → PartitionByClause
ExpressionList partitionExpressionList
returns PartitionByClause
RangeExpression¶
extends: ASTNodeAccessImpl implements: Expression
RangeExpression (startExpression, endExpression)
Expression startExpression
Expression endExpression
getStartExpression () → Expression
returns Expression
setStartExpression (startExpression) → RangeExpression
Expression startExpression
returns RangeExpression
getEndExpression () → Expression
returns Expression
setEndExpression (endExpression) → RangeExpression
Expression endExpression
returns RangeExpression
@Override
toString () → String
returns String
RowConstructor¶
extends: ParenthesedExpressionList implements: Expression
RowConstructor ()
RowConstructor (name, expressionList)
String name
ExpressionList expressionList
getName () → String
returns String
setName (name)
String name
@Override
toString () → String
returns String
withName (name) → RowConstructor
String name
returns RowConstructor
RowGetExpression¶
extends: ASTNodeAccessImpl implements: Expression
RowGetExpression (expression, columnName)
Expression expression
String columnName
@Override
toString () → String
returns String
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
getColumnName () → String
returns String
setColumnName (columnName)
String columnName
SQLServerHints¶
extends: Object implements: Serializable
SQLServerHints ()
withNoLock () → SQLServerHints
returns SQLServerHints
getNoLock () → Boolean
returns Boolean
setNoLock (noLock)
Boolean noLock
getIndexName () → String
returns String
setIndexName (indexName)
String indexName
@Override
toString () → String
returns String
withNoLock (noLock) → SQLServerHints
Boolean noLock
returns SQLServerHints
withIndexName (indexName) → SQLServerHints
String indexName
returns SQLServerHints
SignedExpression¶
extends: ASTNodeAccessImpl implements: Expression
It represents a “-” or “+” or “~” before an expression
SignedExpression ()
SignedExpression (sign, expression)
char sign
Expression expression
getSign () → char
returns char
setSign (sign)
char sign
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withSign (sign) → SignedExpression
char sign
returns SignedExpression
withExpression (expression) → SignedExpression
Expression expression
returns SignedExpression
getExpression (type) → E
Class type
returns E
SpannerInterleaveIn¶
extends: Object
SpannerInterleaveIn ()
SpannerInterleaveIn (table, action)
Table table
OnDelete action
SpannerInterleaveIn (nameParts)
List nameParts
SpannerInterleaveIn (tableName)
String tableName
setTable (table)
Table table
getOnDelete () → OnDelete
returns OnDelete
setOnDelete (action)
OnDelete action
@Override
toString () → String
returns String
withTable (table) → SpannerInterleaveIn
Table table
returns SpannerInterleaveIn
withOnDelete (action) → SpannerInterleaveIn
OnDelete action
returns SpannerInterleaveIn
StringValue¶
extends: ASTNodeAccessImpl implements: Expression
A string as in ‘example_string’
StringValue ()
StringValue (escapedValue)
String escapedValue
getValue () → String
returns String
getPrefix () → String
returns String
getNotExcapedValue () → String
returns String
setValue (string)
String string
setPrefix (prefix)
String prefix
@Override
toString () → String
returns String
withPrefix (prefix) → StringValue
String prefix
returns StringValue
withValue (value) → StringValue
String value
returns StringValue
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
StructType¶
extends: ASTNodeAccessImpl implements: Expression
StructType (dialect, keyword, parameters, arguments)
Dialect dialect
String keyword
List parameters
List arguments
StructType (dialect, parameters, arguments)
Dialect dialect
List parameters
List arguments
StructType (dialect, arguments)
Dialect dialect
List arguments
getDialect () → Dialect
returns Dialect
setDialect (dialect) → StructType
Dialect dialect
returns StructType
getKeyword () → String
returns String
setKeyword (keyword) → StructType
String keyword
returns StructType
getParameters () → List
returns List
setParameters (parameters) → StructType
List parameters
returns StructType
getArguments () → List
returns List
setArguments (arguments) → StructType
List arguments
returns StructType
add (expression, aliasName) → StructType
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
TimeKeyExpression¶
extends: ASTNodeAccessImpl implements: Expression
TimeKeyExpression ()
TimeKeyExpression (value)
String value
getStringValue () → String
returns String
setStringValue (string)
String string
@Override
toString () → String
returns String
withStringValue (stringValue) → TimeKeyExpression
String stringValue
returns TimeKeyExpression
TimeValue¶
extends: ASTNodeAccessImpl implements: Expression
A Time in the form {t ‘hh:mm:ss’}
TimeValue ()
TimeValue (value)
String value
getValue () → Time
returns Time
setValue (d)
Time d
@Override
toString () → String
returns String
TimestampValue¶
extends: ASTNodeAccessImpl implements: Expression
A Timestamp in the form {ts ‘yyyy-mm-dd hh:mm:ss.f …’}
TimestampValue ()
TimestampValue (value)
String value
getValue () → Timestamp
returns Timestamp
setValue (d)
Timestamp d
getRawValue () → String
returns String
setRawValue (rawValue)
String rawValue
@Override
toString () → String
returns String
withValue (value) → TimestampValue
Timestamp value
returns TimestampValue
TimezoneExpression¶
extends: ASTNodeAccessImpl implements: Expression
TimezoneExpression ()
TimezoneExpression (leftExpression, timezoneExpressions)
Expression leftExpression
Expression timezoneExpressions
getLeftExpression () → Expression
returns Expression
setLeftExpression (expression) → TimezoneExpression
Expression expression
returns TimezoneExpression
getTimezoneExpressions () → List
returns List
addTimezoneExpression (timezoneExpr)
Expression timezoneExpr
@Override
toString () → String
returns String
TranscodingFunction¶
extends: ASTNodeAccessImpl implements: Expression
TranscodingFunction (expression, transcodingName)
Expression expression
String transcodingName
TranscodingFunction (colDataType, expression, transcodingName)
TranscodingFunction ()
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
withExpression (expression) → TranscodingFunction
Expression expression
returns TranscodingFunction
getTranscodingName () → String
returns String
setTranscodingName (transcodingName)
String transcodingName
withTranscodingName (transcodingName) → TranscodingFunction
String transcodingName
returns TranscodingFunction
getColDataType () → ColDataType
returns ColDataType
setColDataType (colDataType) → TranscodingFunction
ColDataType colDataType
returns TranscodingFunction
isTranscodeStyle () → boolean
returns boolean
setTranscodeStyle (transcodeStyle) → TranscodingFunction
boolean transcodeStyle
returns TranscodingFunction
accept (expressionVisitor)
ExpressionVisitor expressionVisitor
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
TrimFunction¶
extends: ASTNodeAccessImpl implements: Expression
TrimFunction (trimSpecification, expression, fromExpression, isUsingFromKeyword)
TrimSpecification trimSpecification
Expression expression
Expression fromExpression
boolean isUsingFromKeyword
TrimFunction ()
getTrimSpecification () → TrimSpecification
returns TrimSpecification
setTrimSpecification (trimSpecification)
TrimSpecification trimSpecification
withTrimSpecification (trimSpecification) → TrimFunction
TrimSpecification trimSpecification
returns TrimFunction
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
withExpression (expression) → TrimFunction
Expression expression
returns TrimFunction
getFromExpression () → Expression
returns Expression
setFromExpression (fromExpression)
Expression fromExpression
withFromExpression (fromExpression) → TrimFunction
Expression fromExpression
returns TrimFunction
isUsingFromKeyword () → boolean
returns boolean
setUsingFromKeyword (useFromKeyword)
boolean useFromKeyword
withUsingFromKeyword (useFromKeyword) → TrimFunction
boolean useFromKeyword
returns TrimFunction
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
UserVariable¶
extends: ASTNodeAccessImpl implements: Expression
Simple uservariables like @test.
UserVariable ()
UserVariable (name)
String name
getName () → String
returns String
setName (name)
String name
isDoubleAdd () → boolean
returns boolean
setDoubleAdd (doubleAdd)
boolean doubleAdd
@Override
toString () → String
returns String
withName (name) → UserVariable
String name
returns UserVariable
withDoubleAdd (doubleAdd) → UserVariable
boolean doubleAdd
returns UserVariable
VariableAssignment¶
extends: ASTNodeAccessImpl implements: Expression
Assignment to a user variable like in select @a = 5.
VariableAssignment ()
getVariable () → UserVariable
returns UserVariable
setVariable (variable)
UserVariable variable
getOperation () → String
returns String
setOperation (operation)
String operation
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
WhenClause¶
extends: ASTNodeAccessImpl implements: Expression
A clause of following syntax: WHEN condition THEN expression. Which is part of a CaseExpression.
WhenClause ()
WhenClause (whenExpression, thenExpression)
Expression whenExpression
Expression thenExpression
getThenExpression () → Expression
returns Expression
setThenExpression (thenExpression)
Expression thenExpression
getWhenExpression () → Expression
returns Expression | Returns the whenExpression.
setWhenExpression (whenExpression)
Expression whenExpression | whenExpression The whenExpression to set.
@Override
toString () → String
returns String
withWhenExpression (whenExpression) → WhenClause
Expression whenExpression
returns WhenClause
withThenExpression (thenExpression) → WhenClause
Expression thenExpression
returns WhenClause
getThenExpression (type) → E
Class type
returns E
getWhenExpression (type) → E
Class type
returns E
WindowDefinition¶
extends: Object implements: Serializable
WindowDefinition ()
getOrderBy () → OrderByClause
returns OrderByClause
getPartitionBy () → PartitionByClause
returns PartitionByClause
getWindowElement () → WindowElement
returns WindowElement
setWindowElement (windowElement)
WindowElement windowElement
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getPartitionExpressionList () → ExpressionList
returns ExpressionList
setPartitionExpressionList (partitionExpressionList)
ExpressionList partitionExpressionList
setPartitionExpressionList (partitionExpressionList, brackets)
ExpressionList partitionExpressionList
boolean brackets
getWindowName () → String
returns String
setWindowName (windowName)
String windowName
withWindowName (windowName) → WindowDefinition
String windowName
returns WindowDefinition
@Override
toString () → String
returns String
WindowElement¶
extends: Object implements: Serializable
WindowElement ()
getType () → Type
returns Type
setType (type)
Type type
getOffset () → WindowOffset
returns WindowOffset
setOffset (offset)
WindowOffset offset
getRange () → WindowRange
returns WindowRange
setRange (range)
WindowRange range
@Override
toString () → String
returns String
withType (type) → WindowElement
Type type
returns WindowElement
withOffset (offset) → WindowElement
WindowOffset offset
returns WindowElement
withRange (range) → WindowElement
WindowRange range
returns WindowElement
WindowOffset¶
extends: Object implements: Serializable
WindowOffset ()
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
getType () → Type
returns Type
setType (type)
Type type
@Override
toString () → String
returns String
withExpression (expression) → WindowOffset
Expression expression
returns WindowOffset
withType (type) → WindowOffset
Type type
returns WindowOffset
getExpression (type) → E
Class type
returns E
WindowRange¶
extends: Object implements: Serializable
WindowRange ()
getEnd () → WindowOffset
returns WindowOffset
setEnd (end)
WindowOffset end
getStart () → WindowOffset
returns WindowOffset
setStart (start)
WindowOffset start
@Override
toString () → String
returns String
withStart (start) → WindowRange
WindowOffset start
returns WindowRange
withEnd (end) → WindowRange
WindowOffset end
returns WindowRange
XMLSerializeExpr¶
extends: ASTNodeAccessImpl implements: Expression
XMLSerializeExpr ()
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getDataType () → ColDataType
returns ColDataType
setDataType (dataType)
ColDataType dataType
@Override
toString () → String
returns String
Expression¶
implements: ASTNodeAccess, Model provides: AllColumns, AllValue, AnalyticExpression, AnyComparisonExpression, ArrayConstructor, ArrayExpression, Between, BinaryExpression, CaseExpression, CastExpression, CollateExpression, Column, ConnectByRootOperator, DateTimeLiteralExpression, DateValue, DoubleValue, ExcludesExpression, ExistsExpression, ExpressionList, ExtractExpression, FullTextSearch, Function, HavingClause, HexValue, InExpression, IncludesExpression, IntervalExpression, IsBooleanExpression, IsNullExpression, JdbcNamedParameter, JdbcParameter, JsonAggregateFunction, JsonExpression, JsonFunction, KeepExpression, LambdaExpression, LongValue, MemberOfExpression, MultipleExpression, MySQLGroupConcat, NextValExpression, NotExpression, NullValue, NumericBind, OracleHierarchicalExpression, OracleHint, OracleNamedFunctionParameter, OverlapsCondition, RangeExpression, RowConstructor, RowGetExpression, Select, SignedExpression, StringValue, StructType, TimeKeyExpression, TimeValue, TimestampValue, TimezoneExpression, TranscodingFunction, TrimFunction, UserVariable, VariableAssignment, WhenClause, XMLSerializeExpr,
accept (expressionVisitor)
ExpressionVisitor expressionVisitor
ExpressionVisitor¶
provides: ExpressionDeParser, ExpressionValidator, ExpressionVisitorAdapter, TablesNamesFinder,
visit (aThis)
BitwiseRightShift aThis
visit (aThis)
BitwiseLeftShift aThis
visit (nullValue)
NullValue nullValue
visit (function)
Function function
visit (signedExpression)
SignedExpression signedExpression
visit (jdbcParameter)
JdbcParameter jdbcParameter
visit (jdbcNamedParameter)
JdbcNamedParameter jdbcNamedParameter
visit (doubleValue)
DoubleValue doubleValue
visit (longValue)
LongValue longValue
visit (hexValue)
HexValue hexValue
visit (dateValue)
DateValue dateValue
visit (timeValue)
TimeValue timeValue
visit (timestampValue)
TimestampValue timestampValue
visit (stringValue)
StringValue stringValue
visit (addition)
Addition addition
visit (division)
Division division
visit (division)
IntegerDivision division
visit (multiplication)
Multiplication multiplication
visit (subtraction)
Subtraction subtraction
visit (andExpression)
AndExpression andExpression
visit (orExpression)
OrExpression orExpression
visit (orExpression)
XorExpression orExpression
visit (between)
Between between
visit (overlapsCondition)
OverlapsCondition overlapsCondition
visit (equalsTo)
EqualsTo equalsTo
visit (greaterThan)
GreaterThan greaterThan
visit (greaterThanEquals)
GreaterThanEquals greaterThanEquals
visit (inExpression)
InExpression inExpression
visit (includesExpression)
IncludesExpression includesExpression
visit (excludesExpression)
ExcludesExpression excludesExpression
visit (fullTextSearch)
FullTextSearch fullTextSearch
visit (isNullExpression)
IsNullExpression isNullExpression
visit (isBooleanExpression)
IsBooleanExpression isBooleanExpression
visit (likeExpression)
LikeExpression likeExpression
visit (minorThan)
MinorThan minorThan
visit (minorThanEquals)
MinorThanEquals minorThanEquals
visit (notEqualsTo)
NotEqualsTo notEqualsTo
visit (doubleAnd)
DoubleAnd doubleAnd
visit (contains)
Contains contains
visit (containedBy)
ContainedBy containedBy
visit (selectBody)
ParenthesedSelect selectBody
visit (tableColumn)
Column tableColumn
visit (caseExpression)
CaseExpression caseExpression
visit (whenClause)
WhenClause whenClause
visit (existsExpression)
ExistsExpression existsExpression
visit (memberOfExpression)
MemberOfExpression memberOfExpression
visit (anyComparisonExpression)
AnyComparisonExpression anyComparisonExpression
visit (concat)
Concat concat
visit (matches)
Matches matches
visit (bitwiseAnd)
BitwiseAnd bitwiseAnd
visit (bitwiseOr)
BitwiseOr bitwiseOr
visit (bitwiseXor)
BitwiseXor bitwiseXor
visit (cast)
CastExpression cast
visit (modulo)
Modulo modulo
visit (aexpr)
AnalyticExpression aexpr
visit (eexpr)
ExtractExpression eexpr
visit (iexpr)
IntervalExpression iexpr
visit (oexpr)
visit (rexpr)
RegExpMatchOperator rexpr
visit (jsonExpr)
JsonExpression jsonExpr
visit (jsonExpr)
JsonOperator jsonExpr
visit (var)
UserVariable var
visit (bind)
NumericBind bind
visit (aexpr)
KeepExpression aexpr
visit (groupConcat)
MySQLGroupConcat groupConcat
visit (expressionList)
ExpressionList expressionList
visit (rowConstructor)
RowConstructor rowConstructor
visit (rowGetExpression)
RowGetExpression rowGetExpression
visit (hint)
OracleHint hint
visit (timeKeyExpression)
TimeKeyExpression timeKeyExpression
visit (literal)
DateTimeLiteralExpression literal
visit (aThis)
NotExpression aThis
visit (aThis)
NextValExpression aThis
visit (aThis)
CollateExpression aThis
visit (aThis)
SimilarToExpression aThis
visit (aThis)
ArrayExpression aThis
visit (aThis)
ArrayConstructor aThis
visit (aThis)
VariableAssignment aThis
visit (aThis)
XMLSerializeExpr aThis
visit (aThis)
TimezoneExpression aThis
visit (aThis)
JsonAggregateFunction aThis
visit (aThis)
JsonFunction aThis
visit (aThis)
ConnectByRootOperator aThis
visit (aThis)
visit (allColumns)
AllColumns allColumns
visit (allTableColumns)
AllTableColumns allTableColumns
visit (allValue)
AllValue allValue
visit (isDistinctExpression)
IsDistinctExpression isDistinctExpression
visit (geometryDistance)
GeometryDistance geometryDistance
visit (selectBody)
Select selectBody
visit (transcodingFunction)
TranscodingFunction transcodingFunction
visit (trimFunction)
TrimFunction trimFunction
visit (rangeExpression)
RangeExpression rangeExpression
visit (tsqlLeftJoin)
TSQLLeftJoin tsqlLeftJoin
visit (tsqlRightJoin)
TSQLRightJoin tsqlRightJoin
visit (structType)
StructType structType
visit (lambdaExpression)
LambdaExpression lambdaExpression
expression.operators.arithmetic¶
Addition¶
extends: BinaryExpression
Addition ()
Addition (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
BitwiseAnd¶
extends: BinaryExpression
BitwiseAnd ()
BitwiseAnd (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
BitwiseLeftShift¶
extends: BinaryExpression
BitwiseLeftShift ()
BitwiseLeftShift (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
BitwiseOr¶
extends: BinaryExpression
BitwiseOr ()
BitwiseOr (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
BitwiseRightShift¶
extends: BinaryExpression
BitwiseRightShift ()
BitwiseRightShift (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
BitwiseXor¶
extends: BinaryExpression
BitwiseXor ()
BitwiseXor (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
Concat¶
extends: BinaryExpression
Concat ()
Concat (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
Division¶
extends: BinaryExpression
Division ()
Division (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
IntegerDivision¶
extends: BinaryExpression
IntegerDivision ()
IntegerDivision (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
Modulo¶
extends: BinaryExpression
Modulo expression (a % b).
Modulo ()
Modulo (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
Multiplication¶
extends: BinaryExpression
Multiplication ()
Multiplication (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
Subtraction¶
extends: BinaryExpression
Subtraction ()
Subtraction (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
getStringExpression () → String
returns String
expression.operators.conditional¶
AndExpression¶
extends: BinaryExpression
AndExpression ()
AndExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
setUseOperator (useOperator)
boolean useOperator
isUseOperator () → boolean
returns boolean
@Override
getStringExpression () → String
returns String
withUseOperator (useOperator) → AndExpression
boolean useOperator
returns AndExpression
OrExpression¶
extends: BinaryExpression
OrExpression ()
OrExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
withRightExpression (expression) → OrExpression
Expression expression
returns OrExpression
@Override
getStringExpression () → String
returns String
XorExpression¶
extends: BinaryExpression
XorExpression ()
XorExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
withLeftExpression (expression) → XorExpression
Expression expression
returns XorExpression
@Override
withRightExpression (expression) → XorExpression
Expression expression
returns XorExpression
@Override
getStringExpression () → String
returns String
expression.operators.relational¶
LikeExpression.KeyWord¶
[LIKE, ILIKE, RLIKE, REGEXP, SIMILAR_TO]
RegExpMatchOperatorType¶
[MATCH_CASESENSITIVE, MATCH_CASEINSENSITIVE, NOT_MATCH_CASESENSITIVE, NOT_MATCH_CASEINSENSITIVE]
PostgresSQL match operators.
Between¶
extends: ASTNodeAccessImpl implements: Expression
A “BETWEEN” expr1 expr2 statement
Between ()
getBetweenExpressionEnd () → Expression
returns Expression
getBetweenExpressionStart () → Expression
returns Expression
getLeftExpression () → Expression
returns Expression
isNot () → boolean
returns boolean
setBetweenExpressionEnd (expression)
Expression expression
setBetweenExpressionStart (expression)
Expression expression
setLeftExpression (expression)
Expression expression
setNot (b)
boolean b
@Override
toString () → String
returns String
withLeftExpression (leftExpression) → Between
Expression leftExpression
returns Between
withBetweenExpressionStart (betweenExpressionStart) → Between
Expression betweenExpressionStart
returns Between
withBetweenExpressionEnd (betweenExpressionEnd) → Between
Expression betweenExpressionEnd
returns Between
getBetweenExpressionEnd (type) → E
Class type
returns E
getBetweenExpressionStart (type) → E
Class type
returns E
getLeftExpression (type) → E
Class type
returns E
ComparisonOperator¶
extends: OldOracleJoinBinaryExpression provides: ContainedBy, Contains, DoubleAnd, EqualsTo, GeometryDistance, GreaterThan, GreaterThanEquals, MinorThan, MinorThanEquals, NotEqualsTo, TSQLLeftJoin, TSQLRightJoin
ComparisonOperator (operator)
String operator
ComparisonOperator (operator, left, right)
@Override
getStringExpression () → String
returns String
@Override
withRightExpression (arg0) → ComparisonOperator
Expression arg0
returns ComparisonOperator
@Override
withOldOracleJoinSyntax (oldOracleJoinSyntax) → ComparisonOperator
int oldOracleJoinSyntax
returns ComparisonOperator
@Override
withOraclePriorPosition (oraclePriorPosition) → ComparisonOperator
int oraclePriorPosition
returns ComparisonOperator
ContainedBy¶
extends: ComparisonOperator
ContainedBy ()
Contains¶
extends: ComparisonOperator
Contains ()
DoubleAnd¶
extends: ComparisonOperator
DoubleAnd ()
EqualsTo¶
extends: ComparisonOperator
EqualsTo ()
EqualsTo (left, right)
Expression left
Expression right
ExcludesExpression¶
extends: ASTNodeAccessImpl implements: Expression
ExcludesExpression ()
ExcludesExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
getLeftExpression () → Expression
returns Expression
withLeftExpression (expression) → ExcludesExpression
Expression expression
returns ExcludesExpression
setLeftExpression (expression)
Expression expression
getRightExpression () → Expression
returns Expression
setRightExpression (rightExpression)
Expression rightExpression
@Override
toString () → String
returns String
withRightExpression (rightExpression) → ExcludesExpression
Expression rightExpression
returns ExcludesExpression
getLeftExpression (type) → E
Class type
returns E
getRightExpression (type) → E
Class type
returns E
ExistsExpression¶
extends: ASTNodeAccessImpl implements: Expression
ExistsExpression ()
getRightExpression () → Expression
returns Expression
setRightExpression (expression)
Expression expression
isNot () → boolean
returns boolean
setNot (b)
boolean b
getStringExpression () → String
returns String
@Override
toString () → String
returns String
withRightExpression (rightExpression) → ExistsExpression
Expression rightExpression
returns ExistsExpression
withNot (not) → ExistsExpression
boolean not
returns ExistsExpression
getRightExpression (type) → E
Class type
returns E
ExpressionList¶
extends: ArrayList implements: Expression, Serializable provides: NamedExpressionList, ParenthesedExpressionList
A list of expressions, as in SELECT A FROM TAB WHERE B IN (expr1,expr2,expr3)
ExpressionList (expressions)
Collection expressions
ExpressionList (expressions)
List expressions
ExpressionList (expressions)
T expressions
@Deprecated
isUsingBrackets () → boolean
returns boolean
@Deprecated
getExpressions () → List
returns List
@Deprecated
setExpressions (expressions)
List expressions
addExpression (expression) → ExpressionList
T expression
returns ExpressionList
addExpressions (expressions) → ExpressionList
T expressions
returns ExpressionList
addExpressions (expressions) → ExpressionList
Collection expressions
returns ExpressionList
withExpressions (expressions) → ExpressionList
T expressions
returns ExpressionList
withExpressions (expressions) → ExpressionList
Collection expressions
returns ExpressionList
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
@Override
getASTNode () → SimpleNode
returns SimpleNode
@Override
setASTNode (node)
SimpleNode node
FullTextSearch¶
extends: ASTNodeAccessImpl implements: Expression
FullTextSearch ()
setMatchColumns (columns)
ExpressionList columns
getMatchColumns () → ExpressionList
returns ExpressionList
setAgainstValue (val)
StringValue val
setAgainstValue (val)
setAgainstValue (val)
JdbcParameter val
getAgainstValue () → Expression
returns Expression
setSearchModifier (val)
String val
getSearchModifier () → String
returns String
@Override
toString () → String
returns String
withMatchColumns (matchColumns) → FullTextSearch
ExpressionList matchColumns
returns FullTextSearch
withAgainstValue (againstValue) → FullTextSearch
StringValue againstValue
returns FullTextSearch
withSearchModifier (searchModifier) → FullTextSearch
String searchModifier
returns FullTextSearch
addMatchColumns (matchColumns) → FullTextSearch
Column matchColumns
returns FullTextSearch
addMatchColumns (matchColumns) → FullTextSearch
Collection matchColumns
returns FullTextSearch
GeometryDistance¶
extends: ComparisonOperator
GeometryDistance ()
GeometryDistance (operator)
String operator
GreaterThan¶
extends: ComparisonOperator
GreaterThan ()
GreaterThan (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
GreaterThanEquals¶
extends: ComparisonOperator
GreaterThanEquals ()
GreaterThanEquals (operator)
String operator
GreaterThanEquals (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
InExpression¶
extends: ASTNodeAccessImpl implements: Expression, SupportsOldOracleJoinSyntax
InExpression ()
InExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
@Override
setOldOracleJoinSyntax (oldOracleJoinSyntax)
int oldOracleJoinSyntax
@Override
getOldOracleJoinSyntax () → int
returns int
getLeftExpression () → Expression
returns Expression
withLeftExpression (expression) → InExpression
Expression expression
returns InExpression
setLeftExpression (expression)
Expression expression
isGlobal () → boolean
returns boolean
setGlobal (b) → InExpression
boolean b
returns InExpression
isNot () → boolean
returns boolean
setNot (b)
boolean b
getRightExpression () → Expression
returns Expression
setRightExpression (rightExpression)
Expression rightExpression
@Override
toString () → String
returns String
@Override
getOraclePriorPosition () → int
returns int
@Override
setOraclePriorPosition (priorPosition)
int priorPosition
withRightExpression (rightExpression) → InExpression
Expression rightExpression
returns InExpression
@Override
withOldOracleJoinSyntax (oldOracleJoinSyntax) → InExpression
int oldOracleJoinSyntax
returns InExpression
@Override
withOraclePriorPosition (priorPosition) → InExpression
int priorPosition
returns InExpression
withGlobal (global) → InExpression
boolean global
returns InExpression
withNot (not) → InExpression
boolean not
returns InExpression
getLeftExpression (type) → E
Class type
returns E
getRightExpression (type) → E
Class type
returns E
IncludesExpression¶
extends: ASTNodeAccessImpl implements: Expression
IncludesExpression ()
IncludesExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
getLeftExpression () → Expression
returns Expression
withLeftExpression (expression) → IncludesExpression
Expression expression
returns IncludesExpression
setLeftExpression (expression)
Expression expression
getRightExpression () → Expression
returns Expression
setRightExpression (rightExpression)
Expression rightExpression
@Override
toString () → String
returns String
withRightExpression (rightExpression) → IncludesExpression
Expression rightExpression
returns IncludesExpression
getLeftExpression (type) → E
Class type
returns E
getRightExpression (type) → E
Class type
returns E
IsBooleanExpression¶
extends: ASTNodeAccessImpl implements: Expression
IsBooleanExpression ()
getLeftExpression () → Expression
returns Expression
isNot () → boolean
returns boolean
setLeftExpression (expression)
Expression expression
setNot (b)
boolean b
isTrue () → boolean
returns boolean
setIsTrue (isTrue)
boolean isTrue
@Override
toString () → String
returns String
withIsTrue (isTrue) → IsBooleanExpression
boolean isTrue
returns IsBooleanExpression
withLeftExpression (leftExpression) → IsBooleanExpression
Expression leftExpression
returns IsBooleanExpression
withNot (not) → IsBooleanExpression
boolean not
returns IsBooleanExpression
getLeftExpression (type) → E
Class type
returns E
IsDistinctExpression¶
extends: BinaryExpression
IsDistinctExpression ()
isNot () → boolean
returns boolean
setNot (b)
boolean b
@Override
getStringExpression () → String
returns String
@Override
toString () → String
returns String
IsNullExpression¶
extends: ASTNodeAccessImpl implements: Expression
IsNullExpression ()
IsNullExpression (leftExpression)
Expression leftExpression
getLeftExpression () → Expression
returns Expression
isNot () → boolean
returns boolean
setLeftExpression (expression)
Expression expression
setNot (b)
boolean b
isUseIsNull () → boolean
returns boolean
setUseIsNull (useIsNull)
boolean useIsNull
isUseNotNull () → boolean
returns boolean
setUseNotNull (useNotNull) → IsNullExpression
boolean useNotNull
returns IsNullExpression
@Override
toString () → String
returns String
withUseIsNull (useIsNull) → IsNullExpression
boolean useIsNull
returns IsNullExpression
withLeftExpression (leftExpression) → IsNullExpression
Expression leftExpression
returns IsNullExpression
withNot (not) → IsNullExpression
boolean not
returns IsNullExpression
getLeftExpression (type) → E
Class type
returns E
JsonOperator¶
extends: BinaryExpression
JsonOperator (op)
String op
@Override
getStringExpression () → String
returns String
LikeExpression¶
extends: BinaryExpression
LikeExpression ()
isNot () → boolean
returns boolean
setNot (b)
boolean b
isUseBinary () → boolean
returns boolean
setUseBinary (useBinary) → LikeExpression
boolean useBinary
returns LikeExpression
@Deprecated,| @Override
getStringExpression () → String
returns String
@Override
toString () → String
returns String
getEscape () → Expression
returns Expression
setEscape (escapeExpression)
Expression escapeExpression
@Deprecated
isCaseInsensitive () → boolean
returns boolean
@Deprecated
setCaseInsensitive (caseInsensitive)
boolean caseInsensitive
getLikeKeyWord () → KeyWord
returns KeyWord
setLikeKeyWord (likeKeyWord) → LikeExpression
KeyWord likeKeyWord
returns LikeExpression
setLikeKeyWord (likeKeyWord) → LikeExpression
String likeKeyWord
returns LikeExpression
withEscape (escape) → LikeExpression
Expression escape
returns LikeExpression
@Deprecated
withCaseInsensitive (caseInsensitive) → LikeExpression
boolean caseInsensitive
returns LikeExpression
withNot (not) → LikeExpression
boolean not
returns LikeExpression
Matches¶
extends: OldOracleJoinBinaryExpression
Matches ()
@Override
getStringExpression () → String
returns String
MemberOfExpression¶
extends: ASTNodeAccessImpl implements: Expression
MemberOfExpression (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
getLeftExpression () → Expression
returns Expression
setLeftExpression (leftExpression) → MemberOfExpression
Expression leftExpression
returns MemberOfExpression
getRightExpression () → Expression
returns Expression
setRightExpression (rightExpression) → MemberOfExpression
Expression rightExpression
returns MemberOfExpression
isNot () → boolean
returns boolean
setNot (not) → MemberOfExpression
boolean not
returns MemberOfExpression
@Override
toString () → String
returns String
MinorThan¶
extends: ComparisonOperator
MinorThan ()
MinorThan (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
MinorThanEquals¶
extends: ComparisonOperator
MinorThanEquals ()
MinorThanEquals (operator)
String operator
MinorThanEquals (leftExpression, rightExpression)
Expression leftExpression
Expression rightExpression
NamedExpressionList¶
extends: ExpressionList
A list of named expressions, as in as in select substr(‘xyzzy’ from 2 for 3)
NamedExpressionList ()
getNames () → List
returns List
setNames (list)
List list
@Override
toString () → String
returns String
withNames (names) → NamedExpressionList
List names
returns NamedExpressionList
addNames (names) → NamedExpressionList
String names
returns NamedExpressionList
addNames (names) → NamedExpressionList
Collection names
returns NamedExpressionList
NotEqualsTo¶
extends: ComparisonOperator
NotEqualsTo ()
NotEqualsTo (operator)
String operator
NotEqualsTo (left, right)
Expression left
Expression right
OldOracleJoinBinaryExpression¶
extends: BinaryExpression implements: SupportsOldOracleJoinSyntax provides: ComparisonOperator, Matches
OldOracleJoinBinaryExpression ()
@Override
setOldOracleJoinSyntax (oldOracleJoinSyntax)
int oldOracleJoinSyntax
@Override
toString () → String
returns String
@Override
getOldOracleJoinSyntax () → int
returns int
@Override
getOraclePriorPosition () → int
returns int
@Override
setOraclePriorPosition (oraclePriorPosition)
int oraclePriorPosition
withOldOracleJoinSyntax (oldOracleJoinSyntax) → OldOracleJoinBinaryExpression
int oldOracleJoinSyntax
returns OldOracleJoinBinaryExpression
withOraclePriorPosition (oraclePriorPosition) → OldOracleJoinBinaryExpression
int oraclePriorPosition
returns OldOracleJoinBinaryExpression
@Override
withLeftExpression (arg0) → OldOracleJoinBinaryExpression
Expression arg0
returns OldOracleJoinBinaryExpression
@Override
withRightExpression (arg0) → OldOracleJoinBinaryExpression
Expression arg0
returns OldOracleJoinBinaryExpression
ParenthesedExpressionList¶
extends: ExpressionList provides: Parenthesis, RowConstructor
ParenthesedExpressionList ()
ParenthesedExpressionList (expressions)
ExpressionList expressions
ParenthesedExpressionList (expressions)
T expressions
ParenthesedExpressionList (expressions)
Collection expressions
from (expressions) → ParenthesedExpressionList
ExpressionList expressions
returns ParenthesedExpressionList
@Override
toString () → String
returns String
RegExpMatchOperator¶
extends: BinaryExpression
RegExpMatchOperator (operatorType)
RegExpMatchOperatorType operatorType
getOperatorType () → RegExpMatchOperatorType
returns RegExpMatchOperatorType
@Override
getStringExpression () → String
returns String
@Override
withLeftExpression (arg0) → RegExpMatchOperator
Expression arg0
returns RegExpMatchOperator
@Override
withRightExpression (arg0) → RegExpMatchOperator
Expression arg0
returns RegExpMatchOperator
SimilarToExpression¶
extends: BinaryExpression
SimilarToExpression ()
isNot () → boolean
returns boolean
setNot (b)
boolean b
@Override
getStringExpression () → String
returns String
@Override
toString () → String
returns String
getEscape () → String
returns String
setEscape (escape)
String escape
withEscape (escape) → SimilarToExpression
String escape
returns SimilarToExpression
withNot (not) → SimilarToExpression
boolean not
returns SimilarToExpression
@Override
withLeftExpression (arg0) → SimilarToExpression
Expression arg0
returns SimilarToExpression
@Override
withRightExpression (arg0) → SimilarToExpression
Expression arg0
returns SimilarToExpression
TSQLLeftJoin¶
extends: ComparisonOperator
TSQLLeftJoin ()
TSQLRightJoin¶
extends: ComparisonOperator
TSQLRightJoin ()
SupportsOldOracleJoinSyntax¶
provides: InExpression, OldOracleJoinBinaryExpression,
getOldOracleJoinSyntax () → int
returns int
setOldOracleJoinSyntax (oldOracleJoinSyntax)
int oldOracleJoinSyntax
withOldOracleJoinSyntax (oldOracleJoinSyntax) → SupportsOldOracleJoinSyntax
int oldOracleJoinSyntax
returns SupportsOldOracleJoinSyntax
getOraclePriorPosition () → int
returns int
setOraclePriorPosition (priorPosition)
int priorPosition
withOraclePriorPosition (priorPosition) → SupportsOldOracleJoinSyntax
int priorPosition
returns SupportsOldOracleJoinSyntax
parser¶
ASTNodeAccessImpl¶
extends: Object implements: ASTNodeAccess provides: AllColumns, AllValue, AnalyticExpression, AnyComparisonExpression, ArrayConstructor, ArrayExpression, Between, BinaryExpression, CaseExpression, CastExpression, CollateExpression, Column, ConnectByRootOperator, DateTimeLiteralExpression, DateValue, DoubleValue, ExcludesExpression, ExistsExpression, ExtractExpression, FilterOverImpl, ForClause, FullTextSearch, Function, HavingClause, HexValue, InExpression, IncludesExpression, IntervalExpression, IsBooleanExpression, IsNullExpression, JdbcNamedParameter, JdbcParameter, Join, JsonExpression, JsonFunction, KSQLJoinWindow, KSQLWindow, KeepExpression, LambdaExpression, Limit, LongValue, MemberOfExpression, MultipleExpression, MySQLGroupConcat, NextValExpression, NotExpression, NullValue, NumericBind, OracleHierarchicalExpression, OracleHint, OracleNamedFunctionParameter, OverlapsCondition, ParenthesedFromItem, RangeExpression, RowGetExpression, Select, SelectItem, Sequence, SetOperation, SignedExpression, StringValue, StructType, Synonym, Table, TimeKeyExpression, TimeValue, TimestampValue, TimezoneExpression, Top, TranscodingFunction, TrimFunction, UserVariable, VariableAssignment, WhenClause, XMLSerializeExpr
ASTNodeAccessImpl ()
@Override
getASTNode () → SimpleNode
returns SimpleNode
@Override
setASTNode (node)
SimpleNode node
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
getParent () → ASTNodeAccess
returns ASTNodeAccess
getParent (clazz) → T
Class clazz
returns T
AbstractJSqlParser¶
extends: Object
AbstractJSqlParser ()
withSquareBracketQuotation () → P
returns P
withSquareBracketQuotation (allowSquareBracketQuotation) → P
boolean allowSquareBracketQuotation
returns P
withAllowComplexParsing () → P
returns P
withAllowComplexParsing (allowComplexParsing) → P
boolean allowComplexParsing
returns P
withComplexParsing () → P
returns P
withComplexParsing (allowComplexParsing) → P
boolean allowComplexParsing
returns P
withUnsupportedStatements () → P
returns P
withUnsupportedStatements (allowUnsupportedStatements) → P
boolean allowUnsupportedStatements
returns P
withTimeOut (timeOutMillSeconds) → P
long timeOutMillSeconds
returns P
withBackslashEscapeCharacter () → P
returns P
withBackslashEscapeCharacter (allowBackslashEscapeCharacter) → P
boolean allowBackslashEscapeCharacter
returns P
withFeature (f, enabled) → P
Feature f
boolean enabled
returns P
withFeature (f, value) → P
Feature f
long value
returns P
getConfiguration () → FeatureConfiguration
returns FeatureConfiguration
me () → P
returns P
getAsBoolean (f) → boolean
Feature f
returns boolean
getAsLong (f) → Long
Feature f
returns Long
setErrorRecovery (errorRecovery)
boolean errorRecovery
withErrorRecovery () → P
returns P
withErrorRecovery (errorRecovery) → P
boolean errorRecovery
returns P
getParseErrors () → List
returns List
BaseToken¶
extends: Object
BaseToken ()
CCJSqlParserManager¶
extends: Object implements: JSqlParser
CCJSqlParserManager ()
CCJSqlParserUtil¶
extends: Object
Toolfunctions to start and use JSqlParser.
parse (sql, consumer) → Statement
Parses an sql statement while allowing via consumer to configure the used parser before. For instance to activate SQLServer bracket quotation on could use: {@code CCJSqlParserUtil.parse(“select * from [mytable]”, parser -> parser.withSquareBracketQuotation(true)); }
parse (sql, executorService, consumer) → Statement
newParser (sql) → CCJSqlParser
String sql
returns CCJSqlParser
newParser (is) → CCJSqlParser
InputStream is
returns CCJSqlParser
newParser (is, encoding) → CCJSqlParser
InputStream is
String encoding
returns CCJSqlParser
parseAST (sql) → Node
String sql
returns Node
parseExpression (expression) → Expression
String expression
returns Expression
parseExpression (expression, allowPartialParse) → Expression
@SuppressWarnings
parseExpression (expressionStr, allowPartialParse, consumer) → Expression
parseCondExpression (condExpr) → Expression
Parse an conditional expression. This is the expression after a where clause. Partial parsing is enabled.
String condExpr
returns Expression | the expression parsed
parseCondExpression (condExpr, allowPartialParse) → Expression
Parse an conditional expression. This is the expression after a where clause.
String condExpr
boolean allowPartialParse | allowPartialParse false: needs the whole string to be processed.
returns Expression | the expression parsed
@SuppressWarnings
parseCondExpression (conditionalExpressionStr, allowPartialParse, consumer) → Expression
parseStatement (parser, executorService) → Statement
CCJSqlParser parser | parser the Parser armed with a Statement text
ExecutorService executorService | executorService the Executor Service for parsing within a Thread
returns Statement | the parsed Statement
parseStatements (sqls) → Statements
Parse a statement list.
String sqls
returns Statements | the statements parsed
parseStatements (sqls, consumer) → Statements
parseStatements (sqls, executorService, consumer) → Statements
Parse a statement list.
String sqls
ExecutorService executorService
Consumer consumer
returns Statements | the statements parsed
parseStatements (parser, executorService) → Statements
CCJSqlParser parser | parser the Parser armed with a Statement text
ExecutorService executorService | executorService the Executor Service for parsing within a Thread
returns Statements | the Statements (representing a List of single statements)
streamStatements (listener, is, encoding)
getNestingDepth (sql) → int
String sql
returns int
getUnbalancedPosition (text) → int
String text
returns int
sanitizeSingleSql (sqlStr) → String
String sqlStr
returns String
ParserKeywordsUtils¶
extends: Object
ParserKeywordsUtils ()
@SuppressWarnings
getReservedKeywords (restriction) → List
int restriction
returns List
main (args)
String args | args with: Grammar File, Keyword Documentation File
getAllKeywordsUsingRegex (file) → TreeSet
File file
returns TreeSet
buildGrammarForRelObjectNameWithoutValue (file)
File file
buildGrammarForRelObjectName (file)
File file
getAllKeywords (file) → TreeSet
File file
returns TreeSet
rightPadding (input, ch, length) → String
String input
char ch
int length
returns String
writeKeywordsDocumentationFile (file)
File file
SimpleCharStream¶
extends: Object
SimpleCharStream (dstream, startline, startcolumn, buffersize)
Constructor
Provider dstream
int startline
int startcolumn
int buffersize
SimpleCharStream (dstream, startline, startcolumn)
Constructor
Provider dstream
int startline
int startcolumn
SimpleCharStream (dstream)
Constructor
Provider dstream
setTabSize (i)
int i
getTabSize () → int
returns int
getAbsoluteTokenBegin () → int
returns int
boolean wrapAroundreturns voidreturns voidBeginToken () → char
Start.
returns char | the character read
char creturns voidreadChar () → char
Read a character.
returns char | the character read
@Deprecated
getColumn () → int
returns int | the column
@Deprecated
getLine () → int
returns int | the line
getEndColumn () → int
returns int | get token end column number.
getEndLine () → int
returns int | get token end line number.
getBeginColumn () → int
returns int | get token beginning column number.
getBeginLine () → int
returns int | get token beginning line number.
backup (amount)
Backup a number of characters.
int amount
ReInit (dstream, startline, startcolumn, buffersize)
Reinitialise.
Provider dstream
int startline
int startcolumn
int buffersize
ReInit (dstream, startline, startcolumn)
Reinitialise.
Provider dstream
int startline
int startcolumn
ReInit (dstream)
Reinitialise.
Provider dstream
GetImage () → String
returns String | get token literal value.
GetSuffix (len) → char
int len
returns char | get the suffix.
Done ()
Reset buffer when finished.
adjustBeginLineColumn (newLine, newCol)
Method to adjust line and column numbers for the start of a token.
int newLine
int newCol
ASTNodeAccess¶
implements: Serializable provides: ASTNodeAccessImpl, Expression, FromItem,
getASTNode () → SimpleNode
returns SimpleNode
setASTNode (node)
SimpleNode node
JSqlParser¶
provides: CCJSqlParserManager,
StatementListener¶
provides:
accept (statement)
Statement statement
parser.feature¶
Feature¶
[select, selectGroupBy, selectGroupByGroupingSets, selectHaving, selectInto, limit, limitNull, limitAll, limitOffset, offset, offsetParam, fetch, fetchFirst, fetchNext, join, joinOuterSimple, joinSimple, joinRight, joinNatural, joinFull, joinLeft, joinCross, joinOuter, joinSemi, joinInner, joinStraight, joinApply, joinWindow, joinUsingColumns, skip, first, top, optimizeFor, selectUnique, distinct, distinctOn, orderBy, orderByNullOrdering, selectForUpdate, selectForShare, selectForKeyShare, selectForNoKeyUpdate, selectForUpdateOfTable, selectForUpdateWait, selectForUpdateNoWait, selectForUpdateSkipLocked, insert, insertFromSelect, insertModifierPriority, insertModifierIgnore, insertUseSet, insertUseDuplicateKeyUpdate, insertReturningAll, insertReturningExpressionList, insertValues, values, tableStatement, update, updateFrom, updateJoins, updateUseSelect, updateOrderBy, updateLimit, updateReturning, delete, deleteJoin, deleteTables, deleteLimit, deleteOrderBy, deleteReturningExpressionList, upsert, merge, alterTable, alterSequence, alterView, refreshMaterializedView, refreshMaterializedWithDataView, refreshMaterializedWithNoDataView, alterViewReplace, alterIndex, analyze, truncate, execute, executeExec, executeCall, executeExecute, executeStatement, executeStatementImmediate, executeUsing, replace, drop, dropTable, dropIndex, dropView, dropSchema, dropSequence, dropTableIfExists, dropIndexIfExists, dropViewIfExists, dropSchemaIfExists, dropSequenceIfExists, createSchema, createView, createViewForce, createViewTemporary, createOrReplaceView, createViewMaterialized, createViewWithComment, createTable, createTableUnlogged, createTableCreateOptionStrings, createTableTableOptionStrings, createTableIfNotExists, createTableRowMovement, createTableFromSelect, createIndex, createSequence, createSynonym, createTrigger, commit, comment, commentOnTable, commentOnColumn, commentOnView, describe, desc, explain, show, showTables, showColumns, showIndex, use, grant, function, createFunction, createProcedure, functionalStatement, block, declare, set, reset, pivot, unpivot, pivotXml, setOperation, setOperationUnion, setOperationIntersect, setOperationExcept, setOperationMinus, withItem, withItemRecursive, lateralSubSelect, valuesList, tableFunction, jdbcParameter, jdbcNamedParameter, exprLike, exprSimilarTo, kSqlWindow, oracleOldJoinSyntax, oraclePriorPosition, oracleHint, oracleHierarchicalExpression, oracleOrderBySiblings, mySqlHintStraightJoin, mysqlSqlCacheFlag, mysqlCalcFoundRows, selectForXmlPath, allowSquareBracketQuotation, allowPostgresSpecificSyntax, allowComplexParsing, allowUnsupportedStatements, timeOut, allowBackslashEscapeCharacter]
FeatureConfiguration¶
extends: Object
FeatureConfiguration ()
setValue (feature, value) → FeatureConfiguration
getValue (feature) → Object
Feature feature
returns Object | the configured feature value - can be
nullgetAsBoolean (f) → boolean
Feature f
returns boolean
getAsLong (f) → Long
Feature f
returns Long
getAsString (f) → String
Feature f
returns String
FeatureSet¶
provides: FeatureSetValidation, ModifyableFeatureSet,
getFeatures () → Set
returns Set
contains (feature) → boolean
Feature feature
returns boolean |
true if the feature is identical to one of the features contained in this set, false otherwisegetFeaturesClone () → Set
returns Set | a new HashSet with a copy of supported features
getNotContained (features) → Set
Collection features
returns Set | all features within this feature set which are not contained in given set
retainAll (features) → Set
Collection features
returns Set | all features within this feature set which are contained in given set too.
copy () → ModifyableFeatureSet
returns ModifyableFeatureSet
ModifyableFeatureSet¶
implements: FeatureSet provides: FeaturesAllowed,
add (featureSets) → ModifyableFeatureSet
FeatureSet featureSets
returns ModifyableFeatureSet |
thisadd (features) → ModifyableFeatureSet
Feature features
returns ModifyableFeatureSet |
thisadd (features) → ModifyableFeatureSet
Collection features
returns ModifyableFeatureSet |
thisremove (featureSets) → ModifyableFeatureSet
FeatureSet featureSets
returns ModifyableFeatureSet |
thisremove (features) → ModifyableFeatureSet
Feature features
returns ModifyableFeatureSet |
thisremove (features) → ModifyableFeatureSet
Collection features
returns ModifyableFeatureSet |
thisschema¶
Sequence.ParameterType¶
[INCREMENT_BY, START_WITH, RESTART_WITH, MAXVALUE, NOMAXVALUE, MINVALUE, NOMINVALUE, CYCLE, NOCYCLE, CACHE, NOCACHE, ORDER, NOORDER, KEEP, NOKEEP, SESSION, GLOBAL]
The available parameters to a sequence
Column¶
extends: ASTNodeAccessImpl implements: Expression, MultiPartName
A column. It can have the table name it belongs to.
Column ()
Column (table, columnName)
Table table
String columnName
Column (nameParts)
List nameParts
Column (nameParts, delimiters)
List nameParts
List delimiters
Column (columnName)
String columnName
getArrayConstructor () → ArrayConstructor
returns ArrayConstructor
setArrayConstructor (arrayConstructor) → Column
ArrayConstructor arrayConstructor
returns Column
getTable () → Table
Retrieve the information regarding the Table this Column does belong to, if any can be inferred.
The inference is based only on local information, and not on the whole SQL command. For example, consider the following query:
SELECT x FROM Foo
Given the Column called x, this method would return null, and not the info about the table Foo. On the other hand, consider:
SELECT t.x FROM Foo t
Here, we will get a Table object for a table called t. But because the inference is local, such object will not know that t is just an alias for Foo.
returns Table | an instance of net.sf.jsqlparser.schema.Table representing the table this column does belong to, if it can be inferred. Can be null.
setTable (table)
Table table
getColumnName () → String
returns String
setColumnName (string)
String string
getTableDelimiter () → String
returns String
setTableDelimiter (tableDelimiter)
String tableDelimiter
@Override
getFullyQualifiedName () → String
returns String
getFullyQualifiedName (aliases) → String
boolean aliases
returns String
@Deprecated
getName (aliases) → String
boolean aliases
returns String
@Override
toString () → String
returns String
setCommentText (commentText)
String commentText
getCommentText () → String
returns String
Database¶
extends: Object implements: MultiPartName
Database (databaseName)
String databaseName
Database (server, databaseName)
Server server
String databaseName
setServer (server)
Server server
getDatabaseName () → String
returns String
setDatabaseName (databaseName)
String databaseName
@Override
getFullyQualifiedName () → String
returns String
@Override
toString () → String
returns String
Sequence¶
extends: ASTNodeAccessImpl implements: MultiPartName
Represents the database type for a SEQUENCE
Sequence ()
Sequence (partItems)
List partItems
setParameters (parameters)
List parameters
getParameters () → List
returns List
setDatabase (database)
Database database
getSchemaName () → String
returns String
setSchemaName (string)
String string
getName () → String
returns String
setName (string)
String string
@Override
getFullyQualifiedName () → String
returns String
@Override
toString () → String
returns String
Sequence.Parameter¶
extends: Object
Represents a parameter when declaring a sequence
Parameter (option)
ParameterType option
getValue () → Long
returns Long
setValue (value)
Long value
formatParameter () → String
returns String
Server¶
extends: Object implements: MultiPartName
Server (serverAndInstanceName)
String serverAndInstanceName
Server (serverName, instanceName)
String serverName
String instanceName
getServerName () → String
returns String
setServerName (serverName)
String serverName
getInstanceName () → String
returns String
setInstanceName (instanceName)
String instanceName
@Override
getFullyQualifiedName () → String
returns String
@Override
toString () → String
returns String
Synonym¶
extends: ASTNodeAccessImpl implements: MultiPartName
Synonym ()
Synonym (partItems)
List partItems
setDatabase (database)
Database database
getSchemaName () → String
returns String
setSchemaName (string)
String string
getName () → String
returns String
setName (string)
String string
@Override
getFullyQualifiedName () → String
returns String
@Override
toString () → String
returns String
Table¶
extends: ASTNodeAccessImpl implements: FromItem, MultiPartName
A table. It can have an alias and the schema name it belongs to.
Table ()
Table (name)
String name
Table (schemaName, name)
String schemaName
String name
Table (database, schemaName, name)
Table (partItems)
List partItems
Table (partItems, partDelimiters)
List partItems
List partDelimiters
setDatabase (database)
Database database
getSchemaName () → String
returns String
setSchemaName (schemaName)
String schemaName
getName () → String
returns String
getDBLinkName () → String
returns String
setName (name)
String name
@Override
getFullyQualifiedName () → String
returns String
accept (intoTableVisitor)
IntoTableVisitor intoTableVisitor
getIndexHint () → MySQLIndexHint
returns MySQLIndexHint
withHint (hint) → Table
MySQLIndexHint hint
returns Table
setHint (hint)
MySQLIndexHint hint
getSqlServerHints () → SQLServerHints
returns SQLServerHints
setSqlServerHints (sqlServerHints)
SQLServerHints sqlServerHints
getSampleClause () → SampleClause
returns SampleClause
setSampleClause (sampleClause) → Table
SampleClause sampleClause
returns Table
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
withSqlServerHints (sqlServerHints) → Table
SQLServerHints sqlServerHints
returns Table
getNameParts () → List
returns List
getNamePartDelimiters () → List
returns List
MultiPartName¶
provides: Column, Database, Sequence, Server, Synonym, Table,
getFullyQualifiedName () → String
returns String
statement¶
DeclareType¶
[TABLE, AS, TYPE]
ExplainStatement.OptionType¶
[ANALYZE, VERBOSE, COSTS, BUFFERS, FORMAT]
PurgeObjectType¶
[TABLE, INDEX, RECYCLEBIN, DBA_RECYCLEBIN, TABLESPACE]
ReferentialAction.Action¶
[CASCADE, RESTRICT, NO_ACTION, SET_DEFAULT, SET_NULL]
ReferentialAction.Type¶
[DELETE, UPDATE]
Block¶
extends: Object implements: Statement
Block ()
getStatements () → Statements
returns Statements
setStatements (statements)
Statements statements
hasSemicolonAfterEnd () → boolean
returns boolean
setSemicolonAfterEnd (hasSemicolonAfterEnd)
boolean hasSemicolonAfterEnd
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
withStatements (statements) → Block
Statements statements
returns Block
Commit¶
extends: Object implements: Statement
Commit ()
@Override
toString () → String
returns String
CreateFunctionalStatement¶
extends: Object implements: Statement provides: CreateFunction, CreateProcedure
A base for the declaration of function like statements
String kindString kindList functionDeclarationPartsboolean orReplaceString kindList functionDeclarationPartssetFunctionDeclarationParts (functionDeclarationParts)
List functionDeclarationParts
getFunctionDeclarationParts () → List
returns List | the declaration parts after CREATE FUNCTION|PROCEDURE
getKind () → String
returns String | the kind of functional statement
setOrReplace (orReplace)
boolean orReplace
formatDeclaration () → String
returns String | a whitespace appended String with the declaration parts with some minimal formatting.
@Override
toString () → String
returns String
withFunctionDeclarationParts (functionDeclarationParts) → CreateFunctionalStatement
List functionDeclarationParts
returns CreateFunctionalStatement
addFunctionDeclarationParts (functionDeclarationParts) → CreateFunctionalStatement
String functionDeclarationParts
returns CreateFunctionalStatement
addFunctionDeclarationParts (functionDeclarationParts) → CreateFunctionalStatement
Collection functionDeclarationParts
returns CreateFunctionalStatement
DeclareStatement¶
extends: Object implements: Statement
DeclareStatement ()
setUserVariable (userVariable)
UserVariable userVariable
getUserVariable () → UserVariable
returns UserVariable
@Deprecated
getType () → DeclareType
returns DeclareType | the DeclareType
getDeclareType () → DeclareType
returns DeclareType | the DeclareType
getTypeName () → String
returns String
setDeclareType (declareType)
DeclareType declareType
addType (colDataType, defaultExpr)
ColDataType colDataType
Expression defaultExpr
addType (userVariable, colDataType, defaultExpr)
addTypeDefExprList (typeDefExpressions) → DeclareStatement
TypeDefExpr typeDefExpressions
returns DeclareStatement
addTypeDefExprList (typeDefExpressions) → DeclareStatement
Collection typeDefExpressions
returns DeclareStatement
withTypeDefExprList (typeDefExpressions) → DeclareStatement
List typeDefExpressions
returns DeclareStatement
setTypeDefExprList (expr)
List expr
getTypeDefExprList () → List
returns List
addColumnDefinition (colDef)
ColumnDefinition colDef
setColumnDefinitions (columnDefinitions)
List columnDefinitions
getColumnDefinitions () → List
returns List
getTypeDefinitions () → List
returns List
setTypeName (typeName)
String typeName
@Override
toString () → String
returns String
withUserVariable (userVariable) → DeclareStatement
UserVariable userVariable
returns DeclareStatement
withTypeName (typeName) → DeclareStatement
String typeName
returns DeclareStatement
withDeclareType (declareType) → DeclareStatement
DeclareType declareType
returns DeclareStatement
withColumnDefinitions (columnDefinitions) → DeclareStatement
List columnDefinitions
returns DeclareStatement
addColumnDefinitions (statements) → DeclareStatement
ColumnDefinition statements
returns DeclareStatement
addColumnDefinitions (columnDefinitions) → DeclareStatement
Collection columnDefinitions
returns DeclareStatement
DeclareStatement.TypeDefExpr¶
extends: Object implements: Serializable
TypeDefExpr (colDataType, defaultExpr)
ColDataType colDataType
Expression defaultExpr
TypeDefExpr (userVariable, colDataType, defaultExpr)
DescribeStatement¶
extends: Object implements: Statement
DescribeStatement ()
DescribeStatement (table)
Table table
setTable (table)
Table table
@Override
toString () → String
returns String
withTable (table) → DescribeStatement
Table table
returns DescribeStatement
getDescribeType () → String
returns String
setDescribeType (describeType) → DescribeStatement
String describeType
returns DescribeStatement
ExplainStatement¶
extends: Object implements: Statement
An EXPLAIN statement
ExplainStatement ()
ExplainStatement (select)
Select select
setTable (table) → ExplainStatement
Table table
returns ExplainStatement
setStatement (select)
Select select
getOptions () → LinkedHashMap
returns LinkedHashMap
addOption (option)
Option option
getOption (optionType) → Option
Returns the first option that matches this optionType
OptionType optionType | optionType the option type to retrieve an Option for
returns Option | an option of that type, or null. In case of duplicate options, the first found option will be returned.
@Override
toString () → String
returns String
ExplainStatement.Option¶
extends: Object implements: Serializable
Option (type)
OptionType type
getType () → OptionType
returns OptionType
getValue () → String
returns String
setValue (value)
String value
formatOption () → String
returns String
IfElseStatement¶
extends: Object implements: Statement
IfElseStatement (condition, ifStatement)
Expression condition
Statement ifStatement
getCondition () → Expression
returns Expression
setElseStatement (elseStatement)
Statement elseStatement
setUsingSemicolonForElseStatement (usingSemicolonForElseStatement)
boolean usingSemicolonForElseStatement
isUsingSemicolonForElseStatement () → boolean
returns boolean
setUsingSemicolonForIfStatement (usingSemicolonForIfStatement)
boolean usingSemicolonForIfStatement
isUsingSemicolonForIfStatement () → boolean
returns boolean
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
OutputClause¶
extends: Object implements: Serializable
T-SQL Output Clause
OutputClause (selectItemList, tableVariable, outputTable, columnList)
getSelectItemList () → List
returns List
setSelectItemList (selectItemList)
List selectItemList
getTableVariable () → UserVariable
returns UserVariable
setTableVariable (tableVariable)
UserVariable tableVariable
setOutputTable (outputTable)
Table outputTable
getColumnList () → List
returns List
setColumnList (columnList)
List columnList
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
PurgeStatement¶
extends: Object implements: Statement
PurgeStatement (table)
Table table
PurgeStatement (index)
Index index
PurgeStatement (purgeObjectType)
PurgeObjectType purgeObjectType
PurgeStatement (purgeObjectType, tableSpaceName, userName)
PurgeObjectType purgeObjectType
String tableSpaceName
String userName
@SuppressWarnings
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
getUserName () → String
returns String
setUserName (userName)
String userName
getPurgeObjectType () → PurgeObjectType
returns PurgeObjectType
getObject () → Object
returns Object
ReferentialAction¶
extends: Object implements: Serializable
ReferentialAction ()
ReferentialAction (type, action)
Type type
Action action
getType () → Type
returns Type
setType (type)
Type type
withType (type) → ReferentialAction
Type type
returns ReferentialAction
getAction () → Action
returns Action
setAction (action)
Action action
withAction (action) → ReferentialAction
Action action
returns ReferentialAction
@Override
hashCode () → int
returns int
@Override
toString () → String
returns String
@Override
equals (obj) → boolean
Object obj
returns boolean
ResetStatement¶
extends: Object implements: Statement
ResetStatement ()
ResetStatement (name)
String name
add (name)
String name
getName () → String
returns String
setName (name)
String name
@Override
toString () → String
returns String
ReturningClause¶
extends: ArrayList
RETURNING clause according to
a href= "https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/DELETE.html#GUID-156845A5-B626-412B-9F95-8869B988ABD7" Part of UPDATE, INSERT, DELETE statementsReturningClause (keyword, selectItems, dataItems)
Keyword keyword
List selectItems
List dataItems
ReturningClause (keyword, selectItems, dataItems)
String keyword
List selectItems
List dataItems
ReturningClause (keyword, selectItems)
Keyword keyword
List selectItems
ReturningClause (keyword, selectItems)
String keyword
List selectItems
getKeyword () → Keyword
returns Keyword
setKeyword (keyword) → ReturningClause
Keyword keyword
returns ReturningClause
getDataItems () → List
returns List
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
RollbackStatement¶
extends: Object implements: Statement
RollbackStatement ()
isUsingWorkKeyword () → boolean
returns boolean
withUsingWorkKeyword (usingWorkKeyword) → RollbackStatement
boolean usingWorkKeyword
returns RollbackStatement
setUsingWorkKeyword (usingWorkKeyword)
boolean usingWorkKeyword
isUsingSavepointKeyword () → boolean
returns boolean
withUsingSavepointKeyword (usingSavepointKeyword) → RollbackStatement
boolean usingSavepointKeyword
returns RollbackStatement
setUsingSavepointKeyword (usingSavepointKeyword)
boolean usingSavepointKeyword
getSavepointName () → String
returns String
withSavepointName (savepointName) → RollbackStatement
String savepointName
returns RollbackStatement
setSavepointName (savepointName)
String savepointName
getForceDistributedTransactionIdentifier () → String
returns String
withForceDistributedTransactionIdentifier (forceDistributedTransactionIdentifier) → RollbackStatement
String forceDistributedTransactionIdentifier
returns RollbackStatement
setForceDistributedTransactionIdentifier (forceDistributedTransactionIdentifier)
String forceDistributedTransactionIdentifier
@Override
toString () → String
returns String
SavepointStatement¶
extends: Object implements: Statement
SavepointStatement (savepointName)
String savepointName
getSavepointName () → String
returns String
setSavepointName (savepointName)
String savepointName
@Override
toString () → String
returns String
SetStatement¶
extends: Object implements: Statement
SetStatement ()
SetStatement (name, value)
Object name
ExpressionList value
add (name, value, useEqual)
remove (idx)
int idx
getCount () → int
returns int
isUseEqual (idx) → boolean
int idx
returns boolean
isUseEqual () → boolean
returns boolean
withUseEqual (idx, useEqual) → SetStatement
setUseEqual (idx, useEqual) → SetStatement
withUseEqual (useEqual) → SetStatement
boolean useEqual
returns SetStatement
setUseEqual (useEqual) → SetStatement
boolean useEqual
returns SetStatement
getName () → Object
returns Object
getName (idx) → Object
int idx
returns Object
setName (name)
String name
setName (idx, name)
int idx
String name
getExpressions (idx) → List
int idx
returns List
getExpressions () → List
returns List
setExpressions (idx, expressions)
int idx
ExpressionList expressions
setExpressions (expressions)
ExpressionList expressions
@Override
toString () → String
returns String
getKeyValuePairs () → List
returns List
addKeyValuePairs (keyValuePairs)
Collection keyValuePairs
addKeyValuePairs (keyValuePairs)
NameExpr keyValuePairs
clear ()
getEffectParameter () → String
returns String
setEffectParameter (effectParameter)
String effectParameter
withEffectParameter (effectParameter) → SetStatement
String effectParameter
returns SetStatement
ShowColumnsStatement¶
extends: Object implements: Statement
ShowColumnsStatement ()
ShowColumnsStatement (tableName)
String tableName
getTableName () → String
returns String
setTableName (tableName)
String tableName
@Override
toString () → String
returns String
withTableName (tableName) → ShowColumnsStatement
String tableName
returns ShowColumnsStatement
ShowStatement¶
extends: Object implements: Statement
ShowStatement ()
ShowStatement (name)
String name
getName () → String
returns String
setName (name)
String name
@Override
toString () → String
returns String
withName (name) → ShowStatement
String name
returns ShowStatement
StatementVisitorAdapter¶
extends: Object implements: StatementVisitor
StatementVisitorAdapter ()
Statements¶
extends: ArrayList implements: Serializable
Statements ()
@Deprecated
getStatements () → List
returns List
@Deprecated
setStatements (statements)
List statements
accept (statementVisitor)
StatementVisitor statementVisitor
get (type, index) → E
Class type
int index
returns E
@Override
toString () → String
returns String
UnsupportedStatement¶
extends: Object implements: Statement
UnsupportedStatement (declarations)
List declarations
UnsupportedStatement (upfront, declarations)
String upfront
List declarations
@SuppressWarnings
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
isEmpty () → boolean
returns boolean
UseStatement¶
extends: Object implements: Statement
UseStatement ()
UseStatement (name)
String name
UseStatement (name, hasSchemaKeyword)
String name
boolean hasSchemaKeyword
getName () → String
returns String
setName (name)
String name
hasSchemaKeyword () → boolean
returns boolean
setSchemaKeyword (schemaKeyword)
boolean schemaKeyword
@Override
toString () → String
returns String
withName (name) → UseStatement
String name
returns UseStatement
Statement¶
implements: Model provides: Alter, AlterSequence, AlterSession, AlterSystemStatement, AlterView, Analyze, Block, Comment, Commit, CreateFunctionalStatement, CreateIndex, CreateSchema, CreateSequence, CreateSynonym, CreateTable, CreateView, DeclareStatement, Delete, DescribeStatement, Drop, Execute, ExplainStatement, Grant, IfElseStatement, Insert, Merge, PurgeStatement, RefreshMaterializedViewStatement, RenameTableStatement, ResetStatement, RollbackStatement, SavepointStatement, Select, SetStatement, ShowColumnsStatement, ShowIndexStatement, ShowStatement, ShowTablesStatement, Truncate, UnsupportedStatement, Update, Upsert, UseStatement,
accept (statementVisitor)
StatementVisitor statementVisitor
StatementVisitor¶
provides: StatementDeParser, StatementValidator, StatementVisitorAdapter, TablesNamesFinder,
visit (analyze)
Analyze analyze
visit (savepointStatement)
SavepointStatement savepointStatement
visit (rollbackStatement)
RollbackStatement rollbackStatement
visit (comment)
Comment comment
visit (commit)
Commit commit
visit (delete)
Delete delete
visit (update)
Update update
visit (insert)
Insert insert
visit (drop)
Drop drop
visit (truncate)
Truncate truncate
visit (createIndex)
CreateIndex createIndex
visit (aThis)
CreateSchema aThis
visit (createTable)
CreateTable createTable
visit (createView)
CreateView createView
visit (alterView)
AlterView alterView
visit (materializedView)
RefreshMaterializedViewStatement materializedView
visit (alter)
Alter alter
visit (stmts)
Statements stmts
visit (execute)
Execute execute
visit (set)
SetStatement set
visit (reset)
ResetStatement reset
visit (set)
visit (showIndex)
ShowIndexStatement showIndex
visit (showTables)
ShowTablesStatement showTables
visit (merge)
Merge merge
visit (select)
Select select
visit (upsert)
Upsert upsert
visit (use)
UseStatement use
visit (block)
Block block
visit (describe)
DescribeStatement describe
visit (aThis)
ExplainStatement aThis
visit (aThis)
ShowStatement aThis
visit (aThis)
DeclareStatement aThis
visit (grant)
Grant grant
visit (createSequence)
CreateSequence createSequence
visit (alterSequence)
AlterSequence alterSequence
visit (createFunctionalStatement)
CreateFunctionalStatement createFunctionalStatement
visit (createSynonym)
CreateSynonym createSynonym
visit (alterSession)
AlterSession alterSession
visit (aThis)
IfElseStatement aThis
visit (renameTableStatement)
RenameTableStatement renameTableStatement
visit (purgeStatement)
PurgeStatement purgeStatement
visit (alterSystemStatement)
AlterSystemStatement alterSystemStatement
visit (unsupportedStatement)
UnsupportedStatement unsupportedStatement
statement.alter¶
AlterOperation¶
[ADD, ALTER, DROP, DROP_PRIMARY_KEY, DROP_UNIQUE, DROP_FOREIGN_KEY, MODIFY, CHANGE, ALGORITHM, RENAME, RENAME_TABLE, RENAME_INDEX, RENAME_KEY, RENAME_CONSTRAINT, COMMENT, COMMENT_WITH_EQUAL_SIGN, UNSPECIFIC, TRUNCATE_PARTITION]
AlterSessionOperation¶
[ADVISE_COMMIT, ADVISE_ROLLBACK, ADVISE_NOTHING, CLOSE_DATABASE_LINK, ENABLE_COMMIT_IN_PROCEDURE, DISABLE_COMMIT_IN_PROCEDURE, ENABLE_GUARD, DISABLE_GUARD, ENABLE_PARALLEL_DML, DISABLE_PARALLEL_DML, FORCE_PARALLEL_DML, ENABLE_PARALLEL_DDL, DISABLE_PARALLEL_DDL, FORCE_PARALLEL_DDL, ENABLE_PARALLEL_QUERY, DISABLE_PARALLEL_QUERY, FORCE_PARALLEL_QUERY, ENABLE_RESUMABLE, DISABLE_RESUMABLE, SET]
AlterSystemOperation¶
[ARCHIVE_LOG, CHECKPOINT, CHECK_DATAFILES, DUMP_ACTIVE_SESSION_HISTORY, ENABLE_DISTRIBUTED_RECOVERY, DISABLE_DISTRIBUTED_RECOVERY, ENABLE_RESTRICTED_SESSION, DISABLE_RESTRICTED_SESSION, FLUSH, DISCONNECT_SESSION, KILL_SESSION, SWITCH, SUSPEND, RESUME, QUIESCE, UNQUIESCE, SHUTDOWN, REGISTER, SET, RESET]
Alter¶
extends: Object implements: Statement
Alter ()
setTable (table)
Table table
isUseOnly () → boolean
returns boolean
setUseOnly (useOnly)
boolean useOnly
isUseTableIfExists () → boolean
returns boolean
setUseTableIfExists (useTableIfExists)
boolean useTableIfExists
addAlterExpression (alterExpression)
AlterExpression alterExpression
getAlterExpressions () → List
returns List
setAlterExpressions (alterExpressions)
List alterExpressions
@Override
toString () → String
returns String
addAlterExpressions (alterExpressions) → Alter
AlterExpression alterExpressions
returns Alter
AlterExpression¶
extends: Object implements: Serializable
AlterExpression ()
setOldIndex (oldIndex)
Index oldIndex
hasColumn () → boolean
returns boolean
useBrackets () → boolean
returns boolean
useBrackets (useBrackets)
boolean useBrackets
hasColumn (hasColumn)
boolean hasColumn
getFkSourceSchema () → String
returns String
setFkSourceSchema (fkSourceSchema)
String fkSourceSchema
getCommentText () → String
returns String
setCommentText (commentText)
String commentText
getOperation () → AlterOperation
returns AlterOperation
setOperation (operation)
AlterOperation operation
getOptionalSpecifier () → String
returns String
setOptionalSpecifier (optionalSpecifier)
String optionalSpecifier
setReferentialAction (type, action)
Type type
Action action
withReferentialAction (type, action) → AlterExpression
removeReferentialAction (type)
Type type
getReferentialAction (type) → ReferentialAction
Type type
returns ReferentialAction |
@Deprecated
isOnDeleteCascade () → boolean
returns boolean |
@Deprecated
setOnDeleteCascade (onDeleteCascade)
boolean onDeleteCascade
@Deprecated
isOnDeleteRestrict () → boolean
returns boolean |
@Deprecated
setOnDeleteRestrict (onDeleteRestrict)
boolean onDeleteRestrict
@Deprecated
isOnDeleteSetNull () → boolean
returns boolean |
@Deprecated
setOnDeleteSetNull (onDeleteSetNull)
boolean onDeleteSetNull
getFkColumns () → List
returns List
setFkColumns (fkColumns)
List fkColumns
getFkSourceTable () → String
returns String
setFkSourceTable (fkSourceTable)
String fkSourceTable
getColDataTypeList () → List
returns List
addColDataType (columnName, colDataType)
String columnName
ColDataType colDataType
addColDataType (columnDataType)
ColumnDataType columnDataType
addColDropNotNull (columnDropNotNull)
ColumnDropNotNull columnDropNotNull
addColDropDefault (columnDropDefault)
ColumnDropDefault columnDropDefault
getFkSourceColumns () → List
returns List
setFkSourceColumns (fkSourceColumns)
List fkSourceColumns
getNewTableName () → String
returns String
setNewTableName (newTableName)
String newTableName
getColumnName () → String
returns String
setColumnName (columnName)
String columnName
@Deprecated
getColOldName () → String
returns String
@Deprecated
setColOldName (columnOldName)
String columnOldName
getColumnOldName () → String
returns String
setColumnOldName (columnOldName)
String columnOldName
getConstraintName () → String
returns String
setConstraintName (constraintName)
String constraintName
isUsingIfExists () → boolean
returns boolean
setUsingIfExists (usingIfExists)
boolean usingIfExists
getPkColumns () → List
returns List
setPkColumns (pkColumns)
List pkColumns
getUkColumns () → List
returns List
setUkColumns (ukColumns)
List ukColumns
getUkName () → String
returns String
setUkName (ukName)
String ukName
setIndex (index)
Index index
getConstraints () → List
returns List
setConstraints (constraints)
List constraints
getColumnDropNotNullList () → List
returns List
addParameters (params)
String params
getParameters () → List
returns List
getUseEqual () → boolean
returns boolean
setUseEqual (useEqual)
boolean useEqual
getUk () → boolean
returns boolean
setUk (uk)
boolean uk
getTruncatePartitionName () → String
returns String
setTruncatePartitionName (truncatePartitionName)
String truncatePartitionName
withTruncatePartitionName (truncatePartitionName) → AlterExpression
String truncatePartitionName
returns AlterExpression
isUseIfNotExists () → boolean
returns boolean
setUseIfNotExists (useIfNotExists)
boolean useIfNotExists
withUserIfNotExists (userIfNotExists) → AlterExpression
boolean userIfNotExists
returns AlterExpression
@Override,| @SuppressWarnings
toString () → String
returns String
withOperation (operation) → AlterExpression
AlterOperation operation
returns AlterExpression
withOptionalSpecifier (optionalSpecifier) → AlterExpression
String optionalSpecifier
returns AlterExpression
withColumnName (columnName) → AlterExpression
String columnName
returns AlterExpression
withPkColumns (pkColumns) → AlterExpression
List pkColumns
returns AlterExpression
withUkColumns (ukColumns) → AlterExpression
List ukColumns
returns AlterExpression
withUkName (ukName) → AlterExpression
String ukName
returns AlterExpression
withIndex (index) → AlterExpression
Index index
returns AlterExpression
withConstraintName (constraintName) → AlterExpression
String constraintName
returns AlterExpression
withUsingIfExists (usingIfExists) → AlterExpression
boolean usingIfExists
returns AlterExpression
withOnDeleteRestrict (onDeleteRestrict) → AlterExpression
boolean onDeleteRestrict
returns AlterExpression
withOnDeleteSetNull (onDeleteSetNull) → AlterExpression
boolean onDeleteSetNull
returns AlterExpression
withOnDeleteCascade (onDeleteCascade) → AlterExpression
boolean onDeleteCascade
returns AlterExpression
withFkColumns (fkColumns) → AlterExpression
List fkColumns
returns AlterExpression
withFkSourceSchema (fkSourceSchema) → AlterExpression
String fkSourceSchema
returns AlterExpression
withFkSourceTable (fkSourceTable) → AlterExpression
String fkSourceTable
returns AlterExpression
withFkSourceColumns (fkSourceColumns) → AlterExpression
List fkSourceColumns
returns AlterExpression
withUk (uk) → AlterExpression
boolean uk
returns AlterExpression
withUseEqual (useEqual) → AlterExpression
boolean useEqual
returns AlterExpression
withConstraints (constraints) → AlterExpression
List constraints
returns AlterExpression
withCommentText (commentText) → AlterExpression
String commentText
returns AlterExpression
withColumnOldName (columnOldName) → AlterExpression
String columnOldName
returns AlterExpression
addPkColumns (pkColumns) → AlterExpression
String pkColumns
returns AlterExpression
addPkColumns (pkColumns) → AlterExpression
Collection pkColumns
returns AlterExpression
addUkColumns (ukColumns) → AlterExpression
String ukColumns
returns AlterExpression
addUkColumns (ukColumns) → AlterExpression
Collection ukColumns
returns AlterExpression
addFkColumns (fkColumns) → AlterExpression
String fkColumns
returns AlterExpression
addFkColumns (fkColumns) → AlterExpression
Collection fkColumns
returns AlterExpression
addFkSourceColumns (fkSourceColumns) → AlterExpression
String fkSourceColumns
returns AlterExpression
addFkSourceColumns (fkSourceColumns) → AlterExpression
Collection fkSourceColumns
returns AlterExpression
addConstraints (constraints) → AlterExpression
ConstraintState constraints
returns AlterExpression
addConstraints (constraints) → AlterExpression
Collection constraints
returns AlterExpression
AlterExpression.ColumnDataType¶
extends: ColumnDefinition
ColumnDataType (withType)
boolean withType
ColumnDataType (columnName, withType, colDataType, columnSpecs)
@Override
toString () → String
returns String
@Override
withColDataType (colDataType) → ColumnDataType
ColDataType colDataType
returns ColumnDataType
@Override
addColumnSpecs (columnSpecs) → ColumnDataType
Collection columnSpecs
returns ColumnDataType
AlterExpression.ColumnDropDefault¶
extends: Object implements: Serializable
ColumnDropDefault (columnName)
String columnName
getColumnName () → String
returns String
@Override
toString () → String
returns String
AlterExpression.ColumnDropNotNull¶
extends: Object implements: Serializable
ColumnDropNotNull (columnName)
String columnName
ColumnDropNotNull (columnName, withNot)
String columnName
boolean withNot
getColumnName () → String
returns String
isWithNot () → boolean
returns boolean
@Override
toString () → String
returns String
AlterSession¶
extends: Object implements: Statement
AlterSession (operation, parameters)
AlterSessionOperation operation
List parameters
getOperation () → AlterSessionOperation
returns AlterSessionOperation
setOperation (operation)
AlterSessionOperation operation
getParameters () → List
returns List
setParameters (parameters)
List parameters
@Override,| @SuppressWarnings
toString () → String
returns String
AlterSystemStatement¶
extends: Object implements: Statement
AlterSystemStatement (operation, parameters)
AlterSystemOperation operation
List parameters
getOperation () → AlterSystemOperation
returns AlterSystemOperation
getParameters () → List
returns List
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
DeferrableConstraint¶
extends: Object implements: ConstraintState
DeferrableConstraint ()
DeferrableConstraint (not)
boolean not
isNot () → boolean
returns boolean
setNot (not)
boolean not
@Override
toString () → String
returns String
withNot (not) → DeferrableConstraint
boolean not
returns DeferrableConstraint
EnableConstraint¶
extends: Object implements: ConstraintState
EnableConstraint ()
EnableConstraint (disable)
boolean disable
isDisable () → boolean
returns boolean
setDisable (disable)
boolean disable
@Override
toString () → String
returns String
withDisable (disable) → EnableConstraint
boolean disable
returns EnableConstraint
RenameTableStatement¶
extends: Object implements: Statement
RenameTableStatement (oldName, newName, usingTableKeyword, usingIfExistsKeyword, waitDirective)
isUsingTableKeyword () → boolean
returns boolean
setUsingTableKeyword (usingTableKeyword)
boolean usingTableKeyword
withUsingTableKeyword (usingTableKeyword) → RenameTableStatement
boolean usingTableKeyword
returns RenameTableStatement
isUsingIfExistsKeyword () → boolean
returns boolean
setUsingIfExistsKeyword (usingIfExistsKeyword)
boolean usingIfExistsKeyword
withUsingIfExistsKeyword (usingIfExistsKeyword) → RenameTableStatement
boolean usingIfExistsKeyword
returns RenameTableStatement
getWaitDirective () → String
returns String
setWaitDirective (waitDirective)
String waitDirective
withWaitDirective (waitDirective) → RenameTableStatement
String waitDirective
returns RenameTableStatement
getTableNamesSize () → int
returns int
isTableNamesEmpty () → boolean
returns boolean
getTableNames () → Set
returns Set
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
ValidateConstraint¶
extends: Object implements: ConstraintState
ValidateConstraint ()
ValidateConstraint (not)
boolean not
isNot () → boolean
returns boolean
setNot (not)
boolean not
@Override
toString () → String
returns String
withNot (not) → ValidateConstraint
boolean not
returns ValidateConstraint
ConstraintState¶
provides: DeferrableConstraint, EnableConstraint, ValidateConstraint,
statement.alter.sequence¶
AlterSequence¶
extends: Object implements: Statement
An ALTER SEQUENCE statement
AlterSequence ()
setSequence (sequence)
Sequence sequence
@Override
toString () → String
returns String
withSequence (sequence) → AlterSequence
Sequence sequence
returns AlterSequence
statement.analyze¶
Analyze¶
extends: Object implements: Statement
Analyze ()
setTable (table)
Table table
@Override
toString () → String
returns String
statement.comment¶
Comment¶
extends: Object implements: Statement
Comment ()
setTable (table)
Table table
setColumn (column)
Column column
setView (view)
Table view
getComment () → StringValue
returns StringValue
setComment (comment)
StringValue comment
@Override
toString () → String
returns String
withComment (comment) → Comment
StringValue comment
returns Comment
statement.create.function¶
CreateFunction¶
extends: CreateFunctionalStatement
A CREATE PROCEDURE statement
CreateFunction ()
CreateFunction (functionDeclarationParts)
List functionDeclarationParts
CreateFunction (orReplace, functionDeclarationParts)
boolean orReplace
List functionDeclarationParts
@Override
withFunctionDeclarationParts (functionDeclarationParts) → CreateFunction
List functionDeclarationParts
returns CreateFunction
@Override
addFunctionDeclarationParts (functionDeclarationParts) → CreateFunction
String functionDeclarationParts
returns CreateFunction
@Override
addFunctionDeclarationParts (functionDeclarationParts) → CreateFunction
Collection functionDeclarationParts
returns CreateFunction
statement.create.index¶
CreateIndex¶
extends: Object implements: Statement
CreateIndex ()
isIndexTypeBeforeOn () → boolean
returns boolean
setIndexTypeBeforeOn (indexTypeBeforeOn)
boolean indexTypeBeforeOn
isUsingIfNotExists () → boolean
returns boolean
setUsingIfNotExists (usingIfNotExists) → CreateIndex
boolean usingIfNotExists
returns CreateIndex
setIndex (index)
Index index
setTable (table)
Table table
getTailParameters () → List
returns List
setTailParameters (tailParameters)
List tailParameters
@Override
toString () → String
returns String
withTable (table) → CreateIndex
Table table
returns CreateIndex
withIndex (index) → CreateIndex
Index index
returns CreateIndex
withTailParameters (tailParameters) → CreateIndex
List tailParameters
returns CreateIndex
statement.create.procedure¶
CreateProcedure¶
extends: CreateFunctionalStatement
A CREATE PROCEDURE statement
CreateProcedure ()
CreateProcedure (functionDeclarationParts)
List functionDeclarationParts
CreateProcedure (orReplace, functionDeclarationParts)
boolean orReplace
List functionDeclarationParts
@Override
withFunctionDeclarationParts (functionDeclarationParts) → CreateProcedure
List functionDeclarationParts
returns CreateProcedure
@Override
addFunctionDeclarationParts (functionDeclarationParts) → CreateProcedure
String functionDeclarationParts
returns CreateProcedure
@Override
addFunctionDeclarationParts (functionDeclarationParts) → CreateProcedure
Collection functionDeclarationParts
returns CreateProcedure
statement.create.schema¶
CreateSchema¶
extends: Object implements: Statement
CreateSchema ()
addStatement (statement) → boolean
Add a statement to the schema definition
Statement statement | statement The statement to be added
returns boolean | true if the operation was successful
getAuthorization () → String
The owner of the schema.
returns String | Owner name
getSchemaName () → String
The name of the schema
returns String | Schema name
getSchemaPath () → List
The path of the schema
returns List | Schema path
getStatements () → List
The statements executed as part of the schema creation
returns List | the statements
setAuthorization (authorization)
The owner of the schems.
String authorization | authorization Owner name
setSchemaName (schemaName)
Set the name of the schema
String schemaName | schemaName Schema name
setSchemaPath (schemaPath)
Set the path of the schema
List schemaPath | schemaPath Schema path
toString () → String
returns String
withAuthorization (authorization) → CreateSchema
String authorization
returns CreateSchema
withSchemaName (schemaName) → CreateSchema
String schemaName
returns CreateSchema
withSchemaPath (schemaPath) → CreateSchema
List schemaPath
returns CreateSchema
addSchemaPath (schemaPath) → CreateSchema
String schemaPath
returns CreateSchema
addSchemaPath (schemaPath) → CreateSchema
Collection schemaPath
returns CreateSchema
statement.create.sequence¶
CreateSequence¶
extends: Object implements: Statement
A CREATE SEQUENCE statement
CreateSequence ()
setSequence (sequence)
Sequence sequence
@Override
toString () → String
returns String
withSequence (sequence) → CreateSequence
Sequence sequence
returns CreateSequence
statement.create.synonym¶
CreateSynonym¶
extends: Object implements: Statement
CreateSynonym ()
setSynonym (synonym)
Synonym synonym
isOrReplace () → boolean
returns boolean
setOrReplace (orReplace)
boolean orReplace
isPublicSynonym () → boolean
returns boolean
setPublicSynonym (publicSynonym)
boolean publicSynonym
setForList (forList)
List forList
getForList () → List
returns List
getFor () → String
returns String
@Override
toString () → String
returns String
withSynonym (synonym) → CreateSynonym
Synonym synonym
returns CreateSynonym
statement.create.table¶
RowMovementMode¶
[ENABLE, DISABLE]
CheckConstraint¶
extends: NamedConstraint
CheckConstraint ()
setTable (table)
Table table
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withTable (table) → CheckConstraint
Table table
returns CheckConstraint
withExpression (expression) → CheckConstraint
Expression expression
returns CheckConstraint
getExpression (type) → E
Class type
returns E
@Override
addColumns (functionDeclarationParts) → CheckConstraint
ColumnParams functionDeclarationParts
returns CheckConstraint
@Override
addColumns (functionDeclarationParts) → CheckConstraint
Collection functionDeclarationParts
returns CheckConstraint
ColDataType¶
extends: Object implements: Serializable
ColDataType ()
ColDataType (dataType, precision, scale)
String dataType
int precision
int scale
ColDataType (dataType)
String dataType
getArgumentsStringList () → List
returns List
getDataType () → String
returns String
setArgumentsStringList (list)
List list
setDataType (string)
String string
setDataType (list)
List list
getCharacterSet () → String
returns String
setCharacterSet (characterSet)
String characterSet
getArrayData () → List
returns List
setArrayData (arrayData)
List arrayData
@Override
toString () → String
returns String
withDataType (dataType) → ColDataType
String dataType
returns ColDataType
withArgumentsStringList (argumentsStringList) → ColDataType
List argumentsStringList
returns ColDataType
withCharacterSet (characterSet) → ColDataType
String characterSet
returns ColDataType
withArrayData (arrayData) → ColDataType
List arrayData
returns ColDataType
addArgumentsStringList (argumentsStringList) → ColDataType
String argumentsStringList
returns ColDataType
addArgumentsStringList (argumentsStringList) → ColDataType
Collection argumentsStringList
returns ColDataType
addArrayData (arrayData) → ColDataType
Integer arrayData
returns ColDataType
addArrayData (arrayData) → ColDataType
Collection arrayData
returns ColDataType
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
ColumnDefinition¶
extends: Object implements: Serializable provides: ColumnDataType
Globally used definition class for columns.
ColumnDefinition ()
ColumnDefinition (columnName, colDataType)
String columnName
ColDataType colDataType
ColumnDefinition (columnName, colDataType, columnSpecs)
getColumnSpecs () → List
returns List
setColumnSpecs (list)
List list
getColDataType () → ColDataType
returns ColDataType
setColDataType (type)
ColDataType type
getColumnName () → String
returns String
setColumnName (string)
String string
@Override
toString () → String
returns String
toStringDataTypeAndSpec () → String
returns String
withColumnName (columnName) → ColumnDefinition
String columnName
returns ColumnDefinition
withColDataType (colDataType) → ColumnDefinition
ColDataType colDataType
returns ColumnDefinition
withColumnSpecs (columnSpecs) → ColumnDefinition
List columnSpecs
returns ColumnDefinition
addColumnSpecs (columnSpecs) → ColumnDefinition
String columnSpecs
returns ColumnDefinition
addColumnSpecs (columnSpecs) → ColumnDefinition
Collection columnSpecs
returns ColumnDefinition
CreateTable¶
extends: Object implements: Statement
CreateTable ()
setTable (table)
Table table
isUnlogged () → boolean
returns boolean
setUnlogged (unlogged)
boolean unlogged
getColumnDefinitions () → List
returns List | a list of `ColumnDefinition`s of this table.
setColumnDefinitions (list)
List list
getColumns () → List
returns List
setColumns (columns)
List columns
getTableOptionsStrings () → List
returns List | a list of options (as simple strings) of this table definition, as (“TYPE”, “=”, “MYISAM”)
setTableOptionsStrings (tableOptionsStrings)
List tableOptionsStrings
getCreateOptionsStrings () → List
returns List
setCreateOptionsStrings (createOptionsStrings)
List createOptionsStrings
getIndexes () → List
returns List | a list of `Index`es (for example “PRIMARY KEY”) of this table.
Indexes created with column definitions (as in mycol INT PRIMARY KEY) are not inserted into this list.
setIndexes (list)
List list
setSelect (select, parenthesis)
Select select
boolean parenthesis
setLikeTable (likeTable, parenthesis)
Table likeTable
boolean parenthesis
isIfNotExists () → boolean
returns boolean
setIfNotExists (ifNotExists)
boolean ifNotExists
isOrReplace () → boolean
returns boolean
setOrReplace (orReplace)
boolean orReplace
isSelectParenthesis () → boolean
returns boolean
setSelectParenthesis (selectParenthesis)
boolean selectParenthesis
getRowMovement () → RowMovement
returns RowMovement
setRowMovement (rowMovement)
RowMovement rowMovement
@Override,| @SuppressWarnings
toString () → String
returns String
withTable (table) → CreateTable
Table table
returns CreateTable
withUnlogged (unlogged) → CreateTable
boolean unlogged
returns CreateTable
withCreateOptionsStrings (createOptionsStrings) → CreateTable
List createOptionsStrings
returns CreateTable
withSelectParenthesis (selectParenthesis) → CreateTable
boolean selectParenthesis
returns CreateTable
withIfNotExists (ifNotExists) → CreateTable
boolean ifNotExists
returns CreateTable
withRowMovement (rowMovement) → CreateTable
RowMovement rowMovement
returns CreateTable
withTableOptionsStrings (tableOptionsStrings) → CreateTable
List tableOptionsStrings
returns CreateTable
withColumnDefinitions (columnDefinitions) → CreateTable
List columnDefinitions
returns CreateTable
withColumns (columns) → CreateTable
List columns
returns CreateTable
withIndexes (indexes) → CreateTable
List indexes
returns CreateTable
addCreateOptionsStrings (createOptionsStrings) → CreateTable
String createOptionsStrings
returns CreateTable
addCreateOptionsStrings (createOptionsStrings) → CreateTable
Collection createOptionsStrings
returns CreateTable
addColumnDefinitions (columnDefinitions) → CreateTable
ColumnDefinition columnDefinitions
returns CreateTable
addColumnDefinitions (columnDefinitions) → CreateTable
Collection columnDefinitions
returns CreateTable
addColumns (columns) → CreateTable
String columns
returns CreateTable
addColumns (columns) → CreateTable
Collection columns
returns CreateTable
addIndexes (indexes) → CreateTable
Index indexes
returns CreateTable
addIndexes (indexes) → CreateTable
Collection indexes
returns CreateTable
getSpannerInterleaveIn () → SpannerInterleaveIn
returns SpannerInterleaveIn
setSpannerInterleaveIn (spannerInterleaveIn)
SpannerInterleaveIn spannerInterleaveIn
withSpannerInterleaveIn (spannerInterleaveIn) → CreateTable
SpannerInterleaveIn spannerInterleaveIn
returns CreateTable
ExcludeConstraint¶
extends: Index
ExcludeConstraint ()
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withExpression (expression) → ExcludeConstraint
Expression expression
returns ExcludeConstraint
getExpression (type) → E
Class type
returns E
@Override
addColumns (functionDeclarationParts) → ExcludeConstraint
ColumnParams functionDeclarationParts
returns ExcludeConstraint
@Override
addColumns (functionDeclarationParts) → ExcludeConstraint
Collection functionDeclarationParts
returns ExcludeConstraint
ForeignKeyIndex¶
extends: NamedConstraint
ForeignKeyIndex ()
setTable (table)
Table table
getReferencedColumnNames () → List
returns List
setReferencedColumnNames (referencedColumnNames)
List referencedColumnNames
setReferentialAction (type, action)
Type type
Action action
withReferentialAction (type, action) → ForeignKeyIndex
removeReferentialAction (type)
Type type
getReferentialAction (type) → ReferentialAction
Type type
returns ReferentialAction |
@Deprecated
getOnDeleteReferenceOption () → String
returns String
@Deprecated
setOnDeleteReferenceOption (onDeleteReferenceOption)
String onDeleteReferenceOption
@Deprecated
getOnUpdateReferenceOption () → String
returns String
@Deprecated
setOnUpdateReferenceOption (onUpdateReferenceOption)
String onUpdateReferenceOption
@Override
toString () → String
returns String
withTable (table) → ForeignKeyIndex
Table table
returns ForeignKeyIndex
withReferencedColumnNames (referencedColumnNames) → ForeignKeyIndex
List referencedColumnNames
returns ForeignKeyIndex
withOnDeleteReferenceOption (onDeleteReferenceOption) → ForeignKeyIndex
String onDeleteReferenceOption
returns ForeignKeyIndex
withOnUpdateReferenceOption (onUpdateReferenceOption) → ForeignKeyIndex
String onUpdateReferenceOption
returns ForeignKeyIndex
addReferencedColumnNames (referencedColumnNames) → ForeignKeyIndex
String referencedColumnNames
returns ForeignKeyIndex
addReferencedColumnNames (referencedColumnNames) → ForeignKeyIndex
Collection referencedColumnNames
returns ForeignKeyIndex
@Override
addColumns (functionDeclarationParts) → ForeignKeyIndex
ColumnParams functionDeclarationParts
returns ForeignKeyIndex
@Override
addColumns (functionDeclarationParts) → ForeignKeyIndex
Collection functionDeclarationParts
returns ForeignKeyIndex
Index¶
extends: Object implements: Serializable provides: ExcludeConstraint, NamedConstraint
Index ()
getColumnsNames () → List
returns List
@Deprecated
getColumnWithParams () → List
returns List
@Deprecated
setColumnNamesWithParams (list)
List list
getColumns () → List
returns List
setColumns (columns)
List columns
addColumns (functionDeclarationParts) → Index
ColumnParams functionDeclarationParts
returns Index
getName () → String
returns String
getNameParts () → List
returns List
getType () → String
returns String
setUsing (using)
In postgresql, the index type (Btree, GIST, etc.) is indicated with a USING clause. Please note that: Oracle - the type might be BITMAP, indicating a bitmap kind of index MySQL - the type might be FULLTEXT or SPATIAL
String using
setColumnsNames (list)
List list
setName (name)
String name
setName (name)
List name
setType (string)
String string
getUsing () → String
returns String
getIndexSpec () → List
returns List
setIndexSpec (idxSpec)
List idxSpec
@Override
toString () → String
returns String
getCommentText () → String
returns String
setCommentText (commentText)
String commentText
Index.ColumnParams¶
extends: Object implements: Serializable
ColumnParams (columnName)
String columnName
ColumnParams (columnName, params)
String columnName
List params
getColumnName () → String
returns String
getParams () → List
returns List
@Override
toString () → String
returns String
NamedConstraint¶
extends: Index provides: CheckConstraint, ForeignKeyIndex
NamedConstraint ()
@Override
toString () → String
returns String
@Override
addColumns (functionDeclarationParts) → NamedConstraint
ColumnParams functionDeclarationParts
returns NamedConstraint
@Override
addColumns (functionDeclarationParts) → NamedConstraint
Collection functionDeclarationParts
returns NamedConstraint
RowMovement¶
extends: Object implements: Serializable
Holds data for the row_movement clause: https://docs.oracle.com/cd/B19306_01/server.102/b14200/statements_7002.htm#i2204697
RowMovement ()
getMode () → RowMovementMode
returns RowMovementMode
setMode (mode)
RowMovementMode mode
withMode (mode) → RowMovement
RowMovementMode mode
returns RowMovement
statement.create.view¶
AutoRefreshOption¶
[NONE, YES, NO]
ForceOption¶
[NONE, FORCE, NO_FORCE]
TemporaryOption¶
[NONE, TEMP, TEMPORARY, VOLATILE]
AlterView¶
extends: Object implements: Statement
AlterView ()
setView (view)
Table view
setSelect (select)
Select select
getColumnNames () → List
returns List
setColumnNames (columnNames)
List columnNames
isUseReplace () → boolean
returns boolean
setUseReplace (useReplace)
boolean useReplace
@Override
toString () → String
returns String
getSelectBody (type) → E
Class type
returns E
CreateView¶
extends: Object implements: Statement
CreateView ()
setView (view)
Table view
isOrReplace () → boolean
returns boolean
setOrReplace (orReplace)
boolean orReplace | orReplace was “OR REPLACE” specified?
setSelect (select)
Select select
getColumnNames () → ExpressionList
returns ExpressionList
setColumnNames (columnNames)
ExpressionList columnNames
isMaterialized () → boolean
returns boolean
setMaterialized (materialized)
boolean materialized
getForce () → ForceOption
returns ForceOption
setForce (force)
ForceOption force
isSecure () → boolean
returns boolean
setSecure (secure)
boolean secure
getTemporary () → TemporaryOption
returns TemporaryOption
setTemporary (temp)
TemporaryOption temp
getAutoRefresh () → AutoRefreshOption
returns AutoRefreshOption
setAutoRefresh (autoRefresh)
AutoRefreshOption autoRefresh
isWithReadOnly () → boolean
returns boolean
setWithReadOnly (withReadOnly)
boolean withReadOnly
isIfNotExists () → boolean
returns boolean
setIfNotExists (ifNotExists)
boolean ifNotExists
@Override
toString () → String
returns String
withView (view) → CreateView
Table view
returns CreateView
withSelect (select) → CreateView
Select select
returns CreateView
withOrReplace (orReplace) → CreateView
boolean orReplace
returns CreateView
withColumnNames (columnNames) → CreateView
ExpressionList columnNames
returns CreateView
withMaterialized (materialized) → CreateView
boolean materialized
returns CreateView
withForce (force) → CreateView
ForceOption force
returns CreateView
withWithReadOnly (withReadOnly) → CreateView
boolean withReadOnly
returns CreateView
getViewCommentOptions () → List
returns List
setViewCommentOptions (viewCommentOptions)
List viewCommentOptions
statement.delete¶
DeleteModifierPriority¶
[LOW_PRIORITY]
Delete¶
extends: Object implements: Statement
Delete ()
getOutputClause () → OutputClause
returns OutputClause
setOutputClause (outputClause)
OutputClause outputClause
getReturningClause () → ReturningClause
returns ReturningClause
setReturningClause (returningClause) → Delete
ReturningClause returningClause
returns Delete
getWithItemsList () → List
returns List
setWithItemsList (withItemsList)
List withItemsList
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
getWhere () → Expression
returns Expression
setTable (name)
Table name
setWhere (expression)
Expression expression
getOracleHint () → OracleHint
returns OracleHint
setOracleHint (oracleHint)
OracleHint oracleHint
setLimit (limit)
Limit limit
getTables () → List
returns List
setTables (tables)
List tables
getUsingList () → List
returns List
setUsingList (usingList)
List usingList
getJoins () → List
returns List
setJoins (joins)
List joins
isHasFrom () → boolean
returns boolean
setHasFrom (hasFrom)
boolean hasFrom
@Override,| @SuppressWarnings
toString () → String
returns String
withWhere (where) → Delete
Expression where
returns Delete
withModifierPriority (modifierPriority) → Delete
DeleteModifierPriority modifierPriority
returns Delete
setModifierPriority (modifierPriority)
DeleteModifierPriority modifierPriority
getModifierPriority () → DeleteModifierPriority
returns DeleteModifierPriority
setModifierIgnore (modifierIgnore)
boolean modifierIgnore
setModifierQuick (modifierQuick)
boolean modifierQuick
isModifierIgnore () → boolean
returns boolean
isModifierQuick () → boolean
returns boolean
addOrderByElements (orderByElements) → Delete
OrderByElement orderByElements
returns Delete
getWhere (type) → E
Class type
returns E
statement.drop¶
Drop¶
extends: Object implements: Statement
Drop ()
getParameters () → List
returns List
getType () → String
returns String
setName (string)
Table string
setParameters (list)
List list
setType (string)
String string
isIfExists () → boolean
returns boolean
setIfExists (ifExists)
boolean ifExists
isUsingTemporary () → boolean
returns boolean
setUsingTemporary (useTemporary)
boolean useTemporary
isMaterialized () → boolean
returns boolean
setMaterialized (materialized)
boolean materialized
getTypeToParameters () → Map
returns Map
setTypeToParameters (typeToParameters)
Map typeToParameters
@Override
toString () → String
returns String
formatFuncParams (params) → String
List params
returns String
getParamsByType (type) → List
String type
returns List
statement.execute¶
Execute.ExecType¶
[EXECUTE, EXEC, CALL]
Execute¶
extends: Object implements: Statement
Execute ()
getName () → String
returns String
setName (name)
String name
setName (names)
List names
getExprList () → ExpressionList
returns ExpressionList
setExprList (exprList)
ExpressionList exprList
getExecType () → ExecType
returns ExecType
setExecType (execType)
ExecType execType
@Deprecated
isParenthesis () → boolean
returns boolean
@Override
toString () → String
returns String
withExprList (exprList) → Execute
ExpressionList exprList
returns Execute
statement.grant¶
Grant¶
extends: Object implements: Statement
Grant ()
getRole () → String
returns String
setRole (role)
String role
getPrivileges () → List
returns List
setPrivileges (privileges)
List privileges
getObjectName () → String
returns String
getObjectNameParts () → List
returns List
setObjectName (objectName)
String objectName
setObjectName (objectName)
List objectName
getUsers () → List
returns List
setUsers (users)
List users
@Override
toString () → String
returns String
statement.insert¶
ConflictActionType¶
[DO_NOTHING, DO_UPDATE]
InsertModifierPriority¶
[LOW_PRIORITY, DELAYED, HIGH_PRIORITY, IGNORE]
Insert¶
extends: Object implements: Statement
Insert ()
getDuplicateUpdateSets () → List
returns List
getSetUpdateSets () → List
returns List
getOutputClause () → OutputClause
returns OutputClause
setOutputClause (outputClause)
OutputClause outputClause
setTable (name)
Table name
getOracleHint () → OracleHint
returns OracleHint
setOracleHint (oracleHint)
OracleHint oracleHint
getColumns () → ExpressionList
returns ExpressionList
setColumns (list)
ExpressionList list
@Deprecated
isUseValues () → boolean
returns boolean
getReturningClause () → ReturningClause
returns ReturningClause
setReturningClause (returningClause) → Insert
ReturningClause returningClause
returns Insert
setSelect (select)
Select select
getPlainSelect () → PlainSelect
returns PlainSelect
getSetOperationList () → SetOperationList
returns SetOperationList
@Deprecated
isUseSelectBrackets () → boolean
returns boolean
@Deprecated
isUseDuplicate () → boolean
returns boolean
getModifierPriority () → InsertModifierPriority
returns InsertModifierPriority
setModifierPriority (modifierPriority)
InsertModifierPriority modifierPriority
isModifierIgnore () → boolean
returns boolean
setModifierIgnore (modifierIgnore)
boolean modifierIgnore
@Deprecated
isUseSet () → boolean
returns boolean
getWithItemsList () → List
returns List
setWithItemsList (withItemsList)
List withItemsList
getConflictTarget () → InsertConflictTarget
returns InsertConflictTarget
setConflictTarget (conflictTarget)
InsertConflictTarget conflictTarget
withConflictTarget (conflictTarget) → Insert
InsertConflictTarget conflictTarget
returns Insert
getConflictAction () → InsertConflictAction
returns InsertConflictAction
setConflictAction (conflictAction)
InsertConflictAction conflictAction
withConflictAction (conflictAction) → Insert
InsertConflictAction conflictAction
returns Insert
@Override,| @SuppressWarnings
toString () → String
returns String
withModifierPriority (modifierPriority) → Insert
InsertModifierPriority modifierPriority
returns Insert
withColumns (columns) → Insert
ExpressionList columns
returns Insert
InsertConflictAction¶
extends: Object implements: Serializable
https://www.postgresql.org/docs/current/sql-insert.html conflict_action is one of: DO NOTHING DO UPDATE SET { column_name = { expression | DEFAULT } | ( column_name [, …] ) = [ ROW ] ( { expression | DEFAULT } [, …] ) | ( column_name [, …] ) = ( sub-SELECT ) } [, …] [ WHERE condition ]
InsertConflictAction (conflictActionType)
ConflictActionType conflictActionType
getUpdateSets () → List
returns List
setUpdateSets (updateSets)
List updateSets
withUpdateSets (updateSets) → InsertConflictAction
List updateSets
returns InsertConflictAction
getConflictActionType () → ConflictActionType
returns ConflictActionType
setConflictActionType (conflictActionType)
ConflictActionType conflictActionType
withConflictActionType (conflictActionType) → InsertConflictAction
ConflictActionType conflictActionType
returns InsertConflictAction
addUpdateSet (column, expression) → InsertConflictAction
addUpdateSet (updateSet) → InsertConflictAction
UpdateSet updateSet
returns InsertConflictAction
withUpdateSets (updateSets) → InsertConflictAction
Collection updateSets
returns InsertConflictAction
getWhereExpression () → Expression
returns Expression
setWhereExpression (whereExpression)
Expression whereExpression
withWhereExpression (whereExpression) → InsertConflictAction
Expression whereExpression
returns InsertConflictAction
@SuppressWarnings
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
InsertConflictTarget¶
extends: Object implements: Serializable
https://www.postgresql.org/docs/current/sql-insert.html conflict_target can be one of: ( { index_column_name | ( index_expression ) } [ COLLATE collation ] [ opclass ] [, …] ) [ WHERE index_predicate ] ON CONSTRAINT constraint_name Currently, COLLATE is not supported yet.
InsertConflictTarget (indexColumnName, indexExpression, whereExpression, constraintName)
InsertConflictTarget (indexColumnName, indexExpression, whereExpression, constraintName)
Collection indexColumnName
Expression indexExpression
Expression whereExpression
String constraintName
getIndexColumnNames () → List
returns List
@Deprecated
getIndexColumnName () → String
returns String
getIndexColumnName (index) → String
int index
returns String
addIndexColumnName (indexColumnName) → boolean
String indexColumnName
returns boolean
withIndexColumnName (indexColumnName) → InsertConflictTarget
String indexColumnName
returns InsertConflictTarget
addAllIndexColumnNames (indexColumnName) → boolean
Collection indexColumnName
returns boolean
getIndexExpression () → Expression
returns Expression
setIndexExpression (indexExpression)
Expression indexExpression
withIndexExpression (indexExpression) → InsertConflictTarget
Expression indexExpression
returns InsertConflictTarget
getWhereExpression () → Expression
returns Expression
setWhereExpression (whereExpression)
Expression whereExpression
withWhereExpression (whereExpression) → InsertConflictTarget
Expression whereExpression
returns InsertConflictTarget
getConstraintName () → String
returns String
setConstraintName (constraintName)
String constraintName
withConstraintName (constraintName) → InsertConflictTarget
String constraintName
returns InsertConflictTarget
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
toString () → String
returns String
statement.merge¶
Merge¶
extends: Object implements: Statement
Merge ()
getWithItemsList () → List
returns List
setWithItemsList (withItemsList)
List withItemsList
setTable (name)
Table name
getOracleHint () → OracleHint
returns OracleHint
setOracleHint (oracleHint)
OracleHint oracleHint
setFromItem (fromItem)
FromItem fromItem
getOnCondition () → Expression
returns Expression
setOnCondition (onCondition)
Expression onCondition
getOperations () → List
returns List
setOperations (operations)
List operations
getMergeInsert () → MergeInsert
returns MergeInsert
setMergeInsert (mergeInsert)
MergeInsert mergeInsert
getMergeUpdate () → MergeUpdate
returns MergeUpdate
setMergeUpdate (mergeUpdate)
MergeUpdate mergeUpdate
isInsertFirst () → boolean
returns boolean
setInsertFirst (insertFirst)
boolean insertFirst
getOutputClause () → OutputClause
returns OutputClause
setOutputClause (outputClause) → Merge
OutputClause outputClause
returns Merge
@Override,| @SuppressWarnings
toString () → String
returns String
withOnCondition (onCondition) → Merge
Expression onCondition
returns Merge
withMergeUpdate (mergeUpdate) → Merge
MergeUpdate mergeUpdate
returns Merge
withMergeInsert (mergeInsert) → Merge
MergeInsert mergeInsert
returns Merge
getOnCondition (type) → E
Class type
returns E
MergeDelete¶
extends: Object implements: Serializable, MergeOperation
MergeDelete ()
getAndPredicate () → Expression
returns Expression
setAndPredicate (andPredicate)
Expression andPredicate
withAndPredicate (andPredicate) → MergeDelete
Expression andPredicate
returns MergeDelete
@Override
toString () → String
returns String
MergeInsert¶
extends: Object implements: Serializable, MergeOperation
MergeInsert ()
getAndPredicate () → Expression
returns Expression
setAndPredicate (andPredicate)
Expression andPredicate
getColumns () → ExpressionList
returns ExpressionList
setColumns (columns)
ExpressionList columns
getValues () → ExpressionList
returns ExpressionList
setValues (values)
ExpressionList values
getWhereCondition () → Expression
returns Expression
setWhereCondition (whereCondition)
Expression whereCondition
@Override
toString () → String
returns String
withAndPredicate (andPredicate) → MergeInsert
Expression andPredicate
returns MergeInsert
withColumns (columns) → MergeInsert
ExpressionList columns
returns MergeInsert
withValues (values) → MergeInsert
ExpressionList values
returns MergeInsert
addColumns (columns) → MergeInsert
Column columns
returns MergeInsert
addColumns (columns) → MergeInsert
Collection columns
returns MergeInsert
addValues (values) → MergeInsert
Expression values
returns MergeInsert
addValues (values) → MergeInsert
Collection values
returns MergeInsert
withWhereCondition (whereCondition) → MergeInsert
Expression whereCondition
returns MergeInsert
getAndPredicate (type) → E
Class type
returns E
getWhereCondition (type) → E
Class type
returns E
MergeOperationVisitorAdapter¶
extends: Object implements: MergeOperationVisitor
MergeOperationVisitorAdapter ()
MergeUpdate¶
extends: Object implements: Serializable, MergeOperation
MergeUpdate ()
MergeUpdate (updateSets)
List updateSets
getUpdateSets () → List
returns List
setUpdateSets (updateSets) → MergeUpdate
List updateSets
returns MergeUpdate
getAndPredicate () → Expression
returns Expression
setAndPredicate (andPredicate)
Expression andPredicate
getWhereCondition () → Expression
returns Expression
setWhereCondition (whereCondition)
Expression whereCondition
getDeleteWhereCondition () → Expression
returns Expression
setDeleteWhereCondition (deleteWhereCondition)
Expression deleteWhereCondition
@Override
toString () → String
returns String
withAndPredicate (andPredicate) → MergeUpdate
Expression andPredicate
returns MergeUpdate
withWhereCondition (whereCondition) → MergeUpdate
Expression whereCondition
returns MergeUpdate
withDeleteWhereCondition (deleteWhereCondition) → MergeUpdate
Expression deleteWhereCondition
returns MergeUpdate
getAndPredicate (type) → E
Class type
returns E
getWhereCondition (type) → E
Class type
returns E
getDeleteWhereCondition (type) → E
Class type
returns E
MergeOperation¶
provides: MergeDelete, MergeInsert, MergeUpdate,
Marker interface to cover MergeDelete, MergeUpdate and MergeInsert
accept (mergeOperationVisitor)
MergeOperationVisitor mergeOperationVisitor
MergeOperationVisitor¶
provides: MergeDeParser, MergeOperationVisitorAdapter, MergeValidator,
visit (mergeDelete)
MergeDelete mergeDelete
visit (mergeUpdate)
MergeUpdate mergeUpdate
visit (mergeInsert)
MergeInsert mergeInsert
statement.refresh¶
RefreshMode¶
[DEFAULT, WITH_DATA, WITH_NO_DATA]
RefreshMaterializedViewStatement¶
extends: Object implements: Statement
REFRESH MATERIALIZED VIEW [ CONCURRENTLY ] name [ WITH [ NO ] DATA ]
RefreshMaterializedViewStatement ()
RefreshMaterializedViewStatement (view, concurrently, refreshMode)
setView (view)
Table view
getRefreshMode () → RefreshMode
returns RefreshMode
setRefreshMode (refreshMode)
RefreshMode refreshMode
isConcurrently () → boolean
returns boolean
setConcurrently (concurrently)
boolean concurrently
@SuppressWarnings,| @Override
toString () → String
returns String
withTableName (view) → RefreshMaterializedViewStatement
Table view
returns RefreshMaterializedViewStatement
withConcurrently (concurrently) → RefreshMaterializedViewStatement
boolean concurrently
returns RefreshMaterializedViewStatement
statement.select¶
First.Keyword¶
[FIRST, LIMIT]
ForClause.ForOption¶
[BROWSE, XML, JSON]
ForMode¶
[UPDATE, SHARE, NO_KEY_UPDATE, KEY_SHARE]
KSQLWindow.TimeUnit¶
[DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAYS, HOURS, MINUTES, SECONDS, MILLISECONDS]
KSQLWindow.WindowType¶
[HOPPING, SESSION, TUMBLING]
MySqlSqlCacheFlags¶
[SQL_CACHE, SQL_NO_CACHE]
OrderByElement.NullOrdering¶
[NULLS_FIRST, NULLS_LAST]
SampleClause.SampleKeyword¶
[SAMPLE, TABLESAMPLE]
SampleClause.SampleMethod¶
[BERNOULLI, SYSTEM, BLOCK]
SetOperationList.SetOperationType¶
[INTERSECT, EXCEPT, MINUS, UNION]
AllColumns¶
extends: ASTNodeAccessImpl implements: Expression provides: AllTableColumns
AllColumns (exceptColumns, replaceExpressions)
ExpressionList exceptColumns
List replaceExpressions
AllColumns ()
getExceptColumns () → ExpressionList
returns ExpressionList
addExceptColumn (column) → ExpressionList
Column column
returns ExpressionList
setExceptColumns (exceptColumns) → AllColumns
ExpressionList exceptColumns
returns AllColumns
getReplaceExpressions () → List
returns List
addReplaceExpression (selectItem) → List
SelectItem selectItem
returns List
setReplaceExpressions (replaceExpressions) → AllColumns
List replaceExpressions
returns AllColumns
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
AllTableColumns¶
extends: AllColumns
AllTableColumns (table, exceptColumns, replaceExpressions)
AllTableColumns (table)
Table table
AllTableColumns (table, allColumns)
Table table
AllColumns allColumns
setTable (table)
Table table
withTable (table) → AllTableColumns
Table table
returns AllTableColumns
@Override
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
Distinct¶
extends: Object implements: Serializable
Distinct ()
Distinct (useUnique)
boolean useUnique
getOnSelectItems () → List
returns List
setOnSelectItems (list)
List list
isUseUnique () → boolean
returns boolean
setUseUnique (useUnique)
boolean useUnique
@Override
toString () → String
returns String
addOnSelectItems (onSelectItems) → Distinct
SelectItem onSelectItems
returns Distinct
ExceptOp¶
extends: SetOperation
ExceptOp ()
Fetch¶
extends: Object implements: Serializable
Fetch ()
@Deprecated
getRowCount () → long
returns long
@Deprecated
setRowCount (l)
long l
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
withExpression (expression) → Fetch
Expression expression
returns Fetch
getFetchParameters () → List
returns List
@Deprecated
getFetchParam () → String
returns String
isFetchParamFirst () → boolean
returns boolean
@Deprecated
setFetchParam (s)
String s
setFetchParamFirst (b)
boolean b
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
@Deprecated
withFetchJdbcParameter (fetchJdbcParameter) → Fetch
JdbcParameter fetchJdbcParameter
returns Fetch
First¶
extends: Object implements: Serializable
First ()
getRowCount () → Long
returns Long
setRowCount (rowCount)
Long rowCount
getJdbcParameter () → JdbcParameter
returns JdbcParameter
setJdbcParameter (jdbcParameter)
JdbcParameter jdbcParameter
getKeyword () → Keyword
returns Keyword
setKeyword (keyword)
Keyword keyword
getVariable () → String
returns String
setVariable (variable)
String variable
@Override
toString () → String
returns String
withJdbcParameter (jdbcParameter) → First
JdbcParameter jdbcParameter
returns First
ForClause¶
extends: ASTNodeAccessImpl
ForClause ()
getForOption () → ForOption
returns ForOption
@Override
toString () → String
returns String
FromItemVisitorAdapter¶
extends: Object implements: FromItemVisitor
FromItemVisitorAdapter ()
GroupByElement¶
extends: Object implements: Serializable
GroupByElement ()
isUsingBrackets () → boolean
returns boolean
accept (groupByVisitor)
GroupByVisitor groupByVisitor
getGroupByExpressionList () → ExpressionList
returns ExpressionList
setGroupByExpressions (groupByExpressions)
ExpressionList groupByExpressions
getGroupingSets () → List
returns List
setGroupingSets (groupingSets)
List groupingSets
addGroupingSet (list)
ExpressionList list
@Override,| @SuppressWarnings
toString () → String
returns String
withGroupByExpressions (groupByExpressions) → GroupByElement
ExpressionList groupByExpressions
returns GroupByElement
withGroupingSets (groupingSets) → GroupByElement
List groupingSets
returns GroupByElement
addGroupByExpressions (groupByExpressions) → GroupByElement
Expression groupByExpressions
returns GroupByElement
addGroupByExpressions (groupByExpressions) → GroupByElement
Collection groupByExpressions
returns GroupByElement
addGroupingSets (groupingSets) → GroupByElement
Object groupingSets
returns GroupByElement
addGroupingSets (groupingSets) → GroupByElement
Collection groupingSets
returns GroupByElement
isMysqlWithRollup () → boolean
returns boolean
setMysqlWithRollup (mysqlWithRollup) → GroupByElement
boolean mysqlWithRollup
returns GroupByElement
IntersectOp¶
extends: SetOperation
IntersectOp ()
IntoTableVisitorAdapter¶
extends: Object implements: IntoTableVisitor
IntoTableVisitorAdapter ()
Join¶
extends: ASTNodeAccessImpl
Join ()
isSimple () → boolean
returns boolean
setSimple (b)
boolean b
isInnerJoin () → boolean
A JOIN means INNER when the INNER keyword is set or when no other qualifier has been set.
returns boolean | Tells, if a JOIN means a qualified INNER JOIN.
isInner () → boolean
returns boolean | Tells, if the INNER keyword has been set.
setInner (b)
Sets the INNER keyword and switches off any contradicting qualifiers automatically.
boolean b
isStraight () → boolean
returns boolean
setStraight (b)
boolean b
isOuter () → boolean
Whether is a “OUTER” join
returns boolean | true if is a “OUTER” join
setOuter (b)
Sets the OUTER keyword and switches off any contradicting qualifiers automatically.
boolean b
isApply () → boolean
returns boolean
setApply (apply)
boolean apply
isSemi () → boolean
Whether is a “SEMI” join
returns boolean | true if is a “SEMI” join
setSemi (b)
boolean b
isLeft () → boolean
Whether is a “LEFT” join
returns boolean | true if is a “LEFT” join
setLeft (b)
Sets the LEFT keyword and switches off any contradicting qualifiers automatically.
boolean b
isRight () → boolean
Whether is a “RIGHT” join
returns boolean | true if is a “RIGHT” join
setRight (b)
Sets the RIGHT keyword and switches off any contradicting qualifiers automatically.
boolean b
isNatural () → boolean
Whether is a “NATURAL” join
returns boolean | true if is a “NATURAL” join
isGlobal () → boolean
returns boolean
setNatural (b)
boolean b
setGlobal (b)
boolean b
isFull () → boolean
Whether is a “FULL” join
returns boolean | true if is a “FULL” join
setFull (b)
boolean b
isCross () → boolean
returns boolean
setCross (cross)
boolean cross
setRightItem (item)
FromItem item
getOnExpressions () → Collection
returns Collection
addOnExpression (expression) → Join
Expression expression
returns Join
getUsingColumns () → List
Returns the “USING” list of `net.sf.jsqlparser.schema.Column`s (if any)
returns List
setUsingColumns (list)
List list
isWindowJoin () → boolean
returns boolean
withJoinWindow (joinWindow) → Join
KSQLJoinWindow joinWindow
returns Join
setJoinWindow (joinWindow)
KSQLJoinWindow joinWindow
@Override,| @SuppressWarnings
toString () → String
returns String
JoinHint¶
extends: Object
Hints (Transact-SQL) - Join
JoinHint (keyword)
String keyword
@Override
toString () → String
returns String
KSQLJoinWindow¶
extends: ASTNodeAccessImpl
KSQLJoinWindow ()
isBeforeAfterWindow () → boolean
returns boolean
setBeforeAfterWindow (beforeAfter)
boolean beforeAfter
getDuration () → long
returns long
setDuration (duration)
long duration
getTimeUnit () → TimeUnit
returns TimeUnit
setTimeUnit (timeUnit)
TimeUnit timeUnit
getBeforeDuration () → long
returns long
setBeforeDuration (beforeDuration)
long beforeDuration
getBeforeTimeUnit () → TimeUnit
returns TimeUnit
setBeforeTimeUnit (beforeTimeUnit)
TimeUnit beforeTimeUnit
getAfterDuration () → long
returns long
setAfterDuration (afterDuration)
long afterDuration
getAfterTimeUnit () → TimeUnit
returns TimeUnit
setAfterTimeUnit (afterTimeUnit)
TimeUnit afterTimeUnit
@Override
toString () → String
returns String
withDuration (duration) → KSQLJoinWindow
long duration
returns KSQLJoinWindow
withTimeUnit (timeUnit) → KSQLJoinWindow
TimeUnit timeUnit
returns KSQLJoinWindow
withBeforeDuration (beforeDuration) → KSQLJoinWindow
long beforeDuration
returns KSQLJoinWindow
withBeforeTimeUnit (beforeTimeUnit) → KSQLJoinWindow
TimeUnit beforeTimeUnit
returns KSQLJoinWindow
withAfterDuration (afterDuration) → KSQLJoinWindow
long afterDuration
returns KSQLJoinWindow
withAfterTimeUnit (afterTimeUnit) → KSQLJoinWindow
TimeUnit afterTimeUnit
returns KSQLJoinWindow
from (timeUnitStr) → TimeUnit
String timeUnitStr
returns TimeUnit
KSQLWindow¶
extends: ASTNodeAccessImpl
KSQLWindow ()
isHoppingWindow () → boolean
returns boolean
setHoppingWindow (hopping)
boolean hopping
isTumblingWindow () → boolean
returns boolean
setTumblingWindow (tumbling)
boolean tumbling
isSessionWindow () → boolean
returns boolean
setSessionWindow (session)
boolean session
getSizeDuration () → long
returns long
setSizeDuration (sizeDuration)
long sizeDuration
getSizeTimeUnit () → TimeUnit
returns TimeUnit
setSizeTimeUnit (sizeTimeUnit)
TimeUnit sizeTimeUnit
getAdvanceDuration () → long
returns long
setAdvanceDuration (advanceDuration)
long advanceDuration
getAdvanceTimeUnit () → TimeUnit
returns TimeUnit
setAdvanceTimeUnit (advanceTimeUnit)
TimeUnit advanceTimeUnit
@Override
toString () → String
returns String
withSizeDuration (sizeDuration) → KSQLWindow
long sizeDuration
returns KSQLWindow
withSizeTimeUnit (sizeTimeUnit) → KSQLWindow
TimeUnit sizeTimeUnit
returns KSQLWindow
withAdvanceDuration (advanceDuration) → KSQLWindow
long advanceDuration
returns KSQLWindow
withAdvanceTimeUnit (advanceTimeUnit) → KSQLWindow
TimeUnit advanceTimeUnit
returns KSQLWindow
LateralSubSelect¶
extends: ParenthesedSelect
lateral sub select
LateralSubSelect ()
LateralSubSelect (prefix)
String prefix
LateralSubSelect (prefix, select)
String prefix
Select select
getPrefix () → String
returns String
setPrefix (prefix)
String prefix
withPrefix (prefix) → LateralSubSelect
String prefix
returns LateralSubSelect
withSelect (select) → LateralSubSelect
Select select
returns LateralSubSelect
withAlias (alias) → LateralSubSelect
Alias alias
returns LateralSubSelect
toString () → String
returns String
accept (selectVisitor)
SelectVisitor selectVisitor
LateralView¶
extends: Object implements: Serializable
LateralView (useOuter, generatorFunction, tableAlias, columnAlias)
isUsingOuter () → boolean
returns boolean
setUsingOuter (useOuter)
boolean useOuter
withOuter (useOuter) → LateralView
boolean useOuter
returns LateralView
setGeneratorFunction (generatorFunction)
Function generatorFunction
withGeneratorFunction (generatorFunction) → LateralView
Function generatorFunction
returns LateralView
setTableAlias (tableAlias)
Alias tableAlias
withTableAlias (tableAlias) → LateralView
Alias tableAlias
returns LateralView
setColumnAlias (columnAlias)
Alias columnAlias
withColumnAlias (columnAlias) → LateralView
Alias columnAlias
returns LateralView
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
Limit¶
extends: ASTNodeAccessImpl
Limit ()
getOffset () → Expression
returns Expression
getRowCount () → Expression
returns Expression
setOffset (l)
setRowCount (l)
@Deprecated
isLimitAll () → boolean
returns boolean
@Deprecated
setLimitAll (b)
boolean b
@Deprecated
isLimitNull () → boolean
returns boolean
@Deprecated
setLimitNull (b)
boolean b
@Override
toString () → String
returns String
withRowCount (rowCount) → Limit
Expression rowCount
returns Limit
withOffset (offset) → Limit
Expression offset
returns Limit
getOffset (type) → E
Class type
returns E
getRowCount (type) → E
Class type
returns E
getByExpressions () → ExpressionList
returns ExpressionList
setByExpressions (byExpressions)
ExpressionList byExpressions
setByExpressions (byExpressions)
Expression byExpressions
addByExpression (byExpression)
Expression byExpression
withByExpressions (byExpressions) → Limit
ExpressionList byExpressions
returns Limit
withByExpressions (byExpressions) → Limit
Expression byExpressions
returns Limit
MinusOp¶
extends: SetOperation
MinusOp ()
Offset¶
extends: Object implements: Serializable
Offset ()
getOffset () → Expression
returns Expression
getOffsetParam () → String
returns String
setOffset (offsetExpression)
Expression offsetExpression
setOffsetParam (s)
String s
@Override
toString () → String
returns String
withOffset (offsetExpression) → Offset
Expression offsetExpression
returns Offset
getOffset (type) → E
Class type
returns E
OptimizeFor¶
extends: Object implements: Serializable
A optimize for clause.
OptimizeFor (rowCount)
long rowCount
getRowCount () → long
returns long
setRowCount (l)
long l
@Override
toString () → String
returns String
withRowCount (rowCount) → OptimizeFor
long rowCount
returns OptimizeFor
OrderByElement¶
extends: Object implements: Serializable
OrderByElement ()
isAsc () → boolean
returns boolean
getNullOrdering () → NullOrdering
returns NullOrdering
setNullOrdering (nullOrdering)
NullOrdering nullOrdering
setAsc (asc)
boolean asc
setAscDescPresent (ascDescPresent)
boolean ascDescPresent
isAscDescPresent () → boolean
returns boolean
accept (orderByVisitor)
OrderByVisitor orderByVisitor
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
@Override
toString () → String
returns String
withExpression (expression) → OrderByElement
Expression expression
returns OrderByElement
withAsc (asc) → OrderByElement
boolean asc
returns OrderByElement
withAscDescPresent (ascDescPresent) → OrderByElement
boolean ascDescPresent
returns OrderByElement
withNullOrdering (nullOrdering) → OrderByElement
NullOrdering nullOrdering
returns OrderByElement
getExpression (type) → E
Class type
returns E
isMysqlWithRollup () → boolean
returns boolean
setMysqlWithRollup (mysqlWithRollup) → OrderByElement
boolean mysqlWithRollup
returns OrderByElement
OrderByVisitorAdapter¶
extends: Object implements: OrderByVisitor
OrderByVisitorAdapter ()
ParenthesedFromItem¶
extends: ASTNodeAccessImpl implements: FromItem
ParenthesedFromItem ()
ParenthesedFromItem (fromItem)
FromItem fromItem
setFromItem (fromItem)
FromItem fromItem
getJoins () → List
returns List
setJoins (list)
List list
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
withFromItem (fromItem) → ParenthesedFromItem
FromItem fromItem
returns ParenthesedFromItem
getFromItem (type) → E
Class type
returns E
ParenthesedSelect¶
extends: Select implements: FromItem provides: LateralSubSelect, WithItem
ParenthesedSelect ()
ParenthesedSelect (fromItem)
FromItem fromItem
ParenthesedSelect (fromItem, whereExpressions)
FromItem fromItem
Expression whereExpressions
ParenthesedSelect (fromItem, orderByExpressions)
FromItem fromItem
Collection orderByExpressions
ParenthesedSelect (fromItem, whereExpressions, orderByExpressions)
ParenthesedSelect (selectExpressions, fromItem)
Collection selectExpressions
FromItem fromItem
ParenthesedSelect (selectExpressions, fromItem, whereExpressions)
ParenthesedSelect (selectExpressions, fromItem, orderByExpressions)
ParenthesedSelect (selectExpressions, fromItem, whereExpressions, orderByExpressions)
Collection selectExpressions
FromItem fromItem
Expression whereExpressions
Collection orderByExpressions
withAlias (alias) → ParenthesedSelect
Alias alias
returns ParenthesedSelect
setUnPivot (unPivot)
UnPivot unPivot
getPlainSelect () → PlainSelect
returns PlainSelect
getSetOperationList () → SetOperationList
returns SetOperationList
setSelect (select)
Select select
withSelect (selectBody) → ParenthesedSelect
Select selectBody
returns ParenthesedSelect
withOrderByElements (orderByElements) → ParenthesedSelect
List orderByElements
returns ParenthesedSelect
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
Pivot¶
extends: Object implements: Serializable provides: PivotXml
Pivot ()
accept (pivotVisitor)
PivotVisitor pivotVisitor
getSingleInItems () → List
returns List
setSingleInItems (singleInItems)
List singleInItems
getMultiInItems () → List
returns List
setMultiInItems (multiInItems)
List multiInItems
getFunctionItems () → List
returns List
setFunctionItems (functionItems)
List functionItems
getForColumns () → ExpressionList
returns ExpressionList
setForColumns (forColumns)
ExpressionList forColumns
getInItems () → List
returns List
setAlias (alias)
Alias alias
@Override
toString () → String
returns String
withForColumns (forColumns) → Pivot
ExpressionList forColumns
returns Pivot
addFunctionItems (functionItems) → Pivot
SelectItem functionItems
returns Pivot
addSingleInItems (singleInItems) → Pivot
SelectItem singleInItems
returns Pivot
addMultiInItems (multiInItems) → Pivot
SelectItem multiInItems
returns Pivot
PivotVisitorAdapter¶
extends: Object implements: PivotVisitor
PivotVisitorAdapter ()
PivotXml¶
extends: Pivot
PivotXml ()
setInSelect (inSelect)
Select inSelect
isInAny () → boolean
returns boolean
setInAny (inAny)
boolean inAny
@Override
toString () → String
returns String
getInSelect (type) → E
Class type
returns E
PlainSelect¶
extends: Select
PlainSelect ()
PlainSelect (fromItem)
FromItem fromItem
PlainSelect (fromItem, whereExpressions)
FromItem fromItem
Expression whereExpressions
PlainSelect (fromItem, orderByExpressions)
FromItem fromItem
Collection orderByExpressions
PlainSelect (fromItem, whereExpressions, orderByExpressions)
PlainSelect (selectExpressions, fromItem)
Collection selectExpressions
FromItem fromItem
PlainSelect (selectExpressions, fromItem, whereExpressions)
PlainSelect (selectExpressions, fromItem, orderByExpressions)
PlainSelect (selectExpressions, fromItem, whereExpressions, orderByExpressions)
Collection selectExpressions
FromItem fromItem
Expression whereExpressions
Collection orderByExpressions
@Deprecated
isUseBrackets () → boolean
returns boolean
getIntoTables () → List
returns List
getSelectItems () → List
returns List
getSelectItem (index) → SelectItem
int index
returns SelectItem
getWhere () → Expression
returns Expression
withFromItem (item) → PlainSelect
FromItem item
returns PlainSelect
setFromItem (item)
FromItem item
setIntoTables (intoTables)
List intoTables
withSelectItems (list) → PlainSelect
List list
returns PlainSelect
withSelectItems (selectItems) → PlainSelect
SelectItem selectItems
returns PlainSelect
setSelectItems (list)
List list
addSelectItems (items) → PlainSelect
SelectItem items
returns PlainSelect
addSelectExpressions (expressions) → PlainSelect
Collection expressions
returns PlainSelect
addSelectItems (expressions) → PlainSelect
Expression expressions
returns PlainSelect
addSelectItem (expression, alias) → PlainSelect
addSelectItem (expression) → PlainSelect
Expression expression
returns PlainSelect
setWhere (where)
Expression where
getLateralViews () → List
returns List
setLateralViews (lateralViews)
Collection lateralViews
addLateralView (lateralView) → PlainSelect
LateralView lateralView
returns PlainSelect
withLateralViews (lateralViews) → PlainSelect
Collection lateralViews
returns PlainSelect
addJoins (joins) → PlainSelect
Join joins
returns PlainSelect
withJoins (joins) → PlainSelect
List joins
returns PlainSelect
setJoins (list)
List list
isUsingFinal () → boolean
returns boolean
setUsingFinal (usingFinal)
boolean usingFinal
withUsingFinal (usingFinal) → PlainSelect
boolean usingFinal
returns PlainSelect
isUsingOnly () → boolean
returns boolean
setUsingOnly (usingOnly)
boolean usingOnly
withUsingOnly (usingOnly) → PlainSelect
boolean usingOnly
returns PlainSelect
isUseWithNoLog () → boolean
returns boolean
setUseWithNoLog (useWithNoLog)
boolean useWithNoLog
withUseWithNoLog (useWithNoLog) → PlainSelect
boolean useWithNoLog
returns PlainSelect
setIntoTempTable (intoTempTable)
Table intoTempTable
withIntoTempTable (intoTempTable) → PlainSelect
Table intoTempTable
returns PlainSelect
getOptimizeFor () → OptimizeFor
returns OptimizeFor
setOptimizeFor (optimizeFor)
OptimizeFor optimizeFor
setTop (top)
Top top
setSkip (skip)
Skip skip
getMySqlHintStraightJoin () → boolean
returns boolean
setMySqlHintStraightJoin (mySqlHintStraightJoin)
boolean mySqlHintStraightJoin
setFirst (first)
First first
setDistinct (distinct)
Distinct distinct
getHaving () → Expression
returns Expression
setHaving (expression)
Expression expression
getQualify () → Expression
returns Expression
setQualify (qualify) → PlainSelect
Expression qualify
returns PlainSelect
getGroupBy () → GroupByElement
A list of `Expression`s of the GROUP BY clause. It is null in case there is no GROUP BY clause
returns GroupByElement | a list of `Expression`s
setGroupByElement (groupBy)
GroupByElement groupBy
addGroupByColumnReference (expr) → PlainSelect
Expression expr
returns PlainSelect
getOracleHierarchical () → OracleHierarchicalExpression
returns OracleHierarchicalExpression
setOracleHierarchical (oracleHierarchical)
OracleHierarchicalExpression oracleHierarchical
getOracleHint () → OracleHint
returns OracleHint
setOracleHint (oracleHint)
OracleHint oracleHint
getForXmlPath () → String
returns String
setForXmlPath (forXmlPath)
String forXmlPath
getKsqlWindow () → KSQLWindow
returns KSQLWindow
setKsqlWindow (ksqlWindow)
KSQLWindow ksqlWindow
setEmitChanges (emitChanges)
boolean emitChanges
isEmitChanges () → boolean
returns boolean
getWindowDefinitions () → List
returns List
setWindowDefinitions (windowDefinitions)
List windowDefinitions
@SuppressWarnings
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override,| @SuppressWarnings
toString () → String
returns String
withMySqlSqlCalcFoundRows (mySqlCalcFoundRows) → PlainSelect
boolean mySqlCalcFoundRows
returns PlainSelect
withMySqlSqlNoCache (mySqlCacheFlag) → PlainSelect
MySqlSqlCacheFlags mySqlCacheFlag
returns PlainSelect
setMySqlSqlCalcFoundRows (mySqlCalcFoundRows)
boolean mySqlCalcFoundRows
setMySqlSqlCacheFlag (sqlCacheFlag)
MySqlSqlCacheFlags sqlCacheFlag
getMySqlSqlCalcFoundRows () → boolean
returns boolean
getMySqlSqlCacheFlag () → MySqlSqlCacheFlags
returns MySqlSqlCacheFlags
withDistinct (distinct) → PlainSelect
Distinct distinct
returns PlainSelect
withIntoTables (intoTables) → PlainSelect
List intoTables
returns PlainSelect
withWhere (where) → PlainSelect
Expression where
returns PlainSelect
withOptimizeFor (optimizeFor) → PlainSelect
OptimizeFor optimizeFor
returns PlainSelect
withSkip (skip) → PlainSelect
Skip skip
returns PlainSelect
withMySqlHintStraightJoin (mySqlHintStraightJoin) → PlainSelect
boolean mySqlHintStraightJoin
returns PlainSelect
withFirst (first) → PlainSelect
First first
returns PlainSelect
withTop (top) → PlainSelect
Top top
returns PlainSelect
withOracleHierarchical (oracleHierarchical) → PlainSelect
OracleHierarchicalExpression oracleHierarchical
returns PlainSelect
withOracleHint (oracleHint) → PlainSelect
OracleHint oracleHint
returns PlainSelect
withOracleSiblings (oracleSiblings) → PlainSelect
boolean oracleSiblings
returns PlainSelect
withForXmlPath (forXmlPath) → PlainSelect
String forXmlPath
returns PlainSelect
withKsqlWindow (ksqlWindow) → PlainSelect
KSQLWindow ksqlWindow
returns PlainSelect
withNoWait (noWait) → PlainSelect
boolean noWait
returns PlainSelect
withHaving (having) → PlainSelect
Expression having
returns PlainSelect
addSelectItems (selectItems) → PlainSelect
Collection selectItems
returns PlainSelect
addIntoTables (intoTables) → PlainSelect
Table intoTables
returns PlainSelect
addIntoTables (intoTables) → PlainSelect
Collection intoTables
returns PlainSelect
addJoins (joins) → PlainSelect
Collection joins
returns PlainSelect
getFromItem (type) → E
Class type
returns E
getWhere (type) → E
Class type
returns E
getHaving (type) → E
Class type
returns E
SampleClause¶
extends: Object
SampleClause (keyword, method, percentageArgument, repeatArgument, seedArgument)
String keyword
String method
Number percentageArgument
Number repeatArgument
Number seedArgument
SampleClause ()
SampleClause (keyword)
String keyword
getKeyword () → SampleKeyword
returns SampleKeyword
setKeyword (keyword) → SampleClause
SampleKeyword keyword
returns SampleClause
getPercentageArgument () → Number
returns Number
setPercentageArgument (percentageArgument) → SampleClause
Number percentageArgument
returns SampleClause
getRepeatArgument () → Number
returns Number
setRepeatArgument (repeatArgument) → SampleClause
Number repeatArgument
returns SampleClause
getSeedArgument () → Number
returns Number
setSeedArgument (seedArgument) → SampleClause
Number seedArgument
returns SampleClause
getMethod () → SampleMethod
returns SampleMethod
setMethod (method) → SampleClause
SampleMethod method
returns SampleClause
setMethod (method) → SampleClause
String method
returns SampleClause
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
toString () → String
returns String
Select¶
extends: ASTNodeAccessImpl implements: Statement, Expression provides: ParenthesedSelect, PlainSelect, SetOperationList, TableStatement, Values
Select ()
orderByToString (orderByElements) → String
List orderByElements
returns String
orderByToString (oracleSiblings, orderByElements) → String
boolean oracleSiblings
List orderByElements
returns String
getFormattedList (list, expression) → String
List list
String expression
returns String
getFormattedList (list, expression, useComma, useBrackets) → String
List list
String expression
boolean useComma
boolean useBrackets
returns String
getStringList (list) → String
List the toString out put of the objects in the List comma separated. If the List is null or empty an empty string is returned.
The same as getStringList(list, true, false)
List list | list list of objects with toString methods
returns String | comma separated list of the elements in the list
getStringList (list, useComma, useBrackets) → String
List the toString out put of the objects in the List that can be comma separated. If the List is null or empty an empty string is returned.
List list | list list of objects with toString methods
boolean useComma | useComma true if the list has to be comma separated
boolean useBrackets | useBrackets true if the list has to be enclosed in brackets
returns String | comma separated list of the elements in the list
appendStringListTo (builder, list, useComma, useBrackets) → StringBuilder
Append the toString out put of the objects in the List (that can be comma separated). If the List is null or empty an empty string is returned.
StringBuilder builder
List list | list list of objects with toString methods
boolean useComma | useComma true if the list has to be comma separated
boolean useBrackets | useBrackets true if the list has to be enclosed in brackets
returns StringBuilder | comma separated list of the elements in the list
getWithItemsList () → List
returns List
setWithItemsList (withItemsList)
List withItemsList
isOracleSiblings () → boolean
returns boolean
setOracleSiblings (oracleSiblings)
boolean oracleSiblings
setNoWait (noWait)
boolean noWait
isNoWait () → boolean
returns boolean
getOrderByElements () → List
returns List
setOrderByElements (orderByElements)
List orderByElements
addOrderByElements (orderByElements) → Select
OrderByElement orderByElements
returns Select
addOrderByElements (orderByExpressions) → Select
Expression orderByExpressions
returns Select
setLimit (limit)
Limit limit
setLimitBy (limitBy)
Limit limitBy
withLimitBy (type, limitBy) → E
setOffset (offset)
Offset offset
setFetch (fetch)
Fetch fetch
getIsolation () → WithIsolation
returns WithIsolation
setIsolation (isolation)
WithIsolation isolation
withIsolation (isolation) → Select
WithIsolation isolation
returns Select
getForMode () → ForMode
returns ForMode
setForMode (forMode)
ForMode forMode
setForUpdateTable (forUpdateTable)
Table forUpdateTable
getWait () → Wait
Returns the value of the Wait set for this SELECT
returns Wait | the value of the Wait set for this SELECT
isSkipLocked () → boolean
returns boolean
setSkipLocked (skipLocked)
boolean skipLocked
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
accept (selectVisitor)
SelectVisitor selectVisitor
accept (statementVisitor)
StatementVisitor statementVisitor
getPlainSelect () → PlainSelect
returns PlainSelect
getSetOperationList () → SetOperationList
returns SetOperationList
as (type) → E
Class type
returns E
SelectItem¶
extends: ASTNodeAccessImpl
SelectItem (expression, alias)
T expression
Alias alias
SelectItem (expression, aliasName)
T expression
String aliasName
SelectItem (expression, aliasName)
Long expression
String aliasName
SelectItem (expression, aliasName)
Integer expression
String aliasName
SelectItem (expression, aliasName)
Double expression
String aliasName
SelectItem (expression, aliasName)
String expression
String aliasName
SelectItem ()
SelectItem (expression)
T expression
from (expression, alias) → SelectItem
from (expression) → SelectItem
Expression expression
returns SelectItem
setAlias (alias)
Alias alias
getExpression () → T
returns T
setExpression (expression)
T expression
accept (selectItemVisitor)
SelectItemVisitor selectItemVisitor
@Override
toString () → String
returns String
withExpression (expression) → SelectItem
T expression
returns SelectItem
withAlias (alias) → SelectItem
Alias alias
returns SelectItem
getExpression (type) → E
Class type
returns E
SelectItemVisitorAdapter¶
extends: Object implements: SelectItemVisitor
SelectItemVisitorAdapter ()
SelectVisitorAdapter¶
extends: Object implements: SelectVisitor
SelectVisitorAdapter ()
SetOperation¶
extends: ASTNodeAccessImpl provides: ExceptOp, IntersectOp, MinusOp, UnionOp
SetOperation (type)
SetOperationType type
@Override
toString () → String
returns String
SetOperationList¶
extends: Select
SetOperationList ()
getOrderByElements () → List
returns List
getSelects () → List
returns List
setSelects (selects)
List selects
setOperations (operations)
List operations
getOperations () → List
returns List
getOperation (index) → SetOperation
int index
returns SetOperation
setOrderByElements (orderByElements)
List orderByElements
setBracketsOpsAndSelects (select, ops)
List select
List ops
@Override
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
withOperations (operationList) → SetOperationList
List operationList
returns SetOperationList
withSelects (selects) → SetOperationList
List selects
returns SetOperationList
addSelects (selects) → SetOperationList
Select selects
returns SetOperationList
addSelects (selects) → SetOperationList
Collection selects
returns SetOperationList
addOperations (operationList) → SetOperationList
SetOperation operationList
returns SetOperationList
addOperations (operationList) → SetOperationList
Collection operationList
returns SetOperationList
Skip¶
extends: Object implements: Serializable
Skip ()
getRowCount () → Long
returns Long
setRowCount (rowCount)
Long rowCount
getJdbcParameter () → JdbcParameter
returns JdbcParameter
setJdbcParameter (jdbcParameter)
JdbcParameter jdbcParameter
getVariable () → String
returns String
setVariable (variable)
String variable
@Override
toString () → String
returns String
withJdbcParameter (jdbcParameter) → Skip
JdbcParameter jdbcParameter
returns Skip
TableFunction¶
extends: Function implements: FromItem
TableFunction (function)
Function function
TableFunction (prefix, function)
String prefix
Function function
setFunction (function) → TableFunction
Function function
returns TableFunction
getPrefix () → String
returns String
setPrefix (prefix) → TableFunction
String prefix
returns TableFunction
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@Override
toString () → String
returns String
TableStatement¶
extends: Select
TableStatement ()
setTable (table)
Table table
@Override
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
@SuppressWarnings,| @Override
appendTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
Top¶
extends: ASTNodeAccessImpl implements: Serializable
Top ()
getExpression () → Expression
returns Expression
setExpression (expression)
Expression expression
hasParenthesis () → boolean
returns boolean
setParenthesis (hasParenthesis)
boolean hasParenthesis
isPercentage () → boolean
returns boolean
setPercentage (percentage)
boolean percentage
setWithTies (withTies)
boolean withTies
isWithTies () → boolean
returns boolean
@Override
toString () → String
returns String
withExpression (expression) → Top
Expression expression
returns Top
getExpression (type) → E
Class type
returns E
UnPivot¶
extends: Object implements: Serializable
UnPivot ()
accept (pivotVisitor)
PivotVisitor pivotVisitor
getIncludeNulls () → boolean
returns boolean
setIncludeNulls (includeNulls)
boolean includeNulls
getIncludeNullsSpecified () → boolean
returns boolean
getUnPivotClause () → List
returns List
setUnPivotClause (unpivotClause)
ExpressionList unpivotClause
getUnPivotForClause () → List
returns List
setUnPivotForClause (forColumns)
ExpressionList forColumns
getUnPivotInClause () → List
returns List
setUnPivotInClause (unpivotInClause)
List unpivotInClause
@Override
toString () → String
returns String
setAlias (alias)
Alias alias
UnionOp¶
extends: SetOperation
UnionOp ()
isAll () → boolean
returns boolean
setAll (all)
boolean all
isDistinct () → boolean
returns boolean
setDistinct (distinct)
boolean distinct
@Override
toString () → String
returns String
Values¶
extends: Select implements: FromItem
Values ()
Values (expressions)
ExpressionList expressions
getExpressions () → ExpressionList
returns ExpressionList
setExpressions (expressions)
ExpressionList expressions
@Override
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
withExpressions (expressions) → Values
ExpressionList expressions
returns Values
addExpressions (expressions) → Values
Expression expressions
returns Values
Wait¶
extends: Object implements: Serializable
Wait ()
getTimeout () → long
returns long
setTimeout (timeout)
long timeout
@Override
toString () → String
Returns a String containing the WAIT clause and its timeout, where TIMEOUT is specified by #getTimeout(). The returned string will null be:
" WAIT <TIMEOUT>"returns String
WithIsolation¶
extends: Object implements: Serializable
WithIsolation ()
getIsolation () → String
returns String
setIsolation (s)
String s
@Override
toString () → String
returns String
WithItem¶
extends: ParenthesedSelect
WithItem ()
isRecursive () → boolean
returns boolean
setRecursive (recursive)
boolean recursive
getWithItemList () → List
The `SelectItem`s in this WITH (for example the A,B,C in “WITH mywith (A,B,C) AS …”)
returns List | a list of `SelectItem`s
setWithItemList (withItemList)
List withItemList
@Override,| @SuppressWarnings
appendSelectBodyTo (builder) → StringBuilder
StringBuilder builder
returns StringBuilder
addWithItemList (withItemList) → WithItem
SelectItem withItemList
returns WithItem
FromItem¶
implements: ASTNodeAccess provides: ParenthesedFromItem, ParenthesedSelect, Table, TableFunction, Values,
accept (fromItemVisitor)
FromItemVisitor fromItemVisitor
setAlias (alias)
Alias alias
setPivot (pivot)
Pivot pivot
setUnPivot (unpivot)
UnPivot unpivot
FromItemVisitor¶
provides: FromItemVisitorAdapter, SelectDeParser, SelectValidator, TablesNamesFinder,
visit (tableName)
Table tableName
visit (selectBody)
ParenthesedSelect selectBody
visit (lateralSubSelect)
LateralSubSelect lateralSubSelect
visit (tableFunction)
TableFunction tableFunction
visit (aThis)
ParenthesedFromItem aThis
visit (values)
Values values
GroupByVisitor¶
provides: GroupByValidator,
visit (groupBy)
GroupByElement groupBy
IntoTableVisitor¶
provides: IntoTableVisitorAdapter,
visit (tableName)
Table tableName
OrderByVisitor¶
provides: OrderByValidator, OrderByVisitorAdapter, UpdateDeParser,
visit (orderBy)
OrderByElement orderBy
PivotVisitor¶
provides: ExpressionVisitorAdapter, PivotVisitorAdapter, SelectDeParser, SelectValidator,
visit (pivot)
Pivot pivot
visit (pivot)
PivotXml pivot
visit (unpivot)
UnPivot unpivot
SelectItemVisitor¶
provides: AddAliasesVisitor, ConnectExpressionsVisitor, ExpressionVisitorAdapter, SelectDeParser, SelectItemVisitorAdapter, SelectValidator, TablesNamesFinder,
visit (selectItem)
SelectItem selectItem
SelectVisitor¶
provides: AddAliasesVisitor, ConnectExpressionsVisitor, SelectDeParser, SelectValidator, SelectVisitorAdapter, TableStatementDeParser, TablesNamesFinder,
visit (parenthesedSelect)
ParenthesedSelect parenthesedSelect
visit (plainSelect)
PlainSelect plainSelect
visit (setOpList)
SetOperationList setOpList
visit (withItem)
WithItem withItem
visit (aThis)
Values aThis
visit (lateralSubSelect)
LateralSubSelect lateralSubSelect
visit (tableStatement)
TableStatement tableStatement
statement.show¶
ShowTablesStatement.Modifiers¶
[EXTENDED, FULL]
ShowTablesStatement.SelectionMode¶
[FROM, IN]
ShowIndexStatement¶
extends: Object implements: Statement
ShowIndexStatement ()
ShowIndexStatement (tableName)
String tableName
getTableName () → String
returns String
setTableName (tableName)
String tableName
@Override
toString () → String
returns String
withTableName (tableName) → ShowIndexStatement
String tableName
returns ShowIndexStatement
ShowTablesStatement¶
extends: Object implements: Statement
A SHOW TABLES statement
ShowTablesStatement ()
getModifiers () → EnumSet
returns EnumSet
setModifiers (modifiers)
EnumSet modifiers
getSelectionMode () → SelectionMode
returns SelectionMode
setSelectionMode (selectionMode)
SelectionMode selectionMode
getDbName () → String
returns String
setDbName (dbName)
String dbName
getLikeExpression () → Expression
returns Expression
setLikeExpression (likeExpression)
Expression likeExpression
getWhereCondition () → Expression
returns Expression
setWhereCondition (whereCondition)
Expression whereCondition
@Override
toString () → String
returns String
statement.truncate¶
Truncate¶
extends: Object implements: Statement
Truncate ()
setTable (table)
Table table
getCascade () → boolean
returns boolean
setCascade (c)
boolean c
@Override
toString () → String
returns String
isTableToken () → boolean
returns boolean
setTableToken (hasTable)
boolean hasTable
isOnly () → boolean
returns boolean
setOnly (only)
boolean only
statement.update¶
UpdateModifierPriority¶
[LOW_PRIORITY]
Update¶
extends: Object implements: Statement
Update ()
getOutputClause () → OutputClause
returns OutputClause
setOutputClause (outputClause)
OutputClause outputClause
getUpdateSets () → List
returns List
setUpdateSets (updateSets)
List updateSets
getWithItemsList () → List
returns List
setWithItemsList (withItemsList)
List withItemsList
getWhere () → Expression
returns Expression
setTable (table)
Table table
setWhere (expression)
Expression expression
getOracleHint () → OracleHint
returns OracleHint
setOracleHint (oracleHint)
OracleHint oracleHint
addUpdateSet (column, expression) → Update
@Deprecated
getColumns () → List
returns List
@Deprecated
getExpressions () → List
returns List
@Deprecated
setColumns (list)
List list
@Deprecated
setExpressions (list)
List list
setFromItem (fromItem)
FromItem fromItem
getJoins () → List
returns List
setJoins (joins)
List joins
getStartJoins () → List
returns List
setStartJoins (startJoins)
List startJoins
@Deprecated
isUseColumnsBrackets () → boolean
returns boolean
@Deprecated
setUseColumnsBrackets (useColumnsBrackets)
boolean useColumnsBrackets
@Deprecated
isUseSelect () → boolean
returns boolean
@Deprecated
setUseSelect (useSelect)
boolean useSelect
setOrderByElements (orderByElements)
List orderByElements
setLimit (limit)
Limit limit
getOrderByElements () → List
returns List
getReturningClause () → ReturningClause
returns ReturningClause
setReturningClause (returningClause) → Update
ReturningClause returningClause
returns Update
getModifierPriority () → UpdateModifierPriority
returns UpdateModifierPriority
setModifierPriority (modifierPriority)
UpdateModifierPriority modifierPriority
isModifierIgnore () → boolean
returns boolean
setModifierIgnore (modifierIgnore)
boolean modifierIgnore
@Override,| @SuppressWarnings
toString () → String
returns String
withWhere (where) → Update
Expression where
returns Update
withModifierPriority (modifierPriority) → Update
UpdateModifierPriority modifierPriority
returns Update
addExpressions (expressions) → Update
Expression expressions
returns Update
addOrderByElements (orderByElements) → Update
OrderByElement orderByElements
returns Update
getWhere (type) → E
Class type
returns E
getFromItem (type) → E
Class type
returns E
UpdateSet¶
extends: Object implements: Serializable
UpdateSet ()
UpdateSet (column)
Column column
UpdateSet (column, value)
Column column
Expression value
getColumns () → ExpressionList
returns ExpressionList
setColumns (columns)
ExpressionList columns
getValues () → ExpressionList
returns ExpressionList
getValue (index) → Expression
int index
returns Expression
setValues (values)
ExpressionList values
add (column, value)
Column column
Expression value
add (column)
Add another column to the existing column list. Transform this list into a ParenthesedExpression list when needed.
Column column
add (expression)
Add another expression to the existing value list. Transform this list into a ParenthesedExpression list when needed.
Expression expression
add (expressionList)
ExpressionList expressionList
appendUpdateSetsTo (builder, updateSets) → StringBuilder
StringBuilder builder
Collection updateSets
returns StringBuilder
statement.upsert¶
UpsertType¶
[UPSERT, REPLACE, REPLACE_SET, INSERT_OR_ABORT, INSERT_OR_FAIL, INSERT_OR_IGNORE, INSERT_OR_REPLACE, INSERT_OR_ROLLBACK]
Upsert¶
extends: Object implements: Statement
Upsert ()
getUpdateSets () → List
returns List
getDuplicateUpdateSets () → List
returns List
getUpsertType () → UpsertType
returns UpsertType
setUpsertType (upsertType)
UpsertType upsertType
isUsingInto () → boolean
returns boolean
setUsingInto (useInto)
boolean useInto
setTable (name)
Table name
getColumns () → ExpressionList
returns ExpressionList
setColumns (list)
ExpressionList list
getExpressions () → ExpressionList
returns ExpressionList
setExpressions (list)
ExpressionList list
setSelect (select)
Select select
getPlainSelect () → PlainSelect
returns PlainSelect
getSetOperationList () → SetOperationList
returns SetOperationList
@Override,| @SuppressWarnings
toString () → String
returns String
withColumns (columns) → Upsert
ExpressionList columns
returns Upsert
withExpressions (expressions) → Upsert
ExpressionList expressions
returns Upsert
util¶
AddAliasesVisitor¶
extends: Object implements: SelectVisitor, SelectItemVisitor
Add aliases to every column and expression selected by a select - statement. Existing aliases are recognized and preserved. This class standard uses a prefix of A and a counter to generate new aliases (e.g. A1, A5, …). This behaviour can be altered.
AddAliasesVisitor ()
returns StringsetPrefix (prefix)
String prefix
ConnectExpressionsVisitor¶
extends: Object implements: SelectVisitor, SelectItemVisitor
Connect all selected expressions with a binary expression. Out of select a,b from table one gets select a || b as expr from table. The type of binary expression is set by overwriting this class abstract method createBinaryExpression.
ConnectExpressionsVisitor ()
ConnectExpressionsVisitor (alias)
String alias
returns BinaryExpression@Override
visit (parenthesedSelect)
ParenthesedSelect parenthesedSelect
PerformanceTest¶
extends: Object
PerformanceTest ()
@SuppressWarnings
main (args)
String args
SelectUtils¶
extends: Object
buildSelectFromTableAndExpressions (table, expr) → Select
buildSelectFromTableAndSelectItems (table, selectItems) → Select
addExpression (select, expr)
Adds an expression to select statements. E.g. a simple column is an expression.
Select select
Expression expr
addJoin (select, table, onExpression) → Join
Adds a simple join to a select statement. The introduced join is returned for more configuration settings on it (e.g. left join, right join).
TablesNamesFinder¶
extends: Object implements: SelectVisitor, FromItemVisitor, ExpressionVisitor, SelectItemVisitor, StatementVisitor
Find all used tables within an select statement.
Override extractTableName method to modify the extracted table names (e.g. without schema).
TablesNamesFinder ()
getTables (statement) → Set
Statement statement
returns Set
getTablesOrOtherSources (statement) → Set
Statement statement
returns Set
findTables (sqlStr) → Set
String sqlStr
returns Set
findTablesOrOtherSources (sqlStr) → Set
String sqlStr
returns Set
@Deprecated
getTableList (expr) → List
Main entry for this Tool class. A list of found tables is returned.
Expression expr
returns List
getTables (expr) → Set
Expression expr
returns Set
findTablesInExpression (exprStr) → Set
String exprStr
returns Set
Override to adapt the tableName generation (e.g. with / without schema).
Table tablereturns String |@Override
visit (tableName)
Table tableName
visitBinaryExpression (binaryExpression)
BinaryExpression binaryExpression
Initializes table names collector. Important is the usage of Column instances to find table
names. This is only allowed for expression parsing, where a better place for tablenames could not be there. For complete statements only from items are used to avoid some alias as tablenames.
boolean allowColumnProcessingreturns void@Override
visit (iexpr)
IntervalExpression iexpr
visit (analyze)
Analyze analyze
visit (ifElseStatement)
IfElseStatement ifElseStatement
visit (oracleNamedFunctionParameter)
OracleNamedFunctionParameter oracleNamedFunctionParameter
util.cnfexpression¶
CNFConverter¶
extends: Object
This class handles the conversion from a normal expression tree into the CNF form. Here is the definition of CNF form: https://en.wikipedia.org/wiki/Conjunctive_normal_form Basically it will follow these steps: To help understanding, I will generate an example: Here is the original tree: OR / OR NOT / | NOT H AND | / NOT G OR | / F H NOT | OR / AND L / ( ) ( ) | | J K 1. rebuild the tree by replacing the “and” and “or” operators (which are binary) into their counterparts node that could hold multiple elements. Also, leave out the parenthesis node between the conditional operators to make the tree uniform. After the transform, the result should be like this: OR(M) / OR(M) NOT / | NOT H AND(M) | / NOT G OR(M) | / F H NOT | OR(M) / AND(M) L / J K 2. push the not operators into the bottom of the expression. That means the not operator will be the root of the expression tree where no “and” or “or” exists. Be sure use the De Morgan’s law and double not law. How to use De Morgan law: For example, here is the original expression tree: NOT | AND(M) / G H After we use the De Morgan law, the result should be like this: OR(M) / NOT NOT | | G H After the transform, the result should be like this: OR(M) / OR(M) OR(M) / / F H NOT AND(M) | / G NOT OR(M) | / H AND(M) L / J K 3. gather all the adjacent “and” or “or” operator together. After doing that, the expression tree will be presented as: all the and expression will be in either odd or even levels, this will be the same for the or operator. After the transform, the expression tree should be like this: OR(M) / / F H NOT AND(M) | / G NOT OR(M) | / H AND(M) L / J K 4. push the and operator upwards until the root is an and operator and all the children are or operators with multiple components. At this time we get the result: an expression in CNF form. How do we push and up? Use distribution law! For example, here is the way to push the and up and merge them. OR / AND L / J K In the normal form, it could be: (J AND K) OR L. If we apply the distribution law, we will get the result like this: (J OR L) AND (K OR L), the tree form of this should be like: AND / OR OR / / J L K L So after we push the AND at the deepest level up and merge it with the existing add, we get this result. OR(M) / / F H NOT AND(M) | / | G NOT OR(M) OR(M) | / / H J L K L Now let us push the and up and we will get the result like this: AND(M) / | OR(M) OR(M) OR(M) / / / / | / / | F H NOT NOT F H NOT J L F H NOT K L | | | | G H G G 5. The last step, convert the Multiple Expression back to the binary form. Note the final tree shall be left-inclined. The final expression tree shall be like this: AND / AND ( ) / | ( ) ( ) part1 | | OR part2 / OR NOT / | OR NOT H / | F H G part1: OR / OR L / OR K / OR NOT / | F H G part2: OR / OR L / OR J / OR NOT / | F H G
CNFConverter ()
convertToCNF (expr) → Expression
Expression expr
returns Expression
MultiAndExpression¶
extends: MultipleExpression
This helper class is mainly used for handling the CNF conversion.
MultiAndExpression (childlist)
List childlist
@Override
getStringExpression () → String
returns String
MultiOrExpression¶
extends: MultipleExpression
MultiOrExpression (childlist)
List childlist
@Override
getStringExpression () → String
returns String
MultipleExpression¶
extends: ASTNodeAccessImpl implements: Expression provides: MultiAndExpression, MultiOrExpression
This is a helper class that mainly used for handling the CNF conversion.
MultipleExpression (childlist)
List childlist
size () → int
returns int
getList () → List
returns List
getChild (index) → Expression
int index
returns Expression
removeChild (index) → Expression
int index
returns Expression
setChild (index, express)
int index
Expression express
getIndex (express) → int
Expression express
returns int
addChild (index, express)
int index
Expression express
getStringExpression () → String
returns String
@Override
toString () → String
returns String
util.deparser¶
AlterDeParser¶
extends: AbstractDeParser
AlterDeParser (buffer)
StringBuilder buffer
AlterSequenceDeParser¶
extends: AbstractDeParser
A class to de-parse (that is, transform from JSqlParser hierarchy into a string) a net.sf.jsqlparser.statement.alter.sequence.AlterSequence
AlterSequenceDeParser (buffer)
StringBuilder buffer | buffer the buffer that will be filled with the AlterSequence
AlterSessionDeParser¶
extends: AbstractDeParser
AlterSessionDeParser (buffer)
StringBuilder buffer
AlterViewDeParser¶
extends: AbstractDeParser
AlterViewDeParser (buffer)
StringBuilder buffer
AlterViewDeParser (buffer, selectVisitor)
StringBuilder buffer
SelectVisitor selectVisitor
CreateIndexDeParser¶
extends: AbstractDeParser
CreateIndexDeParser (buffer)
StringBuilder buffer
CreateSequenceDeParser¶
extends: AbstractDeParser
A class to de-parse (that is, transform from JSqlParser hierarchy into a string) a net.sf.jsqlparser.statement.create.sequence.CreateSequence
CreateSequenceDeParser (buffer)
StringBuilder buffer | buffer the buffer that will be filled with the CreatSequence
CreateSynonymDeparser¶
extends: AbstractDeParser
A class to de-parse (that is, transform from JSqlParser hierarchy into a string) a CreateSynonym
CreateSynonymDeparser (buffer)
StringBuilder buffer
CreateTableDeParser¶
extends: AbstractDeParser
CreateTableDeParser (buffer)
StringBuilder buffer
CreateTableDeParser (statementDeParser, buffer)
StatementDeParser statementDeParser
StringBuilder buffer
CreateViewDeParser¶
extends: AbstractDeParser
CreateViewDeParser (buffer)
StringBuilder buffer
CreateViewDeParser (buffer, selectVisitor)
StringBuilder buffer
SelectVisitor selectVisitor
DeclareStatementDeParser¶
extends: AbstractDeParser
DeclareStatementDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
DeleteDeParser¶
extends: AbstractDeParser
DeleteDeParser ()
DeleteDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
DropDeParser¶
extends: AbstractDeParser
DropDeParser (buffer)
StringBuilder buffer
ExecuteDeParser¶
extends: AbstractDeParser
ExecuteDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
ExpressionDeParser¶
extends: AbstractDeParser implements: ExpressionVisitor
ExpressionDeParser ()
ExpressionDeParser (selectVisitor, buffer)
SelectVisitor selectVisitor
StringBuilder buffer
visitOldOracleJoinBinaryExpression (expression, operator)
OldOracleJoinBinaryExpression expression
String operator
@Override
visit (selectBody)
Select selectBody
visit (trimFunction)
TrimFunction trimFunction
getSelectVisitor () → SelectVisitor
returns SelectVisitor
setSelectVisitor (visitor)
SelectVisitor visitor
@Override
visit (oracleNamedFunctionParameter)
OracleNamedFunctionParameter oracleNamedFunctionParameter
ExpressionListDeParser¶
extends: AbstractDeParser
ExpressionListDeParser (expressionVisitor, builder)
ExpressionVisitor expressionVisitor
StringBuilder builder
GrantDeParser¶
extends: AbstractDeParser
GrantDeParser (buffer)
StringBuilder buffer
GroupByDeParser¶
extends: AbstractDeParser
GroupByDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
InsertDeParser¶
extends: AbstractDeParser
InsertDeParser ()
InsertDeParser (expressionVisitor, selectVisitor, buffer)
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
getSelectVisitor () → SelectVisitor
returns SelectVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
setSelectVisitor (visitor)
SelectVisitor visitor
LimitDeparser¶
extends: AbstractDeParser
LimitDeparser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (expressionVisitor)
ExpressionVisitor expressionVisitor
MergeDeParser¶
extends: AbstractDeParser implements: MergeOperationVisitor
MergeDeParser (expressionDeParser, selectDeParser, buffer)
OrderByDeParser¶
extends: AbstractDeParser
OrderByDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
@Override
deParse (orderByElementList)
List orderByElementList
deParse (oracleSiblings, orderByElementList)
boolean oracleSiblings
List orderByElementList
deParseElement (orderBy)
OrderByElement orderBy
RefreshMaterializedViewStatementDeParser¶
extends: AbstractDeParser
RefreshMaterializedViewStatementDeParser (buffer)
StringBuilder buffer
ResetStatementDeParser¶
extends: AbstractDeParser
ResetStatementDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
SelectDeParser¶
extends: AbstractDeParser implements: SelectVisitor, SelectItemVisitor, FromItemVisitor, PivotVisitor
SelectDeParser ()
SelectDeParser (buffer)
StringBuilder buffer
SelectDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
visit (top)
Top top
visit (offset)
Offset offset
visit (fetch)
Fetch fetch
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
deparseLateralView (lateralView)
LateralView lateralView
SetStatementDeParser¶
extends: AbstractDeParser
SetStatementDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
ShowColumnsStatementDeParser¶
extends: AbstractDeParser
ShowColumnsStatementDeParser (buffer)
StringBuilder buffer
ShowIndexStatementDeParser¶
extends: AbstractDeParser
ShowIndexStatementDeParser (buffer)
StringBuilder buffer
ShowStatementDeParser¶
extends: AbstractDeParser
ShowStatementDeParser (buffer)
StringBuilder buffer
ShowTablesStatementDeparser¶
extends: AbstractDeParser
ShowTablesStatementDeparser (buffer)
StringBuilder buffer
StatementDeParser¶
extends: AbstractDeParser implements: StatementVisitor
StatementDeParser (buffer)
StringBuilder buffer
StatementDeParser (expressionDeParser, selectDeParser, buffer)
@Override
visit (materializedViewStatement)
RefreshMaterializedViewStatement materializedViewStatement
visit (analyzer)
Analyze analyzer
TableStatementDeParser¶
extends: AbstractDeParser implements: SelectVisitor
TableStatementDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
visit (offset)
Offset offset
UpdateDeParser¶
extends: AbstractDeParser implements: OrderByVisitor
UpdateDeParser ()
UpdateDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
setExpressionVisitor (visitor)
ExpressionVisitor visitor
UpsertDeParser¶
extends: AbstractDeParser
UpsertDeParser (expressionVisitor, selectVisitor, buffer)
getExpressionVisitor () → ExpressionVisitor
returns ExpressionVisitor
getSelectVisitor () → SelectVisitor
returns SelectVisitor
setExpressionVisitor (visitor)
ExpressionDeParser visitor
setSelectVisitor (visitor)
SelectDeParser visitor
UseStatementDeParser¶
extends: AbstractDeParser
UseStatementDeParser (buffer)
StringBuilder buffer
ValuesStatementDeParser¶
extends: AbstractDeParser
ValuesStatementDeParser (expressionVisitor, buffer)
ExpressionVisitor expressionVisitor
StringBuilder buffer
util.validation¶
ParseException¶
extends: ValidationException
wraps a JSQLParserException to add to the errors collected by validation
ParseException (message, cause)
String message
Throwable cause
ParseException (message)
String message
ParseException (cause)
Throwable cause
UnexpectedValidationException¶
extends: ValidationException
can be used on unexpected errors during validation
UnexpectedValidationException (message, cause)
String message
Throwable cause
UnexpectedValidationException (message)
String message
UnexpectedValidationException (cause)
Throwable cause
Validation¶
extends: Object
Parses the given statement list with ParseCapability and performs validation with configured ValidationCapability’s. Errors are are reported by calling #validate().
Validation (capabilities, statements)
Collection capabilities
String statements
Validation (featureConfiguration, capabilities, statements)
validate () → List
returns List | the errors - may be an empty list.
getFeatureConfiguration () → FeatureConfiguration
returns FeatureConfiguration
getCapabilities () → Collection
returns Collection
getStatements () → List
returns List
getErrors () → List
returns List
getParsedStatements () → Statements
returns Statements
validate (capabilities, statements) → List
Collection capabilities
String statements
returns List | a list of ValidationError’s
createValidationContext (config, capabilities) → ValidationContext
FeatureConfiguration config
Collection capabilities
returns ValidationContext | a ValidationContext of the given config and capabilities
toValidationErrors (statements, parsedStatement, errorMap) → List
validate (statement, context) → Map
Statement statement
ValidationContext context
returns Map | a map mapping the ValidationCapability to a set of `ValidationException`s
ValidationContext¶
extends: Object
ValidationContext ()
put (key, value) → ValidationContext
get (key, type) → T
getOptional (key, type) → T
reinit (reInit) → ValidationContext
boolean reInit
returns ValidationContext
setConfiguration (configuration) → ValidationContext
FeatureConfiguration configuration
returns ValidationContext
getConfiguration () → FeatureConfiguration
returns FeatureConfiguration
getAsBoolean (f) → boolean
Feature f
returns boolean
getAsString (f) → String
Feature f
returns String
getCapabilities () → Collection
returns Collection
setCapabilities (capabilities) → ValidationContext
Collection capabilities
returns ValidationContext
ValidationError¶
extends: Object
ValidationError (statements)
String statements
addError (error) → ValidationError
ValidationException error
returns ValidationError
addErrors (errors) → ValidationError
Collection errors
returns ValidationError
getErrors () → Set
returns Set | the set of ValidationException’s (no duplicates)
getCapability () → ValidationCapability
returns ValidationCapability | the ValidationCapability which produced this error
getStatements () → String
returns String | the statements (may be more than one) given for validation
setCapability (databaseType)
ValidationCapability databaseType
setParsedStatement (parsedStatement)
Statement parsedStatement
withCapability (databaseType) → ValidationError
ValidationCapability databaseType
returns ValidationError
withParsedStatement (parsedStatement) → ValidationError
Statement parsedStatement
returns ValidationError
@Override
toString () → String
returns String
ValidationException¶
extends: RuntimeException provides: DatabaseException, ParseException, UnexpectedValidationException
ValidationException (message, cause)
String message
Throwable cause
ValidationException (message)
String message
ValidationException (cause)
Throwable cause
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
@Override
toString () → String
returns String
ValidationUtil¶
extends: Object
map (list, fn) → List
List list
Function fn
returns List
getAlias (alias) → String
Alias alias
returns String
ContextKey¶
provides: AllowedTypesContext, FeatureContext, MetadataContext,
the context key - a ValidationCapability should define constants of expected context - values needed for validation.
ValidationCapability¶
provides: AllowedTypesValidation, DatabaseMetaDataValidation, FeatureSetValidation,
getName () → String
returns String | a name of this ValidationCapability
validate (context, errorConsumer)
Validate and add ValidationException’s to given consumer.
ValidationContext context
Consumer errorConsumer
toError (message) → ValidationException
String message
returns ValidationException
toError (message, th) → ValidationException
Validator¶
provides: AbstractValidator,
isValid () → boolean
returns boolean |
true, all ValidationCapability’s have no errorsisValid (capabilities) → boolean
ValidationCapability capabilities
returns boolean |
true, if the given ValidationCapability’s have no errors. false otherwise.getValidationErrors () → Map
returns Map | the ValidationCapability’s requested mapped to a set of error-messages
getValidationErrors (capabilities) → Map
ValidationCapability capabilities
returns Map | the filtered view of requested ValidationCapability’s mapped to a set of error-messages
getValidationErrors (capabilities) → Map
Collection capabilities
returns Map | the filtered view of requested ValidationCapability’s mapped to a set of error-messages
setContext (ctx)
validate (statement)
validates given statement.
S statement
util.validation.allowedtypes¶
AllowedTypesContext¶
[allowed_types, argument, allow_null]
AllowedTypesValidation¶
extends: Object implements: ValidationCapability
AllowedTypesValidation ()
@Override
getName () → String
returns String
util.validation.feature¶
DatabaseType¶
[ANSI_SQL, ORACLE, MYSQL, SQLSERVER, MARIADB, POSTGRESQL, H2]
The DatabaseType is named like the identifier used within the jdbc-connection-url (upper case), this may change in future, therefore use #get(String) to retrieve the DatabaseType.
FeatureContext¶
[feature]
H2Version¶
[V_1_4_200]
Please add Features supported and place a link to public documentation
MariaDbVersion¶
[V10_5_4, ORACLE_MODE]
Please add Features supported and place a link to public documentation
MySqlVersion¶
[V8_0]
Please add Features supported and place a link to public documentation
OracleVersion¶
[V19C]
Please add Features supported and place a link to public documentation
PostgresqlVersion¶
[V10, V11, V12, V13, V14]
Please add Features supported and place a link to public documentation
SQLVersion¶
[SQL1986, SQL1989, SQL1992, SQL1999, SQL2003, SQL2006, SQL2008, SQL2011, SQL2016, SQL2019]
Enum containing the ANSI SQL Standard Versions - features are not guaranteed to be complete, just add them if you are sure they are part of the standard :)
SqlServerVersion¶
[V2019]
Please add Features supported and place a link to public documentation
FeaturesAllowed¶
extends: Object implements: FeatureSetValidation, ModifyableFeatureSet
Privileges/Features allowed
FeaturesAllowed (features)
Feature features
FeaturesAllowed (name, features)
String name
Feature features
@Override
remove (featureSets) → FeaturesAllowed
FeatureSet featureSets
returns FeaturesAllowed |
this@Override
copy () → FeaturesAllowed
returns FeaturesAllowed | returns a modifiable copy of this FeaturesAllowed object
@Override
unmodifyable () → FeaturesAllowed
makes the inner Feature-set unmodifiable
returns FeaturesAllowed |
this@Override
getMessage (feature) → ValidationException
Feature feature
returns ValidationException |
featureName + " not allowed."@Override
getName () → String
returns String
@Override
getFeatures () → Set
returns Set
FeatureSetValidation¶
implements: ValidationCapability, FeatureSet provides: DatabaseType, FeaturesAllowed, Version,
@Override
getFeatures () → Set
returns Set | all supported Feature’s
getMessage (feature) → ValidationException
Feature feature
returns ValidationException | the default message if not contained in the feature set
@Override
getName () → String
returns String
Version¶
implements: FeatureSetValidation provides: DatabaseType, H2Version, MariaDbVersion, MySqlVersion, OracleVersion, PostgresqlVersion, SQLVersion, SqlServerVersion,
getVersionString () → String
returns String | the version string
@Override
getMessage (feature) → ValidationException
Feature feature
returns ValidationException |
featureName + " not supported."util.validation.metadata¶
MetadataContext¶
[named, exists]
NamedObject¶
[database, schema, table, view, column, index, constraint, uniqueConstraint, sequence, synonym, procedure, user, role, trigger, alias]
NamesLookup¶
[UPPERCASE, LOWERCASE, NO_TRANSFORMATION]
A strategy for transformation of database-names before lookup in database-catalog-metadata
AbstractDatabaseMetaDataCapability¶
extends: Object implements: DatabaseMetaDataValidation provides: JdbcDatabaseMetaDataCapability
Adapter class always throwing UnsupportedOperationException for all exists - methods.
AbstractDatabaseMetaDataCapability (connection, namesLookup)
With caching enabled - see #isCacheResults()
Connection connection
UnaryOperator namesLookup | namesLookup - see NamesLookup
AbstractDatabaseMetaDataCapability (connection, namesLookup, cacheResults)
Connection connection
UnaryOperator namesLookup | namesLookup - see NamesLookup
boolean cacheResults | cacheResults - whether the results should be cached for later lookups
getNamesLookup () → UnaryOperator
returns UnaryOperator
getConnection () → Connection
returns Connection
isCacheResults () → boolean
returns boolean
clearCache () → AbstractDatabaseMetaDataCapability
Named namedBiPredicate fnreturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanMap resultsNamed namereturns booleanNamed namereturns UnsupportedOperationException
DatabaseException¶
extends: ValidationException
database-errors wrapping a SQLException or PersistenceException
DatabaseException (message, cause)
String message
Throwable cause
DatabaseException (message)
String message
DatabaseException (cause)
Throwable cause
JdbcDatabaseMetaDataCapability¶
extends: AbstractDatabaseMetaDataCapability
Validates against schema by jdbc-metadata in a very basic way with simple caching and comparing names by String#equalsIgnoreCase(String)
JdbcDatabaseMetaDataCapability (connection, namesLookup)
Connection connection
UnaryOperator namesLookup | namesLookup - see NamesLookup
JdbcDatabaseMetaDataCapability (connection, namesLookup, cacheResults)
Connection connection
UnaryOperator namesLookup | namesLookup - see NamesLookup
boolean cacheResults | cacheResults - whether the results should be cached for later lookups
Named¶
extends: Object
Named (namedObject, fqn)
NamedObject namedObject
String fqn
getFqn () → String
returns String
getAlias () → String
returns String
getNamedObject () → NamedObject
returns NamedObject
getParents () → List
returns List
getFqnLookup () → String
returns String | the fqn transformed for catalog-lookup (uppercase/lowercase/.. depends on database)
getAliasLookup () → String
returns String | the alias transformed for catalog-lookup (uppercase/lowercase/.. depends on database)
@Override
hashCode () → int
returns int
@Override
equals (obj) → boolean
Object obj
returns boolean
@Override
toString () → String
returns String
DatabaseMetaDataValidation¶
implements: ValidationCapability provides: AbstractDatabaseMetaDataCapability,
exists (named) → boolean
Named named
returns boolean |
true, if the object exists, false otherwise.getErrorMessage (named, checkForExists) → ValidationException
getUnexpectedErrorMessage (named, cause) → ValidationException
@Override
getName () → String
returns String
util.validation.validator¶
AbstractValidator¶
extends: Object implements: Validator provides: AlterSequenceValidator, AlterSessionValidator, AlterValidator, AlterViewValidator, AnalyzeValidator, CreateIndexValidator, CreateSequenceValidator, CreateSynonymValidator, CreateTableValidator, CreateViewValidator, DeclareStatementValidator, DeleteValidator, DropValidator, ExecuteValidator, ExpressionValidator, GrantValidator, GroupByValidator, InsertValidator, LimitValidator, MergeValidator, OrderByValidator, RefreshMaterializedViewStatementValidator, ResetStatementValidator, SelectValidator, SetStatementValidator, ShowColumnsStatementValidator, ShowIndexStatementValidator, ShowStatementValidator, ShowTablesStatementValidator, StatementValidator, TableStatementValidator, UpdateValidator, UpsertValidator, UseStatementValidator, ValuesStatementValidator
A abstract base for a Validation
AbstractValidator ()
getValidator (type) → T
Class type
returns T
returns Consumerreturns ValidationContextboolean reInitreturns ValidationContextadds an error for this {@link ValidationCapability}
ValidationCapability capabilityValidationException errorreturns void@Override
getValidationErrors () → Map
returns Map
getCapabilities () → Collection
returns Collection
E elementConsumer elementConsumerreturns voidList elementListSupplier validatorSupplierBiConsumer elementConsumerreturns voidExpression expressionreturns voidExpression expressionreturns voidList expressionsreturns voidFromItem fromItemsreturns voidList fromItemsreturns voidList orderByElementsreturns voidFromItem fromItemreturns voidFromItem fromItemreturns voidIterates through all {@link ValidationCapability} and validates the feature with
{@link #validateFeature(ValidationCapability, Feature)}
<ul> <li>the name with {@link #validateName(ValidationCapability, NamedObject, String)}</li> <li>the feature with {@link #validateFeature(ValidationCapability, Feature)}</li> </ul>
Feature featureNamedObject namedObjectString fqn | fqn - fully qualified name of named objectreturns voidIterates through all {@link ValidationCapability} and validates
<ul> <li>the name with {@link #validateName(ValidationCapability, NamedObject, String)}</li> <li>the feature with {@link #validateFeature(ValidationCapability, Feature)}</li> </ul>
Feature featureNamedObject namedObjectString fqn | fqn - fully qualified name of named objectString aliasreturns voidIterates through all {@link ValidationCapability} and validates for the name with
{@link #validateName(ValidationCapability, NamedObject, String)}
NamedObject namedObjectString fqn | fqn - fully qualified name of named objectreturns voidIterates through all {@link ValidationCapability} and validates for the name with
{@link #validateName(ValidationCapability, NamedObject, String)}
and condition is <code>true</code>
ValidationCapability capabilityboolean conditionFeature featurereturns voidvalidates for the feature if given elements is not empty - see
{@link #isNotEmpty(Collection)}
ValidationCapability capabilityList elementsFeature featurereturns voidValidates for the feature if given element is not <code>null</code>
ValidationCapability capabilityObject elementFeature featurereturns voidValidates if given {@link ValidationCapability} is a {@link FeatureSetValidation}
ValidationCapability capabilityFeature featurereturns voidValidates if given {@link ValidationCapability} is a {@link DatabaseMetaDataValidation}
ValidationCapability capabilityNamedObject namedObjectString fqn | fqn - fully qualified name of named objectString aliasreturns voidValidationCapability capabilityNamedObject namedObjectString fqn | fqn - fully qualified name of named objectreturns voidValidates if given {@link ValidationCapability} is a {@link DatabaseMetaDataValidation}
ValidationCapability capabilityNamedObject namedObjectString fqn | fqn - fully qualified name of named objectString aliasboolean exists | exists -true, check for existence,false, check for non-existenceNamedObject parentsreturns voidValidationCapability capabilityNamedObject namedObjectString fqn | fqn - fully qualified name of named objectboolean existsNamedObject parentsreturns voidValidationCapability capabilityString namereturns voidValidationCapability capabilityString nameString aliasreturns voidValidationCapability capabilityList columnNamesNamedObject parentsreturns voidValidationCapability capabilityList columnNamesboolean existsNamedObject parentsreturns voidValidationCapability capabilityNamedObject namedObjectString nameString aliasNamedObject parentsreturns voidValidationCapability capabilityNamedObject namedObjectString nameNamedObject parentsreturns voidValidationCapability capabilityNamedObject namedObjectString nameString aliasboolean existsNamedObject parentsreturns voidCollection creturns booleanString creturns boolean
AlterSequenceValidator¶
extends: AbstractValidator
AlterSequenceValidator ()
AlterSessionValidator¶
extends: AbstractValidator
AlterSessionValidator ()
AlterValidator¶
extends: AbstractValidator
AlterValidator ()
validate (alter, e)
Alter alter
AlterViewValidator¶
extends: AbstractValidator
AlterViewValidator ()
AnalyzeValidator¶
extends: AbstractValidator
AnalyzeValidator ()
CreateIndexValidator¶
extends: AbstractValidator
CreateIndexValidator ()
CreateSequenceValidator¶
extends: AbstractValidator
CreateSequenceValidator ()
CreateSynonymValidator¶
extends: AbstractValidator
CreateSynonymValidator ()
CreateTableValidator¶
extends: AbstractValidator
CreateTableValidator ()
CreateViewValidator¶
extends: AbstractValidator
CreateViewValidator ()
DeclareStatementValidator¶
extends: AbstractValidator
DeclareStatementValidator ()
DeleteValidator¶
extends: AbstractValidator
DeleteValidator ()
DropValidator¶
extends: AbstractValidator
DropValidator ()
ExecuteValidator¶
extends: AbstractValidator
ExecuteValidator ()
ExpressionValidator¶
extends: AbstractValidator implements: ExpressionVisitor
ExpressionValidator ()
visitOldOracleJoinBinaryExpression (expression, operator)
OldOracleJoinBinaryExpression expression
String operator
@Override
visit (selectBody)
ParenthesedSelect selectBody
@Override
visit (oracleNamedFunctionParameter)
OracleNamedFunctionParameter oracleNamedFunctionParameter
GrantValidator¶
extends: AbstractValidator
GrantValidator ()
GroupByValidator¶
extends: AbstractValidator implements: GroupByVisitor
GroupByValidator ()
InsertValidator¶
extends: AbstractValidator
InsertValidator ()
LimitValidator¶
extends: AbstractValidator
LimitValidator ()
MergeValidator¶
extends: AbstractValidator implements: MergeOperationVisitor
MergeValidator ()
OrderByValidator¶
extends: AbstractValidator implements: OrderByVisitor
OrderByValidator ()
RefreshMaterializedViewStatementValidator¶
extends: AbstractValidator
RefreshMaterializedViewStatementValidator ()
ReplaceValidator¶
extends: UpsertValidator
ReplaceValidator ()
ResetStatementValidator¶
extends: AbstractValidator
ResetStatementValidator ()
SelectValidator¶
extends: AbstractValidator implements: SelectVisitor, SelectItemVisitor, FromItemVisitor, PivotVisitor
SelectValidator ()
validateOffset (offset)
Offset offset
validateFetch (fetch)
Fetch fetch
validateOptionalJoins (joins)
List joins
validateOptionalJoin (join)
Join join
SetStatementValidator¶
extends: AbstractValidator
SetStatementValidator ()
ShowColumnsStatementValidator¶
extends: AbstractValidator
ShowColumnsStatementValidator ()
ShowIndexStatementValidator¶
extends: AbstractValidator
ShowIndexStatementValidator ()
ShowStatementValidator¶
extends: AbstractValidator
ShowStatementValidator ()
ShowTablesStatementValidator¶
extends: AbstractValidator
ShowTablesStatementValidator ()
StatementValidator¶
extends: AbstractValidator implements: StatementVisitor
StatementValidator ()
visit (renameTableStatement)
RenameTableStatement renameTableStatement
TableStatementValidator¶
extends: AbstractValidator
TableStatementValidator ()
UpdateValidator¶
extends: AbstractValidator
UpdateValidator ()
UpsertValidator¶
extends: AbstractValidator provides: ReplaceValidator
UpsertValidator ()
UseStatementValidator¶
extends: AbstractValidator
UseStatementValidator ()
ValuesStatementValidator¶
extends: AbstractValidator
ValuesStatementValidator ()