OPENJPA-1376: Documentation update - be more specific about OpenJPA versions, improve formatting.

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@1173782 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Milosz Tylenda 2011-09-21 18:28:02 +00:00
parent fe7e359367
commit a381632d14
2 changed files with 28 additions and 28 deletions

View File

@ -408,7 +408,7 @@
</section> </section>
<section id="jpa_2.2_metamodelArrays"> <section id="jpa_2.2_metamodelArrays">
<title> <title>
MetaModel attributes for Arrays MetaModel Attributes for Arrays
</title> </title>
<!-- See OPENJPA-2025 for details. --> <!-- See OPENJPA-2025 for details. -->
<para> <para>
@ -417,7 +417,7 @@
so that arrays which are not stored as PersistentCollections will use a SingularAttribute instead of a ListAttribute. so that arrays which are not stored as PersistentCollections will use a SingularAttribute instead of a ListAttribute.
</para> </para>
<para> <para>
If youre application uses the MetaModel API and your entities contain arrays of any of the following types: byte[], Byte[], char[], Character[] and If your application uses the MetaModel API and your entities contain arrays of any of the following types: byte[], Byte[], char[], Character[] and
do not use the @PersistentCollection annotation with those fields you will need to update your application to use OpenJPA 2.2.0. do not use the @PersistentCollection annotation with those fields you will need to update your application to use OpenJPA 2.2.0.
</para> </para>
<para> In order for the existing applications to work with OpenJPA you may: <para> In order for the existing applications to work with OpenJPA you may:
@ -446,15 +446,15 @@
</section> </section>
<section id="UseNativeSequenceCache"> <section id="UseNativeSequenceCache">
<title> <title>
useNativeSequenceCache property. useNativeSequenceCache Property.
</title> </title>
<!-- See OPENJPA-1376 for details. --> <!-- See OPENJPA-1376 for details. -->
<para> <para>
In the OpenJPA 2.2.x release, code was added which changed the way sequences were generated, please see In OpenJPA 2.2.0, code was added which changed the way sequences were generated, please see
<xref linkend="jpa_2.2_allocationSize"/> for details. This functionality was eventually back ported <xref linkend="jpa_2.2_allocationSize"/> for details. This functionality was eventually back ported
to previous releases, and enabeld by the useNativeSequenceCache property on the DBDictionary. Setting this property to previous releases, and enabled by the <literal>useNativeSequenceCache</literal> property on the DBDictionary. Setting this property
has no effect in 2.2.x and later releases and any occurrence of it should be removed. If previous behavior is has no effect in 2.2.0 and later releases and any occurrence of it should be removed. If previous behavior is
desired (i.e. useNativeSequenceCache=true), please see the details described in section desired (i.e. <literal>useNativeSequenceCache=true</literal>), please see the details described in section
<xref linkend="jpa_2.2_allocationSize"/>. <xref linkend="jpa_2.2_allocationSize"/>.
</para> </para>
</section> </section>

View File

@ -3409,27 +3409,6 @@ ResultSet.getString</methodname> will be used to obtain clob data rather than
<methodname>ResultSet.getCharacterStream</methodname>. <methodname>ResultSet.getCharacterStream</methodname>.
</para> </para>
</listitem> </listitem>
<listitem id="DBDictionary.UseSchemaName">
<para>
<indexterm>
<primary>
schema
</primary>
<secondary>
UseSchemaName
</secondary>
</indexterm>
<literal>UseNativeSequenceCache</literal>: This property was used in
2.1.x and prior releases to indicate (when set to false) that OpenJPA
should not use the CACHE clause when getting a native sequence; instead
the INCREMENT BY clause gets its value equal to the allocationSize
property. Post 2.1.x, code was added to allow said functionality by
default (see OPENJPA-1376).
For forward compatibility, this property still remains, however it has
been deprecated and will eventually be removed. Setting this property
has no effect and any occurrence of it should be removed.
</para>
</listitem>
<listitem id="DBDictionary.UseNativeSequenceCache"> <listitem id="DBDictionary.UseNativeSequenceCache">
<para> <para>
<indexterm> <indexterm>
@ -3440,6 +3419,27 @@ has no effect and any occurrence of it should be removed.
UseNativeSequenceCache UseNativeSequenceCache
</secondary> </secondary>
</indexterm> </indexterm>
<literal>UseNativeSequenceCache</literal>: This property was introduced in
the 2.1.2 release to indicate (when set to <literal>false</literal>) that OpenJPA
should not use the <literal>CACHE</literal> clause when creating a native sequence; instead
the <literal>INCREMENT BY</literal> clause gets its value equal to the allocationSize
property. In the 2.2.0 release, code was added to allow said functionality by
default (see OPENJPA-1376).
For forward compatibility, this property still remains, however it has
been deprecated and will eventually be removed. Setting this property
has no effect and any occurrence of it should be removed.
</para>
</listitem>
<listitem id="DBDictionary.UseSchemaName">
<para>
<indexterm>
<primary>
schema
</primary>
<secondary>
UseSchemaName
</secondary>
</indexterm>
<literal>UseSchemaName</literal>: If <literal>false</literal>, then avoid <literal>UseSchemaName</literal>: If <literal>false</literal>, then avoid
including the schema name in table name references. Defaults to <literal>true including the schema name in table name references. Defaults to <literal>true
</literal>. </literal>.