3.4. Propriétés de configuration optionnelles

Il y a un certain nombre d'autres propriétés qui contrôlent le fonctionnement d'Hibernate à l'exécution. Toutes sont optionnelles et ont comme valeurs par défaut des valeurs "raisonnables" pour un fonctionnement nominal.

Warning: some of these properties are "system-level" only. System-level properties can be set only via java -Dproperty=value or hibernate.properties. They may not be set by the other techniques described above.

Tableau 3.3. Propriétés de configuration d'Hibernate

Property name Purpose
hibernate.dialect The classname of a Hibernate org.hibernate.dialect.Dialect which allows Hibernate to generate SQL optimized for a particular relational database.

eg. full.classname.of.Dialect

In most cases Hibernate will actually be able to chose the correct org.hibernate.dialect.Dialect implementation to use based on the JDBC metadata returned by the JDBC driver.

hibernate.show_sql Write all SQL statements to console. This is an alternative to setting the log category org.hibernate.SQL to debug.

eg. true | false

hibernate.format_sql Pretty print the SQL in the log and console.

eg. true | false

hibernate.default_schema Qualify unqualified table names with the given schema/tablespace in generated SQL.

eg. SCHEMA_NAME

hibernate.default_catalog Qualify unqualified table names with the given catalog in generated SQL.

eg. CATALOG_NAME

hibernate.session_factory_name The org.hibernate.SessionFactory will be automatically bound to this name in JNDI after it has been created.

eg. jndi/composite/name

hibernate.max_fetch_depth Set a maximum "depth" for the outer join fetch tree for single-ended associations (one-to-one, many-to-one). A 0 disables default outer join fetching.

ex. valeurs recommandées entre 0 et 3

hibernate.default_batch_fetch_size Set a default size for Hibernate batch fetching of associations.

ex. Valeurs recommandées : 4, 8, 16

hibernate.default_entity_mode Set a default mode for entity representation for all sessions opened from this SessionFactory

dynamic-map, dom4j, pojo

hibernate.order_updates Force Hibernate to order SQL updates by the primary key value of the items being updated. This will result in fewer transaction deadlocks in highly concurrent systems.

eg. true | false

hibernate.generate_statistics If enabled, Hibernate will collect statistics useful for performance tuning.

eg. true | false

hibernate.use_identifer_rollback If enabled, generated identifier properties will be reset to default values when objects are deleted.

eg. true | false

hibernate.use_sql_comments If turned on, Hibernate will generate comments inside the SQL, for easier debugging, defaults to false.

eg. true | false


Tableau 3.4. Propriétés Hibernate liées à JDBC et aux connexions

Property name Purpose
hibernate.jdbc.fetch_size A non-zero value determines the JDBC fetch size (calls Statement.setFetchSize()).
hibernate.jdbc.batch_size A non-zero value enables use of JDBC2 batch updates by Hibernate.

ex. les valeurs recommandées entre 5 et 30

hibernate.jdbc.batch_versioned_data Set this property to true if your JDBC driver returns correct row counts from executeBatch() (it is usually safe to turn this option on). Hibernate will then use batched DML for automatically versioned data. Defaults to false.

eg. true | false

hibernate.jdbc.factory_class Select a custom org.hibernate.jdbc.Batcher. Most applications will not need this configuration property.

eg. classname.of.BatcherFactory

hibernate.jdbc.use_scrollable_resultset Enables use of JDBC2 scrollable resultsets by Hibernate. This property is only necessary when using user supplied JDBC connections, Hibernate uses connection metadata otherwise.

eg. true | false

hibernate.jdbc.use_streams_for_binary Use streams when writing/reading binary or serializable types to/from JDBC. *system-level property*

eg. true | false

hibernate.jdbc.use_get_generated_keys Enable use of JDBC3 PreparedStatement.getGeneratedKeys() to retrieve natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+, set to false if your driver has problems with the Hibernate identifier generators. By default, tries to determine the driver capabilities using connection metadata.

eg. true|false

hibernate.connection.provider_class The classname of a custom org.hibernate.connection.ConnectionProvider which provides JDBC connections to Hibernate.

eg. classname.of.ConnectionProvider

hibernate.connection.isolation Set the JDBC transaction isolation level. Check java.sql.Connection for meaningful values but note that most databases do not support all isolation levels and some define additional, non-standard isolations.

eg. 1, 2, 4, 8

hibernate.connection.autocommit Enables autocommit for JDBC pooled connections (not recommended).

eg. true | false

hibernate.connection.release_mode Specify when Hibernate should release JDBC connections. By default, a JDBC connection is held until the session is explicitly closed or disconnected. For an application server JTA datasource, you should use after_statement to aggressively release connections after every JDBC call. For a non-JTA connection, it often makes sense to release the connection at the end of each transaction, by using after_transaction. auto will choose after_statement for the JTA and CMT transaction strategies and after_transaction for the JDBC transaction strategy.

eg. auto (default) | on_close | after_transaction | after_statement

Note that this setting only affects Sessions returned from SessionFactory.openSession. For Sessions obtained through SessionFactory.getCurrentSession, the CurrentSessionContext implementation configured for use controls the connection release mode for those Sessions. See Section 2.5, « Sessions Contextuelles »

hibernate.connection.<propertyName> Pass the JDBC property <propertyName> to DriverManager.getConnection().
hibernate.jndi.<propertyName> Pass the property <propertyName> to the JNDI InitialContextFactory.

Tableau 3.5. Propriétés du Cache d'Hibernate

Property name Purpose
hibernate.cache.provider_class The classname of a custom CacheProvider.

eg. classname.of.CacheProvider

hibernate.cache.use_minimal_puts Optimize second-level cache operation to minimize writes, at the cost of more frequent reads. This setting is most useful for clustered caches and, in Hibernate3, is enabled by default for clustered cache implementations.

eg. true|false

hibernate.cache.use_query_cache Enable the query cache, individual queries still have to be set cachable.

eg. true|false

hibernate.cache.use_second_level_cache May be used to completely disable the second level cache, which is enabled by default for classes which specify a <cache> mapping.

eg. true|false

hibernate.cache.query_cache_factory The classname of a custom QueryCache interface, defaults to the built-in StandardQueryCache.

eg. classname.of.QueryCache

hibernate.cache.region_prefix A prefix to use for second-level cache region names.

eg. prefix

hibernate.cache.use_structured_entries Forces Hibernate to store data in the second-level cache in a more human-friendly format.

eg. true|false


Tableau 3.6. Propriétés des transactions Hibernate

Property name Purpose
hibernate.transaction.factory_class The classname of a TransactionFactory to use with Hibernate Transaction API (defaults to JDBCTransactionFactory).

eg. classname.of.TransactionFactory

jta.UserTransaction A JNDI name used by JTATransactionFactory to obtain the JTA UserTransaction from the application server.

eg. jndi/composite/name

hibernate.transaction.manager_lookup_class The classname of a TransactionManagerLookup - required when JVM-level caching is enabled or when using hilo generator in a JTA environment.

eg. classname.of.TransactionManagerLookup

hibernate.transaction.flush_before_completion If enabled, the session will be automatically flushed during the before completion phase of the transaction. Built-in and automatic session context management is preferred, see Section 2.5, « Sessions Contextuelles ».

eg. true | false

hibernate.transaction.auto_close_session If enabled, the session will be automatically closed during the after completion phase of the transaction. Built-in and utomatic session context management is preferred, see Section 2.5, « Sessions Contextuelles ».

eg. true | false


Tableau 3.7. Propriétés diverses

Property name Purpose
hibernate.current_session_context_class Supply a (custom) strategy for the scoping of the "current" Session. See Section 2.5, « Sessions Contextuelles » for more information about the built-in strategies.

eg. jta | thread | managed | custom.Class

hibernate.query.factory_class Chooses the HQL parser implementation.

eg. org.hibernate.hql.ast.ASTQueryTranslatorFactory or org.hibernate.hql.classic.ClassicQueryTranslatorFactory

hibernate.query.substitutions Mapping from tokens in Hibernate queries to SQL tokens (tokens might be function or literal names, for example).

eg. hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC

hibernate.hbm2ddl.auto Automatically validate or export schema DDL to the database when the SessionFactory is created. With create-drop, the database schema will be dropped when the SessionFactory is closed explicitly.

eg. validate | update | create | create-drop

hibernate.cglib.use_reflection_optimizer Enables use of CGLIB instead of runtime reflection (System-level property). Reflection can sometimes be useful when troubleshooting, note that Hibernate always requires CGLIB even if you turn off the optimizer. You can not set this property in hibernate.cfg.xml.

