Package gudusoft.gsqlparser.sqlenv

Class TSQLEnv

Object

gudusoft.gsqlparser.sqlenv.TSQLEnv

Direct Known Subclasses:

GrabitSQLEnv, MultipleGrabitSQLEnv, MultipleSQLDepSQLEnv, SQLDepSQLEnv, SqlflowSQLEnv, TDDLSQLEnv

public abstract class TSQLEnv
extends Object

SQL environment includes the metadata of a list of databases. The typical scenario is there is one database includes some schemas, and each schema includes some tables, views, procedures and etc.

Database known as catalog in ANSI SQL.
Each catalog including a list of schemas.
Each schema including a list of schema objects such as table, procedure, function, trigger and more.
Implement your own concrete class derived from this class to get the metadata from a real database. Usually, this is done by querying the INFORMATION_SCHEMA in the initSQLEnv() method which should be override in your own class.

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<EDbVendor,Boolean>	catalogCollationCaseSensitive
static final Map<EDbVendor,Boolean>	columnCollationCaseSensitive
static final String	DEFAULT_DB_NAME
static final String	DEFAULT_SCHEMA_NAME
static final String	DEFAULT_SERVER_NAME	add a table
static final Map<EDbVendor,Boolean>	defaultCollationCaseSensitive
static final Map<EDbVendor,Boolean>	functionCollationCaseSensitive
static final Map<EDbVendor,Boolean>	isAliasReferenceForbidden
static final Map<EDbVendor,Boolean>	tableCollationCaseSensitive

Constructor Summary

Constructors

Constructor	Description
TSQLEnv(EDbVendor dbVendor)	create a SQL environment.

Method Summary

