API 1.1-SNAPSHOT¶

Base Package: ai.starlake.jsqltranspiler

Base¶

Dialect¶

[GOOGLE_BIG_QUERY, DATABRICKS, SNOWFLAKE, AMAZON_REDSHIFT, ANY, DUCK_DB]

The enum Dialect.

CatalogNotFoundException¶

extends: RuntimeException

CatalogNotFoundException (catalogName, cause)

String catalogName

Throwable cause

CatalogNotFoundException (catalogName)

String catalogName

getCatalogName () → String

returns String

ColumnNotFoundException¶

extends: RuntimeException

ColumnNotFoundException (columnName, tableNames, cause)

String columnName
String> tableNames
Throwable cause

ColumnNotFoundException (columnName, tableNames)

String columnName

String> tableNames

getColumnName () → String

returns String

getTableNames () → String>

returns String>

JSQLColumResolver¶

extends: Object implements: JdbcResultSetMetaData>, JdbcResultSetMetaData> provides: JSQLResolver

A class for resolving the actual columns returned by a SELECT statement. Depends on virtual or physical Database Metadata holding the schema and table information.

JSQLColumResolver (metaData)

Instantiates a new JSQLColumnResolver for the provided Database Metadata

JdbcMetaData metaData

JSQLColumResolver (currentCatalogName, currentSchemaName, metaDataDefinition)

Instantiates a new JSQLColumnResolver for the provided simplified Metadata, presented as an Array of Tables and Column Names only.

String currentCatalogName
String currentSchemaName
String[][] metaDataDefinition

JSQLColumResolver (metaDataDefinition)

Instantiates a new JSQLColumnResolver for the provided simplified Metadata with an empty CURRENT_SCHEMA and CURRENT_CATALOG

String[][] metaDataDefinition

@SuppressWarnings

getResultSetMetaData (select) → JdbcResultSetMetaData

Resolves the actual columns returned by a SELECT statement for a given CURRENT_CATALOG and CURRENT_SCHEMA and wraps this information into ResultSetMetaData.

Select select

returns JdbcResultSetMetaData

@SuppressWarnings

getResultSetMetaData (sqlStr, metaData) → JdbcResultSetMetaData

Resolves the actual columns returned by a SELECT statement for a given CURRENT_CATALOG and CURRENT_SCHEMA and wraps this information into ResultSetMetaData.

String sqlStr
JdbcMetaData metaData
returns JdbcResultSetMetaData

getResultSetMetaData (sqlStr, metaDataDefinition, currentCatalogName, currentSchemaName) → JdbcResultSetMetaData

Resolves the actual columns returned by a SELECT statement for a given CURRENT_CATALOG and CURRENT_SCHEMA and wraps this information into ResultSetMetaData.

String sqlStr
String[][] metaDataDefinition
String currentCatalogName
String currentSchemaName
returns JdbcResultSetMetaData

getResultSetMetaData (sqlStr, metaDataDefinition) → JdbcResultSetMetaData

Resolves the actual columns returned by a SELECT statement for an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA and wraps this information into ResultSetMetaData.

String sqlStr
String[][] metaDataDefinition
returns JdbcResultSetMetaData

getResultSetMetaData (sqlStr) → JdbcResultSetMetaData

Resolves the actual columns returned by a SELECT statement for an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA and wraps this information into ResultSetMetaData.

String sqlStr

returns JdbcResultSetMetaData

getResolvedStatementText (sqlStr) → String

Gets the rewritten statement text with any AllColumns “*” or AllTableColumns “t.*” expression resolved into the actual columns

String sqlStr

returns String

getLineage (treeBuilderClass, sqlStr, connection) → T

TreeBuilder treeBuilderClass
String sqlStr
Connection connection
returns T

getLineage (treeBuilderClass, sqlStr, metaDataDefinition, currentCatalogName, currentSchemaName) → T

TreeBuilder treeBuilderClass
String sqlStr
String[][] metaDataDefinition
String currentCatalogName
String currentSchemaName
returns T

getLineage (treeBuilderClass, select) → T

TreeBuilder treeBuilderClass
Select select
returns T

getLineage (treeBuilderClass, sqlStr) → T

TreeBuilder treeBuilderClass
String sqlStr
returns T

getQualifiedTableName (catalogName, schemaName, tableName) → String

String catalogName
String schemaName
String tableName
returns String

getQualifiedColumnName (catalogName, schemaName, tableName, columName) → String

String catalogName
String schemaName
String tableName
String columName
returns String

@Override

visit (table, context) → JdbcResultSetMetaData

Table table
S context
returns JdbcResultSetMetaData

@Override

visit (tableName)

Table tableName

visit (parenthesedSelect, context) → JdbcResultSetMetaData

ParenthesedSelect parenthesedSelect
JdbcMetaData context
returns JdbcResultSetMetaData

@Override

visit (parenthesedSelect, context) → JdbcResultSetMetaData

ParenthesedSelect parenthesedSelect
S context
returns JdbcResultSetMetaData

@Override

visit (parenthesedSelect)

ParenthesedSelect parenthesedSelect

@SuppressWarnings

visit (select, metaData) → JdbcResultSetMetaData

PlainSelect select
JdbcMetaData metaData
returns JdbcResultSetMetaData

@Override

visit (select, context) → JdbcResultSetMetaData

PlainSelect select
S context
returns JdbcResultSetMetaData

@Override

visit (plainSelect)

PlainSelect plainSelect

@Override

visit (fromQuery, s) → JdbcResultSetMetaData

FromQuery fromQuery
S s
returns JdbcResultSetMetaData

visit (select) → JdbcResultSetMetaData

Select select

returns JdbcResultSetMetaData

@Override

visit (setOperationList, context) → JdbcResultSetMetaData

SetOperationList setOperationList
S context
returns JdbcResultSetMetaData

@Override

visit (setOpList)

SetOperationList setOpList

@Override

visit (withItem, context) → JdbcResultSetMetaData

WithItem withItem
S context
returns JdbcResultSetMetaData

@Override

visit (withItem)

WithItem withItem

@Override

visit (values, context) → JdbcResultSetMetaData

Values values
S context
returns JdbcResultSetMetaData

@Override

visit (values)

Values values

@Override

visit (lateralSubSelect, context) → JdbcResultSetMetaData

LateralSubSelect lateralSubSelect
S context
returns JdbcResultSetMetaData

@Override

visit (lateralSubSelect)

LateralSubSelect lateralSubSelect

@Override

visit (tableFunction, context) → JdbcResultSetMetaData

TableFunction tableFunction
S context
returns JdbcResultSetMetaData

@Override

visit (tableFunction)

TableFunction tableFunction

@Override

visit (parenthesedFromItem, context) → JdbcResultSetMetaData

ParenthesedFromItem parenthesedFromItem
S context
returns JdbcResultSetMetaData

@Override

visit (parenthesedFromItem)

ParenthesedFromItem parenthesedFromItem

@Override

visit (tableStatement, context) → JdbcResultSetMetaData

TableStatement tableStatement
S context
returns JdbcResultSetMetaData

@Override

visit (tableStatement)

TableStatement tableStatement

getErrorMode () → ErrorMode

Gets the error mode.

returns ErrorMode

setErrorMode (errorMode) → JSQLColumResolver

Sets the error mode.

ErrorMode errorMode

returns JSQLColumResolver

addUnresolved (unquotedQualifiedName)

Add the name of an unresolvable column or table to the list.

String unquotedQualifiedName

getUnresolvedObjects () → String>

Gets unresolved column or table names, not existing in the schema

returns String>

isCommentFlag () → boolean

returns boolean

setCommentFlag (commentFlag)

boolean commentFlag

JSQLDeleteTranspiler¶

extends: DeleteDeParser

ExpressionVisitor expressionVisitor

StringBuilder builder

JSQLExpressionColumnResolver¶

extends: JdbcColumn>> implements: JdbcColumn>>

JSQLExpressionColumnResolver (columResolver)

JSQLColumResolver columResolver

JdbcMetaData metaData

Column column

returns JdbcColumn

Expression expression

S context

returns JdbcColumn>

Expression expression

S context

Expression> subExpressions

returns JdbcColumn>

@Override

visit (function, context) → JdbcColumn>

Function function
S context
returns JdbcColumn>

@Override

visit (function, context) → JdbcColumn>

TranscodingFunction function
S context
returns JdbcColumn>

@Override

visit (function, context) → JdbcColumn>

JsonAggregateFunction function
S context
returns JdbcColumn>

@Override

visit (function, context) → JdbcColumn>

JsonFunction function
S context
returns JdbcColumn>

@Override

visit (function, context) → JdbcColumn>

AnalyticExpression function
S context
returns JdbcColumn>

@SuppressWarnings,| @Override

visit (allTableColumns, context) → JdbcColumn>

AllTableColumns allTableColumns
S context
returns JdbcColumn>

@SuppressWarnings,| @Override

visit (allColumns, context) → JdbcColumn>

AllColumns allColumns
S context
returns JdbcColumn>

@Override

visit (column, context) → JdbcColumn>

Column column
S context
returns JdbcColumn>

