public Interface JdbcSettings

Controls the autocommit mode of JDBC connections obtained from any ConnectionProvider implementation which respects this setting, which the built-in implementations do, except for org.hibernate.engine.jdbc.connections.internal.DatasourceConnectionProviderImpl.

Specifies how Hibernate should manage JDBC connections in terms of acquisition and release, either:

• an instance of the enumeration org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode, or
• the name of one of its instances.

The default is DELAYED_ACQUISITION_AND_RELEASE_AFTER_TRANSACTION.

Since

5.2

See Also

org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode, org.hibernate.boot.SessionFactoryBuilder#applyConnectionHandlingMode(PhysicalConnectionHandlingMode)

A prefix for properties specifying arbitrary JDBC connection properties. These properties are simply passed along to the provider when creating a connection.

For example, declaring hibernate.connection.foo=bar tells Hibernate to append foo=bar to the JDBC connection URL.

Specifies a ConnectionProvider to use for obtaining JDBC connections, either:

• an instance of ConnectionProvider,
• a Class representing a class that implements ConnectionProvider, or
• the name of a class that implements ConnectionProvider.

The term "class" appears in the setting name due to legacy reasons; however it can accept instances.

Indicates that Connections obtained from the configured ConnectionProvider have auto-commit already disabled when they are acquired.

It is inappropriate to set this value to true when the Connections returned by the provider do not, in fact, have auto-commit disabled. Doing so may lead to Hibernate executing SQL operations outside the scope of any transaction.

Since

5.2.10

See Also

org.hibernate.boot.SessionFactoryBuilder#applyConnectionProviderDisablesAutoCommit(boolean)

Specifies the Hibernate SQL dialect, either

• an instance of org.hibernate.dialect.Dialect,
• a Class representing a class that extends Dialect, or
• the name of a class that extends Dialect.

By default, Hibernate will attempt to automatically determine the dialect from the JDBC URL and JDBC metadata, so this setting is not usually necessary.

See Also

org.hibernate.dialect.Dialect

Controls whether to use JDBC markers (`?`) or dialect native markers for parameters within preparable SQL statements.

Specifies additional org.hibernate.engine.jdbc.dialect.spi.DialectResolver implementations to register with the standard org.hibernate.engine.jdbc.dialect.spi.DialectFactory.

Enables formatting of SQL logged to the console.

Enables highlighting of SQL logged to the console using ANSI escape codes.

Specified the JDBC transaction isolation level.

Allows passing a specific java.sql.Connection instance to be used by org.hibernate.tool.schema.spi.SchemaManagementTool for the purpose of determining the org.hibernate.dialect.Dialect, and for performing database actions if requested.

For Dialect resolution, jakarta.persistence.database-product-name and, optionally, jakarta.persistence.database-product-version, jakarta.persistence.database-major-version, and jakarta.persistence.database-minor-version can be used instead

See Also

JAKARTA_HBM2DDL_DB_NAME, JAKARTA_HBM2DDL_DB_VERSION, JAKARTA_HBM2DDL_DB_MAJOR_VERSION, JAKARTA_HBM2DDL_DB_MINOR_VERSION

Used in conjunction with jakarta.persistence.database-product-name for the purpose of determining the org.hibernate.dialect.Dialect to use when the name does not provide enough detail.

The value is expected to match what would be returned from java.sql.DatabaseMetaData#getDatabaseMajorVersion()) for the underlying database.

See Also

JAKARTA_HBM2DDL_DB_NAME

Used in conjunction with jakarta.persistence.database-product-name for the purpose of determining the org.hibernate.dialect.Dialect to use when the name does not provide enough detail.

The value is expected to match what would be returned from java.sql.DatabaseMetaData#getDatabaseMinorVersion()) for the underlying database.

See Also

JAKARTA_HBM2DDL_DB_NAME

