Package org.hibernate.engine.jdbc.env.spi

Interface ExtractedDatabaseMetaData

All Known Implementing Classes:

ExtractedDatabaseMetaDataImpl

public interface ExtractedDatabaseMetaData

Information extracted from DatabaseMetaData regarding what the JDBC driver reports as being supported or not. Obviously DatabaseMetaData reports many things, these are a few in which we have particular interest.

Method Summary

Modifier and Type	Method	Description
boolean	doesDataDefinitionCauseTransactionCommit()	Did the driver report to DDL statements performed within a transaction performing an implicit commit of the transaction.
String	getConnectionCatalogName()	Retrieve the name of the catalog in effect when we connected to the database.
String	getConnectionSchemaName()	Retrieve the name of the schema in effect when we connected to the database.
JdbcEnvironment	getJdbcEnvironment()	Obtain the JDBC Environment from which this metadata came.
default List<SequenceInformation>	getSequenceInformationList()	Retrieve the list of SequenceInformation objects which describe the underlying database sequences.
SQLStateType	getSqlStateType()	Retrieve the type of codes the driver says it uses for SQLState.
boolean	supportsBatchUpdates()	Did the driver report to supporting batched updates?
boolean	supportsDataDefinitionInTransaction()	Did the driver report to support performing DDL within transactions?
boolean	supportsGetGeneratedKeys()	Did the driver report to supporting retrieval of generated keys?
boolean	supportsNamedParameters()	Does the driver report supporting named parameters?
boolean	supportsRefCursors()	Does the driver report supporting Types.REF_CURSOR?
boolean	supportsScrollableResults()	Did the driver report to supporting scrollable result sets?

Method Details

getJdbcEnvironment

JdbcEnvironment getJdbcEnvironment()

Obtain the JDBC Environment from which this metadata came.

Returns:

The JDBC environment

getConnectionCatalogName

String getConnectionCatalogName()

Retrieve the name of the catalog in effect when we connected to the database.

Returns:

The catalog name

See Also:

• MappingSettings.DEFAULT_SCHEMA

getConnectionSchemaName

String getConnectionSchemaName()

Retrieve the name of the schema in effect when we connected to the database.

Returns:

The schema name

supportsNamedParameters

boolean supportsNamedParameters()

Does the driver report supporting named parameters?

Returns:

true indicates the driver reported true; false indicates the driver reported false or that the driver could not be asked.

See Also:

• QuerySettings.CALLABLE_NAMED_PARAMS_ENABLED

supportsRefCursors

boolean supportsRefCursors()

Does the driver report supporting Types.REF_CURSOR?

Returns:

true indicates the driver reported true; false indicates the driver reported false or that the driver could not be asked.

See Also:

• DatabaseMetaData.supportsRefCursors()
• Dialect.supportsRefCursors()

supportsScrollableResults

boolean supportsScrollableResults()

Did the driver report to supporting scrollable result sets?

Returns:

True if the driver reported to support ResultSet.TYPE_SCROLL_INSENSITIVE.

See Also:

• DatabaseMetaData.supportsResultSetType(int)
• JdbcSettings.USE_SCROLLABLE_RESULTSET

supportsGetGeneratedKeys

boolean supportsGetGeneratedKeys()

Did the driver report to supporting retrieval of generated keys?

Returns:

True if the driver reported to support calls to Statement.getGeneratedKeys()

See Also:

• DatabaseMetaData.supportsGetGeneratedKeys()
• JdbcSettings.USE_GET_GENERATED_KEYS

supportsBatchUpdates

boolean supportsBatchUpdates()

Did the driver report to supporting batched updates?

Returns:

True if the driver supports batched updates

See Also:

• DatabaseMetaData.supportsBatchUpdates()
• Dialect.supportsBatchUpdates()

supportsDataDefinitionInTransaction

boolean supportsDataDefinitionInTransaction()

Did the driver report to support performing DDL within transactions?

Returns:

True if the drivers supports DDL statements within transactions.

See Also:

• DatabaseMetaData.dataDefinitionIgnoredInTransactions()

doesDataDefinitionCauseTransactionCommit

boolean doesDataDefinitionCauseTransactionCommit()

Did the driver report to DDL statements performed within a transaction performing an implicit commit of the transaction.

Returns:

True if the driver/database performs an implicit commit of transaction when DDL statement is performed

See Also:

• DatabaseMetaData.dataDefinitionCausesTransactionCommit()

getSqlStateType

SQLStateType getSqlStateType()

Retrieve the type of codes the driver says it uses for SQLState. They might follow either the X/Open standard or the SQL92 standard.

Returns:

The SQLState strategy reportedly used by this driver/database.

See Also:

• DatabaseMetaData.getSQLStateType()

getSequenceInformationList

default List<SequenceInformation> getSequenceInformationList()

Retrieve the list of SequenceInformation objects which describe the underlying database sequences.

Returns:

SequenceInformation objects.