@Override

visit (select, context) → JdbcColumn>

ParenthesedSelect select
S context
returns JdbcColumn>

@Override

visit (select, context) → JdbcColumn>

Select select
S context
returns JdbcColumn>

@Override

visit (plainSelect, context) → JdbcColumn>

PlainSelect plainSelect
S context
returns JdbcColumn>

@Override

visit (setOperationList, context) → JdbcColumn>

SetOperationList setOperationList
S context
returns JdbcColumn>

@Override

visit (withItem, context) → JdbcColumn>

WithItem withItem
S context
returns JdbcColumn>

@Override

visit (values, context) → JdbcColumn>

Values values
S context
returns JdbcColumn>

@Override

visit (lateralSubSelect, context) → JdbcColumn>

LateralSubSelect lateralSubSelect
S context
returns JdbcColumn>

@Override

visit (tableStatement, context) → JdbcColumn>

TableStatement tableStatement
S context
returns JdbcColumn>

clearFunctions ()

getFunctions () → Expression>

returns Expression>

JSQLExpressionTranspiler¶

extends: ExpressionDeParser provides: BigQueryExpressionTranspiler, RedshiftExpressionTranspiler

The type Expression transpiler.

JSQLExpressionTranspiler (deParser, builder)

SelectDeParser deParser

StringBuilder builder

isDatePart (expression, dialect) → boolean

Expression expression
Dialect dialect
returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

Expression expression

returns boolean

isDateTimePart (expression, dialect) → boolean

Expression expression
Dialect dialect
returns boolean

toDateTimePart (expression, dialect) → Expression

Expression expression
Dialect dialect
returns Expression

hasTimeZoneInfo (timestampStr) → boolean

String timestampStr

returns boolean

hasTimeZoneInfo (timestamp) → boolean

Expression timestamp

returns boolean

rewriteDateLiteral (p, dateTimeType) → Expression

Expression p
DateTime dateTimeType
returns Expression

ExpressionList parameters

int index

returns boolean

@SuppressWarnings,| @Override

visit (function, params) → StringBuilder

Function function
S params
returns StringBuilder

@Override

visit (allColumns, context) → StringBuilder

AllColumns allColumns
S context
returns StringBuilder

@SuppressWarnings,| @Override

visit (function, context) → StringBuilder

AnalyticExpression function
S context
returns StringBuilder

ExpressionList parameters

returns Expression

Function function

ExpressionList parameters

returns Expression

ExpressionList parameters

returns Expression

ExpressionList parameters

returns Expression

ExpressionList parameters

returns Expression

Function function

ExpressionList parameters

returns void

Function function

ExpressionList parameters

returns void

Function function

ExpressionList parameters

DateTime dateTimeType

returns Expression

StringValue formatStringValue

returns StringValue

Function function

ExpressionList parameters

returns void

Function function

ExpressionList parameters

DateTime dateTimeType

returns void

Function function

ExpressionList parameters

DateTime dateTimeType

returns Expression

Function function

ExpressionList parameters

returns void

Function function

ExpressionList parameters

DateTime dateTimeType

returns void

Function function

ExpressionList parameters

returns void

Function function

ExpressionList parameters

returns Expression

ExpressionList parameters

returns Expression

Function function

ExpressionList parameters

returns Expression

ExpressionList parameters

returns Expression

@Override

visit (extractExpression, context) → StringBuilder

ExtractExpression extractExpression
S context
returns StringBuilder

@Override

visit (stringValue, context) → StringBuilder

StringValue stringValue
S context
returns StringBuilder

@Override

visit (hexValue, context) → StringBuilder

HexValue hexValue
S context
returns StringBuilder

convertUnicode (input) → String

String input

returns String

@Override

visit (castExpression, context) → StringBuilder

CastExpression castExpression
S context
returns StringBuilder

@Override

visit (structType, context) → StringBuilder

StructType structType
S context
returns StringBuilder

visit (jsonFunction, context) → StringBuilder

JsonFunction jsonFunction
S context
returns StringBuilder

rewriteType (colDataType) → ColDataType

ColDataType colDataType

returns ColDataType

warning (s)

String s

convertByteStringToUnicode (byteString) → String

String byteString

returns String

Date date

String pattern

String tzID

returns String

castDateTime (expression) → Expression

String expression

returns Expression

castDateTime (expression) → Expression

Expression expression

returns Expression

@SuppressWarnings

castDateTime (expression) → Expression

DateTimeLiteralExpression expression

returns Expression

@SuppressWarnings

castDateTime (expression) → Expression

CastExpression expression

returns Expression

@SuppressWarnings

castDateTime (expression) → Expression

StringValue expression

returns Expression

castInterval (expression) → Expression

String expression

returns Expression

castInterval (e1, e2, dialect) → Expression

Expression e1
Expression e2
Dialect dialect
returns Expression

castInterval (expression) → Expression

Expression expression

returns Expression

castInterval (expression) → Expression

StringValue expression

returns Expression

castInterval (expression) → Expression

CastExpression expression

returns Expression

castInterval (expression) → Expression

IntervalExpression expression

returns Expression

@Override

visit (expression, context) → StringBuilder

TimeKeyExpression expression
S context
returns StringBuilder

@Override

visit (likeExpression, context) → StringBuilder

LikeExpression likeExpression
S context
returns StringBuilder

@Override

visit (function, context) → StringBuilder

TranscodingFunction function
S context
returns StringBuilder

isEmpty (collection) → boolean

Collection collection

returns boolean

hasParameters (function) → boolean

Function function

returns boolean

@Override

visit (column, context) → StringBuilder

Column column
S context
returns StringBuilder

@Override

visit (expressionList, context) → StringBuilder

ExpressionList expressionList
S context
returns StringBuilder

@Override

visit (e, context) → StringBuilder

JsonExpression e
S context
returns StringBuilder

visit (arrayConstructor, context) → StringBuilder

ArrayConstructor arrayConstructor
S context
returns StringBuilder

JSQLFromQueryTranspiler¶

extends: Object implements: PlainSelect>, PlainSelect>

JSQLFromQueryTranspiler ()

@Override

visit (fromQuery, plainSelect) → PlainSelect

FromQuery fromQuery
PlainSelect plainSelect
returns PlainSelect

@Override

visit (aggregatePipeOperator, plainSelect) → PlainSelect

AggregatePipeOperator aggregatePipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (asPipeOperator, plainSelect) → PlainSelect

AsPipeOperator asPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (callPipeOperator, plainSelect) → PlainSelect

CallPipeOperator callPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (dropPipeOperator, plainSelect) → PlainSelect

DropPipeOperator dropPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (extendPipeOperator, plainSelect) → PlainSelect

ExtendPipeOperator extendPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (joinPipeOperator, plainSelect) → PlainSelect

JoinPipeOperator joinPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (limitPipeOperator, plainSelect) → PlainSelect

LimitPipeOperator limitPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (orderByPipeOperator, plainSelect) → PlainSelect

OrderByPipeOperator orderByPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (pivotPipeOperator, plainSelect) → PlainSelect

PivotPipeOperator pivotPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (renamePipeOperator, plainSelect) → PlainSelect

RenamePipeOperator renamePipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (selectPipeOperator, plainSelect) → PlainSelect

SelectPipeOperator selectPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (setPipeOperator, plainSelect) → PlainSelect

SetPipeOperator setPipeOperator
PlainSelect plainSelect
returns PlainSelect

AllColumns allColumns

SetPipeOperator setPipeOperator

returns void

AllColumns allColumns

DropPipeOperator setPipeOperator

returns void

@Override

visit (tableSamplePipeOperator, plainSelect) → PlainSelect

TableSamplePipeOperator tableSamplePipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (setOperationPipeOperator, plainSelect) → PlainSelect

SetOperationPipeOperator setOperationPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (unPivotPipeOperator, plainSelect) → PlainSelect

UnPivotPipeOperator unPivotPipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (wherePipeOperator, plainSelect) → PlainSelect

WherePipeOperator wherePipeOperator
PlainSelect plainSelect
returns PlainSelect

@Override

visit (windowPipeOperator, plainSelect) → PlainSelect

WindowPipeOperator windowPipeOperator
PlainSelect plainSelect
returns PlainSelect

JSQLInsertTranspiler¶

extends: InsertDeParser

ExpressionVisitor expressionVisitor

SelectVisitor selectVisitor

StringBuilder builder

JSQLMergeTranspiler¶

extends: MergeDeParser

JSQLMergeTranspiler (expressionDeParser, selectDeParser, buffer)

ExpressionDeParser expressionDeParser
SelectDeParser selectDeParser
StringBuilder buffer

JSQLResolver¶

extends: JSQLColumResolver

JSQLResolver (metaData)

JdbcMetaData metaData

JSQLResolver (currentCatalogName, currentSchemaName, metaDataDefinition)

String currentCatalogName
String currentSchemaName
String[][] metaDataDefinition

JSQLResolver (metaDataDefinition)

String[][] metaDataDefinition

@Override

visit (withItem, context) → JdbcResultSetMetaData

WithItem withItem
S context
returns JdbcResultSetMetaData