Modifier and Type	Method	Description
TSQLFunction	addFunction(TObjectName qualifiedFunctionName, boolean fromDDL)
TSQLFunction	addFunction(String qualifiedFunctionName, boolean fromDDL)	Add a function to SQLEnv, if a function with the same already exists, just return the existing one.
TSQLProcedure	addOraclePackage(String qualifiedProcedureName, boolean fromDDL)
TSQLProcedure	addProcedure(String qualifiedProcedureName, boolean fromDDL)
TSQLRoutine	addSQLRoutine(String qualifiedProcedureName, boolean fromDDL, ESQLDataObjectType type)
TSQLTable	addTable(String qualifiedTableName, boolean fromDDL)	Add a new table to the SQLEnv.
TSQLTrigger	addTrigger(String qualifiedTriggerName, boolean fromDDL)
TSQLTable	addView(String qualifiedViewName, boolean fromDDL)
boolean	columnInTable(String qualifiedTablename, String columnName)
static boolean	compareColumn(EDbVendor dbVendor, TObjectName sourceColumn, TObjectName targetColumn)
boolean	compareColumn(String ident1, String ident2)
static boolean	compareIdentifier(EDbVendor dbVendor, ESQLDataObjectType objectType, TObjectName source, TObjectName target)
static boolean	compareIdentifier(EDbVendor dbVendor, ESQLDataObjectType objectType, String ident1, String ident2)
boolean	compareIdentifier(ESQLDataObjectType objectType, String ident1, String ident2)
static boolean	compareQualifiedColumn(EDbVendor dbVendor, String sourceColumn, String targetColumn, String sourceTable, String targetTable, String sourceSchema, String targetSchema, String sourceDatabase, String targetDatabase)
static boolean	compareQualifiedTable(EDbVendor dbVendor, String sourceTable, String targetTable, String sourceSchema, String targetSchema, String sourceDatabase, String targetDatabase)
static boolean	compareTable(EDbVendor dbVendor, TObjectName sourceTable, TObjectName targetTable)
boolean	compareTable(String ident1, String ident2)
TSQLCatalog	createSQLCatalog(String catalogName)	create a new catalog/database in the SQL environment.
TSQLSchema	createSQLSchema(String qualifiedSchemaName)	create a new schema and add to the catalog
static String	delimitedChar(EDbVendor dbVendor)	used to delimit a database identifier, such as [ used in SQL Server, ` used in MySQL
protected boolean	doAddCatalog(TSQLCatalog sqlCatalog)	add a catalog to the SQL environment, called internally.
TSQLSchemaObject	doAddSchemaObject(TObjectName qualifiedObjectName, ESQLDataObjectType objectType)
TSQLSchemaObject	doAddSchemaObject(String qualifiedObjectName, ESQLDataObjectType objectType)
protected TSQLSchemaObject	doSearchSchemaObject(String catalog, String schema, String table, ESQLDataObjectType objectType)
static boolean	endsWithDelimitedIdentifier(EDbVendor dbVendor, String identifier)
String	getAFullQualifiedSchemaObjectName(String schemaObjectName)	If the input name is fully qualified with db and schema, just return it without any modification.
List<TSQLCatalog>	getCatalogList()	a list of catalog/database in this SQL environment.
ICatalogProvider	getCatalogProvider()	Get ICatalogProvider (Phase 3)
CatalogStore	getCatalogStore()	Returns the Calcite-backed catalog store (Phase 3.5 integration).
TSQLColumn	getColumnInTable(String qualifiedTablename, String columnName)
ArrayList<String>	getColumnsInTable(String qualifiedTablename, boolean columnNameOnly)
static String	getDatabaseName(TObjectName schemaObjectName)
static String	getDatabaseName(String schemaObjectName)
EDbVendor	getDBVendor()	the database vendor where this SQL environment is generated from.
String	getDefaultCatalogName()	the current active catalog/database in the SQL environment.
String	getDefaultSchemaName()	the current schema name in the SQL environment.
String	getDefaultServerName()
IdentifierProfile	getIdentifierProfile()	Get IdentifierProfile (Phase 0)
IdentifierService	getIdentifierService()	Get IdentifierService (Phase 0)
int	getNumberOfTables()
static String	getObjectName(TObjectName schemaObjectName)
static String	getObjectName(String schemaObjectName)
String	getProcedureParameterValue(String procedureName, int paramPos)
static String	getSchemaName(TObjectName schemaObjectName)
static String	getSchemaName(String schemaObjectName)
TSQLCatalog	getSQLCatalog(String catalogName, boolean createIfNotExist)	get a catalog from the SQL environment if already exists, otherwise, create a new catalog.
TSQLSchema	getSQLSchema(String qualifiedSchemaName, boolean createIfNotExist)	get a schema from the specified catalog, if not exists, create a new schema in the catalog.
static String	getStmtSeparatorChar(EDbVendor dbVendor)
void	getVariableValue(String variableName, String variableValue)
abstract void	initSQLEnv()	This method must be override in the subclass to build a SQL environment with real metadata.
static boolean	isDelimitedIdentifier(EDbVendor dbVendor, String identifier)
boolean	isDelimitedIdentifier(String identifier)
boolean	isEnableGetMetadataFromDDL()	If this option is enabled, SQLEnv will collect table/view/function/procedure metadata from the create table/create view/create function/create procedure statement during the parse of the SQL script.
static boolean	isUsedBySqlflow()
static boolean	matchSubObjectNameToWhole(EDbVendor dbVendor, ESQLDataObjectType sqlDataObjectType, String sub, String whole)	比较 一个数据库对象名是否等于或者属于另一个对象 等于 就是完全相等（根据不同数据库的比较规则） 属于 表示如下情况： 1.
static String	normalizeIdentifier(EDbVendor dbVendor, ESQLDataObjectType sqlDataObjectType, String identifier)	1.
String	normalizeIdentifier(ESQLDataObjectType sqlDataObjectType, String identifier)
protected boolean	putSchemaObject(String schemaObjectName, TSQLSchemaObject schemaObject)	put a schema object into the hashmap which can be used to find a schema object in a more efficient way.
TSQLCatalog	searchCatalog(String catalogName)	search catalog in the catalog list, return null if not found.
TSQLFunction	searchFunction(TObjectName qualifiedTablename)
TSQLFunction	searchFunction(String qualifiedTablename)
protected TSQLSchemaObject	searchSchemaObject(TObjectName qualifiedName, ESQLDataObjectType objectType)
TSQLSchemaObject	searchSchemaObject(String qualifiedName, ESQLDataObjectType objectType)	Phase 1: 使用 IdentifierService 的新方法处理多段名
TSQLTable	searchTable(TObjectName tableName)
TSQLTable	searchTable(String qualifiedTablename)	find a table in the SQL environment by using a qualified table name: catalogName.schemaName.tableName
void	setDefaultCatalogName(String defaultCatalogName)
void	setDefaultSchemaName(String defaultSchemaName)
void	setDefaultServerName(String defaultServerName)
void	setEnableGetMetadataFromDDL(boolean enableGetMetadataFromDDL)
static boolean	supportCatalog(EDbVendor dbVendor)	Whether this database support catalog or not?
static boolean	supportSchema(EDbVendor dbVendor)	Whether this database support schema or not?
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

columnCollationCaseSensitive

public static final Map<EDbVendor,Boolean> columnCollationCaseSensitive

functionCollationCaseSensitive

public static final Map<EDbVendor,Boolean> functionCollationCaseSensitive

tableCollationCaseSensitive

public static final Map<EDbVendor,Boolean> tableCollationCaseSensitive

catalogCollationCaseSensitive

public static final Map<EDbVendor,Boolean> catalogCollationCaseSensitive

defaultCollationCaseSensitive

public static final Map<EDbVendor,Boolean> defaultCollationCaseSensitive

isAliasReferenceForbidden

public static final Map<EDbVendor,Boolean> isAliasReferenceForbidden

DEFAULT_SERVER_NAME

public static final String DEFAULT_SERVER_NAME

add a table

See Also:

• Constant Field Values

DEFAULT_DB_NAME

public static final String DEFAULT_DB_NAME

See Also:

• Constant Field Values

DEFAULT_SCHEMA_NAME

public static final String DEFAULT_SCHEMA_NAME

See Also:

• Constant Field Values

Constructor Details

TSQLEnv

public TSQLEnv(EDbVendor dbVendor)

create a SQL environment.

Parameters:

dbVendor - the database vendor

Method Details

getStmtSeparatorChar

public static String getStmtSeparatorChar(EDbVendor dbVendor)

supportSchema

public static boolean supportSchema(EDbVendor dbVendor)

Whether this database support schema or not?

Parameters:

dbVendor -

Returns:

supportCatalog

public static boolean supportCatalog(EDbVendor dbVendor)

Whether this database support catalog or not?

Parameters:

dbVendor -

Returns:

delimitedChar

public static String delimitedChar(EDbVendor dbVendor)

used to delimit a database identifier, such as [ used in SQL Server, ` used in MySQL

Parameters:

dbVendor -

Returns:

isDelimitedIdentifier

public static boolean isDelimitedIdentifier(EDbVendor dbVendor,
 String identifier)

endsWithDelimitedIdentifier

public static boolean endsWithDelimitedIdentifier(EDbVendor dbVendor,
 String identifier)

isDelimitedIdentifier

public boolean isDelimitedIdentifier(String identifier)

compareColumn

public boolean compareColumn(String ident1,
 String ident2)

compareTable

public boolean compareTable(String ident1,
 String ident2)

compareIdentifier

public boolean compareIdentifier(ESQLDataObjectType objectType,
 String ident1,
 String ident2)

compareColumn

public static boolean compareColumn(EDbVendor dbVendor,
 TObjectName sourceColumn,
 TObjectName targetColumn)

compareTable

public static boolean compareTable(EDbVendor dbVendor,
 TObjectName sourceTable,
 TObjectName targetTable)

compareQualifiedTable

public static boolean compareQualifiedTable(EDbVendor dbVendor,
 String sourceTable,
 String targetTable,
 String sourceSchema,
 String targetSchema,
 String sourceDatabase,
 String targetDatabase)

compareQualifiedColumn

public static boolean compareQualifiedColumn(EDbVendor dbVendor,
 String sourceColumn,
 String targetColumn,
 String sourceTable,
 String targetTable,
 String sourceSchema,
 String targetSchema,
 String sourceDatabase,
 String targetDatabase)

compareIdentifier

public static boolean compareIdentifier(EDbVendor dbVendor,
 ESQLDataObjectType objectType,
 TObjectName source,
 TObjectName target)

compareIdentifier

public static boolean compareIdentifier(EDbVendor dbVendor,
 ESQLDataObjectType objectType,
 String ident1,
 String ident2)

normalizeIdentifier

public String normalizeIdentifier(ESQLDataObjectType sqlDataObjectType,
 String identifier)

normalizeIdentifier

public static String normalizeIdentifier(EDbVendor dbVendor,
 ESQLDataObjectType sqlDataObjectType,
 String identifier)

1. remove delimited char if it's delimited/quoted identifier 2. change the case of the name in the same way as it saved to the information_schema

Parameters:

dbVendor -

sqlDataObjectType -

identifier -

Returns:

matchSubObjectNameToWhole

public static boolean matchSubObjectNameToWhole(EDbVendor dbVendor,
 ESQLDataObjectType sqlDataObjectType,
 String sub,
 String whole)

比较 一个数据库对象名是否等于或者属于另一个对象 等于 就是完全相等（根据不同数据库的比较规则） 属于 表示如下情况： 1. column1 -> 属于 -> table1.column1 2. table1 -> 属于 -> db1.schema1.table1 3. `schema1.table1` -> 属于 -> `db1`.`schema1`.`table1` 4. `schema1.table1` -> 不属于 -> `db1`.`schema2`.`table1`

Parameters:

sub -

whole -

Returns:

setEnableGetMetadataFromDDL

public void setEnableGetMetadataFromDDL(boolean enableGetMetadataFromDDL)

isEnableGetMetadataFromDDL

public boolean isEnableGetMetadataFromDDL()

If this option is enabled, SQLEnv will collect table/view/function/procedure metadata from the create table/create view/create function/create procedure statement during the parse of the SQL script.
A TSQLEnv object instance must be passed to TGSqlParser before parsing the SQL script. And this TSQLEnv instance can be passed to another TGSqlParser object with the collected database metadata.
Default value is true.

Returns:

getDBVendor

public EDbVendor getDBVendor()

the database vendor where this SQL environment is generated from.

Returns:

the database vendor

getCatalogStore

public CatalogStore getCatalogStore()

Returns the Calcite-backed catalog store (Phase 3.5 integration).

Note: This method delegates to the underlying CatalogStoreProvider. Direct access to CatalogStore is provided for backward compatibility with existing test code.

Returns:

the catalog store

getIdentifierService

public IdentifierService getIdentifierService()

Get IdentifierService (Phase 0)

Returns:

IdentifierService instance

getIdentifierProfile

public IdentifierProfile getIdentifierProfile()

Get IdentifierProfile (Phase 0)

Returns:

IdentifierProfile instance

getCatalogProvider

public ICatalogProvider getCatalogProvider()

Get ICatalogProvider (Phase 3)

Returns:

ICatalogProvider instance

initSQLEnv

public abstract void initSQLEnv()

This method must be override in the subclass to build a SQL environment with real metadata.
this usually done by querying the INFORMATION_SCHEMA

getCatalogList

public List<TSQLCatalog> getCatalogList()

a list of catalog/database in this SQL environment.

Returns:

a list of catalog/database

doAddCatalog

protected boolean doAddCatalog(TSQLCatalog sqlCatalog)

add a catalog to the SQL environment, called internally.

Parameters:

sqlCatalog - catalog

Returns:

return false if a catalog with the same name already exists.

putSchemaObject

protected boolean putSchemaObject(String schemaObjectName,
 TSQLSchemaObject schemaObject)

put a schema object into the hashmap which can be used to find a schema object in a more efficient way.

Parameters:

schemaObjectName - name of schema object

schemaObject - instance of a schema object

Returns:

always return true.

doSearchSchemaObject

protected TSQLSchemaObject doSearchSchemaObject(String catalog,
 String schema,
 String table,
 ESQLDataObjectType objectType)

searchSchemaObject

protected TSQLSchemaObject searchSchemaObject(TObjectName qualifiedName,
 ESQLDataObjectType objectType)

searchSchemaObject

public TSQLSchemaObject searchSchemaObject(String qualifiedName,
 ESQLDataObjectType objectType)

Phase 1: 使用 IdentifierService 的新方法处理多段名

searchTable

public TSQLTable searchTable(String qualifiedTablename)

find a table in the SQL environment by using a qualified table name: catalogName.schemaName.tableName

Parameters:

qualifiedTablename - , can be catalog.schema.table, or .schema.table, use currentCatalogName or iterate all catalogs or catalog..table, use current schema name or iterate all schema under catalog or ..table, use currentCatalogName or iterate all catalogs, use current schema or iterate all schema

Returns:

a table

searchTable

public TSQLTable searchTable(TObjectName tableName)

getDefaultCatalogName

public String getDefaultCatalogName()

the current active catalog/database in the SQL environment. If search a table in syntax like this: .schemaName.tableName and this current catalog name is not null, then, search the table in this syntax: currentCatalogName.schemaName.tableName. If the current catalog name is null, search all catalogs in the catalog list.

Returns:

the name of the current active catalog/database

getDefaultSchemaName

public String getDefaultSchemaName()

the current schema name in the SQL environment.
If search a table in syntax like this: catalogname..tableName and this current schema name is not null, then, search the table in this syntax: catalogName.currentSchemaName.tableName. If the current schema name is null, search all schemas under catalogName

Returns:

the default schema name

setDefaultCatalogName

public void setDefaultCatalogName(String defaultCatalogName)

setDefaultSchemaName

public void setDefaultSchemaName(String defaultSchemaName)

getDefaultServerName

public String getDefaultServerName()

setDefaultServerName

public void setDefaultServerName(String defaultServerName)

createSQLCatalog

public TSQLCatalog createSQLCatalog(String catalogName)

create a new catalog/database in the SQL environment.

Parameters:

catalogName - catalog name

Returns:

instance of the created catalog

getSQLCatalog

public TSQLCatalog getSQLCatalog(String catalogName,
 boolean createIfNotExist)

get a catalog from the SQL environment if already exists, otherwise, create a new catalog.

Parameters:

catalogName - catalog name

createIfNotExist - if this value is true, then create a new catalog if it's not exists

Returns:

a catalog instance

searchCatalog

public TSQLCatalog searchCatalog(String catalogName)

search catalog in the catalog list, return null if not found.

Parameters:

catalogName - catalog name

Returns:

null if not found.

createSQLSchema

public TSQLSchema createSQLSchema(String qualifiedSchemaName)

create a new schema and add to the catalog

Parameters:

qualifiedSchemaName - must be a qualified name like: catalog.schema. Otherwise, a null exception will be raised.

Returns:

a new schema instance

getSQLSchema

public TSQLSchema getSQLSchema(String qualifiedSchemaName,
 boolean createIfNotExist)

get a schema from the specified catalog, if not exists, create a new schema in the catalog.

Parameters:

qualifiedSchemaName - must be a qualified name like: catalog.schema. Otherwise, a null exception will be raised.

createIfNotExist - if this value is true, then create a new schema if it's not exists

Returns:

a schema instance

getColumnsInTable

public ArrayList<String> getColumnsInTable(String qualifiedTablename,
 boolean columnNameOnly)

Parameters:

qualifiedTablename - 需要完整的tablename，例如 catalog.schema.table, 如果仅传入 table name， 需要利用 default catalog, default schema 拼接完整的名称： catalog.schema.table

columnNameOnly -

Returns:

columnInTable

public boolean columnInTable(String qualifiedTablename,
 String columnName)

getColumnInTable

public TSQLColumn getColumnInTable(String qualifiedTablename,
 String columnName)

doAddSchemaObject

public TSQLSchemaObject doAddSchemaObject(String qualifiedObjectName,
 ESQLDataObjectType objectType)

doAddSchemaObject

public TSQLSchemaObject doAddSchemaObject(TObjectName qualifiedObjectName,
 ESQLDataObjectType objectType)

addFunction

public TSQLFunction addFunction(String qualifiedFunctionName,
 boolean fromDDL)

Add a function to SQLEnv, if a function with the same already exists, just return the existing one.

Parameters:

qualifiedFunctionName -

Returns:

function

addFunction

public TSQLFunction addFunction(TObjectName qualifiedFunctionName,
 boolean fromDDL)

addOraclePackage

public TSQLProcedure addOraclePackage(String qualifiedProcedureName,
 boolean fromDDL)

addProcedure

public TSQLProcedure addProcedure(String qualifiedProcedureName,
 boolean fromDDL)

addSQLRoutine

public TSQLRoutine addSQLRoutine(String qualifiedProcedureName,
 boolean fromDDL,
 ESQLDataObjectType type)

addTrigger

public TSQLTrigger addTrigger(String qualifiedTriggerName,
 boolean fromDDL)

addTable

public TSQLTable addTable(String qualifiedTableName,
 boolean fromDDL)

Add a new table to the SQLEnv. If the table with the same name already exists in the SQLEnv, the existing table will be returned.
dbName.schemaName.tablename. If dbName is not specified, getDefaultCatalogName() will be used to put this table in. If schemaName is not specified, getDefaultSchemaName() will be used to put this table in.
If the specified database and schema are not already exists, a new database/schema will be generated automatically.

Parameters:

qualifiedTableName - qualified table name

fromDDL - is this table generated from a create table statement

Returns:

SQL Table

addView

public TSQLTable addView(String qualifiedViewName,
 boolean fromDDL)

getObjectName

public static String getObjectName(TObjectName schemaObjectName)

getObjectName

public static String getObjectName(String schemaObjectName)

getDatabaseName

public static String getDatabaseName(TObjectName schemaObjectName)

getDatabaseName

public static String getDatabaseName(String schemaObjectName)

getSchemaName

public static String getSchemaName(TObjectName schemaObjectName)

getSchemaName

public static String getSchemaName(String schemaObjectName)

searchFunction

public TSQLFunction searchFunction(TObjectName qualifiedTablename)

searchFunction

public TSQLFunction searchFunction(String qualifiedTablename)

getAFullQualifiedSchemaObjectName

public String getAFullQualifiedSchemaObjectName(String schemaObjectName)

If the input name is fully qualified with db and schema, just return it without any modification. If the schema name is missed, use getDefaultSchemaName() instead If the database name is missed, use getDefaultCatalogName() instead some sample result:
db.schema.table .schema.table, getDefaultCatalogName() is null ..table, both getDefaultCatalogName() and getDefaultSchemaName() are null.

Parameters:

schemaObjectName -

Returns:

getNumberOfTables

public int getNumberOfTables()

toString

public String toString()

Overrides:

toString in class Object

getProcedureParameterValue

public String getProcedureParameterValue(String procedureName,
 int paramPos)

getVariableValue

public void getVariableValue(String variableName,
 String variableValue)

isUsedBySqlflow

public static boolean isUsedBySqlflow()