Field Summary

Field Details

• JAKARTA_JTA_DATASOURCE

  static final String JAKARTA_JTA_DATASOURCE

  Specifies a JTADataSource to use for Connections.Hibernate allows either

  • an instance ofDataSource
  • a JNDI name under which to obtain theDataSource; see alsoEnvironmentSettings.JNDI_URL,EnvironmentSettings.JNDI_CLASS,EnvironmentSettings.JNDI_PREFIX

  See JPA 2 sections 9.4.3 and 8.2.1.5

  See Also:

  • Constant Field Values

• JAKARTA_NON_JTA_DATASOURCE

  static final String JAKARTA_NON_JTA_DATASOURCE

  Specifies a non-JTADataSource to use for Connections.Hibernate allows either

  • an instance ofDataSource
  • a JNDI name under which to obtain theDataSource; see alsoEnvironmentSettings.JNDI_URL,EnvironmentSettings.JNDI_CLASS,EnvironmentSettings.JNDI_PREFIX

  See JPA 2 sections 9.4.3 and 8.2.1.5

  See Also:

  • Constant Field Values

• JAKARTA_JDBC_DRIVER

  static final String JAKARTA_JDBC_DRIVER

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

  Used in conjunction withJAKARTA_JDBC_URL,JAKARTA_JDBC_USERandJAKARTA_JDBC_PASSWORD to specify how to connect to the database.

  When connections are obtained from aDataSource, useeitherJAKARTA_JTA_DATASOURCE orJAKARTA_NON_JTA_DATASOURCEinstead.

  See section 8.2.1.9

  See Also:

  • Constant Field Values

• JAKARTA_JDBC_URL

  static final String JAKARTA_JDBC_URL

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

  Used in conjunction withJAKARTA_JDBC_DRIVER,JAKARTA_JDBC_USERandJAKARTA_JDBC_PASSWORD to specify how to connect to the database.

  When connections are obtained from aDataSource, useeitherJAKARTA_JTA_DATASOURCE orJAKARTA_NON_JTA_DATASOURCEinstead.

  See section 8.2.1.9

  See Also:

  • Constant Field Values

• JAKARTA_JDBC_USER

  static final String JAKARTA_JDBC_USER

  Specifies the database user to use when connecting via JDBC.

  Used in conjunction withJAKARTA_JDBC_DRIVER,JAKARTA_JDBC_URLandJAKARTA_JDBC_PASSWORD to specify how to connect to the database.

  Depending on the configuredConnectionProvider, the specified username might be used to:

  • create a JDBC connection usingDriverManager.getConnection(String,java.util.Properties) orDriver.connect(String,java.util.Properties), or
  • obtain a JDBC connection from a datasource, usingDataSource.getConnection(String, String).

  See section 8.2.1.9

  See Also:

  • DriverManager.getConnection(String, String, String)
  • DataSource.getConnection(String, String)
  • Constant Field Values

• JAKARTA_JDBC_PASSWORD

  static final String JAKARTA_JDBC_PASSWORD

  Specifies the password to use when connecting via JDBC.

  Used in conjunction withJAKARTA_JDBC_DRIVER,JAKARTA_JDBC_URLandJAKARTA_JDBC_USER to specify how to connect to the database.

  See JPA 2 section 8.2.1.9

  See Also:

  • DriverManager.getConnection(String, String, String)
  • DataSource.getConnection(String, String)
  • Constant Field Values

• JAKARTA_HBM2DDL_CONNECTION

  static final String JAKARTA_HBM2DDL_CONNECTION

  Allows passing a specificConnection instance to be used bySchemaManagementTool for the purpose ofdetermining theDialect, and for performingdatabase actions if requested.

  ForDialect 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
  • Constant Field Values

• JAKARTA_HBM2DDL_DB_NAME

  static final String JAKARTA_HBM2DDL_DB_NAME

  Specifies the name of the database vendor (as would be reported byDatabaseMetaData.getDatabaseProductName()) for the purpose ofdetermining theDialect to use.

  For cases when the name of the database vendor is not enough alone, a combinationof"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
  • Constant Field Values

  Implementation Specification:

  database actions are notavailable when supplying just the name and versions

