Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.tool.schema.extract.internal.AbstractInformationExtractorImpl

Modifier and Type	Class and Description
protected static interface	AbstractInformationExtractorImpl.ForeignKeyBuilder
protected static class	AbstractInformationExtractorImpl.ForeignKeyBuilderImpl

Modifier and Type	Field and Description
private Identifier	currentCatalog
private String	currentCatalogFilter
private Identifier	currentSchema
private String	currentSchemaFilter
private final ExtractionContext	extractionContext
private String[]	extraPhysicalTableTypes
private static final CoreMessageLogger	LOG
private final String[]	tableTypes
private final boolean	useJdbcMetadataDefaultsSetting

Access	Constructor and Description
public	AbstractInformationExtractorImpl(ExtractionContext extractionContext)

Modifier and Type	Method and Description
protected void	addColumns(TableInformation tableInformation)
protected void	addExtractedColumnInformation(TableInformation tableInformation, ResultSet resultSet)
public boolean	catalogExists(Identifier The name of the catalog to look for. catalog) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.catalogExists. Does the given catalog exist yet?
protected JDBCException	convertSQLException(SQLException sqlException, String message)
protected String	determineCatalogFilter(Identifier catalog)
protected String	determineSchemaFilter(Identifier schema)
private NameSpaceTablesInformation	extractNameSpaceTablesInformation(ResultSet resultSet)
private PrimaryKeyInformation	extractPrimaryKeyInformation(TableInformation tableInformation, ResultSet resultSet)
private QualifiedTableName	extractPrimaryKeyTableName(ResultSet resultSet)
private TableInformation	extractTableInformation(ResultSet resultSet)
private TableInformation	extractTableInformation(Identifier catalog, Identifier schema, Identifier tableName, ResultSet resultSet)
private QualifiedTableName	extractTableName(ResultSet resultSet)
private AbstractInformationExtractorImpl.ForeignKeyBuilder	generateForeignKeyBuilder(Identifier fkIdentifier)
private Identifier	getCurrentCatalog(JdbcEnvironment jdbcEnvironment)
private String	getCurrentCatalogFilter(JdbcEnvironment jdbcEnvironment)
private Identifier	getCurrentSchema(JdbcEnvironment jdbcEnvironment)
private String	getCurrentSchemaFilter(JdbcEnvironment jdbcEnvironment)
protected ExtractionContext	getExtractionContext()
public Iterable<ForeignKeyInformation>	getForeignKeys(TableInformation The table for which to locate foreign-keys tableInformation) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getForeignKeys. Extract information about foreign keys defined on the given table (targeting or point-at other tables).
public Iterable<IndexInformation>	getIndexes(TableInformation The table for which to locate indexes tableInformation) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getIndexes. Extract information about indexes defined against the given table.
public PrimaryKeyInformation	getPrimaryKey(TableInformationImpl The table for which to locate primary key information, tableInformation) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getPrimaryKey. Extract information about the given table's primary key.
protected String	getResultSetCatalogLabel()
protected String	getResultSetColumnNameLabel()
protected String	getResultSetColumnPositionColumn()
protected String	getResultSetColumnSizeLabel()
protected String	getResultSetDecimalDigitsLabel()
protected String	getResultSetForeignKeyColumnNameLabel()
protected String	getResultSetForeignKeyLabel()
protected String	getResultSetIndexNameLabel()
protected String	getResultSetIndexTypeLabel()
protected String	getResultSetIsNullableLabel()
protected String	getResultSetPrimaryKeyCatalogLabel()
protected String	getResultSetPrimaryKeyColumnNameLabel()
protected String	getResultSetPrimaryKeyNameLabel()
protected String	getResultSetPrimaryKeySchemaLabel()
protected String	getResultSetPrimaryKeyTableLabel()
protected String	getResultSetRemarksLabel()
protected String	getResultSetSchemaLabel()
protected String	getResultSetSqlTypeCodeLabel()
protected String	getResultSetTableNameLabel()
protected String	getResultSetTableTypeLabel()
protected abstract String	getResultSetTableTypesPhysicalTableConstant()
protected String	getResultSetTypeNameLabel()
public TableInformation	getTable(Identifier Can be `null`, indicating that any catalog may be considered a match. A non-`null` value indicates that search should be limited to the passed catalog. catalog, Identifier Can be `null`, indicating that any schema may be considered a match. A non-`null` value indicates that search should be limited to the passed schema . schema, Identifier The name of the table to look for. tableName) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getTable. Look for a matching table.
public NameSpaceTablesInformation	getTables(Identifier Can be `null`, indicating that any catalog may be considered a match. A non-`null` value indicates that search should be limited to the passed catalog. catalog, Identifier Can be `null`, indicating that any schema may be considered a match. A non-`null` value indicates that search should be limited to the passed schema . schema) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getTables. Extract all the tables information.
protected IdentifierHelper	identifierHelper()
protected TruthValue	interpretNullable(int nullable)
private TruthValue	interpretTruthValue(String nullable)
protected boolean	isPhysicalTableType(String tableType)
private TableInformation	locateTableInNamespace(Identifier catalog, Identifier schema, Identifier tableName)
private void	populateTablesWithColumns(String catalogFilter, String schemaFilter, NameSpaceTablesInformation tables)
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processCatalogsResultSet(ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a column of existing catalog names. The column label must be the same as returned by `getResultSetCatalogLabel`. execute `processor.process( resultSet )`; release resources whether `processor.process( resultSet )` executes successfully or not.
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processColumnsResultSet(String – a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search catalog, String – a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search schemaPattern, String – a table name pattern; must match the table name as it is stored in the database tableNamePattern, String – a column name pattern; must match the column name as it is stored in the database columnNamePattern, ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a row for any existing catalog/schema/table/column combination as specified by the `catalog`, `schemaPattern`, `tableNamePattern`, and `columnNamePattern` parameters described below. The `ResultSet` must contain the following, consistent with the corresponding columns returned by `DatabaseMetaData#getColumns` column label `getResultSetTableNameLabel` for table name column label `getResultSetColumnNameLabel` for column name column label `getResultSetSqlTypeCodeLabel` SQL type code from java.sql.Types column label `getResultSetTypeNameLabel` for database column type name column label `getResultSetColumnSizeLabel` for column size column label `getResultSetDecimalDigitsLabel` for number of fractional digits column label `getResultSetIsNullableLabel` for nullability
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processImportedKeysResultSet(String – a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search catalog, String – a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search schema, String – a table name; must match the table name as it is stored in the database table, ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a row for each foreign key/ primary key column making up a foreign key for any existing catalog/schema/table combination as specified by the `catalog`, `schema`, and `table` parameters described below. The `ResultSet` must contain the following, consistent with the corresponding columns returned by `DatabaseMetaData#getImportedKeys`: column label `getResultSetForeignKeyLabel` - foreign key name (may be null) column label `getResultSetPrimaryKeyCatalogLabel` - primary key table catalog being imported (may be null) column label `getResultSetPrimaryKeySchemaLabel` - primary key table schema being imported (may be null) column label `getResultSetPrimaryKeyTableLabel` - primary key table name being imported column label `getResultSetForeignKeyColumnNameLabel` - foreign key column name column label `getResultSetPrimaryKeyColumnNameLabel` - primary key column name being imported
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processIndexInfoResultSet(String – a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search catalog, String – a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search schema, String – a table name; must match the table name as it is stored in this database table, boolean – when true, return only indices for unique values; when false, return indices regardless of whether unique or not unique, boolean – when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate approximate, ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a row for each column defined in an index. The `ResultSet` must contain the following, consistent with the corresponding columns returned by `DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)` column label `getResultSetIndexNameLabel` for index name; null when TYPE is tableIndexStatistic column label `getResultSetIndexTypeLabel` index type: `DatabaseMetaData#tableIndexStatistic` - this identifies table statistics that are returned in conjunction with a table's index descriptions Any value other than `DatabaseMetaData#tableIndexStatistic` - this indicates that a table's index description (not statisics) is being returned.
protected abstract <T> T	processPrimaryKeysResultSet(String catalogFilter, String schemaFilter, Identifier tableName, ExtractionContext.ResultSetProcessor<T> processor)
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processSchemaResultSet(String – a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means catalog name should not be used to narrow down the search. catalog, String – a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search. schemaPattern, ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a row for any existing catalog/schema combination as specified by the `catalog` and `schemaPattern` parameters described below. The row contents will not be examined by `processor.process( resultSet )`, so column label names are not specified; execute `processor.process( resultSet )`; release resources whether `processor.process( resultSet )` executes successfully or not.
protected abstract < - defined by `processor` T> T	Returns: - defined by `processor` processTableResultSet(String - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search catalog, String - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search schemaPattern, String - a table name pattern; must match the table name as it is stored in the database tableNamePattern, String[] - a list of table types types, ExtractionContext.ResultSetProcessor<T> - the provided ResultSetProcessor. processor) Must do the following: obtain a `ResultSet` containing a row for any existing catalog/schema/table/table type combination as specified by the `catalogFilter`, `schemaFilter`, `tableNameFilter`, and `tableTypes` parameters described below. The `ResultSet` must contain the following, consistent with the corresponding columns returned by `DatabaseMetaData#getTables(String, String, String, String[])` column label `getResultSetTableNameLabel` for table name column label `getResultSetTableTypeLabel` for table type column label `getResultSetRemarksLabel` for table comment
public boolean	schemaExists(Identifier The name of the catalog to look in. catalog, Identifier The name of the schema to look for. schema) Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.schemaExists. Does the given schema exist yet?
protected String	toMetaDataObjectName(Identifier identifier)

protected void

addColumns(TableInformation tableInformation)

protected void

addExtractedColumnInformation(TableInformation tableInformation, ResultSet resultSet)

public boolean

catalogExists(Identifier

The name of the catalog to look for.

catalog)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.catalogExists.

Does the given catalog exist yet?

protected JDBCException

convertSQLException(SQLException sqlException, String message)

protected String

determineCatalogFilter(Identifier catalog)

protected String

determineSchemaFilter(Identifier schema)

private NameSpaceTablesInformation

extractNameSpaceTablesInformation(ResultSet resultSet)

private PrimaryKeyInformation

extractPrimaryKeyInformation(TableInformation tableInformation, ResultSet resultSet)

private QualifiedTableName

extractPrimaryKeyTableName(ResultSet resultSet)

private TableInformation

extractTableInformation(ResultSet resultSet)

private TableInformation

extractTableInformation(Identifier catalog, Identifier schema, Identifier tableName, ResultSet resultSet)

private QualifiedTableName

extractTableName(ResultSet resultSet)

private AbstractInformationExtractorImpl.ForeignKeyBuilder

generateForeignKeyBuilder(Identifier fkIdentifier)

private Identifier

getCurrentCatalog(JdbcEnvironment jdbcEnvironment)

private String

getCurrentCatalogFilter(JdbcEnvironment jdbcEnvironment)

private Identifier

getCurrentSchema(JdbcEnvironment jdbcEnvironment)

private String

getCurrentSchemaFilter(JdbcEnvironment jdbcEnvironment)

protected ExtractionContext

getExtractionContext()

public Iterable<ForeignKeyInformation>

getForeignKeys(TableInformation

The table for which to locate foreign-keys

tableInformation)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getForeignKeys.

Extract information about foreign keys defined on the given table (targeting or point-at other tables).

public Iterable<IndexInformation>

getIndexes(TableInformation

The table for which to locate indexes

tableInformation)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getIndexes.

Extract information about indexes defined against the given table.

public PrimaryKeyInformation

getPrimaryKey(TableInformationImpl

The table for which to locate primary key information,

tableInformation)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getPrimaryKey.

Extract information about the given table's primary key.

protected String

getResultSetCatalogLabel()

protected String

getResultSetColumnNameLabel()

protected String

getResultSetColumnPositionColumn()

protected String

getResultSetColumnSizeLabel()

protected String

getResultSetDecimalDigitsLabel()

protected String

getResultSetForeignKeyColumnNameLabel()

protected String

getResultSetForeignKeyLabel()

protected String

getResultSetIndexNameLabel()

protected String

getResultSetIndexTypeLabel()

protected String

getResultSetIsNullableLabel()

protected String

getResultSetPrimaryKeyCatalogLabel()

protected String

getResultSetPrimaryKeyColumnNameLabel()

protected String

getResultSetPrimaryKeyNameLabel()

protected String

getResultSetPrimaryKeySchemaLabel()

protected String

getResultSetPrimaryKeyTableLabel()

protected String

getResultSetRemarksLabel()

protected String

getResultSetSchemaLabel()

protected String

getResultSetSqlTypeCodeLabel()

protected String

getResultSetTableNameLabel()

protected String

getResultSetTableTypeLabel()

protected abstract String

getResultSetTableTypesPhysicalTableConstant()

protected String

getResultSetTypeNameLabel()

public TableInformation

getTable(Identifier

Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.

catalog, Identifier

Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .

schema, Identifier

The name of the table to look for.

tableName)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getTable.

Look for a matching table.

public NameSpaceTablesInformation

getTables(Identifier

Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.

catalog, Identifier

Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .

schema)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.getTables.

Extract all the tables information.

protected IdentifierHelper

identifierHelper()

protected TruthValue

interpretNullable(int nullable)

private TruthValue

interpretTruthValue(String nullable)

protected boolean

isPhysicalTableType(String tableType)

private TableInformation

locateTableInNamespace(Identifier catalog, Identifier schema, Identifier tableName)

private void

populateTablesWithColumns(String catalogFilter, String schemaFilter, NameSpaceTablesInformation tables)

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processCatalogsResultSet(ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a column of existing catalog names. The column label must be the same as returned by getResultSetCatalogLabel.
execute processor.process( resultSet );
release resources whether processor.process( resultSet ) executes successfully or not.

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processColumnsResultSet(String

– a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

catalog, String

– a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

schemaPattern, String

– a table name pattern; must match the table name as it is stored in the database

tableNamePattern, String

– a column name pattern; must match the column name as it is stored in the database

columnNamePattern, ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a row for any existing catalog/schema/table/column combination as specified by the catalog, schemaPattern, tableNamePattern, and columnNamePattern parameters described below. The ResultSet must contain the following, consistent with the corresponding columns returned by DatabaseMetaData#getColumns
- column label getResultSetTableNameLabel for table name
- column label getResultSetColumnNameLabel for column name
- column label getResultSetSqlTypeCodeLabel SQL type code from java.sql.Types
- column label getResultSetTypeNameLabel for database column type name
- column label getResultSetColumnSizeLabel for column size
- column label getResultSetDecimalDigitsLabel for number of fractional digits
- column label getResultSetIsNullableLabel for nullability

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processImportedKeysResultSet(String

– a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

catalog, String

– a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

schema, String

– a table name; must match the table name as it is stored in the database

table, ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a row for each foreign key/ primary key column making up a foreign key for any existing catalog/schema/table combination as specified by the catalog, schema, and table parameters described below. The ResultSet must contain the following, consistent with the corresponding columns returned by DatabaseMetaData#getImportedKeys:
- column label getResultSetForeignKeyLabel - foreign key name (may be null)
- column label getResultSetPrimaryKeyCatalogLabel - primary key table catalog being imported (may be null)
- column label getResultSetPrimaryKeySchemaLabel - primary key table schema being imported (may be null)
- column label getResultSetPrimaryKeyTableLabel - primary key table name being imported
- column label getResultSetForeignKeyColumnNameLabel - foreign key column name
- column label getResultSetPrimaryKeyColumnNameLabel - primary key column name being imported

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processIndexInfoResultSet(String

– a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

catalog, String

– a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

schema, String

– a table name; must match the table name as it is stored in this database

table, boolean

– when true, return only indices for unique values; when false, return indices regardless of whether unique or not

unique, boolean

– when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate

approximate, ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a row for each column defined in an index. The ResultSet must contain the following, consistent with the corresponding columns returned by DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)
- column label getResultSetIndexNameLabel for index name; null when TYPE is tableIndexStatistic
- column label getResultSetIndexTypeLabel index type:
  - DatabaseMetaData#tableIndexStatistic - this identifies table statistics that are returned in conjunction with a table's index descriptions
  - Any value other than DatabaseMetaData#tableIndexStatistic - this indicates that a table's index description (not statisics) is being returned.

protected abstract <T> T

processPrimaryKeysResultSet(String catalogFilter, String schemaFilter, Identifier tableName, ExtractionContext.ResultSetProcessor<T> processor)

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processSchemaResultSet(String

– a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means catalog name should not be used to narrow down the search.

catalog, String

– a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search.

schemaPattern, ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a row for any existing catalog/schema combination as specified by the catalog and schemaPattern parameters described below. The row contents will not be examined by processor.process( resultSet ), so column label names are not specified;
execute processor.process( resultSet );
release resources whether processor.process( resultSet ) executes successfully or not.

protected abstract <

- defined by processor

T> T

Returns:

- defined by processor

processTableResultSet(String

- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

catalog, String

- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

schemaPattern, String

- a table name pattern; must match the table name as it is stored in the database

tableNamePattern, String[]

- a list of table types

types, ExtractionContext.ResultSetProcessor<T>

- the provided ResultSetProcessor.

processor)

Must do the following:

obtain a ResultSet containing a row for any existing catalog/schema/table/table type combination as specified by the catalogFilter, schemaFilter, tableNameFilter, and tableTypes parameters described below. The ResultSet must contain the following, consistent with the corresponding columns returned by DatabaseMetaData#getTables(String, String, String, String[])
- column label getResultSetTableNameLabel for table name
- column label getResultSetTableTypeLabel for table type
- column label getResultSetRemarksLabel for table comment

public boolean

schemaExists(Identifier

The name of the catalog to look in.

catalog, Identifier

The name of the schema to look for.

schema)

Implements org.hibernate.tool.schema.extract.spi.InformationExtractor.schemaExists.

Does the given schema exist yet?

protected String

toMetaDataObjectName(Identifier identifier)

public abstract Class AbstractInformationExtractorImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary