You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by cu...@apache.org on 2010/05/20 20:26:20 UTC
svn commit: r946744 - in
/openjpa/branches/1.2.x/openjpa-project/src/doc/manual: ref_guide_conf.xml
ref_guide_meta.xml ref_guide_optimization.xml
Author: curtisr7
Date: Thu May 20 18:26:20 2010
New Revision: 946744
URL: http://svn.apache.org/viewvc?rev=946744&view=rev
Log:
OPENJPA-1673: Update 1.2.x docs for MetaDataRepository.
Modified:
openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml
openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_meta.xml
openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_optimization.xml
Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml?rev=946744&r1=946743&r2=946744&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_conf.xml Thu May 20 18:26:20 2010
@@ -2231,6 +2231,53 @@ retrieve metadata for your persistent cl
<xref linkend="ref_guide_meta_factory"/> for details.
</para>
</section>
+ <!-- start -->
+ <section id="openjpa.MetaDataRepository">
+ <title>
+ openjpa.MetaDataRepository
+ </title>
+ <indexterm zone="openjpa.MetaDataRepository">
+ <primary>
+ MetaDataRepository
+ </primary>
+ </indexterm>
+ <indexterm zone="openjpa.MetaDataRepository">
+ <primary>
+ metadata
+ </primary>
+ <secondary>
+ MetaDataRepository
+ </secondary>
+ </indexterm>
+ <para>
+<emphasis role="bold">Property name: </emphasis><literal>openjpa.MetaDataRepository
+</literal>
+ </para>
+ <para>
+<emphasis role="bold">Configuration API:</emphasis>
+<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataRepository()">
+<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataRepository
+</methodname></ulink>
+ </para>
+ <para>
+<emphasis role="bold">Resource adaptor config-property: </emphasis><literal>
+MetaDataRepository</literal>
+ </para>
+ <para>
+ <emphasis role="bold">Default:</emphasis>none<literal></literal>
+ </para>
+ <para>
+<emphasis role="bold">Description:</emphasis> A plugin string (see
+<xref linkend="ref_guide_conf_plugins"/>) describing the
+<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataRepository.html">
+<classname>openjpa.meta.MetaDataRepository</classname></ulink> to use to store and
+retrieve metadata for your persistent classes. See
+<xref linkend="ref_guide_meta_repository"/> for details.
+ </para>
+ </section>
+
+ <!-- end -->
+
<section id="openjpa.Multithreaded">
<title>
openjpa.Multithreaded
Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_meta.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_meta.xml?rev=946744&r1=946743&r2=946744&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_meta.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_meta.xml Thu May 20 18:26:20 2010
@@ -119,6 +119,29 @@ scanned for annotated JPA entities.
</programlisting>
</example>
</section>
+ <!-- start added -->
+ <section id="ref_guide_meta_repository">
+ <para>The openjpa.MetaDataRepository configuration property controls the configuration of
+ the MetaDataRepository. The following are valid properties:</para>
+ <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.
+ 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>
+ </itemizedlist>
+
+ <title>Metadata Repository</title>
+ <example id="ref_guide_meta_repo">
+<programlisting>
+<property name="openjpa.MetaDataRepository" value="Preload=true"/>
+</programlisting>
+ </example>
+ </section>
+ <!-- end added -->
<section id="ref_guide_meta_jpa">
<title>
Additional JPA Metadata
Modified: openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_optimization.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_optimization.xml?rev=946744&r1=946743&r2=946744&view=diff
==============================================================================
--- openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_optimization.xml (original)
+++ openjpa/branches/1.2.x/openjpa-project/src/doc/manual/ref_guide_optimization.xml Thu May 20 18:26:20 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>