Specifies the name of the database vendor (as would be reported by java.sql.DatabaseMetaData#getDatabaseProductName) for the purpose of determining the org.hibernate.dialect.Dialect to use.

For cases when the name of the database vendor is not enough alone, a combination of jakarta.persistence.database-product-version, jakarta.persistence.database-major-version jakarta.persistence.database-minor-version can be used instead

See Also

JAKARTA_HBM2DDL_DB_VERSION, JAKARTA_HBM2DDL_DB_MAJOR_VERSION, JAKARTA_HBM2DDL_DB_MINOR_VERSION

Used in conjunction with jakarta.persistence.database-product-name for the purpose of determining the org.hibernate.dialect.Dialect to use when the name does not provide enough detail.

The value is expected to match what would be returned from java.sql.DatabaseMetaData#getDatabaseProductVersion()) for the underlying database.

See Also

JAKARTA_HBM2DDL_DB_NAME

Specifies the name of a JDBC driver to use to connect to the database.

Used in conjunction with JAKARTA_JDBC_URL, JAKARTA_JDBC_USER and JAKARTA_JDBC_PASSWORD to specify how to connect to the database.

When connections are obtained from a javax.sql.DataSource, use either JAKARTA_JTA_DATASOURCE or JAKARTA_NON_JTA_DATASOURCE instead.

See section 8.2.1.9

Specifies the password to use when connecting via JDBC.

Used in conjunction with JAKARTA_JDBC_DRIVER, JAKARTA_JDBC_URL and JAKARTA_JDBC_USER to specify how to connect to the database.

See JPA 2 section 8.2.1.9

Specifies the JDBC connection URL to use to connect to the database.

Used in conjunction with JAKARTA_JDBC_DRIVER, JAKARTA_JDBC_USER and JAKARTA_JDBC_PASSWORD to specify how to connect to the database.

When connections are obtained from a javax.sql.DataSource, use either JAKARTA_JTA_DATASOURCE or JAKARTA_NON_JTA_DATASOURCE instead.

See section 8.2.1.9

Specifies the database user to use when connecting via JDBC.

Used in conjunction with JAKARTA_JDBC_DRIVER, JAKARTA_JDBC_URL and JAKARTA_JDBC_PASSWORD to specify how to connect to the database.

Depending on the configured ConnectionProvider, the specified username might be used to:

• create a JDBC connection using java.sql.DriverManager#getConnection(String, java.util.Properties) or java.sql.Driver#connect(String, java.util.Properties), or
• obtain a JDBC connection from a datasource, using javax.sql.DataSource#getConnection(String, String).

See section 8.2.1.9

Specifies a JTA javax.sql.DataSource to use for Connections. Hibernate allows either

• an instance of javax.sql.DataSource
• a JNDI name under which to obtain the javax.sql.DataSource; see also EnvironmentSettings#JNDI_URL, EnvironmentSettings#JNDI_CLASS, EnvironmentSettings#JNDI_PREFIX

See JPA 2 sections 9.4.3 and 8.2.1.5

Specifies a non-JTA javax.sql.DataSource to use for Connections. Hibernate allows either

• an instance of javax.sql.DataSource
• a JNDI name under which to obtain the javax.sql.DataSource; see also EnvironmentSettings#JNDI_URL, EnvironmentSettings#JNDI_CLASS, EnvironmentSettings#JNDI_PREFIX

See JPA 2 sections 9.4.3 and 8.2.1.5

Specifies the time zone to use in the JDBC driver, which is supposed to match the database timezone.

This is the timezone what will be passed to java.sql.PreparedStatement#setTimestamp(int, java.sql.Timestamp, java.util.Calendar) java.sql.PreparedStatement#setTime(int, java.sql.Time, java.util.Calendar), java.sql.ResultSet#getTimestamp(int, Calendar), and java.sql.ResultSet#getTime(int, Calendar) when binding parameters.

The time zone may be given as:

• an instance of java.util.TimeZone,
• an instance of java.time.ZoneId, or
• a time zone ID string to be passed to java.time.ZoneId#of(String).

By default, the JVM default time zone is assumed by the JDBC driver.

Since

5.2.3

When enabled, specifies that JDBC statement warnings should be logged.

The default is determined by org.hibernate.dialect.Dialect#isJdbcLogWarningsEnabledByDefault().

Since

5.1

See Also

java.sql.Statement#getWarnings()

Specifies a duration in milliseconds defining the minimum query execution time that characterizes a "slow" query. Any SQL query which takes longer than this amount of time to execute will be logged.

A value of 0, the default, disables logging of "slow" queries.

See Also

org.hibernate.stat.Statistics#getSlowQueries()

When enabled, specifies that Hibernate should not use contextual LOB creation.

See Also

org.hibernate.engine.jdbc.LobCreator, org.hibernate.engine.jdbc.LobCreationContext

Specifies the maximum number of inactive connections for the built-in connection pool.

Enables logging of generated SQL to the console.

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If 0, the JDBC driver's default settings will be used.

See Also

java.sql.PreparedStatement#setFetchSize(int), org.hibernate.boot.SessionFactoryBuilder#applyJdbcFetchSize(int), org.hibernate.ScrollableResults#setFetchSize(int)

Specifies a org.hibernate.resource.jdbc.spi.StatementInspector implementation associated with the org.hibernate.SessionFactory, either:

• an instance of StatementInspector,
• a Class representing an class that implements StatementInspector, or
• the name of a class that implements StatementInspector.

Since

5.0

See Also

org.hibernate.boot.SessionFactoryBuilder#applyStatementInspector(StatementInspector)

Specifies that generated primary keys may be retrieved using the JDBC 3 java.sql.PreparedStatement#getGeneratedKeys() operation.

Usually, performance will be improved if this behavior is enabled, assuming the JDBC driver supports getGeneratedKeys().

See Also

java.sql.PreparedStatement#getGeneratedKeys, org.hibernate.boot.SessionFactoryBuilder#applyGetGeneratedKeysSupport(boolean)

Controls how Hibernate should handle scrollable results -

• true indicates that insensitive scrolling can be used
• false indicates that sensitive scrolling must be used

See Also

org.hibernate.boot.SessionFactoryBuilder#applyScrollableResultsSupport(boolean), Query#scroll, ExtractedDatabaseMetaData#supportsScrollableResults()

Specifies that comments should be added to the generated SQL.

See Also

org.hibernate.boot.SessionFactoryBuilder#applySqlComments(boolean)