@Override

visit (select, metaData) → JdbcResultSetMetaData

PlainSelect select
JdbcMetaData metaData
returns JdbcResultSetMetaData

getWhereColumns () → JdbcColumn>

returns JdbcColumn>

getFlattendedWhereColumns () → JdbcColumn>

returns JdbcColumn>

setWhereColumns (whereColumns) → JSQLResolver

JdbcColumn> whereColumns

returns JSQLResolver

getWithColumns () → JdbcColumn>

returns JdbcColumn>

getSelectColumns () → JdbcColumn>

returns JdbcColumn>

getDeleteColumns () → JdbcColumn>

returns JdbcColumn>

getUpdateColumns () → JdbcColumn>

returns JdbcColumn>

getInsertColumns () → JdbcColumn>

returns JdbcColumn>

getGroupByColumns () → JdbcColumn>

returns JdbcColumn>

getHavingColumns () → JdbcColumn>

returns JdbcColumn>

getJoinedOnColumns () → JdbcColumn>

returns JdbcColumn>

getFlattenedJoinedOnColumns () → JdbcColumn>

returns JdbcColumn>

getOrderByColumns () → JdbcColumn>

returns JdbcColumn>

getFunctions () → Expression>

returns Expression>

getFlatFunctionNames () → String>

returns String>

flatten (columns) → JdbcColumn>

JdbcColumn> columns

returns JdbcColumn>

resolve (st) → JdbcColumn>

Resolves all the columns used at any clause of a SELECT, INSERT, UPDATE or DELETE statement for an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA.

Statement st

returns JdbcColumn>

resolve (sqlStr) → JdbcColumn>

Resolves all the columns used at any clause of a SELECT statement for an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA.

String sqlStr

returns JdbcColumn>

JSQLSelectTranspiler¶

extends: SelectDeParser provides: BigQuerySelectTranspiler, DatabricksSelectTranspiler, RedshiftSelectTranspiler, SnowflakeSelectTranspiler

Instantiates a new transpiler. | JSQLExpressionTranspiler expressionTranspiler

StringBuilder resultBuilder

JSQLSelectTranspiler (expressionDeparserClass, builder)

ExpressionDeParser> expressionDeparserClass

StringBuilder builder

getResultBuilder () → StringBuilder

Gets result builder.

returns StringBuilder

@Override

visit (top)

Top top

@Override

visit (tableFunction, params) → StringBuilder

TableFunction tableFunction
S params
returns StringBuilder

visit (plainSelect, params) → StringBuilder

PlainSelect plainSelect
S params
returns StringBuilder

@SuppressWarnings

visit (select, params) → StringBuilder

ParenthesedSelect select
S params
returns StringBuilder

@Override

visit (table, params) → StringBuilder

Table table
S params
returns StringBuilder

@Override

visit (selectItem, context) → StringBuilder

SelectItem selectItem
S context
returns StringBuilder

@Override

visit (fromQuery, context) → StringBuilder

FromQuery fromQuery
S context
returns StringBuilder

visit (selectPipeOperator, select) → PlainSelect

SelectPipeOperator selectPipeOperator
PlainSelect select
returns PlainSelect

JSQLTranspiler¶

extends: StatementDeParser provides: BigQueryTranspiler, DatabricksTranspiler, RedshiftTranspiler, SnowflakeTranspiler

The type JSQLTranspiler.

JSQLSelectTranspiler> selectTranspilerClass

JSQLExpressionTranspiler> expressionTranspilerClass

JSQLTranspiler (parameters)

Object> parameters

JSQLTranspiler ()

@SuppressWarnings

transpileQuery (qryStr, dialect, parameters, executorService, consumer) → String

Transpile a query string in the defined dialect into DuckDB compatible SQL.

String qryStr
Dialect dialect
Object> parameters
ExecutorService executorService
CCJSqlParser> consumer
returns String

transpileQuery (qryStr, dialect, parameters) → String

Transpile a query string in the defined dialect into DuckDB compatible SQL.

String qryStr
Dialect dialect
Object> parameters
returns String

transpileQuery (qryStr, dialect) → String

Transpile a query string in the defined dialect into DuckDB compatible SQL.

String qryStr
Dialect dialect
returns String

@SuppressWarnings

transpile (sqlStr, parameters, outputFile, executorService, consumer)

Transpile a query string from a file or STDIN and write the transformed query string into a file or STDOUT. Using the provided Executor Service for observing the parser.

String sqlStr
Object> parameters
File outputFile
ExecutorService executorService
CCJSqlParser> consumer

transpile (sqlStr, parameters, outputFile) → boolean

Transpile a query string from a file or STDIN and write the transformed query string into a file or STDOUT.

String sqlStr
Object> parameters
File outputFile
returns boolean

transpile (sqlStr, outputFile) → boolean

Transpile a query string from a file or STDIN and write the transformed query string into a file or STDOUT.

String sqlStr
File outputFile
returns boolean

readResource (url) → String

Read the text content from a resource file.

URL url

returns String

readResource (clazz, suffix) → String

Read the text content from a resource file relative to a particular class’ suffix

Class clazz
String suffix
returns String

getMacros (executorService, consumer) → String>

Get the Macro CREATE FUNCTION statements as a list of text, using the provided ExecutorService to monitor the parser

ExecutorService executorService
CCJSqlParser> consumer
returns String>

getMacros () → String>

Get the Macro CREATE FUNCTION statements as a list of text

returns String>

getMacroArray () → String[]

Get the Macro CREATE FUNCTION statements as an Array of text

returns String[]

createMacros (conn)

Create the Macros in a given JDBC connection

Connection conn

transpile (statement, parameters) → String

Rewrite a given SQL Statement into a text representation.

Statement statement
Object> parameters
returns String

transpileBigQuery (statement, parameters) → String

Rewrite a given BigQuery SQL Statement into a text representation.

Statement statement
Object> parameters
returns String

transpileDatabricks (statement, parameters) → String

Rewrite a given DataBricks SQL Statement into a text representation.

Statement statement
Object> parameters
returns String

transpileSnowflake (statement, parameters) → String

Rewrite a given Snowflake SQL Statement into a text representation.

Statement statement
Object> parameters
returns String

transpileAmazonRedshift (statement, parameters) → String

Rewrite a given Redshift SQL Statement into a text representation.

Statement statement
Object> parameters
returns String

unpipe (sqlStr, executorService, consumer) → String

String sqlStr
ExecutorService executorService
CCJSqlParser> consumer
returns String

unpipe (sqlStr, consumer) → String

String sqlStr
CCJSqlParser> consumer
returns String

unpipe (sqlStr) → String

String sqlStr

returns String

visit (select, context) → StringBuilder

Select select
S context
returns StringBuilder

visit (insert, context) → StringBuilder

Insert insert
S context
returns StringBuilder

visit (update, context) → StringBuilder

Update update
S context
returns StringBuilder

visit (delete, context) → StringBuilder

Delete delete
S context
returns StringBuilder

visit (merge, context) → StringBuilder

Merge merge
S context
returns StringBuilder

JSQLUpdateTranspiler¶

extends: UpdateDeParser

ExpressionVisitor expressionVisitor

StringBuilder builder

SchemaNotFoundException¶

extends: RuntimeException

SchemaNotFoundException (SchemaName, cause)

String SchemaName

Throwable cause

SchemaNotFoundException (SchemaName)

String SchemaName

getSchemaName () → String

returns String

TableNotDeclaredException¶

extends: RuntimeException

TableNotDeclaredException (tableName, tableNames, cause)

String tableName
String> tableNames
Throwable cause

TableNotDeclaredException (tableName, tableNames)

String tableName

String> tableNames

getTableName () → String

returns String

TableNotFoundException¶

extends: RuntimeException

TableNotFoundException (tableName, schemaNames, cause)

String tableName
String> schemaNames
Throwable cause

TableNotFoundException (tableName, schemaNames)

String tableName

String> schemaNames

getTableName () → String

returns String

uery¶

BigQueryExpressionTranspiler¶

extends: JSQLExpressionTranspiler

BigQueryExpressionTranspiler (selectDeParser, buffer)

SelectDeParser selectDeParser

StringBuilder buffer

BigQuerySelectTranspiler¶

extends: JSQLSelectTranspiler

BigQuerySelectTranspiler (expressionDeparserClass, builder)

ExpressionDeParser> expressionDeparserClass

StringBuilder builder

@Override

visit (select, params) → StringBuilder

PlainSelect select
S params
returns StringBuilder

BigQueryTranspiler¶

extends: JSQLTranspiler

BigQueryTranspiler (parameters)

Object> parameters

bricks¶

DatabricksExpressionTranspiler¶

extends: RedshiftExpressionTranspiler

DatabricksExpressionTranspiler (selectDeParser, buffer)

SelectDeParser selectDeParser

StringBuilder buffer

toDateTimePart (expression) → Expression

Expression expression

returns Expression

castInterval (e1, e2) → Expression

Expression e1
Expression e2
returns Expression

@Override,| @SuppressWarnings

visit (function, params) → StringBuilder

Function function
S params
returns StringBuilder

