JSQLTranspiler 0.7-SNAPSHOT API¶
Base Package: ai.starlake.jsqltranspiler
Base¶
JSQLTranspiler.Dialect¶
[GOOGLE_BIG_QUERY, DATABRICKS, SNOWFLAKE, AMAZON_REDSHIFT, ANY, DUCK_DB]
The enum Dialect.
JSQLColumResolver¶
extends: Object
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 | metaData the meta data
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 | currentCatalogName the current catalog name
String currentSchemaName | currentSchemaName the current schema name
String metaDataDefinition | metaDataDefinition the metadata definition as n Array of Tablename and Column Names
JSQLColumResolver (metaDataDefinition)
Instantiates a new JSQLColumnResolver for the provided simplified Metadata with an empty CURRENT_SCHEMA and CURRENT_CATALOG
String metaDataDefinition | metaDataDefinition the metadata definition as n Array of Table name and Column Names
@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 | sqlStr the SELECT statement text
JdbcMetaData metaData | metaData the Database Meta Data
returns JdbcResultSetMetaData | the ResultSetMetaData representing the actual columns returned by the SELECT statement
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 | sqlStr the SELECT statement text
String metaDataDefinition | metaDataDefinition the metadata definition as an array of Tables with Columns e.g. { TABLE_NAME, COLUMN1, COLUMN2 … COLUMN10 }
String currentCatalogName | currentCatalogName the CURRENT_CATALOG name (which is the default catalog for accessing the schemas)
String currentSchemaName | currentSchemaName the CURRENT_SCHEMA name (which is the default schema for accessing the tables)
returns JdbcResultSetMetaData | the ResultSetMetaData representing the actual columns returned by the SELECT statement
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 | sqlStr the SELECT statement text
String metaDataDefinition | metaDataDefinition the metadata definition as an array of Tables with Columns e.g. { TABLE_NAME, COLUMN1, COLUMN2 … COLUMN10 }
returns JdbcResultSetMetaData | the ResultSetMetaData representing the actual columns returned by the SELECT statement
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 | sqlStr the SELECT statement text
returns JdbcResultSetMetaData | the ResultSetMetaData representing the actual columns returned by the SELECT statement
getResolvedStatementText (sqlStr) → String
Gets the rewritten statement text with any AllColumns “*” or AllTableColumns “t.*” expression resolved into the actual columns
String sqlStr | sqlStr the query statement string (using any AllColumns “*” or AllTableColumns “t.*” expression)
returns String | rewritten statement text with any AllColumns “*” or AllTableColumns “t.*” expression resolved into the actual columns
getLineage (treeBuilderClass, sqlStr, connection) → T
Class treeBuilderClass
String sqlStr
Connection connection
returns T
getLineage (treeBuilderClass, sqlStr, metaDataDefinition, currentCatalogName, currentSchemaName) → T
Class treeBuilderClass
String sqlStr
String metaDataDefinition
String currentCatalogName
String currentSchemaName
returns T
getLineage (treeBuilderClass, select) → T
Class treeBuilderClass
Select select
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
@Override
visit (tableName)
Table tableName
visit (parenthesedSelect, context) → JdbcResultSetMetaData
@Override
visit (parenthesedSelect, context) → JdbcResultSetMetaData
@Override
visit (parenthesedSelect)
ParenthesedSelect parenthesedSelect
@SuppressWarnings
visit (select, metaData) → JdbcResultSetMetaData
@Override
visit (select, context) → JdbcResultSetMetaData
@Override
visit (plainSelect)
PlainSelect plainSelect
visit (select) → JdbcResultSetMetaData
Select select
returns JdbcResultSetMetaData
@Override
visit (setOperationList, context) → JdbcResultSetMetaData
@Override
visit (setOpList)
SetOperationList setOpList
@Override
visit (withItem, context) → JdbcResultSetMetaData
@Override
visit (withItem)
<any> withItem
@Override
visit (values, context) → JdbcResultSetMetaData
@Override
visit (values)
Values values
@Override
visit (lateralSubSelect, context) → JdbcResultSetMetaData
@Override
visit (lateralSubSelect)
LateralSubSelect lateralSubSelect
@Override
visit (tableFunction, context) → JdbcResultSetMetaData
@Override
visit (tableFunction)
TableFunction tableFunction
@Override
visit (parenthesedFromItem, context) → JdbcResultSetMetaData
@Override
visit (parenthesedFromItem)
ParenthesedFromItem parenthesedFromItem
@Override
visit (tableStatement, context) → JdbcResultSetMetaData
@Override
visit (tableStatement)
TableStatement tableStatement
getErrorMode () → ErrorMode
Gets the error mode.
returns ErrorMode | the error mode
setErrorMode (errorMode) → JSQLColumResolver
Sets the error mode.
ErrorMode errorMode | errorMode the error mode
returns JSQLColumResolver | the error mode
addUnresolved (unquotedQualifiedName)
Add the name of an unresolvable column or table to the list.
String unquotedQualifiedName | unquotedQualifiedName the unquoted qualified name of the table or column
getUnresolvedObjects () → Set
Gets unresolved column or table names, not existing in the schema
returns Set | the unresolved column or table names
JSQLDeleteTranspiler¶
extends: DeleteDeParser
JSQLExpressionColumnResolver¶
extends: <any>
JSQLExpressionColumnResolver (columResolver)
JSQLColumResolver columResolver
Expression expressionS contextreturns ListExpression expressionS contextCollection subExpressionsreturns List@Override
visit (function, context) → List
Function function
S context
returns List
@SuppressWarnings,| @Override
visit (allTableColumns, context) → List
AllTableColumns allTableColumns
S context
returns List
@SuppressWarnings,| @Override
visit (allColumns, context) → List
AllColumns allColumns
S context
returns List
@Override
visit (column, context) → List
Column column
S context
returns List
@Override
visit (select, context) → List
ParenthesedSelect select
S context
returns List
@Override
visit (select, context) → List
Select select
S context
returns List
@Override
visit (plainSelect, context) → List
PlainSelect plainSelect
S context
returns List
@Override
visit (setOperationList, context) → List
SetOperationList setOperationList
S context
returns List
@Override
visit (withItem, context) → List
<any> withItem
S context
returns List
@Override
visit (values, context) → List
Values values
S context
returns List
@Override
visit (lateralSubSelect, context) → List
LateralSubSelect lateralSubSelect
S context
returns List
@Override
visit (tableStatement, context) → List
TableStatement tableStatement
S context
returns List
JSQLExpressionTranspiler¶
extends: ExpressionDeParser provides: BigQueryExpressionTranspiler, RedshiftExpressionTranspiler
The type Expression transpiler.
JSQLExpressionTranspiler (deParser, buffer)
SelectDeParser deParser
StringBuilder buffer
isDatePart (expression, dialect) → boolean
Expression expression
Dialect dialect
returns boolean
Expression expressionreturns booleanisDateTimePart (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
@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
@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
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
<any> expressionList
S context
returns StringBuilder
@Override
visit (e, context) → StringBuilder
JsonExpression e
S context
returns StringBuilder
JSQLInsertTranspiler¶
extends: InsertDeParser
JSQLMergeTranspiler¶
extends: MergeDeParser
JSQLMergeTranspiler (expressionDeParser, selectDeParser, buffer)
ExpressionDeParser expressionDeParser
SelectDeParser selectDeParser
StringBuilder buffer
JSQLSelectTranspiler¶
extends: SelectDeParser provides: BigQuerySelectTranspiler, DatabricksSelectTranspiler, RedshiftSelectTranspiler, SnowflakeSelectTranspiler
Instantiates a new transpiler. | JSQLExpressionTranspiler expressionTranspiler
StringBuilder resultBuilderJSQLSelectTranspiler (expressionDeparserClass, builder)
Class expressionDeparserClass
StringBuilder builder
getResultBuilder () → StringBuilder
Gets result builder.
returns StringBuilder | the result builder
@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
<any> selectItem
S context
returns StringBuilder
JSQLTranspiler¶
extends: StatementDeParser provides: BigQueryTranspiler, DatabricksTranspiler, RedshiftTranspiler, SnowflakeTranspiler
The type JSQLTranspiler.
Class selectTranspilerClassClass expressionTranspilerClassJSQLTranspiler (parameters)
Map parameters
JSQLTranspiler ()
@SuppressWarnings
transpileQuery (qryStr, dialect, parameters, executorService, consumer) → String
Transpile a query string in the defined dialect into DuckDB compatible SQL.
String qryStr | qryStr the original query string
Dialect dialect | dialect the dialect of the query string
Map parameters | parameters the map of substitution key/value pairs (can be empty)
ExecutorService executorService | executorService the ExecutorService to use for running and observing JSQLParser
Consumer consumer | consumer the parser configuration to use for the parsing
returns String | the transformed query string
transpileQuery (qryStr, dialect, parameters) → String
Transpile a query string in the defined dialect into DuckDB compatible SQL.
String qryStr | qryStr the original query string
Dialect dialect | dialect the dialect of the query string
Map parameters | parameters the map of substitution key/value pairs (can be empty)
returns String | the transformed query string
transpileQuery (qryStr, dialect) → String
Transpile a query string in the defined dialect into DuckDB compatible SQL.
String qryStr | qryStr the original query string
Dialect dialect | dialect the dialect of the query string
returns String | the transformed query 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 | sqlStr the original query string
Map parameters | parameters the map of substitution key/value pairs (can be empty)
File outputFile | outputFile the output file, writing to STDOUT when not defined
ExecutorService executorService | executorService the ExecutorService to use for running and observing JSQLParser
Consumer consumer | consumer the parser configuration to use for the parsing
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 | sqlStr the original query string
Map parameters | parameters the map of substitution key/value pairs (can be empty)
File outputFile | outputFile the output file, writing to STDOUT when not defined
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 | sqlStr the original query string
File outputFile | outputFile the output file, writing to STDOUT when not defined
returns boolean
readResource (url) → String
Read the text content from a resource file.
URL url | url the URL of the resource file
returns String | the text content
readResource (clazz, suffix) → String
Read the text content from a resource file relative to a particular class’ suffix
Class clazz | clazz the Class which defines the classpath URL of the resource file
String suffix | suffix the Class Name suffix used for naming the resource file
returns String | the text content
getMacros (executorService, consumer) → Collection
Get the Macro CREATE FUNCTION statements as a list of text, using the provided ExecutorService to monitor the parser
ExecutorService executorService | executorService the ExecutorService to use for running and observing JSQLParser
Consumer consumer | consumer the parser configuration to use for the parsing
returns Collection | the list of statement texts
getMacros () → Collection
Get the Macro CREATE FUNCTION statements as a list of text
returns Collection | the list of statement texts
getMacroArray () → String
Get the Macro CREATE FUNCTION statements as an Array of text
returns String | the array of statement texts
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 | statement the statement
Map parameters
returns String | the string
transpileBigQuery (statement, parameters) → String
Rewrite a given BigQuery SQL Statement into a text representation.
Statement statement | statement the statement
Map parameters
returns String | the string
transpileDatabricks (statement, parameters) → String
Rewrite a given DataBricks SQL Statement into a text representation.
Statement statement | statement the statement
Map parameters
returns String | the string
transpileSnowflake (statement, parameters) → String
Rewrite a given Snowflake SQL Statement into a text representation.
Statement statement | statement the statement
Map parameters
returns String | the string
transpileAmazonRedshift (statement, parameters) → String
Rewrite a given Redshift SQL Statement into a text representation.
Statement statement | statement the statement
Map parameters
returns String | the 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
uery¶
BigQueryExpressionTranspiler¶
extends: JSQLExpressionTranspiler
BigQueryExpressionTranspiler (selectDeParser, buffer)
SelectDeParser selectDeParser
StringBuilder buffer
BigQuerySelectTranspiler¶
extends: JSQLSelectTranspiler
BigQuerySelectTranspiler (expressionDeparserClass, builder)
Class expressionDeparserClass
StringBuilder builder
@Override
visit (select, params) → StringBuilder
PlainSelect select
S params
returns StringBuilder
BigQueryTranspiler¶
extends: JSQLTranspiler
BigQueryTranspiler (parameters)
Map 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)
Class expressionDeparserClass
StringBuilder builder
DatabricksTranspiler¶
extends: JSQLTranspiler
DatabricksTranspiler (parameters)
Map 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
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)
Class expressionDeparserClass
StringBuilder builder
RedshiftTranspiler¶
extends: JSQLTranspiler
RedshiftTranspiler (parameters)
Map parameters
ma¶
JdbcMetaData.ErrorMode¶
[STRICT, LENIENT, IGNORE]
JdbcUtils.DatabaseSpecific¶
[ORACLE, POSTGRESQL, MSSQL, MYSQL, SNOWFLAKE, DUCKCB, OTHER]
Used for detecting RDBMS type and DB specific handling
CaseInsensitiveConcurrentSet¶
extends: Object
newSet () → Set
returns Set
add (s) → boolean
String s
returns boolean
contains (s) → boolean
String s
returns boolean
remove (s) → boolean
String s
returns boolean
CaseInsensitiveLinkedHashMap¶
extends: LinkedHashMap
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 | quotedIdentifier the quoted identifier
returns String | the pure identifier without quotes
@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 () → Set
returns Set
@Override
keySet () → Set
returns Set
JdbcCatalog¶
extends: Object implements: Comparable
JdbcCatalog (tableCatalog, catalogSeparator)
String tableCatalog
String catalogSeparator
JdbcCatalog ()
getCatalogs (metaData) → Collection
DatabaseMetaData metaData
returns Collection
put (jdbcSchema) → JdbcSchema
JdbcSchema jdbcSchema
returns JdbcSchema
get (tableSchema) → JdbcSchema
String tableSchema
returns JdbcSchema
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
put (key, value) → JdbcSchema
containsValue (value) → boolean
JdbcSchema value
returns boolean
size () → int
returns int
replace (key, value) → JdbcSchema
isEmpty () → boolean
returns boolean
compute (key, remappingFunction) → JdbcSchema
putAll (m)
Map m
values () → Collection
returns Collection
replace (key, oldValue, newValue) → boolean
forEach (action)
BiConsumer action
getOrDefault (key, defaultValue) → JdbcSchema
remove (key, value) → boolean
String key
Object value
returns boolean
computeIfPresent (key, remappingFunction) → JdbcSchema
replaceAll (function)
BiFunction function
computeIfAbsent (key, mappingFunction) → JdbcSchema
putIfAbsent (value) → JdbcSchema
JdbcSchema value
returns JdbcSchema
merge (key, value, remappingFunction) → JdbcSchema
containsKey (key) → boolean
String key
returns boolean
remove (key) → JdbcSchema
String key
returns JdbcSchema
clear ()
entrySet () → Set
returns Set
keySet () → Set
returns Set
getTableCatalog () → String
returns String
setTableCatalog (tableCatalog)
String tableCatalog
getCatalogSeparator () → String
returns String
setCatalogSeparator (catalogSeparator)
String catalogSeparator
getSchemas () → List
returns List
setSchemas (schemas)
List schemas
JdbcColumn¶
extends: Object implements: Comparable
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
@Override,| @SuppressWarnings
equals (o) → boolean
Object o
returns boolean
@SuppressWarnings,| @Override
toString () → String
returns String
@Override,| @SuppressWarnings
hashCode () → int
returns int
getParent () → JdbcColumn
returns JdbcColumn
getChildren () → List
returns List
add (children) → JdbcColumn
Collection 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: Comparable
JdbcIndexColumn (ordinalPosition, columnName, ascOrDesc, cardinality, pages, filterCondition)
Short ordinalPosition
String columnName
String ascOrDesc
Long cardinality
Long pages
String filterCondition
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
JdbcJSONSerializer¶
extends: Object
JdbcJSONSerializer ()
toJson (metadata, out, indent)
toJson (metadata, out)
JdbcMetaData metadata
Writer out
toJson (metadata) → JSONObject
JdbcMetaData metadata
returns JSONObject
fromJson (in) → JdbcMetaData
Reader in
returns JdbcMetaData
JdbcCatalog catalogreturns JSONObjectJdbcSchema schemareturns JSONObjectJdbcTable tablereturns JSONObjectJdbcColumn columnreturns JSONObjectJSONObject jsonreturns JdbcCatalogJSONObject jsonreturns JdbcSchemaJSONObject jsonreturns JdbcTableJSONObject jsonreturns 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 | schemaDefinition the schema definition of tables and columns
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 | catalogName the CURRENT_CATALOG
String schemaName | schemaName the CURRENT_SCHEMA
String schemaDefinition | schemaDefinition the schema definition of tables and columns
JdbcMetaData (catalogName, schemaName)
Instantiates a new virtual JDBC MetaData object with a given CURRENT_CATALOG and CURRENT_SCHEMA.
String catalogName | catalogName the CURRENT_CATALOG to set
String schemaName | schemaName the CURRENT_SCHEMA to set
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 | con the physical database connection
getTypeName (sqlType) → String
int sqlType
returns String
put (jdbcCatalog) → JdbcCatalog
JdbcCatalog jdbcCatalog
returns JdbcCatalog
getCatalogMap () → Map
returns Map
put (jdbcSchema) → JdbcSchema
JdbcSchema jdbcSchema
returns JdbcSchema
put (rsMetaData, name, errorMessage) → JdbcTable
@SuppressWarnings
getTableColumns (catalogName, schemaName, tableName, columnName) → List
String catalogName
String schemaName
String tableName
String columnName
returns List
@SuppressWarnings
getColumn (catalogName, schemaName, tableName, columnName) → JdbcColumn
put (key, value) → JdbcCatalog
containsValue (value) → boolean
JdbcCatalog value
returns boolean
size () → int
returns int
replace (key, value) → JdbcCatalog
isEmpty () → boolean
returns boolean
compute (key, remappingFunction) → JdbcCatalog
putAll (m)
Map m
values () → Collection
returns Collection
replace (key, oldValue, newValue) → boolean
forEach (action)
BiConsumer action
getOrDefault (key, defaultValue) → JdbcCatalog
remove (key, value) → boolean
computeIfPresent (key, remappingFunction) → JdbcCatalog
replaceAll (function)
BiFunction function
computeIfAbsent (key, mappingFunction) → JdbcCatalog
putIfAbsent (value) → JdbcCatalog
JdbcCatalog value
returns JdbcCatalog
merge (key, value, remappingFunction) → JdbcCatalog
get (key) → JdbcCatalog
String key
returns JdbcCatalog
containsKey (key) → boolean
String key
returns boolean
remove (key) → JdbcCatalog
String key
returns JdbcCatalog
clear ()
entrySet () → Set
returns Set
keySet () → Set
returns Set
addSchema (schemaName) → JdbcSchema
String schemaName
returns JdbcSchema
addTable (catalogName, schemaName, tableName, columns) → JdbcMetaData
addTable (catalogName, schemaName, tableName, columns) → JdbcMetaData
addTable (schemaName, tableName, columns) → JdbcMetaData
addTable (schemaName, tableName, columns) → JdbcMetaData
addTable (tableName, columns) → JdbcMetaData
addTable (tableName, columns) → JdbcMetaData
addTable (tableName, columnNames) → JdbcMetaData
addColumns (tableName, columns) → 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 () → CaseInsensitiveLinkedHashMap
returns CaseInsensitiveLinkedHashMap
addFromTables (fromTables) → JdbcMetaData
Collection fromTables
returns JdbcMetaData
addFromTables (fromTables) → JdbcMetaData
Table fromTables
returns JdbcMetaData
getLeftUsingJoinedColumns () → CaseInsensitiveLinkedHashMap
returns CaseInsensitiveLinkedHashMap
addLeftUsingJoinColumns (columns) → JdbcMetaData
Collection columns
returns JdbcMetaData
getRightUsingJoinedColumns () → CaseInsensitiveLinkedHashMap
returns CaseInsensitiveLinkedHashMap
addRightUsingJoinColumns (columns) → JdbcMetaData
Collection columns
returns JdbcMetaData
getNaturalJoinedTables () → CaseInsensitiveLinkedHashMap
returns CaseInsensitiveLinkedHashMap
addNaturalJoinedTable (t) → JdbcMetaData
Table t
returns JdbcMetaData
copyOf (metaData, fromTables) → JdbcMetaData
copyOf (metaData) → JdbcMetaData
JdbcMetaData metaData
returns JdbcMetaData
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 | unquotedQualifiedName the unquoted qualified name of the table or column
getUnresolvedObjects () → Set
Gets unresolved column or table names, not existing in the schema
returns Set | the unresolved column or table names
getErrorMode () → ErrorMode
Gets the error mode.
returns ErrorMode | the error mode
setErrorMode (errorMode) → JdbcMetaData
Sets the error mode.
ErrorMode errorMode | errorMode the error mode
returns JdbcMetaData | the error mode
getDatabaseType () → String
returns String
setDatabaseType (databaseType)
String databaseType
getCatalogsList () → List
returns List
setCatalogsList (catalogs)
List 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 () → ArrayList
returns ArrayList
getLabels () → ArrayList
returns ArrayList
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: Comparable
JdbcSchema (tableSchema, tableCatalog)
String tableSchema
String tableCatalog
JdbcSchema ()
getSchemas (metaData) → Collection
DatabaseMetaData metaData
returns Collection
@Override
equals (o) → boolean
Object o
returns boolean
@Override
hashCode () → int
returns int
containsValue (value) → boolean
JdbcTable value
returns boolean
size () → int
returns int
isEmpty () → boolean
returns boolean
compute (key, remappingFunction) → JdbcTable
putAll (m)
Map m
values () → Collection
returns Collection
replace (key, oldValue, newValue) → boolean
forEach (action)
BiConsumer action
remove (key, value) → boolean
computeIfPresent (key, remappingFunction) → JdbcTable
replaceAll (function)
BiFunction function
computeIfAbsent (key, mappingFunction) → JdbcTable
merge (key, value, remappingFunction) → JdbcTable
containsKey (key) → boolean
String key
returns boolean
clear ()
entrySet () → Set
returns Set
keySet () → Set
returns Set
getTables () → List
returns List
setTables (tables)
List tables
getSchemaName () → String
returns String
setSchemaName (schemaName)
String schemaName
JdbcTable¶
extends: Object implements: Comparable
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)
JdbcTable ()
getTables (metaData, currentCatalog, currentSchema) → Collection
DatabaseMetaData metaData
String currentCatalog
String currentSchema
returns Collection
getColumns (metaData)
DatabaseMetaData metaData
getIndices (metaData, approximate)
DatabaseMetaData metaData
boolean approximate
getPrimaryKey (metaData)
DatabaseMetaData metaData
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
containsIndexKey (indexName) → boolean
String indexName
returns boolean
@Override,| @SuppressWarnings
equals (o) → boolean
Object o
returns boolean
@Override,| @SuppressWarnings
hashCode () → int
returns int
put (key, value) → JdbcColumn
containsValue (value) → boolean
JdbcColumn value
returns boolean
size () → int
returns int
replace (key, value) → JdbcColumn
isEmpty () → boolean
returns boolean
compute (key, remappingFunction) → JdbcColumn
putAll (m)
Map m
values () → Collection
returns Collection
replace (key, oldValue, newValue) → boolean
forEach (action)
BiConsumer action
getOrDefault (key, defaultValue) → JdbcColumn
remove (key, value) → boolean
computeIfPresent (key, remappingFunction) → JdbcColumn
replaceAll (function)
BiFunction function
computeIfAbsent (key, mappingFunction) → JdbcColumn
putIfAbsent (key, value) → JdbcColumn
merge (key, value, remappingFunction) → JdbcColumn
remove (key) → JdbcColumn
String key
returns JdbcColumn
clear ()
entrySet () → Set
returns Set
keySet () → Set
returns Set
getColumns () → List
returns List
setColumns (columns)
List 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 | index of the searched column in the results set or -1 if not found
SampleSchemaProvider¶
extends: Object implements: SchemaProvider
SampleSchemaProvider ()
getTables () → Map
returns Map
getTable (schemaName, tableName) → Map
String schemaName
String tableName
returns Map
getTables (tableName) → Map
String tableName
returns Map
ma.treebuilder¶
JsonTreeBuilder¶
extends: TreeBuilder
JsonTreeBuilder (resultSetMetaData)
JdbcResultSetMetaData resultSetMetaData
JsonTreeBuilderMinimized¶
extends: TreeBuilder
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
TreeBuilder¶
extends: Object provides: JsonTreeBuilder, JsonTreeBuilderMinimized, XmlTreeBuilder
TreeBuilder (resultSetMetaData)
JdbcResultSetMetaData resultSetMetaData
getConvertedTree (resolver) → T
JSQLColumResolver resolver
returns T
XmlTreeBuilder¶
extends: TreeBuilder
XmlTreeBuilder (resultSetMetaData)
JdbcResultSetMetaData resultSetMetaData
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)
Class 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)
Map parameters