Package org.hibernate.tool.schema.extract.internal

Class InformationExtractorJdbcDatabaseMetaDataImpl

java.lang.Object

org.hibernate.tool.schema.extract.internal.AbstractInformationExtractorImpl

org.hibernate.tool.schema.extract.internal.InformationExtractorJdbcDatabaseMetaDataImpl

All Implemented Interfaces:

InformationExtractor

public class InformationExtractorJdbcDatabaseMetaDataImpl
extends AbstractInformationExtractorImpl

Implementation of the InformationExtractor contract which uses the standard JDBC DatabaseMetaData API for extraction.

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.tool.schema.extract.internal.AbstractInformationExtractorImpl

AbstractInformationExtractorImpl.ForeignKeyBuilder, AbstractInformationExtractorImpl.ForeignKeyBuilderImpl

Constructor Summary

Constructors

Constructor	Description
InformationExtractorJdbcDatabaseMetaDataImpl(ExtractionContext extractionContext)

Method Summary

Modifier and Type	Method	Description
protected void	addColumns(TableInformation tableInformation)
protected String	getResultSetTableTypesPhysicalTableConstant()
<T> T	processCatalogsResultSet(ExtractionContext.ResultSetProcessor<T> processor)	Must do the following: obtain a ResultSet containing a column of existing catalog names.
protected <T> T	processColumnsResultSet(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern, ExtractionContext.ResultSetProcessor<T> 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.
protected <T> T	processCrossReferenceResultSet(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable, ExtractionContext.ResultSetProcessor<T> processor)	Must do the following: obtain a ResultSet containing a row for each foreign key column making up a foreign key for any existing foreignCatalog/foreignSchema/foreignTable combination as specified by parameters described below.
protected <T> T	processImportedKeysResultSet(String catalog, String schema, String table, ExtractionContext.ResultSetProcessor<T> 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.
protected <T> T	processIndexInfoResultSet(String catalog, String schema, String table, boolean unique, boolean approximate, ExtractionContext.ResultSetProcessor<T> processor)	Must do the following: obtain a ResultSet containing a row for each column defined in an index.
protected <T> T	processPrimaryKeysResultSet(String catalogFilter, String schemaFilter, Identifier tableName, ExtractionContext.ResultSetProcessor<T> processor)
protected <T> T	processSchemaResultSet(String catalog, String schemaPattern, ExtractionContext.ResultSetProcessor<T> 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.
protected <T> T	processTableResultSet(String catalog, String schemaPattern, String tableNamePattern, String[] types, ExtractionContext.ResultSetProcessor<T> 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.

Methods inherited from class org.hibernate.tool.schema.extract.internal.AbstractInformationExtractorImpl

addExtractedColumnInformation, catalogExists, convertSQLException, determineCatalogFilter, determineSchemaFilter, getExtractionContext, getForeignKeys, getIndexes, getPrimaryKey, getResultSetCatalogLabel, getResultSetColumnNameLabel, getResultSetColumnPositionColumn, getResultSetColumnSizeLabel, getResultSetDecimalDigitsLabel, getResultSetForeignKeyColumnNameLabel, getResultSetForeignKeyLabel, getResultSetIndexNameLabel, getResultSetIndexTypeLabel, getResultSetIsNullableLabel, getResultSetPrimaryKeyCatalogLabel, getResultSetPrimaryKeyColumnNameLabel, getResultSetPrimaryKeyNameLabel, getResultSetPrimaryKeySchemaLabel, getResultSetPrimaryKeyTableLabel, getResultSetRemarksLabel, getResultSetSchemaLabel, getResultSetSqlTypeCodeLabel, getResultSetTableNameLabel, getResultSetTableTypeLabel, getResultSetTypeNameLabel, getTable, getTables, identifierHelper, interpretNullable, isPhysicalTableType, schemaExists, toMetaDataObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

InformationExtractorJdbcDatabaseMetaDataImpl

public InformationExtractorJdbcDatabaseMetaDataImpl(ExtractionContext extractionContext)

Method Detail

getResultSetTableTypesPhysicalTableConstant

protected String getResultSetTableTypesPhysicalTableConstant()

Specified by:

getResultSetTableTypesPhysicalTableConstant in class AbstractInformationExtractorImpl

processCatalogsResultSet

public <T> T processCatalogsResultSet(ExtractionContext.ResultSetProcessor<T> processor)
                               throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

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

Specified by:

processCatalogsResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processSchemaResultSet

protected <T> T processSchemaResultSet(String catalog,
                                       String schemaPattern,
                                       ExtractionContext.ResultSetProcessor<T> processor)
                                throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. 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;
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The catalog and schemaPattern parameters are as specified by DatabaseMetaData.getSchemas(String, String), and are copied here:

Specified by:

processSchemaResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

catalog - – 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.

schemaPattern - – 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.

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processTableResultSet

protected <T> T processTableResultSet(String catalog,
                                      String schemaPattern,
                                      String tableNamePattern,
                                      String[] types,
                                      ExtractionContext.ResultSetProcessor<T> processor)
                               throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. 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 AbstractInformationExtractorImpl.getResultSetTableNameLabel() for table name
   • column label AbstractInformationExtractorImpl.getResultSetTableTypeLabel() for table type
   • column label AbstractInformationExtractorImpl.getResultSetRemarksLabel() for table comment
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The catalog, schemaPattern, tableNamePattern, and columnNamePattern parameters are as specified by DatabaseMetaData.getTables(String, String, String, String[]), and are copied here:

Specified by:

processTableResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

catalog - - 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

schemaPattern - - 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

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

types - - a list of table types

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processColumnsResultSet

protected <T> T processColumnsResultSet(String catalog,
                                        String schemaPattern,
                                        String tableNamePattern,
                                        String columnNamePattern,
                                        ExtractionContext.ResultSetProcessor<T> processor)
                                 throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. 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(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
   • column label AbstractInformationExtractorImpl.getResultSetTableNameLabel() for table name
   • column label AbstractInformationExtractorImpl.getResultSetColumnNameLabel() for column name
   • column label AbstractInformationExtractorImpl.getResultSetSqlTypeCodeLabel() SQL type code from java.sql.Types
   • column label AbstractInformationExtractorImpl.getResultSetTypeNameLabel() for database column type name
   • column label AbstractInformationExtractorImpl.getResultSetColumnSizeLabel() for column size
   • column label AbstractInformationExtractorImpl.getResultSetDecimalDigitsLabel() for number of fractional digits
   • column label AbstractInformationExtractorImpl.getResultSetIsNullableLabel() for nullability
   Rows must be ordered by catalog, schema, table name, and column position.
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The catalog, schemaPattern, tableNamePattern, and columnNamePattern parameters are as specified by DatabaseMetaData.getColumns(String, String, String, String), and are copied here:

Specified by:

processColumnsResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

catalog - – 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

schemaPattern - – 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

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

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

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processPrimaryKeysResultSet

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

Specified by:

processPrimaryKeysResultSet in class AbstractInformationExtractorImpl

Throws:

SQLException

processIndexInfoResultSet

protected <T> T processIndexInfoResultSet(String catalog,
                                          String schema,
                                          String table,
                                          boolean unique,
                                          boolean approximate,
                                          ExtractionContext.ResultSetProcessor<T> processor)
                                   throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. 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 AbstractInformationExtractorImpl.getResultSetIndexNameLabel() for index name; null when TYPE is tableIndexStatistic
   • column label AbstractInformationExtractorImpl.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.
     Note that Hibernate ignores statistics and does not care about the actual type of index.
   • column label AbstractInformationExtractorImpl.getResultSetColumnNameLabel() - column name; null when TYPE is DatabaseMetaData.tableIndexStatistic
   The ResultSet must be ordered so that the columns for a particular index are in contiguous rows in order of column position.
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The catalog, schemaPattern, tableNamePattern, and columnNamePattern parameters are as specified by DatabaseMetaData.getIndexInfo(String, String, String, boolean, boolean), and are copied here:

Specified by:

processIndexInfoResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

catalog - – 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

schema - – 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

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

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

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

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processImportedKeysResultSet

protected <T> T processImportedKeysResultSet(String catalog,
                                             String schema,
                                             String table,
                                             ExtractionContext.ResultSetProcessor<T> processor)
                                      throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. 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(java.lang.String, java.lang.String, java.lang.String):
   • column label AbstractInformationExtractorImpl.getResultSetForeignKeyLabel() - foreign key name (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyCatalogLabel() - primary key table catalog being imported (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeySchemaLabel() - primary key table schema being imported (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyTableLabel() - primary key table name being imported
   • column label AbstractInformationExtractorImpl.getResultSetForeignKeyColumnNameLabel() - foreign key column name
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyColumnNameLabel() - primary key column name being imported
   The ResultSet must be ordered by the primary key catalog/schema/table and column position within the key.
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The catalog, schema, and table parameters are as specified by DatabaseMetaData.getImportedKeys(String, String, String) and are copied here:

Specified by:

processImportedKeysResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

catalog - – 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

schema - – 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

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

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

processCrossReferenceResultSet

protected <T> T processCrossReferenceResultSet(String parentCatalog,
                                               String parentSchema,
                                               String parentTable,
                                               String foreignCatalog,
                                               String foreignSchema,
                                               String foreignTable,
                                               ExtractionContext.ResultSetProcessor<T> processor)
                                        throws SQLException

Description copied from class: AbstractInformationExtractorImpl

Must do the following:

1. obtain a ResultSet containing a row for each foreign key column making up a foreign key for any existing foreignCatalog/foreignSchema/foreignTable combination as specified by parameters described below. The ResultSet must contain the following, consistent with the corresponding columns returned by DatabaseMetaData.getCrossReference(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String):
   • column label AbstractInformationExtractorImpl.getResultSetForeignKeyLabel() - foreign key name (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyCatalogLabel() - primary key table catalog being imported (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeySchemaLabel() - primary key table schema being imported (may be null)
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyTableLabel() - primary key table name being imported
   • column label AbstractInformationExtractorImpl.getResultSetForeignKeyColumnNameLabel() - foreign key column name
   • column label AbstractInformationExtractorImpl.getResultSetPrimaryKeyColumnNameLabel() - primary key column name being imported
   The ResultSet must be ordered by the primary key foreignCatalog/foreignSchema/foreignTable and column position within the key.
2. execute processor.process( resultSet );
3. release resources whether processor.process( resultSet ) executes successfully or not.

The parentCatalog, parentSchema, parentTable, foreignCatalog, foreignSchema, foreignTable parameters are as specified by DatabaseMetaData.getCrossReference( String, String, String, String, String, String) and are copied here:

Specified by:

processCrossReferenceResultSet in class AbstractInformationExtractorImpl

Type Parameters:

T - - defined by processor

Parameters:

parentCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

parentSchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria

parentTable - the name of the table that exports the key; must match the table name as it is stored in the database

foreignCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

foreignSchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria

foreignTable - the name of the table that imports the key; must match the table name as it is stored in the database

processor - - the provided ResultSetProcessor.

Returns:

- defined by processor

Throws:

SQLException - - if a database error occurs

See Also:

AbstractInformationExtractorImpl.processImportedKeysResultSet(String, String, String, ExtractionContext.ResultSetProcessor)

addColumns

protected void addColumns(TableInformation tableInformation)

Overrides:

addColumns in class AbstractInformationExtractorImpl