@Override

visit (function, params) → StringBuilder

AnalyticExpression function
S params
returns StringBuilder

@Override

visit (column, params) → StringBuilder

Column column
S params
returns StringBuilder

rewriteType (colDataType) → ColDataType

ColDataType colDataType

returns ColDataType

DatabricksSelectTranspiler¶

extends: JSQLSelectTranspiler

DatabricksSelectTranspiler (expressionDeparserClass, builder)

ExpressionDeParser> expressionDeparserClass

StringBuilder builder

DatabricksTranspiler¶

extends: JSQLTranspiler

DatabricksTranspiler (parameters)

Object> parameters

hift¶

RedshiftExpressionTranspiler¶

extends: JSQLExpressionTranspiler provides: DatabricksExpressionTranspiler, SnowflakeExpressionTranspiler

RedshiftExpressionTranspiler (deParser, buffer)

SelectDeParser deParser

StringBuilder buffer

@Override,| @SuppressWarnings

visit (function, params) → StringBuilder

Function function
S params
returns StringBuilder

@Override

visit (function, params) → StringBuilder

AnalyticExpression function
S params
returns StringBuilder

Expression expr1

String type1

Expression expr2

String type2

returns CaseExpression

visit (column, params) → StringBuilder

Column column
S params
returns StringBuilder

toFormat (s) → String

String s

returns String

rewriteType (colDataType) → ColDataType

ColDataType colDataType

returns ColDataType

RedshiftSelectTranspiler¶

extends: JSQLSelectTranspiler

RedshiftSelectTranspiler (expressionDeparserClass, builder)

ExpressionDeParser> expressionDeparserClass

StringBuilder builder

RedshiftTranspiler¶

extends: JSQLTranspiler

RedshiftTranspiler (parameters)

Object> parameters

ma¶

ErrorMode¶

[STRICT, LENIENT, IGNORE]

DatabaseSpecific¶

[ORACLE, POSTGRESQL, MSSQL, MYSQL, SNOWFLAKE, DUCKCB, OTHER]

Used for detecting RDBMS type and DB specific handling

CaseInsensitiveConcurrentSet¶

extends: Object

newSet () → String>

returns String>

add (s) → boolean

String s

returns boolean

contains (s) → boolean

String s

returns boolean

remove (s) → boolean

String s

returns boolean

CaseInsensitiveLinkedHashMap¶

extends: String,V>

A Case insensitive linked hash map preserving the original spelling of the keys. It can be used for looking up a database’s schemas, tables, columns, indices and constraints.

CaseInsensitiveLinkedHashMap ()

unquote (quotedIdentifier) → String

Removes leading and trailing quotes from a SQL quoted identifier

String quotedIdentifier

returns String

@Override

put (key, value) → V

String key
V value
returns V

@Override

get (key) → V

Object key

returns V

@Override

containsKey (key) → boolean

Object key

returns boolean

@Override

remove (key) → V

Object key

returns V

@Override

clear ()

@Override

entrySet () → String,V>>

returns String,V>>

@Override

keySet () → String>

returns String>

JdbcCatalog¶

extends: Object implements: JdbcCatalog>

JdbcCatalog (tableCatalog, catalogSeparator)

String tableCatalog

String catalogSeparator

JdbcCatalog ()

getCatalogs (metaData) → JdbcCatalog>

DatabaseMetaData metaData

returns JdbcCatalog>

put (jdbcSchema) → JdbcSchema

JdbcSchema jdbcSchema

returns JdbcSchema

get (tableSchema) → JdbcSchema

String tableSchema

returns JdbcSchema

@Override

compareTo (o) → int

JdbcCatalog o

returns int

@Override

equals (o) → boolean

Object o

returns boolean

@Override

hashCode () → int

returns int

put (key, value) → JdbcSchema

String key
JdbcSchema value
returns JdbcSchema

containsValue (value) → boolean

JdbcSchema value

returns boolean

size () → int

returns int

replace (key, value) → JdbcSchema

String key
JdbcSchema value
returns JdbcSchema

isEmpty () → boolean

returns boolean

compute (key, remappingFunction) → JdbcSchema

String key
JdbcSchema> remappingFunction
returns JdbcSchema

putAll (m)

JdbcSchema> m

values () → JdbcSchema>

returns JdbcSchema>

replace (key, oldValue, newValue) → boolean

String key
JdbcSchema oldValue
JdbcSchema newValue
returns boolean

forEach (action)

JdbcSchema> action

getOrDefault (key, defaultValue) → JdbcSchema

String key
JdbcSchema defaultValue
returns JdbcSchema

remove (key, value) → boolean

String key
Object value
returns boolean

computeIfPresent (key, remappingFunction) → JdbcSchema

String key
JdbcSchema> remappingFunction
returns JdbcSchema

replaceAll (function)

JdbcSchema> function

computeIfAbsent (key, mappingFunction) → JdbcSchema

String key
JdbcSchema> mappingFunction
returns JdbcSchema

putIfAbsent (value) → JdbcSchema

JdbcSchema value

returns JdbcSchema

merge (key, value, remappingFunction) → JdbcSchema

String key
JdbcSchema value
JdbcSchema> remappingFunction
returns JdbcSchema

containsKey (key) → boolean

String key

returns boolean

remove (key) → JdbcSchema

String key

returns JdbcSchema

clear ()

entrySet () → JdbcSchema>>

returns JdbcSchema>>

keySet () → String>

returns String>

getTableCatalog () → String

returns String

setTableCatalog (tableCatalog)

String tableCatalog

getCatalogSeparator () → String

returns String

setCatalogSeparator (catalogSeparator)

String catalogSeparator

getSchemas () → JdbcSchema>

returns JdbcSchema>

setSchemas (schemas)

JdbcSchema> schemas

JdbcColumn¶

extends: Object implements: JdbcColumn>

JdbcColumn (tableCatalog, tableSchema, tableName, columnName, dataType, typeName, columnSize, decimalDigits, numericPrecisionRadix, nullable, remarks, columnDefinition, characterOctetLength, ordinalPosition, isNullable, scopeCatalog, scopeSchema, scopeTable, scopeColumn, sourceDataType, isAutomaticIncrement, isGeneratedColumn, expression)

String tableCatalog
String tableSchema
String tableName
String columnName
Integer dataType
String typeName
Integer columnSize
Integer decimalDigits
Integer numericPrecisionRadix
Integer nullable
String remarks
String columnDefinition
Integer characterOctetLength
Integer ordinalPosition
String isNullable
String scopeCatalog
String scopeSchema
String scopeTable
String scopeColumn
Short sourceDataType
String isAutomaticIncrement
String isGeneratedColumn
Expression expression

JdbcColumn (tableCatalog, tableSchema, tableName, columnName, dataType, typeName, columnSize, decimalDigits, nullable, remarks, expression)

String tableCatalog
String tableSchema
String tableName
String columnName
Integer dataType
String typeName
Integer columnSize
Integer decimalDigits
Integer nullable
String remarks
Expression expression

JdbcColumn (columnName, dataType, typeName, columnSize, decimalDigits, nullable, remarks, expression)

String columnName
Integer dataType
String typeName
Integer columnSize
Integer decimalDigits
Integer nullable
String remarks
Expression expression

JdbcColumn (tableCatalog, tableSchema, tableName, columnName, expression)

String tableCatalog
String tableSchema
String tableName
String columnName
Expression expression

JdbcColumn (columnName, expression)

String columnName

Expression expression

JdbcColumn (columnName)

String columnName

JdbcColumn (tableName, columnName, expression)

String tableName
String columnName
Expression expression

JdbcColumn (tableName, columnName)

String tableName

String columnName

@Override,| @SuppressWarnings

equals (o) → boolean

Object o

returns boolean

@Override,| @SuppressWarnings

compareTo (o) → int

JdbcColumn o

returns int

@SuppressWarnings,| @Override

toString () → String

returns String

@Override,| @SuppressWarnings

hashCode () → int

returns int

getParent () → JdbcColumn

returns JdbcColumn

getChildren () → JdbcColumn>

returns JdbcColumn>

add (children) → JdbcColumn

JdbcColumn> children

returns JdbcColumn

add (children) → JdbcColumn

JdbcColumn[] children

returns JdbcColumn

getExpression () → Expression

returns Expression

setExpression (expression) → JdbcColumn

Expression expression

returns JdbcColumn

JdbcIndex¶

extends: Object

JdbcIndex (tableCatalog, tableSchema, tableName, nonUnique, indexQualifier, indexName, type)

String tableCatalog
String tableSchema
String tableName
Boolean nonUnique
String indexQualifier
String indexName
Short type

put (ordinalPosition, columnName, ascOrDesc, cardinality, pages, filterCondition) → JdbcIndexColumn

Short ordinalPosition
String columnName
String ascOrDesc
Long cardinality
Long pages
String filterCondition
returns JdbcIndexColumn

@Override,| @SuppressWarnings

equals (o) → boolean

Object o

returns boolean

@Override,| @SuppressWarnings

hashCode () → int

returns int

JdbcIndexColumn¶

extends: Object implements: JdbcIndexColumn>