• JAKARTA_HBM2DDL_DB_VERSION

  static final String JAKARTA_HBM2DDL_DB_VERSION

  Used in conjunction with"jakarta.persistence.database-product-name" for the purpose ofdetermining theDialect to use when the name doesnot provide enough information.

  The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseProductVersion()) for theunderlying database.

  See Also:

  • JAKARTA_HBM2DDL_DB_NAME
  • Constant Field Values

• JAKARTA_HBM2DDL_DB_MAJOR_VERSION

  static final String JAKARTA_HBM2DDL_DB_MAJOR_VERSION

  Used in conjunction with"jakarta.persistence.database-product-name" for the purpose ofdetermining theDialect to use when the name doesnot provide enough information.

  The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseMajorVersion()) for the underlyingdatabase.

  See Also:

  • JAKARTA_HBM2DDL_DB_NAME
  • Constant Field Values

• JAKARTA_HBM2DDL_DB_MINOR_VERSION

  static final String JAKARTA_HBM2DDL_DB_MINOR_VERSION

  Used in conjunction with"jakarta.persistence.database-product-name" for the purpose ofdetermining theDialect to use when the name doesnot provide enough information.

  The value is expected to match what would be returned fromDatabaseMetaData.getDatabaseMinorVersion()) for the underlyingdatabase.

  See Also:

  • JAKARTA_HBM2DDL_DB_NAME
  • Constant Field Values

• DIALECT

  static final String DIALECT

  Specifies the HibernateSQL dialect, either

  • an instance ofDialect,
  • aClass representing a class that extendsDialect, or
  • the name of a class that extendsDialect.

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

  See Also:

  • Dialect
  • Constant Field Values

  API Note:

  As of Hibernate 6, this property should not be explicitly specified, except when using a custom user-written implementation ofDialect. Instead, applications should allow Hibernate to select theDialect automatically.

• DIALECT_RESOLVERS

  static final String DIALECT_RESOLVERS

  Specifies additionalDialectResolverimplementations to register with the standardDialectFactory.

  See Also:

  • Constant Field Values

• CONNECTION_PROVIDER

  static final String CONNECTION_PROVIDER

  Specifies aConnectionProvider to use for obtaining JDBC connections,either:

  • a short strategy name likeagroal,hikaricp,c3p0,
  • an instance ofConnectionProvider,
  • aClass object representing a class that implementsConnectionProvider, or
  • the name of a class that implementsConnectionProvider.

  If this property is not explicitly set, a connection provider is chosenautomatically:

  • ifJAKARTA_JTA_DATASOURCE orJAKARTA_NON_JTA_DATASOURCE is set, a datasource-based implementation is used;
  • otherwise, aConnectionProvider is loaded automatically as aJava service;
  • but if no service is found, or if more than one service is available, a default implementation is used as a fallback.

  The default implementation is not recommended for use in production.

  See Also:

  • Constant Field Values

  API Note:

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

• POOL_SIZE

  static final String POOL_SIZE

  Specifies the maximum number of inactive connections for anyconnection pool which respects thissetting, including every built-in implementation except forDataSourceConnectionProvider.

  The default pool size depends on the connection provider.

  See Also:

  • Constant Field Values

• ISOLATION

  static final String ISOLATION

  Specifies the JDBC transaction isolation level for connections obtainedfrom anyConnectionProvider implementation which respects thissetting, including every built-in implementation except forDataSourceConnectionProvider.

  Possible values are enumerated byConnection:READ_UNCOMMITTED,READ_COMMITTED,REPEATABLE_READ,SERIALIZABLE.

  If this setting is not explicitly specified, Hibernate does not modifythe transaction isolation level of the JDBC connection.

  See Also:

  • Connection.setTransactionIsolation(int)
  • Constant Field Values

