Apache
/
openjpa
mirror of https://github.com/apache/openjpa.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

OPENJPA-1673: Update docs for MetaDataRepository. 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@946726 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Richard G. Curtis 2010-05-20 17:54:37 +00:00
parent 1c01e8da2a
commit 4a1ab58598
3 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
openjpa-project/src/doc/manual/ref_guide_meta.xml
View File

@ -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>
&lt;property name="openjpa.MetaDataRepository" value="Preload=true,NoLock=true"/&gt;
&lt;property name="openjpa.MetaDataRepository" value="Preload=true"/&gt;
</programlisting>
</example>
</section>

15
openjpa-project/src/doc/manual/ref_guide_optimization.xml
View File

@ -606,6 +606,21 @@ scalability problems. You can disable this protective behavior by setting the
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>

2
openjpa-project/src/doc/manual/ref_guide_remote.xml
View File

@ -354,7 +354,7 @@ use detached state managers, as determined by the settings above.
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