JdbcIndexColumn (ordinalPosition, columnName, ascOrDesc, cardinality, pages, filterCondition)

Short ordinalPosition
String columnName
String ascOrDesc
Long cardinality
Long pages
String filterCondition

@Override

compareTo (o) → int

JdbcIndexColumn o

returns int

@Override

equals (o) → boolean

Object o

returns boolean

@Override

hashCode () → int

returns int

JdbcJSONSerializer¶

extends: Object

JdbcJSONSerializer ()

toJson (metadata, out, indent)

JdbcMetaData metadata
Writer out
int indent

toJson (metadata, out)

JdbcMetaData metadata

Writer out

toJson (metadata) → JSONObject

JdbcMetaData metadata

returns JSONObject

fromJson (in) → JdbcMetaData

Reader in

returns JdbcMetaData

JdbcCatalog catalog

returns JSONObject

JdbcSchema schema

returns JSONObject

JdbcTable table

returns JSONObject

JdbcColumn column

returns JSONObject

JSONObject json

returns JdbcCatalog

JSONObject json

returns JdbcSchema

JSONObject json

returns JdbcTable

JSONObject json

returns JdbcColumn

JdbcMetaData¶

extends: Object implements: DatabaseMetaData

The type Jdbc metadata.

JdbcMetaData (schemaDefinition)

Instantiates a new virtual JDBC MetaData object with an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA and creates tables from the provided definition.

String[][] schemaDefinition

JdbcMetaData (catalogName, schemaName, schemaDefinition)

Instantiates a new virtual JDBC MetaData object for the given CURRENT_CATALOG and CURRENT_SCHEMA and creates tables from the provided definition.

String catalogName
String schemaName
String[][] schemaDefinition

JdbcMetaData (catalogName, schemaName)

Instantiates a new virtual JDBC MetaData object with a given CURRENT_CATALOG and CURRENT_SCHEMA.

String catalogName

String schemaName

JdbcMetaData ()

Instantiates a new virtual JDBC MetaData object with an empty CURRENT_CATALOG and an empty CURRENT_SCHEMA.

JdbcMetaData (con)

Derives JDBC MetaData object from a physical database connection.

Connection con

getTypeName (sqlType) → String

int sqlType

returns String

put (jdbcCatalog) → JdbcCatalog

JdbcCatalog jdbcCatalog

returns JdbcCatalog

getCatalogMap () → JdbcCatalog>

returns JdbcCatalog>

put (jdbcSchema) → JdbcSchema

JdbcSchema jdbcSchema

returns JdbcSchema

put (jdbcTable) → JdbcTable

JdbcTable jdbcTable

returns JdbcTable

put (rsMetaData, name, errorMessage) → JdbcTable

JdbcResultSetMetaData rsMetaData
String name
String errorMessage
returns JdbcTable

@SuppressWarnings

getTableColumns (catalogName, schemaName, tableName, columnName) → JdbcColumn>

String catalogName
String schemaName
String tableName
String columnName
returns JdbcColumn>

@SuppressWarnings

getColumn (catalogName, schemaName, tableName, columnName) → JdbcColumn

String catalogName
String schemaName
String tableName
String columnName
returns JdbcColumn

put (key, value) → JdbcCatalog

String key
JdbcCatalog value
returns JdbcCatalog

containsValue (value) → boolean

JdbcCatalog value

returns boolean

size () → int

returns int

replace (key, value) → JdbcCatalog

String key
JdbcCatalog value
returns JdbcCatalog

isEmpty () → boolean

returns boolean

compute (key, remappingFunction) → JdbcCatalog

String key
JdbcCatalog> remappingFunction
returns JdbcCatalog

putAll (m)

JdbcCatalog> m

values () → JdbcCatalog>

returns JdbcCatalog>

replace (key, oldValue, newValue) → boolean

String key
JdbcCatalog oldValue
JdbcCatalog newValue
returns boolean

forEach (action)

JdbcCatalog> action

getOrDefault (key, defaultValue) → JdbcCatalog

String key
JdbcCatalog defaultValue
returns JdbcCatalog

remove (key, value) → boolean

String key
JdbcCatalog value
returns boolean

computeIfPresent (key, remappingFunction) → JdbcCatalog

String key
JdbcCatalog> remappingFunction
returns JdbcCatalog

replaceAll (function)

JdbcCatalog> function

computeIfAbsent (key, mappingFunction) → JdbcCatalog

String key
JdbcCatalog> mappingFunction
returns JdbcCatalog

putIfAbsent (value) → JdbcCatalog

JdbcCatalog value

returns JdbcCatalog

merge (key, value, remappingFunction) → JdbcCatalog

String key
JdbcCatalog value
JdbcCatalog> remappingFunction
returns JdbcCatalog

get (key) → JdbcCatalog

String key

returns JdbcCatalog

containsKey (key) → boolean

String key

returns boolean

remove (key) → JdbcCatalog

String key

returns JdbcCatalog

clear ()

entrySet () → JdbcCatalog>>

returns JdbcCatalog>>

keySet () → String>

returns String>

addSchema (schemaName) → JdbcSchema

String schemaName

returns JdbcSchema

addTable (catalogName, schemaName, tableName, columns) → JdbcMetaData

String catalogName
String schemaName
String tableName
JdbcColumn> columns
returns JdbcMetaData

addTable (catalogName, schemaName, tableName, columns) → JdbcMetaData

String catalogName
String schemaName
String tableName
JdbcColumn[] columns
returns JdbcMetaData

addTable (schemaName, tableName, columns) → JdbcMetaData

String schemaName
String tableName
JdbcColumn> columns
returns JdbcMetaData

addTable (schemaName, tableName, columns) → JdbcMetaData

String schemaName
String tableName
JdbcColumn[] columns
returns JdbcMetaData

addTable (tableName, columns) → JdbcMetaData

String tableName
JdbcColumn> columns
returns JdbcMetaData

addTable (tableName, columns) → JdbcMetaData

String tableName
JdbcColumn[] columns
returns JdbcMetaData

addTable (tableName, columnNames) → JdbcMetaData

String tableName
String[] columnNames
returns JdbcMetaData

addColumns (tableName, columns) → JdbcTable

String tableName
JdbcColumn> columns
returns JdbcTable

addColumns (tableName, columns) → JdbcTable

String tableName
JdbcColumn[] columns
returns JdbcTable

@Override

allProceduresAreCallable () → boolean

returns boolean

@Override

allTablesAreSelectable () → boolean

returns boolean

@Override

getURL () → String

returns String

@Override

getUserName () → String

returns String

@Override

isReadOnly () → boolean

returns boolean

@Override

nullsAreSortedHigh () → boolean

returns boolean

@Override

nullsAreSortedLow () → boolean

returns boolean

@Override

nullsAreSortedAtStart () → boolean

returns boolean

@Override

nullsAreSortedAtEnd () → boolean

returns boolean

@Override

getDatabaseProductName () → String

returns String

@Override

getDatabaseProductVersion () → String

returns String

@Override

getDriverName () → String

returns String

@Override

getDriverVersion () → String

returns String

@Override

getDriverMajorVersion () → int

returns int

@Override

getDriverMinorVersion () → int

returns int

@Override

usesLocalFiles () → boolean

returns boolean

@Override

usesLocalFilePerTable () → boolean

returns boolean

@Override

supportsMixedCaseIdentifiers () → boolean

returns boolean

@Override

storesUpperCaseIdentifiers () → boolean

returns boolean

@Override

storesLowerCaseIdentifiers () → boolean

returns boolean

@Override

storesMixedCaseIdentifiers () → boolean

returns boolean

@Override

supportsMixedCaseQuotedIdentifiers () → boolean

returns boolean

@Override

storesUpperCaseQuotedIdentifiers () → boolean

returns boolean

@Override

storesLowerCaseQuotedIdentifiers () → boolean

returns boolean

@Override

storesMixedCaseQuotedIdentifiers () → boolean

returns boolean

@Override

getIdentifierQuoteString () → String

returns String

@Override

getSQLKeywords () → String

returns String

@Override

getNumericFunctions () → String

returns String

@Override

getStringFunctions () → String

returns String

@Override

getSystemFunctions () → String

returns String

@Override

getTimeDateFunctions () → String

returns String

@Override

getSearchStringEscape () → String

returns String

@Override

getExtraNameCharacters () → String

returns String

@Override

supportsAlterTableWithAddColumn () → boolean

returns boolean

@Override

supportsAlterTableWithDropColumn () → boolean

returns boolean

@Override

supportsColumnAliasing () → boolean

returns boolean

@Override

nullPlusNonNullIsNull () → boolean

returns boolean

@Override

supportsConvert () → boolean

returns boolean

@Override

supportsConvert (fromType, toType) → boolean

int fromType
int toType
returns boolean

@Override

supportsTableCorrelationNames () → boolean

returns boolean

@Override

supportsDifferentTableCorrelationNames () → boolean

returns boolean

@Override

supportsExpressionsInOrderBy () → boolean

returns boolean

@Override

supportsOrderByUnrelated () → boolean

returns boolean

@Override