• AUTOCOMMIT

  static final String AUTOCOMMIT

  Controls the autocommit mode of JDBC connections obtained from anyConnectionProvider implementation which respects this setting,including every built-in implementation except forDataSourceConnectionProvider.

  See Also:

  • Connection.setAutoCommit(boolean)
  • Constant Field Values

  Default Value:

  false

• CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT

  static final String CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT

  Indicates that connections obtained from the configuredConnectionProvider haveauto-commit already disabled when theyare acquired.

  It is inappropriate to set this value totrue when the connections returned bythe provider do not, in fact, have auto-commit disabled. Doing so may lead to Hibernateexecuting SQL operations outside the scope of any transaction.

  Since:

  5.2.10

  See Also:

  • SessionFactoryBuilder.applyConnectionProviderDisablesAutoCommit(boolean)
  • Constant Field Values

  API Note:

  By default, Hibernate callsConnection.setAutoCommit(boolean)on newly obtained connections. With this setting enabled, that call is skipped, alongwith some other operations, in the interest of performance.

  Default Value:

  false

• CONNECTION_PREFIX

  @Deprecated(since="7")static final String CONNECTION_PREFIX

  Deprecated.

  This setting is only supported byC3P0ConnectionProviderandDriverManagerConnectionProvider.

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

  For example, declaringhibernate.connection.foo=bar tells Hibernate toappendfoo=bar to the JDBC connection URL.

  See Also:

  • Constant Field Values

• STATEMENT_INSPECTOR

  static final String STATEMENT_INSPECTOR

  Specifies aStatementInspectorimplementation associated with theSessionFactory,either:

  • an instance ofStatementInspector,
  • aClass representing a class that implementsStatementInspector, or
  • the name of a class that implementsStatementInspector.

  Since:

  5.0

  See Also:

  • SessionFactoryBuilder.applyStatementInspector(StatementInspector)
  • Constant Field Values

• SHOW_SQL

  static final String SHOW_SQL

  Enables logging of generated SQL to the console.

  See Also:

  • Constant Field Values

  Default Value:

  false

• FORMAT_SQL

  static final String FORMAT_SQL

  Enables formatting of SQL logged to the console.

  See Also:

  • Constant Field Values

  Default Value:

  false

• HIGHLIGHT_SQL

  static final String HIGHLIGHT_SQL

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

  See Also:

  • Constant Field Values

  Default Value:

  false

• LOG_SLOW_QUERY

  static final String LOG_SLOW_QUERY

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

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

  See Also:

  • Statistics.getSlowQueries()
  • Constant Field Values

• USE_SQL_COMMENTS

  static final String USE_SQL_COMMENTS

  Specifies that comments should be added to the generated SQL.

  See Also:

  • SessionFactoryBuilder.applySqlComments(boolean)
  • Constant Field Values

  Default Value:

  false

• STATEMENT_FETCH_SIZE

  static final String STATEMENT_FETCH_SIZE

  Gives the JDBC driver a hint as to the number of rows that should be fetchedfrom the database when more rows are needed. If0, the JDBC driver'sdefault settings will be used.

  See Also:

  • Statement.setFetchSize(int)
  • SessionFactoryBuilder.applyJdbcFetchSize(int)
  • ScrollableResults.setFetchSize(int)
  • Constant Field Values

  Default Value:

  0

• USE_SCROLLABLE_RESULTSET

  @Deprecated(since="7",forRemoval=true)static final String USE_SCROLLABLE_RESULTSET

  Deprecated, for removal: This API element is subject to removal in a future version.

  It's not necessary to set this explicitly

  Controls how Hibernate should handle scrollable results:

  • true indicates thatinsensitive scrolling can be used;
  • false indicates thatforward-only scrolling must be used.

  See Also:

  • SessionFactoryBuilder.applyScrollableResultsSupport(boolean)
  • Query.scroll()
  • ExtractedDatabaseMetaData.supportsScrollableResults()
  • Constant Field Values

  Default Value:

  true if the underlying driver supports scrollable results,false otherwise

