java.lang.Object | |
↳ | org.hibernate.cfg.Environment |
Provides access to configuration info passed in Properties objects.
Hibernate has two property scopes:
property | meaning |
hibernate.dialect | classname of org.hibernate.dialect.Dialect subclass |
hibernate.cache.provider_class | classname of org.hibernate.cache.CacheProvider subclass (if not specified EHCache is used) |
hibernate.connection.provider_class | classname of org.hibernate.connection.ConnectionProvider subclass (if not specified hueristics are used) |
hibernate.connection.username | database username |
hibernate.connection.password | database password |
hibernate.connection.url | JDBC URL (when using java.sql.DriverManager) |
hibernate.connection.driver_class | classname of JDBC driver |
hibernate.connection.isolation | JDBC transaction isolation level (only when using java.sql.DriverManager) | hibernate.connection.pool_size | the maximum size of the connection pool (only when using java.sql.DriverManager) |
hibernate.connection.datasource | databasource JNDI name (when using javax.sql.Datasource) |
hibernate.jndi.url | JNDI InitialContext URL |
hibernate.jndi.class | JNDI InitialContext classname |
hibernate.max_fetch_depth | maximum depth of outer join fetching |
hibernate.jdbc.batch_size | enable use of JDBC2 batch API for drivers which support it |
hibernate.jdbc.fetch_size | set the JDBC fetch size |
hibernate.jdbc.use_scrollable_resultset | enable use of JDBC2 scrollable resultsets (you only need this specify this property when using user supplied connections) |
hibernate.jdbc.use_getGeneratedKeys | enable use of JDBC3 PreparedStatement.getGeneratedKeys() to retrieve natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+ |
hibernate.hbm2ddl.auto | enable auto DDL export |
hibernate.default_schema | use given schema name for unqualified tables (always optional) |
hibernate.default_catalog | use given catalog name for unqualified tables (always optional) |
hibernate.session_factory_name | If set, the factory attempts to bind this name to itself in the JNDI context. This name is also used to support cross JVM Session (de)serialization. |
hibernate.transaction.manager_lookup_class | classname of org.hibernate.transaction.TransactionManagerLookup implementor |
hibernate.transaction.factory_class | the factory to use for instantiating Transactions. (Defaults to JDBCTransactionFactory.) |
hibernate.query.substitutions | query language token substitutions |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | AUTOCOMMIT | JDBC autocommit mode | |||||||||
String | AUTO_CLOSE_SESSION | Enable automatic session close at end of transaction | |||||||||
String | BATCH_STRATEGY | Select a custom batcher. | |||||||||
String | BATCH_VERSIONED_DATA | Should versioned data be included in batching? | |||||||||
String | BYTECODE_PROVIDER | ||||||||||
String | C3P0_ACQUIRE_INCREMENT | Number of connections acquired when pool is exhausted | |||||||||
String | C3P0_IDLE_TEST_PERIOD | Idle time before a C3P0 pooled connection is validated | |||||||||
String | C3P0_MAX_SIZE | Maximum size of C3P0 connection pool | |||||||||
String | C3P0_MAX_STATEMENTS | Maximum size of C3P0 statement cache | |||||||||
String | C3P0_MIN_SIZE | Minimum size of C3P0 connection pool | |||||||||
String | C3P0_TIMEOUT | Maximum idle time for C3P0 connection pool | |||||||||
String | CACHE_NAMESPACE | The CacheProvider JNDI namespace, if pre-bound to JNDI. | |||||||||
String | CACHE_PROVIDER | The CacheProvider implementation class | |||||||||
String | CACHE_PROVIDER_CONFIG | The CacheProvider implementation class | |||||||||
String | CACHE_REGION_FACTORY | The RegionFactory implementation class
|
|||||||||
String | CACHE_REGION_PREFIX | The CacheProvider region name prefix | |||||||||
String | CHECK_NULLABILITY | Enable nullability checking. | |||||||||
String | CONNECTION_PREFIX | prefix for arbitrary JDBC connection properties | |||||||||
String | CONNECTION_PROVIDER | ConnectionProvider implementor to use when obtaining connections | |||||||||
String | CURRENT_SESSION_CONTEXT_CLASS | Context scoping impl for getCurrentSession() processing. |
|||||||||
String | DATASOURCE | java.sql.Datasource JNDI name | |||||||||
String | DEFAULT_BATCH_FETCH_SIZE | The default batch size for batch fetching | |||||||||
String | DEFAULT_CATALOG | A default database catalog name to use for unqualified tablenames | |||||||||
String | DEFAULT_ENTITY_MODE | The EntityMode in which set the Session opened from the SessionFactory. | |||||||||
String | DEFAULT_SCHEMA | A default database schema (owner) name to use for unqualified tablenames | |||||||||
String | DIALECT | Hibernate SQL Dialect class
|
|||||||||
String | DIALECT_RESOLVERS | DialectResolver classes to register with the
DialectFactory
|
|||||||||
String | DRIVER | JDBC driver class | |||||||||
String | FLUSH_BEFORE_COMPLETION | Enable automatic flush during the JTA beforeCompletion() callback | |||||||||
String | FORMAT_SQL | Enable formatting of SQL logged to the console | |||||||||
String | GENERATE_STATISTICS | Enable statistics collection | |||||||||
String | GLOBALLY_QUOTED_IDENTIFIERS | Should all database identifiers be quoted. | |||||||||
String | HBM2DDL_AUTO | Auto export/update schema using hbm2ddl tool. | |||||||||
String | HBM2DDL_IMPORT_FILES | Comma-separated names of the optional files containing SQL DML statements executed during the SessionFactory creation. | |||||||||
String | ISOLATION | JDBC transaction isolation level | |||||||||
String | JACC_CONTEXTID | The jacc context id of the deployment | |||||||||
String | JNDI_CLASS | JNDI initial context class, Context.INITIAL_CONTEXT_FACTORY | |||||||||
String | JNDI_PREFIX | prefix for arbitrary JNDI InitialContext properties | |||||||||
String | JNDI_URL | JNDI provider URL, Context.PROVIDER_URL | |||||||||
String | JPAQL_STRICT_COMPLIANCE | ||||||||||
String | MAX_FETCH_DEPTH | Maximum depth of outer join fetching | |||||||||
String | ORDER_INSERTS | Enable ordering of insert statements for the purpose of more efficient JDBC batching. | |||||||||
String | ORDER_UPDATES | Enable ordering of update statements by primary key value | |||||||||
String | OUTPUT_STYLESHEET | An XSLT resource used to generate "custom" XML | |||||||||
String | PASS | JDBC password | |||||||||
String | POOL_SIZE | Maximum number of inactive connections for Hibernate's connection pool | |||||||||
String | PREFER_POOLED_VALUES_LO | When using pooled optimizers , prefer interpreting the
database value as the lower (lo) boundary. |
|||||||||
String | PROXOOL_EXISTING_POOL | Proxool property to configure the Proxool Provider from an already existing pool (true / false) | |||||||||
String | PROXOOL_POOL_ALIAS | Proxool property with the Proxool pool alias to use (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or PROXOOL_XML) | |||||||||
String | PROXOOL_PREFIX | Proxool/Hibernate property prefix | |||||||||
String | PROXOOL_PROPERTIES | Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties) | |||||||||
String | PROXOOL_XML | Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml) | |||||||||
String | QUERY_CACHE_FACTORY | The QueryCacheFactory implementation class. | |||||||||
String | QUERY_PLAN_CACHE_MAX_SOFT_REFERENCES | The maximum number of soft references maintained by SoftLimitMRUCache . |
|||||||||
String | QUERY_PLAN_CACHE_MAX_STRONG_REFERENCES | The maximum number of strong references maintained by SoftLimitMRUCache . |
|||||||||
String | QUERY_STARTUP_CHECKING | Should named queries be checked during startup (the default is enabled). | |||||||||
String | QUERY_SUBSTITUTIONS | A comma-separated list of token substitutions to use when translating a Hibernate query to SQL | |||||||||
String | QUERY_TRANSLATOR | The classname of the HQL query parser factory | |||||||||
String | RELEASE_CONNECTIONS | Specifies how Hibernate should release JDBC connections. | |||||||||
String | SESSION_FACTORY_NAME | JNDI name to bind to SessionFactory | |||||||||
String | SHOW_SQL | Enable logging of generated SQL to the console | |||||||||
String | SQL_EXCEPTION_CONVERTER | The SQLExceptionConverter to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. |
|||||||||
String | STATEMENT_BATCH_SIZE | Maximum JDBC batch size. | |||||||||
String | STATEMENT_FETCH_SIZE | Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. | |||||||||
String | TRANSACTION_MANAGER_STRATEGY | TransactionManagerLookup implementor to use for obtaining the TransactionManager | |||||||||
String | TRANSACTION_STRATEGY | TransactionFactory implementor to use for creating Transactions | |||||||||
String | URL | JDBC URL | |||||||||
String | USER | JDBC user | |||||||||
String | USER_TRANSACTION | JNDI name of JTA UserTransaction object | |||||||||
String | USE_GET_GENERATED_KEYS | Tells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys() method. | |||||||||
String | USE_IDENTIFIER_ROLLBACK | ||||||||||
String | USE_MINIMAL_PUTS | Optimize the cache for minimal puts instead of minimal gets | |||||||||
String | USE_QUERY_CACHE | Enable the query cache (disabled by default) | |||||||||
String | USE_REFLECTION_OPTIMIZER | Use bytecode libraries optimized property access | |||||||||
String | USE_SCROLLABLE_RESULTSET | Use JDBC scrollable ResultSets. | |||||||||
String | USE_SECOND_LEVEL_CACHE | Enable the second-level cache (enabled by default) | |||||||||
String | USE_SQL_COMMENTS | Add comments to the generated SQL | |||||||||
String | USE_STREAMS_FOR_BINARY | Use java.io streams to read / write binary data from / to JDBC | |||||||||
String | USE_STRUCTURED_CACHE | Enable use of structured second-level cache entries | |||||||||
String | WRAP_RESULT_SETS | Enable wrapping of JDBC result sets in order to speed up column name lookups for broken JDBC drivers |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return System properties, extended by any properties specified
in hibernate.properties.
| |||||||||||
Get the name of a JDBC transaction isolation level
| |||||||||||
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
| |||||||||||
Does this JVM's implementation of java.sql.Timestamp have a bug in which the following is true:
new java.sql.Timestamp( x ).getTime() != x
NOTE : IBM JDK 1.3.1 the only known JVM to exhibit this behavior. | |||||||||||
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
| |||||||||||
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
| |||||||||||
Should we use reflection optimization?
| |||||||||||
Should we use streams to bind binary types to JDBC IN parameters?
| |||||||||||
Issues warnings to the user when any obsolete or renamed property names are used.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
JDBC autocommit mode
Enable automatic session close at end of transaction
Select a custom batcher.
Should versioned data be included in batching?
Number of connections acquired when pool is exhausted
Idle time before a C3P0 pooled connection is validated
Maximum size of C3P0 connection pool
Maximum size of C3P0 statement cache
Minimum size of C3P0 connection pool
Maximum idle time for C3P0 connection pool
The CacheProvider JNDI namespace, if pre-bound to JNDI.
The CacheProvider implementation class
The CacheProvider implementation class
The RegionFactory
implementation class
The CacheProvider region name prefix
Enable nullability checking. Raises an exception if a property marked as not-null is null. Default to false if Bean Validation is present in the classpath and Hibernate Annotations is used, true otherwise.
prefix for arbitrary JDBC connection properties
ConnectionProvider implementor to use when obtaining connections
Context scoping impl for getCurrentSession()
processing.
java.sql.Datasource JNDI name
The default batch size for batch fetching
A default database catalog name to use for unqualified tablenames
The EntityMode in which set the Session opened from the SessionFactory.
A default database schema (owner) name to use for unqualified tablenames
DialectResolver
classes to register with the
DialectFactory
JDBC driver class
Enable automatic flush during the JTA beforeCompletion() callback
Enable formatting of SQL logged to the console
Enable statistics collection
Should all database identifiers be quoted.
Auto export/update schema using hbm2ddl tool. Valid values are update, create, create-drop and validate.
Comma-separated names of the optional files containing SQL DML statements executed during the SessionFactory creation. File order matters, the statements of a give file are executed before the statements of the following files. These statements are only executed if the schema is created ie if hibernate.hbm2ddl.auto is set to create or create-drop. The default value is /import.sql
JDBC transaction isolation level
The jacc context id of the deployment
JNDI initial context class, Context.INITIAL_CONTEXT_FACTORY
prefix for arbitrary JNDI InitialContext properties
JNDI provider URL, Context.PROVIDER_URL
Maximum depth of outer join fetching
Enable ordering of insert statements for the purpose of more efficient JDBC batching.
Enable ordering of update statements by primary key value
An XSLT resource used to generate "custom" XML
Maximum number of inactive connections for Hibernate's connection pool
When using pooled optimizers
, prefer interpreting the
database value as the lower (lo) boundary. The default is to interpret it as the high boundary.
Proxool property to configure the Proxool Provider from an already existing pool (true / false)
Proxool property with the Proxool pool alias to use (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or PROXOOL_XML)
Proxool/Hibernate property prefix
Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties)
Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml)
The QueryCacheFactory implementation class.
The maximum number of soft references maintained by SoftLimitMRUCache
. Default is 2048.
The maximum number of strong references maintained by SoftLimitMRUCache
. Default is 128.
Should named queries be checked during startup (the default is enabled).
Mainly intended for test environments.A comma-separated list of token substitutions to use when translating a Hibernate query to SQL
The classname of the HQL query parser factory
Specifies how Hibernate should release JDBC connections.
JNDI name to bind to SessionFactory
Enable logging of generated SQL to the console
The SQLExceptionConverter
to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. The default is to use the configured
Dialect
's preferred SQLExceptionConverter.
Maximum JDBC batch size. A nonzero value enables batch updates.
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, JDBC driver default settings will be used.
TransactionManagerLookup implementor to use for obtaining the TransactionManager
TransactionFactory implementor to use for creating Transactions
JNDI name of JTA UserTransaction object
Tells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys() method. In general, performance will be better if this property is set to true and the underlying JDBC driver supports getGeneratedKeys().
Optimize the cache for minimal puts instead of minimal gets
Enable the query cache (disabled by default)
Use bytecode libraries optimized property access
Use JDBC scrollable ResultSets. This property is only necessary when there is no ConnectionProvider, ie. the user is supplying JDBC connections.
Enable the second-level cache (enabled by default)
Add comments to the generated SQL
Use java.io streams to read / write binary data from / to JDBC
Enable use of structured second-level cache entries
Enable wrapping of JDBC result sets in order to speed up column name lookups for broken JDBC drivers
Return System properties, extended by any properties specified in hibernate.properties.
Get the name of a JDBC transaction isolation level
isolation | as defined by java.sql.Connection |
---|
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
Does this JVM handle java.sql.Timestamp in the JDK 1.4 compliant way wrt to nano rolling>
Does this JVM's implementation of java.sql.Timestamp have a bug in which the following is true:
new java.sql.Timestamp( x ).getTime() != x
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
Does this JDK/JVM define the JDBC Statement
interface with a 'getGeneratedKeys' method?
This method is deprecated.
Starting with 3.3 Hibernate requires JDK 1.4 or higher
Does this JVM support LinkedHashSet
and LinkedHashMap
?
LinkedHashSet
and LinkedHashMap
are available.Should we use reflection optimization?
Should we use streams to bind binary types to JDBC IN parameters?
Issues warnings to the user when any obsolete or renamed property names are used.
props | The specified properties. |
---|