eg. true | false


3.4.1. Dialectes SQL

Vous devriez toujours positionner la propriété hibernate.dialect à la sous-classe de org.hibernate.dialect.Dialect appropriée à votre base de données. Si vous spécifiez un dialecte, Hibernate utilisera des valeurs adaptées pour certaines autres propriétés listées ci-dessus, vous évitant l'effort de le faire à la main.

Tableau 3.8. Dialectes SQL d'Hibernate (hibernate.dialect)

SGBD Dialect
DB2 org.hibernate.dialect.DB2Dialect
DB2 AS/400 org.hibernate.dialect.DB2400Dialect
DB2 OS390 org.hibernate.dialect.DB2390Dialect
PostgreSQL org.hibernate.dialect.PostgreSQLDialect
MySQL org.hibernate.dialect.MySQLDialect
MySQL with InnoDB org.hibernate.dialect.MySQLInnoDBDialect
MySQL with MyISAM org.hibernate.dialect.MySQLMyISAMDialect
Oracle (any version) org.hibernate.dialect.OracleDialect
Oracle 9i/10g org.hibernate.dialect.Oracle9Dialect
Sybase org.hibernate.dialect.SybaseDialect
Sybase Anywhere org.hibernate.dialect.SybaseAnywhereDialect
Microsoft SQL Server org.hibernate.dialect.SQLServerDialect
SAP DB org.hibernate.dialect.SAPDBDialect
Informix org.hibernate.dialect.InformixDialect
HypersonicSQL org.hibernate.dialect.HSQLDialect
Ingres org.hibernate.dialect.IngresDialect
Progress org.hibernate.dialect.ProgressDialect
Mckoi SQL org.hibernate.dialect.MckoiDialect
Interbase org.hibernate.dialect.InterbaseDialect
Pointbase org.hibernate.dialect.PointbaseDialect
FrontBase org.hibernate.dialect.FrontbaseDialect
Firebird org.hibernate.dialect.FirebirdDialect

3.4.2. Chargement par Jointure Ouverte

Si votre base de données supporte les outer joins de type ANSI, Oracle ou Sybase, le chargement par jointure ouverte devrait améliorer les performances en limitant le nombre d'aller-retour avec la base de données (la base de données effectuant donc potentiellement plus de travail). Le chargement par jointure ouverte permet à un graphe entier d'objets connectés par une relation plusieurs-à-un, un-à-plusieurs ou un-à-un d'être chargé en un seul SELECT SQL.

Le chargement par jointure ouverte peut être désactiver globalement en mettant la propriété hibernate.max_fetch_depth à 0. Une valeur de 1 ou plus active le chargement par jointure ouverte pour les associatiosn un-à-un et plusieurs-à-un qui ont été mappée avec fetch="join".

Reportez vous à Section 19.1, « Stratégies de chargement » pour plus d'information.

3.4.3. Flux binaires

Oracle limite la taille d'un tableau de byte qui peuvent être passées à et vers son pilote JDBC. Si vous souhaitez utiliser des instances larges de type binary ou serializable, vous devez activer la propriété hibernate.jdbc.use_streams_for_binary. C'est une fonctionalité de niveau système uniquement.

3.4.4. Cache de second niveau et cache de requêtes

Les propriétés préfixées par hibernate.cache vous permettent d'utiliser un système de cache de second niveau. Ce cache peut avoir une portée dans le processus ou même être utilisable dans un système distribué. Référez vous au chapitre Section 19.2, « Le cache de second niveau » pour plus de détails.

3.4.5. Substitution dans le langage de requêtage

Vous pouvez définir de nouveaux tokens dans les requêtes Hibernate en utilisant la propriété hibernate.query.substitutions. Par exemple :

hibernate.query.substitutions vrai=1, faux=0

remplacerait les tokens vrai et faux par des entiers dans le SQL généré.

hibernate.query.substitutions toLowercase=LOWER

permettrait de renommer la fonction SQL LOWER en toLowercase

3.4.6. Statistiques Hibernate

Si vous activez hibernate.generate_statistics, Hibernate va fournir un certains nombre de métriques utiles pour régler les performances d'une application qui tourne via SessionFactory.getStatistics(). Hibernate peut aussi être configuré pour exposer ces statistiques via JMX. Lisez les Javadoc des interfaces dans le package org.hibernate.stats pour plus d'informations.