• DIALECT_NATIVE_PARAM_MARKERS

  @Incubatingstatic final String DIALECT_NATIVE_PARAM_MARKERS

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

  Since:

  6.2

  See Also:

  • ParameterMarkerStrategy
  • Dialect.getNativeParameterMarkerStrategy()
  • Constant Field Values

  Implementation Note:

  False by default, indicating standard JDBC parameter markers (`?`)are used. Set totrue to use the Dialect's native markers, if any. ForDialects without native markers, the standard JDBC strategy is used.

• NON_CONTEXTUAL_LOB_CREATION

  static final String NON_CONTEXTUAL_LOB_CREATION

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

  See Also:

  • LobCreator
  • LobCreationContext
  • Constant Field Values

• LOG_JDBC_WARNINGS

  static final String LOG_JDBC_WARNINGS

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

  Logging of JDBC warnings may also be controlled via the log category"org.hibernate.orm.jdbc.warn".

  The default is determined byDialect.isJdbcLogWarningsEnabledByDefault().

  Since:

  5.1

  See Also:

  • Statement.getWarnings()
  • Constant Field Values

• LOG_JDBC_ERRORS

  @Incubatingstatic final String LOG_JDBC_ERRORS

  When enabled, specifies that JDBC errors should be logged before being rethrown.

  Logging of JDBC errors may also be controlled via the log category"org.hibernate.orm.jdbc.error".

  Since:

  7

  See Also:

  • Constant Field Values

  Default Value:

  true

• JDBC_TIME_ZONE

  static final String JDBC_TIME_ZONE

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

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

  The time zone may be given as:

  • an instance ofTimeZone,
  • an instance ofZoneId, or
  • a time zone ID string to be passed toZoneId.of(String).

  By default, theJVM default time zoneis assumed by the JDBC driver.

  Since:

  5.2.3

  See Also:

  • Constant Field Values

• USE_GET_GENERATED_KEYS

  static final String USE_GET_GENERATED_KEYS

  Specifies that generated primary keys may be retrieved using the JDBC 3Statement.getGeneratedKeys() operation.

  Usually, performance will be improved if this behavior is enabled, assumingthe JDBC driver supportsgetGeneratedKeys().

  See Also:

  • Statement.getGeneratedKeys()
  • SessionFactoryBuilder.applyGetGeneratedKeysSupport(boolean)
  • Constant Field Values

  Default Value:

  true if the underlying driver supportsgetGeneratedKeys(),false otherwise

• CONNECTION_HANDLING

  static final String CONNECTION_HANDLING

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

  • an instance of the enumerationPhysicalConnectionHandlingMode, or
  • the name of one of its instances.

  The default isDELAYED_ACQUISITION_AND_RELEASE_AFTER_TRANSACTION.

  Since:

  5.2

  See Also:

  • PhysicalConnectionHandlingMode
  • SessionFactoryBuilder.applyConnectionHandlingMode(PhysicalConnectionHandlingMode)
  • Constant Field Values

• ALLOW_METADATA_ON_BOOT

  static final String ALLOW_METADATA_ON_BOOT

  Whether access to JDBCmetadata is allowed during bootstrap.

  Allowable options are defined byJdbcMetadataOnBoot. For configuration, any of thefollowing forms are accepted:

  • an instance ofJdbcMetadataOnBoot
  • case-insensitiveJdbcMetadataOnBoot option name
  • for legacy purposes,true orfalse -true is mapped toJdbcMetadataOnBoot.ALLOW andfalse is mapped toJdbcMetadataOnBoot.DISALLOW

  Since:

  6.5

  See Also:

  • JdbcMetadataOnBoot
  • Constant Field Values

  Default Value:

  allow

• DRIVER

  @Deprecatedstatic final String DRIVER

  Deprecated.

  The JPA-standard settingJAKARTA_JDBC_DRIVER is now preferred.

  See Also:

  • Constant Field Values