supportsGroupBy () → boolean

returns boolean

@Override

supportsGroupByUnrelated () → boolean

returns boolean

@Override

supportsGroupByBeyondSelect () → boolean

returns boolean

@Override

supportsLikeEscapeClause () → boolean

returns boolean

@Override

supportsMultipleResultSets () → boolean

returns boolean

@Override

supportsMultipleTransactions () → boolean

returns boolean

@Override

supportsNonNullableColumns () → boolean

returns boolean

@Override

supportsMinimumSQLGrammar () → boolean

returns boolean

@Override

supportsCoreSQLGrammar () → boolean

returns boolean

@Override

supportsExtendedSQLGrammar () → boolean

returns boolean

@Override

supportsANSI92EntryLevelSQL () → boolean

returns boolean

@Override

supportsANSI92IntermediateSQL () → boolean

returns boolean

@Override

supportsANSI92FullSQL () → boolean

returns boolean

@Override

supportsIntegrityEnhancementFacility () → boolean

returns boolean

@Override

supportsOuterJoins () → boolean

returns boolean

@Override

supportsFullOuterJoins () → boolean

returns boolean

@Override

supportsLimitedOuterJoins () → boolean

returns boolean

@Override

getSchemaTerm () → String

returns String

@Override

getProcedureTerm () → String

returns String

@Override

getCatalogTerm () → String

returns String

@Override

isCatalogAtStart () → boolean

returns boolean

@Override

getCatalogSeparator () → String

returns String

@Override

supportsSchemasInDataManipulation () → boolean

returns boolean

@Override

supportsSchemasInProcedureCalls () → boolean

returns boolean

@Override

supportsSchemasInTableDefinitions () → boolean

returns boolean

@Override

supportsSchemasInIndexDefinitions () → boolean

returns boolean

@Override

supportsSchemasInPrivilegeDefinitions () → boolean

returns boolean

@Override

supportsCatalogsInDataManipulation () → boolean

returns boolean

@Override

supportsCatalogsInProcedureCalls () → boolean

returns boolean

@Override

supportsCatalogsInTableDefinitions () → boolean

returns boolean

@Override

supportsCatalogsInIndexDefinitions () → boolean

returns boolean

@Override

supportsCatalogsInPrivilegeDefinitions () → boolean

returns boolean

@Override

supportsPositionedDelete () → boolean

returns boolean

@Override

supportsPositionedUpdate () → boolean

returns boolean

@Override

supportsSelectForUpdate () → boolean

returns boolean

@Override

supportsStoredProcedures () → boolean

returns boolean

@Override

supportsSubqueriesInComparisons () → boolean

returns boolean

@Override

supportsSubqueriesInExists () → boolean

returns boolean

@Override

supportsSubqueriesInIns () → boolean

returns boolean

@Override

supportsSubqueriesInQuantifieds () → boolean

returns boolean

@Override

supportsCorrelatedSubqueries () → boolean

returns boolean

@Override

supportsUnion () → boolean

returns boolean

@Override

supportsUnionAll () → boolean

returns boolean

@Override

supportsOpenCursorsAcrossCommit () → boolean

returns boolean

@Override

supportsOpenCursorsAcrossRollback () → boolean

returns boolean

@Override

supportsOpenStatementsAcrossCommit () → boolean

returns boolean

@Override

supportsOpenStatementsAcrossRollback () → boolean

returns boolean

@Override

getMaxBinaryLiteralLength () → int

returns int

@Override

getMaxCharLiteralLength () → int

returns int

@Override

getMaxColumnNameLength () → int

returns int

@Override

getMaxColumnsInGroupBy () → int

returns int

@Override

getMaxColumnsInIndex () → int

returns int

@Override

getMaxColumnsInOrderBy () → int

returns int

@Override

getMaxColumnsInSelect () → int

returns int

@Override

getMaxColumnsInTable () → int

returns int

@Override

getMaxConnections () → int

returns int

@Override

getMaxCursorNameLength () → int

returns int

@Override

getMaxIndexLength () → int

returns int

@Override

getMaxSchemaNameLength () → int

returns int

@Override

getMaxProcedureNameLength () → int

returns int

@Override

getMaxCatalogNameLength () → int

returns int

@Override

getMaxRowSize () → int

returns int

@Override

doesMaxRowSizeIncludeBlobs () → boolean

returns boolean

@Override

getMaxStatementLength () → int

returns int

@Override

getMaxStatements () → int

returns int

@Override

getMaxTableNameLength () → int

returns int

@Override

getMaxTablesInSelect () → int

returns int

@Override

getMaxUserNameLength () → int

returns int

@Override

getDefaultTransactionIsolation () → int

returns int

@Override

supportsTransactions () → boolean

returns boolean

@Override

supportsTransactionIsolationLevel (level) → boolean

int level

returns boolean

@Override

supportsDataDefinitionAndDataManipulationTransactions () → boolean

returns boolean

@Override

supportsDataManipulationTransactionsOnly () → boolean

returns boolean

@Override

dataDefinitionCausesTransactionCommit () → boolean

returns boolean

@Override

dataDefinitionIgnoredInTransactions () → boolean

returns boolean

@Override

getProcedures (catalog, schemaPattern, procedureNamePattern) → ResultSet

String catalog
String schemaPattern
String procedureNamePattern
returns ResultSet

@Override

getProcedureColumns (catalog, schemaPattern, procedureNamePattern, columnNamePattern) → ResultSet

String catalog
String schemaPattern
String procedureNamePattern
String columnNamePattern
returns ResultSet

@Override

getTables (catalog, schemaPattern, tableNamePattern, types) → ResultSet

String catalog
String schemaPattern
String tableNamePattern
String[] types
returns ResultSet

@Override

getSchemas () → ResultSet

returns ResultSet

@Override

getCatalogs () → ResultSet

returns ResultSet

@Override

getTableTypes () → ResultSet

returns ResultSet

@Override

getColumns (catalog, schemaPattern, tableNamePattern, columnNamePattern) → ResultSet

String catalog
String schemaPattern
String tableNamePattern
String columnNamePattern
returns ResultSet

@Override

getColumnPrivileges (catalog, schema, table, columnNamePattern) → ResultSet

String catalog
String schema
String table
String columnNamePattern
returns ResultSet

@Override

getTablePrivileges (catalog, schemaPattern, tableNamePattern) → ResultSet

String catalog
String schemaPattern
String tableNamePattern
returns ResultSet

@Override

getBestRowIdentifier (catalog, schema, table, scope, nullable) → ResultSet

String catalog
String schema
String table
int scope
boolean nullable
returns ResultSet

@Override

getVersionColumns (catalog, schema, table) → ResultSet

String catalog
String schema
String table
returns ResultSet

@Override

getPrimaryKeys (catalog, schema, table) → ResultSet

String catalog
String schema
String table
returns ResultSet

@Override

getImportedKeys (catalog, schema, table) → ResultSet

String catalog
String schema
String table
returns ResultSet

@Override

getExportedKeys (catalog, schema, table) → ResultSet

String catalog
String schema
String table
returns ResultSet

@Override

getCrossReference (parentCatalog, parentSchema, parentTable, foreignCatalog, foreignSchema, foreignTable) → ResultSet

String parentCatalog
String parentSchema
String parentTable
String foreignCatalog
String foreignSchema
String foreignTable
returns ResultSet

@Override

getTypeInfo () → ResultSet

returns ResultSet

@Override

getIndexInfo (catalog, schema, table, unique, approximate) → ResultSet

String catalog
String schema
String table
boolean unique
boolean approximate
returns ResultSet

@Override

supportsResultSetType (type) → boolean

int type

returns boolean

@Override

supportsResultSetConcurrency (type, concurrency) → boolean

int type
int concurrency
returns boolean

@Override

ownUpdatesAreVisible (type) → boolean

int type

returns boolean

@Override

ownDeletesAreVisible (type) → boolean

int type

returns boolean

@Override

ownInsertsAreVisible (type) → boolean

int type

returns boolean

@Override

othersUpdatesAreVisible (type) → boolean

int type

returns boolean

@Override

othersDeletesAreVisible (type) → boolean

int type

returns boolean

@Override

othersInsertsAreVisible (type) → boolean

int type

returns boolean

@Override

updatesAreDetected (type) → boolean

int type

returns boolean

@Override

deletesAreDetected (type) → boolean

int type

returns boolean

@Override

insertsAreDetected (type) → boolean

int type

returns boolean

@Override

supportsBatchUpdates () → boolean

returns boolean

@Override

getUDTs (catalog, schemaPattern, typeNamePattern, types) → ResultSet

String catalog
String schemaPattern
String typeNamePattern
int[] types
returns ResultSet

@Override

getConnection () → Connection

returns Connection

@Override

supportsSavepoints () → boolean

returns boolean

@Override

supportsNamedParameters () → boolean

returns boolean

@Override

supportsMultipleOpenResults () → boolean

returns boolean

@Override

supportsGetGeneratedKeys () → boolean

returns boolean

@Override

getSuperTypes (catalog, schemaPattern, typeNamePattern) → ResultSet

