Author: curtisr7
Date: Thu May 20 17:54:37 2010
New Revision: 946726
URL: http://svn.apache.org/viewvc?rev=946726&view=rev
Log:
OPENJPA-1673: Update docs for MetaDataRepository.
Modified:
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml?rev=946726&r1=946725&r2=946726&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml Thu May 20 17:54:37 2010
@@ -126,23 +126,18 @@ scanned for annotated JPA entities.
<itemizedlist>
<listitem><para>
<literal>Preload</literal>: A boolean property. If true, OpenJPA will eagerly
load the repository on
- EntityManagerFactory creation. As a result, all Entity classes will be eagerly loaded
by the JVM. If
- false, the repository will be lazily loaded as Entity classes are loaded by the JVM. The
default value
- is false.
+ EntityManagerFactory creation. As a result, all Entity classes will be eagerly loaded
by the JVM.
+ Once MetaData preloading completes, all locking is removed from the
MetaDataRepository and this will
+ result in a much more scalable repository. If false, the repository
will be lazily loaded as Entity
+ classes are loaded by the JVM. The default value is false.
</para>
- </listitem>
- <listitem><para>
- <literal>NoLock</literal>: If true, the repository will be treated as a read
only data structure and
- minimal locking will be imposed on users. Preload must be set to true for OpenJPA to honor
setting
- NoLock to true. The default value is false.
- </para>
- </listitem>
+ </listitem>
</itemizedlist>
<title>Metadata Repository</title>
<example id="ref_guide_meta_repo">
<programlisting>
-<property name="openjpa.MetaDataRepository" value="Preload=true,NoLock=true"/>
+<property name="openjpa.MetaDataRepository" value="Preload=true"/>
</programlisting>
</example>
</section>
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml?rev=946726&r1=946725&r2=946726&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml Thu May 20 17:54:37
2010
@@ -606,6 +606,21 @@ scalability problems. You can disable th
linkend="ref_guide_runtime_broker_finalization"/> for details.
</entry>
</row>
+ <row>
+ <entry colname="name">
+ <emphasis role="bold">
+ Preload MetaDataRepository
+ </emphasis>
+ <para>
+<emphasis>scalability</emphasis>
+ </para>
+ </entry>
+ <entry colname="desc">
+By default, the MetaDataRepository is lazily loaded which means that fair amounts of locking
+is used to ensure that metadata is processed properly. Enabling preloading allows OpenJPA
to
+load metadata upfront and remove locking. See <xref linkend="ref_guide_meta_repository"/>
for details.
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml?rev=946726&r1=946725&r2=946726&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml Thu May 20 17:54:37
2010
@@ -354,7 +354,7 @@ use detached state managers, as determin
DetachState setting.</emphasis> Detach all fields and relations as described by the
loaded
property when an explicit detach is requested or when a
single Entity is being detached as part of serialization. When the entire
-persistence context is being auto-detached(@See openjpa.AutoDetach),
+persistence context is being auto-detached ( <literal>openjpa.AutoDetach</literal>
),
the minimal amount of work will be completed to disassociate all Entities from
the persistence context. <emphasis role="bold">It is highly recommended that all Entities
have a
@Version field when using this property</emphasis>. In addition, care needs to be taken
|