• URL

  @Deprecatedstatic final String URL

  Deprecated.

  The JPA-standard settingJAKARTA_JDBC_URL is now preferred.

  See Also:

  • Constant Field Values

• USER

  @Deprecatedstatic final String USER

  Deprecated.

  The JPA-standard settingJAKARTA_JDBC_USER is now preferred.

  See Also:

  • PASS
  • Constant Field Values

• PASS

  @Deprecatedstatic final String PASS

  Deprecated.

  The JPA-standard settingJAKARTA_JDBC_PASSWORD is now preferred.

  See Also:

  • USER
  • Constant Field Values

• DATASOURCE

  @Deprecatedstatic final String DATASOURCE

  Deprecated.

  The JPA-standard"jakarta.persistence.jtaDataSource" or"jakarta.persistence.nonJtaDataSource" setting are now preferred.

  See Also:

  • DataSource
  • Constant Field Values

• JPA_JTA_DATASOURCE

  @Deprecatedstatic final String JPA_JTA_DATASOURCE

  Deprecated.

  UseJAKARTA_JTA_DATASOURCE instead

  See Also:

  • Constant Field Values

• JPA_NON_JTA_DATASOURCE

  @Deprecatedstatic final String JPA_NON_JTA_DATASOURCE

  Deprecated.

  UseJAKARTA_NON_JTA_DATASOURCE instead

  See Also:

  • Constant Field Values

• JPA_JDBC_DRIVER

  @Deprecatedstatic final String JPA_JDBC_DRIVER

  Deprecated.

  UseJAKARTA_JDBC_DRIVER instead

  See Also:

  • Constant Field Values

• JPA_JDBC_URL

  @Deprecatedstatic final String JPA_JDBC_URL

  Deprecated.

  UseJAKARTA_JDBC_URL instead

  See Also:

  • Constant Field Values

• JPA_JDBC_USER

  @Deprecatedstatic final String JPA_JDBC_USER

  Deprecated.

  UseJAKARTA_JDBC_USER instead

  See Also:

  • Constant Field Values

• JPA_JDBC_PASSWORD

  @Deprecatedstatic final String JPA_JDBC_PASSWORD

  Deprecated.

  UseJAKARTA_JDBC_PASSWORD instead

  See Also:

  • Constant Field Values

• HBM2DDL_CONNECTION

  @Deprecatedstatic final String HBM2DDL_CONNECTION

  Deprecated.

  UseJAKARTA_HBM2DDL_CONNECTION instead

  See Also:

  • Constant Field Values

• DIALECT_DB_NAME

  @Deprecatedstatic final String DIALECT_DB_NAME

  Deprecated.

  UseJAKARTA_HBM2DDL_DB_NAME instead

  See Also:

  • DIALECT_DB_VERSION
  • DIALECT_DB_MAJOR_VERSION
  • DIALECT_DB_MINOR_VERSION
  • Constant Field Values

• DIALECT_DB_VERSION

  @Deprecatedstatic final String DIALECT_DB_VERSION

  Deprecated.

  UseJAKARTA_HBM2DDL_DB_VERSION instead

  See Also:

  • DIALECT_DB_NAME
  • Constant Field Values

• DIALECT_DB_MAJOR_VERSION

  @Deprecatedstatic final String DIALECT_DB_MAJOR_VERSION

  Deprecated.

  UseJAKARTA_HBM2DDL_DB_MAJOR_VERSION instead

  See Also:

  • DIALECT_DB_NAME
  • DIALECT_DB_MINOR_VERSION
  • Constant Field Values

• DIALECT_DB_MINOR_VERSION

  @Deprecatedstatic final String DIALECT_DB_MINOR_VERSION

  Deprecated.

  UseJAKARTA_HBM2DDL_DB_MINOR_VERSION instead

  See Also:

  • DIALECT_DB_NAME
  • DIALECT_DB_MAJOR_VERSION
  • DialectResolver
  • Constant Field Values