String catalog
String schemaPattern
String typeNamePattern
returns ResultSet

@Override

getSuperTables (catalog, schemaPattern, tableNamePattern) → ResultSet

String catalog
String schemaPattern
String tableNamePattern
returns ResultSet

@Override

getAttributes (catalog, schemaPattern, typeNamePattern, attributeNamePattern) → ResultSet

String catalog
String schemaPattern
String typeNamePattern
String attributeNamePattern
returns ResultSet

@Override

supportsResultSetHoldability (holdability) → boolean

int holdability

returns boolean

@Override

getResultSetHoldability () → int

returns int

@Override

getDatabaseMajorVersion () → int

returns int

@Override

getDatabaseMinorVersion () → int

returns int

@Override

getJDBCMajorVersion () → int

returns int

@Override

getJDBCMinorVersion () → int

returns int

@Override

getSQLStateType () → int

returns int

@Override

locatorsUpdateCopy () → boolean

returns boolean

@Override

supportsStatementPooling () → boolean

returns boolean

@Override

getRowIdLifetime () → RowIdLifetime

returns RowIdLifetime

@Override

getSchemas (catalog, schemaPattern) → ResultSet

String catalog
String schemaPattern
returns ResultSet

@Override

supportsStoredFunctionsUsingCallSyntax () → boolean

returns boolean

@Override

autoCommitFailureClosesAllResultSets () → boolean

returns boolean

@Override

getClientInfoProperties () → ResultSet

returns ResultSet

@Override

getFunctions (catalog, schemaPattern, functionNamePattern) → ResultSet

String catalog
String schemaPattern
String functionNamePattern
returns ResultSet

@Override

getFunctionColumns (catalog, schemaPattern, functionNamePattern, columnNamePattern) → ResultSet

String catalog
String schemaPattern
String functionNamePattern
String columnNamePattern
returns ResultSet

@Override

getPseudoColumns (catalog, schemaPattern, tableNamePattern, columnNamePattern) → ResultSet

String catalog
String schemaPattern
String tableNamePattern
String columnNamePattern
returns ResultSet

@Override

generatedKeyAlwaysReturned () → boolean

returns boolean

@Override

unwrap (iface) → T

Class iface

returns T

@Override

isWrapperFor (iface) → boolean

Class iface

returns boolean

getFromTables () → Table>

returns Table>

addFromTables (fromTables) → JdbcMetaData

Table> fromTables

returns JdbcMetaData

addFromTables (fromTables) → JdbcMetaData

Table[] fromTables

returns JdbcMetaData

getLeftUsingJoinedColumns () → Column>

returns Column>

addLeftUsingJoinColumns (columns) → JdbcMetaData

Column> columns

returns JdbcMetaData

getRightUsingJoinedColumns () → Column>

returns Column>

addRightUsingJoinColumns (columns) → JdbcMetaData

Column> columns

returns JdbcMetaData

getNaturalJoinedTables () → Table>

returns Table>

addNaturalJoinedTable (t) → JdbcMetaData

Table t

returns JdbcMetaData

copyOf (metaData, fromTables) → JdbcMetaData

JdbcMetaData metaData
Table> fromTables
returns JdbcMetaData

copyOf (metaData) → JdbcMetaData

JdbcMetaData metaData

returns JdbcMetaData

JdbcTable table

returns JdbcTable

getCurrentCatalogName () → String

returns String

getCurrentSchemaName () → String

returns String

setCatalogSeparator (catalogSeparator) → JdbcMetaData

String catalogSeparator

returns JdbcMetaData

addUnresolved (unquotedQualifiedName)

Add the name of an unresolvable column or table to the list.

String unquotedQualifiedName

getUnresolvedObjects () → String>

Gets unresolved column or table names, not existing in the schema

returns String>

getErrorMode () → ErrorMode

Gets the error mode.

returns ErrorMode

setErrorMode (errorMode) → JdbcMetaData

Sets the error mode.

ErrorMode errorMode

returns JdbcMetaData

getDatabaseType () → String

returns String

setDatabaseType (databaseType)

String databaseType

getCatalogsList () → JdbcCatalog>

returns JdbcCatalog>

setCatalogsList (catalogs)

JdbcCatalog> catalogs

setCurrentCatalogName (currentCatalogName)

String currentCatalogName

setCurrentSchemaName (currentSchemaName)

String currentSchemaName

JdbcPrimaryKey¶

extends: Object

JdbcPrimaryKey (tableCatalog, tableSchema, tableName, primaryKeyName)

String tableCatalog
String tableSchema
String tableName
String primaryKeyName

@Override

equals (o) → boolean

Object o

returns boolean

@Override

hashCode () → int

returns int

JdbcReference¶

extends: Object

JdbcReference (pkTableCatalog, pkTableSchema, pkTableName, fkTableCatalog, fkTableSchema, fkTableName, updateRule, deleteRule, fkName, pkName, deferrability)

String pkTableCatalog
String pkTableSchema
String pkTableName
String fkTableCatalog
String fkTableSchema
String fkTableName
Short updateRule
Short deleteRule
String fkName
String pkName
Short deferrability

@Override,| @SuppressWarnings

equals (o) → boolean

Object o

returns boolean

@Override,| @SuppressWarnings

hashCode () → int

returns int

JdbcResultSetMetaData¶

extends: Object implements: ResultSetMetaData

JdbcResultSetMetaData ()

getColumns () → JdbcColumn>

returns JdbcColumn>

getLabels () → String>

returns String>

add (jdbcColumn, label)

JdbcColumn jdbcColumn

String label

clear ()

add (resultSetMetaData)

JdbcResultSetMetaData resultSetMetaData

@Override

getColumnCount () → int

returns int

@Override

isAutoIncrement (column) → boolean

int column

returns boolean

@Override

isCaseSensitive (column) → boolean

int column

returns boolean

@Override

isSearchable (column) → boolean

int column

returns boolean

@Override

isCurrency (column) → boolean

int column

returns boolean

@Override

isNullable (column) → int

int column

returns int

@Override

isSigned (column) → boolean

int column

returns boolean

@Override

getColumnDisplaySize (column) → int

int column

returns int

@Override

getColumnLabel (column) → String

int column

returns String

@Override

getColumnName (column) → String

int column

returns String

getScopeTable (column) → String

int column

returns String

getScopeSchema (column) → String

int column

returns String

getScopeCatalog (column) → String

int column

returns String

@Override

getSchemaName (column) → String

int column

returns String

@Override

getPrecision (column) → int

int column

returns int

@Override

getScale (column) → int

int column

returns int

@Override

getTableName (column) → String

int column

returns String

@Override

getCatalogName (column) → String

int column

returns String

@Override

getColumnType (column) → int

int column

returns int

@Override

getColumnTypeName (column) → String

int column

returns String

@Override

isReadOnly (column) → boolean

int column

returns boolean

@Override

isWritable (column) → boolean

int column

returns boolean

@Override

isDefinitelyWritable (column) → boolean

int column

returns boolean

@Override

getColumnClassName (column) → String

int column

returns String

@Override

unwrap (iface) → T

Class iface

returns T

@Override

isWrapperFor (iface) → boolean

Class iface

returns boolean

JdbcSchema¶

extends: Object implements: JdbcSchema>

JdbcSchema (tableSchema, tableCatalog)

String tableSchema

String tableCatalog

JdbcSchema ()

getSchemas (metaData) → JdbcSchema>

DatabaseMetaData metaData

returns JdbcSchema>

put (jdbcTable) → JdbcTable

JdbcTable jdbcTable

returns JdbcTable

get (tableName) → JdbcTable

String tableName

returns JdbcTable

@Override

compareTo (o) → int

JdbcSchema o

returns int

@Override

equals (o) → boolean

Object o

returns boolean

@Override

hashCode () → int

returns int

put (key, value) → JdbcTable

String key
JdbcTable value
returns JdbcTable

containsValue (value) → boolean

JdbcTable value

returns boolean

size () → int

returns int

replace (key, value) → JdbcTable

String key
JdbcTable value
returns JdbcTable

isEmpty () → boolean

returns boolean

compute (key, remappingFunction) → JdbcTable

String key
JdbcTable> remappingFunction
returns JdbcTable

putAll (m)

JdbcTable> m

values () → JdbcTable>

returns JdbcTable>

replace (key, oldValue, newValue) → boolean

String key
JdbcTable oldValue
JdbcTable newValue
returns boolean

forEach (action)

JdbcTable> action

getOrDefault (key, defaultValue) → JdbcTable

String key
JdbcTable defaultValue
returns JdbcTable

remove (key, value) → boolean

String key
JdbcTable value
returns boolean

computeIfPresent (key, remappingFunction) → JdbcTable

String key
JdbcTable> remappingFunction
returns JdbcTable

replaceAll (function)

JdbcTable> function

computeIfAbsent (key, mappingFunction) → JdbcTable

String key
JdbcTable> mappingFunction
returns JdbcTable

putIfAbsent (value) → JdbcTable

JdbcTable value

returns JdbcTable

merge (key, value, remappingFunction) → JdbcTable

String key
JdbcTable value
JdbcTable> remappingFunction
returns JdbcTable

