added extra HB3 properties

git-svn-id: https://svn.jboss.org/repos/hibernate/trunk/Hibernate3/doc@4391 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Gavin King 2004-08-20 12:48:17 +00:00
parent 8c6da481a6
commit 083a42ea06
1 changed files with 57 additions and 24 deletions

View File

@ -16,9 +16,9 @@
<para> <para>
An instance of <literal>org.hibernate.cfg.Configuration</literal> An instance of <literal>org.hibernate.cfg.Configuration</literal>
represents an entire set of mappings of an application's Java types to a represents an entire set of mappings of an application's Java types to an
SQL database. The <literal>Configuration</literal> is used to build a SQL database. The <literal>Configuration</literal> is used to build an
(immutable)` <literal>SessionFactory</literal>. The mappings are compiled (immutable) <literal>SessionFactory</literal>. The mappings are compiled
from various XML mapping files. from various XML mapping files.
</para> </para>
@ -43,8 +43,8 @@
<para> <para>
Then Hibernate will look for mapping files named Then Hibernate will look for mapping files named
<literal>/org/hibernate/autcion/Item.hbm.xml</literal> and <literal>/org/hibernate/auction/Item.hbm.xml</literal> and
<literal>/org/hibernate/autcion/Bid.hbm.xml</literal> in the classpath. <literal>/org/hibernate/auction/Bid.hbm.xml</literal> in the classpath.
This approach eliminates any hardcoded filenames. This approach eliminates any hardcoded filenames.
</para> </para>
@ -406,6 +406,19 @@ hibernate.dialect = \
</para> </para>
</entry> </entry>
</row> </row>
<row>
<entry>
<literal>hibernate.default_catalog</literal>
</entry>
<entry>
Qualify unqualified tablenames with the given catalog
in generated SQL.
<para>
<emphasis role="strong">eg.</emphasis>
<literal>CATALOG_NAME</literal>
</para>
</entry>
</row>
<row> <row>
<entry> <entry>
<literal>hibernate.session_factory_name</literal> <literal>hibernate.session_factory_name</literal>
@ -721,10 +734,21 @@ hibernate.dialect = \
<literal>hibernate.generate_statistics</literal> <literal>hibernate.generate_statistics</literal>
</entry> </entry>
<entry> <entry>
If turned on, several runtime statistics are available by calling If enabled, Hibernate will collect statistics useful for
<literal>SessionFactory.getStatistics()</literal>. Also see the performance tuning.
<literal>StatisticsServiceMBean</literal> if you are using a <para>
JMX server, documented on the Hibernate web site. <emphasis role="strong">eg.</emphasis>
<literal>true</literal> | <literal>false</literal>
</para>
</entry>
</row>
<row>
<entry>
<literal>hibernate.use_identifer_rollback</literal>
</entry>
<entry>
If enabled, generated identifier properties will be
reset to default values when objects are deleted.
<para> <para>
<emphasis role="strong">eg.</emphasis> <emphasis role="strong">eg.</emphasis>
<literal>true</literal> | <literal>false</literal> <literal>true</literal> | <literal>false</literal>
@ -843,12 +867,12 @@ hibernate.dialect = \
<title>Outer Join Fetching</title> <title>Outer Join Fetching</title>
<para> <para>
If your database supports ANSI or Oracle style outer joins, <emphasis>outer join If your database supports ANSI, Oracle or Sybase style outer joins, <emphasis>outer join
fetching</emphasis> might increase performance by limiting the number of round fetching</emphasis> will often increase performance by limiting the number of round
trips to and from the database (at the cost of possibly more work performed by trips to and from the database (at the cost of possibly more work performed by
the database itself). Outer join fetching allows a graph of objects connected the database itself). Outer join fetching allows a whole graph of objects connected
by many-to-one, one-to-many or one-to-one associations to be retrieved in a single by many-to-one, one-to-many, many-to-many and one-to-one associations to be retrieved
SQL <literal>SELECT</literal>. in a single SQL <literal>SELECT</literal>.
</para> </para>
<para> <para>
@ -893,14 +917,12 @@ hibernate.dialect = \
</sect2> </sect2>
<sect2 id="configuration-optional-cacheprovider" revision="1"> <sect2 id="configuration-optional-cacheprovider" revision="1">
<title>Custom <literal>CacheProvider</literal></title> <title>Second-level and query cache</title>
<para> <para>
You may integrate a JVM-level (or clustered) second-level cache system by The properties prefixed by <literal>hibernate.cache</literal>
implementing the interface <literal>org.hibernate.cache.CacheProvider</literal>. allow you to use a process or cluster scoped second-level cache system
You may select the custom implementation by setting with Hibernate. See the "Performance" chapter for more details.
<literal>hibernate.cache.provider_class</literal>. See the "Performance" chapter
for more details.
</para> </para>
</sect2> </sect2>
@ -943,9 +965,9 @@ hibernate.dialect = \
</para> </para>
<para> <para>
If you wish to use JVM-level caching of mutable data in a JTA environment, you must specify If you wish to use a second-level cache for mutable data in a JTA environment, you must specify
a strategy for obtaining the JTA <literal>TransactionManager</literal>, as this is a strategy for obtaining the JTA <literal>TransactionManager</literal>, since J2EE does not
not standardized for J2EE containers: standardize a single mechanism:
</para> </para>
<table frame="topbot" id="jtamanagerlookup" revision="1"> <table frame="topbot" id="jtamanagerlookup" revision="1">
@ -1064,6 +1086,17 @@ hibernate.dialect = \
</sect2> </sect2>
<sect2 id="configuration-optional-statistics" revision="1">
<title>Hibernate statistics</title>
<para>
If you enable <literal>hibernate.generate_statistics</literal>, Hibernate will
expose a number of metrics that are useful when tuning a running system via
<literal>SessionFactory.getStatistics()</literal>. Hibernate can even be configured
to expose these statistics via JMX (see the website for details).
</para>
</sect2>
</sect1> </sect1>
<sect1 id="configuration-logging"> <sect1 id="configuration-logging">
@ -1136,7 +1169,7 @@ hibernate.dialect = \
An alternative approach to configuration is to specify a full configuration in An alternative approach to configuration is to specify a full configuration in
a file named <literal>hibernate.cfg.xml</literal>. This file can be used as a a file named <literal>hibernate.cfg.xml</literal>. This file can be used as a
replacement for the <literal>hibernate.properties</literal> file or, if both replacement for the <literal>hibernate.properties</literal> file or, if both
are present, override properties. are present, to override properties.
</para> </para>
<para> <para>