containsKey (key) → boolean

String key

returns boolean

remove (key) → JdbcTable

String key

returns JdbcTable

clear ()

entrySet () → JdbcTable>>

returns JdbcTable>>

keySet () → String>

returns String>

getTables () → JdbcTable>

returns JdbcTable>

setTables (tables)

JdbcTable> tables

getSchemaName () → String

returns String

setSchemaName (schemaName)

String schemaName

JdbcTable¶

extends: Object implements: JdbcTable>

JdbcTable (tableCatalog, tableSchema, tableName, tableType, remarks, typeCatalog, typeSchema, typeName, selfReferenceColName, referenceGeneration)

String tableCatalog
String tableSchema
String tableName
String tableType
String remarks
String typeCatalog
String typeSchema
String typeName
String selfReferenceColName
String referenceGeneration

JdbcTable (tableCatalog, tableSchema, tableName)

String tableCatalog
String tableSchema
String tableName

JdbcTable (catalog, schema, tableName)

JdbcCatalog catalog
JdbcSchema schema
String tableName

JdbcTable ()

getTables (metaData, currentCatalog, currentSchema) → JdbcTable>

DatabaseMetaData metaData
String currentCatalog
String currentSchema
returns JdbcTable>

getColumns (metaData)

DatabaseMetaData metaData

getIndices (metaData, approximate)

DatabaseMetaData metaData

boolean approximate

getPrimaryKey (metaData)

DatabaseMetaData metaData

@Override

compareTo (o) → int

JdbcTable o

returns int

add (jdbcColumn) → JdbcColumn

JdbcColumn jdbcColumn

returns JdbcColumn

add (tableCatalog, tableSchema, tableName, columnName, dataType, typeName, columnSize, decimalDigits, numericPrecisionRadix, nullable, remarks, columnDefinition, characterOctetLength, ordinalPosition, isNullable, scopeCatalog, scopeSchema, scopeTable, scopeColumn, sourceDataType, isAutomaticIncrement, isGeneratedColumn) → JdbcColumn

String tableCatalog
String tableSchema
String tableName
String columnName
Integer dataType
String typeName
Integer columnSize
Integer decimalDigits
Integer numericPrecisionRadix
Integer nullable
String remarks
String columnDefinition
Integer characterOctetLength
Integer ordinalPosition
String isNullable
String scopeCatalog
String scopeSchema
String scopeTable
String scopeColumn
Short sourceDataType
String isAutomaticIncrement
String isGeneratedColumn
returns JdbcColumn

containsKey (columnName) → boolean

String columnName

returns boolean

contains (jdbcColumn) → boolean

JdbcColumn jdbcColumn

returns boolean

put (jdbcIndex) → JdbcIndex

JdbcIndex jdbcIndex

returns JdbcIndex

containsIndexKey (indexName) → boolean

String indexName

returns boolean

get (indexName) → JdbcIndex

String indexName

returns JdbcIndex

@Override,| @SuppressWarnings

equals (o) → boolean

Object o

returns boolean

@Override,| @SuppressWarnings

hashCode () → int

returns int

put (key, value) → JdbcColumn

String key
JdbcColumn value
returns JdbcColumn

containsValue (value) → boolean

JdbcColumn value

returns boolean

size () → int

returns int

replace (key, value) → JdbcColumn

String key
JdbcColumn value
returns JdbcColumn

isEmpty () → boolean

returns boolean

compute (key, remappingFunction) → JdbcColumn

String key
JdbcColumn> remappingFunction
returns JdbcColumn

putAll (m)

JdbcColumn> m

values () → JdbcColumn>

returns JdbcColumn>

replace (key, oldValue, newValue) → boolean

String key
JdbcColumn oldValue
JdbcColumn newValue
returns boolean

forEach (action)

JdbcColumn> action

getOrDefault (key, defaultValue) → JdbcColumn

String key
JdbcColumn defaultValue
returns JdbcColumn

remove (key, value) → boolean

String key
JdbcColumn value
returns boolean

computeIfPresent (key, remappingFunction) → JdbcColumn

String key
JdbcColumn> remappingFunction
returns JdbcColumn

replaceAll (function)

JdbcColumn> function

computeIfAbsent (key, mappingFunction) → JdbcColumn

String key
JdbcColumn> mappingFunction
returns JdbcColumn

putIfAbsent (key, value) → JdbcColumn

String key
JdbcColumn value
returns JdbcColumn

merge (key, value, remappingFunction) → JdbcColumn

String key
JdbcColumn value
JdbcColumn> remappingFunction
returns JdbcColumn

remove (key) → JdbcColumn

String key

returns JdbcColumn

clear ()

entrySet () → JdbcColumn>>

returns JdbcColumn>>

keySet () → String>

returns String>

getColumns () → JdbcColumn>

returns JdbcColumn>

setColumns (columns)

JdbcColumn> columns

getTableName () → String

returns String

setTableName (tableName)

String tableName

getTableType () → String

returns String

setTableType (tableType)

String tableType

JdbcUtils¶

extends: Object

JdbcUtils ()

findColumnSafe (rs, columnName) → int

Safe variant of java.sql.ResultSet.findColumn() Does not throw SQLException if columnName does not exist in result set.

ResultSet rs
String columnName
returns int

Retrieves column’s value from ResultSet safely (does not throw SQLException if column (name)

not present in ResultSet.

ResultSet rs

String columnName

returns String

Retrieves column’s value from ResultSet safely (does not throw SQLException if column (name)

not present in ResultSet.

ResultSet rs

String columnName

String defaultValue

returns String

ResultSet rs

int columnIdx

String defaultValue

returns String

ResultSet rs

String columnName

returns Integer

ResultSet rs

String columnName

returns Short

ResultSet rs

String columnName

returns Boolean

SampleSchemaProvider¶

extends: Object implements: SchemaProvider

SampleSchemaProvider ()

getTables () → String>>

returns String>>

getTable (schemaName, tableName) → String>

String schemaName
String tableName
returns String>

getTables (tableName) → String>>

String tableName

returns String>>

ma.treebuilder¶

JsonTreeBuilder¶

extends: String>

JsonTreeBuilder (resultSetMetaData)

JdbcResultSetMetaData resultSetMetaData

int indent

returns void

String input

int indentLevel

returns StringBuilder

JdbcColumn column

String alias

int indent

returns void

PMD.CyclomaticComplexity

@Override

getConvertedTree (resolver) → String

JSQLColumResolver resolver

returns String

JsonTreeBuilderMinimized¶

extends: String>

Concise/minimized version of output generated by JsonTreeBuilder. Useful when the output needs to be transported somewhere or parsed back into POJO.

JsonTreeBuilderMinimized (resultSetMetaData)

JdbcResultSetMetaData resultSetMetaData

JdbcColumn column

String alias

returns void

PMD.CyclomaticComplexity

@Override

getConvertedTree (resolver) → String

JSQLColumResolver resolver

returns String

TreeBuilder¶

extends: Object

TreeBuilder (resultSetMetaData)

JdbcResultSetMetaData resultSetMetaData

getConvertedTree (resolver) → T

JSQLColumResolver resolver

returns T

XmlTreeBuilder¶

extends: String>

XmlTreeBuilder (resultSetMetaData)

JdbcResultSetMetaData resultSetMetaData

int indent

returns void

String input

int indentLevel

returns StringBuilder

JdbcColumn column

String alias

int indent

returns void

PMD.CyclomaticComplexity

@Override

getConvertedTree (resolver) → String

JSQLColumResolver resolver

returns String

flake¶

SnowflakeExpressionTranspiler¶

extends: RedshiftExpressionTranspiler

SnowflakeExpressionTranspiler (deParser, buffer)

SelectDeParser deParser

StringBuilder buffer

toDateTimePart (expression) → Expression

Expression expression

returns Expression

castInterval (e1, e2) → Expression

Expression e1
Expression e2
returns Expression

@Override,| @SuppressWarnings

visit (function, params) → StringBuilder

Function function
S params
returns StringBuilder

@Override

visit (function, params) → StringBuilder

AnalyticExpression function
S params
returns StringBuilder

@Override

visit (column, params) → StringBuilder

Column column
S params
returns StringBuilder

@Override

visit (hexValue, params) → StringBuilder

HexValue hexValue
S params
returns StringBuilder

@Override

visit (likeExpression, params) → StringBuilder

LikeExpression likeExpression
S params
returns StringBuilder

rewriteType (colDataType) → ColDataType

ColDataType colDataType

returns ColDataType

SnowflakeSelectTranspiler¶

extends: JSQLSelectTranspiler

SnowflakeSelectTranspiler (expressionDeparserClass, builder)

ExpressionDeParser> expressionDeparserClass

StringBuilder builder

@Override

visit (values, params) → StringBuilder

Values values
S params
returns StringBuilder

@Override,| @SuppressWarnings

visit (tableFunction, params) → StringBuilder

TableFunction tableFunction
S params
returns StringBuilder

SnowflakeTranspiler¶

extends: JSQLTranspiler

SnowflakeTranspiler (parameters)

Object> parameters