Author: dezzio
Date: Thu Jul 10 12:48:28 2008
New Revision: 675700
URL: http://svn.apache.org/viewvc?rev=675700&view=rev
Log:
Corrected descriptions of a few existing properties
Modified:
openjpa/branches/1.1.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
Modified:
openjpa/branches/1.1.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
URL:
http://svn.apache.org/viewvc/openjpa/branches/1.1.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml?rev=675700&r1=675699&r2=675700&view=diff
==============================================================================
--- openjpa/branches/1.1.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
(original)
+++ openjpa/branches/1.1.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
Thu Jul 10 12:48:28 2008
@@ -760,7 +760,7 @@
</tertiary>
</indexterm>
<literal>AutoAssignTypeName</literal>: The column type name for auto-increment
-columns. For example, " <literal>SERIAL</literal> " for PostgreSQL. This
+columns. For example, " <literal>BIGSERIAL</literal> " for PostgreSQL. This
property is set automatically in the dictionary, and should not need to be
overridden, and is only used when the schema is generated using the <literal>
mappingtool</literal>.
@@ -1069,8 +1069,9 @@
</indexterm>
<literal>DriverVendor</literal>: The vendor of the particular JDBC driver you
are using. Some dictionaries must alter their behavior depending on the driver
-vendor. See the <literal>VENDOR_XXX</literal> constants defined in your
-dictionary's Javadoc for available options.
+vendor. Dictionaries usually detect the driver vendor and set this property
+themselves. See the <literal>VENDOR_XXX</literal> constants defined in the
+<classname>DBDictionary</classname> Javadoc for available options.
</para>
</listitem>
<listitem id="DBDictionary.FloatTypeName">
@@ -1207,7 +1208,7 @@
</indexterm>
<literal>LastGeneratedKeyQuery</literal>: The query to issue to obtain the last
automatically generated key for an auto-increment column. For example, "
-<literal>select @@identity</literal> " for Sybase. This property is set
+<literal>SELECT LAST_INSERT_ID()</literal> " for MySQL. This property is set
automatically in the dictionary, and should not need to be overridden.
</para>
</listitem>
@@ -1252,7 +1253,7 @@
</secondary>
</indexterm>
<literal>MaxAutoAssignNameLength</literal>: Set this property to the maximum
-length of name for sequences used for auto-increment columns. Names longer than
+length of the sequence name used for auto-increment columns. Names longer than
this value are truncated. Defaults to <literal>31</literal>.
</para>
</listitem>
@@ -1346,7 +1347,8 @@
</indexterm>
<literal>NextSequenceQuery</literal>: A SQL string for obtaining a native
sequence value. May use a placeholder of <literal>{0}</literal> for the
variable
-sequence name. Defaults to a database-appropriate value.
+sequence name. Defaults to a database-appropriate value. For example,
+" <literal>SELECT {0}.NEXTVAL FROM DUAL</literal> " for Oracle.
</para>
</listitem>
<listitem id="DBDictionary.NullTypeName">
@@ -1555,10 +1557,13 @@
</secondary>
</indexterm>
<literal>SimulateLocking</literal>: Some databases do not support pessimistic
-locking, which will result in an exception when you attempt a pessimistic
-transaction. Setting this property to <literal>true</literal> bypasses the
-locking check to allow pessimistic transactions even on databases that do not
-support locking. Defaults to <literal>false</literal>.
+locking, which will result in an exception when you attempt a
+transaction while using the pessimistic lock manager.
+Setting this property to <literal>true</literal> suppresses the
+locking of rows in the database, thereby allowing pessimistic transactions
+even on databases that do not support locking. At the same time, setting this
+property to true means that you do not obtain the semantics of a pessimistic
+transaction with the database. Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SmallintTypeName">
@@ -1617,13 +1622,16 @@
StoreLargeNumbersAsStrings
</secondary>
</indexterm>
-<literal>StoreLargeNumbersAsStrings</literal>: Many databases have limitations
-on the number of digits that can be stored in a numeric field (for example,
-Oracle can only store 38 digits). For applications that operate on very large
-<classname>BigInteger</classname> and <classname>BigDecimal</classname> values,
-it may be necessary to store these objects as string fields rather than the
-database's numeric type. Note that this may prevent meaningful numeric queries
-from being executed against the database. Defaults to <literal>false</literal>.
+<literal>StoreLargeNumbersAsStrings</literal>: When true, the dictionary
+prefers to store Java fields of
+type <classname>BigInteger</classname> and <classname>BigDecimal</classname>)
+as string values in the database. Likewise, the dictionary will instruct
+the mapping tool to map these Java types to character columns.
+Because some databases have limitations on the number of digits that can
+be stored in a numeric column (for example, Oracle can only store 38
+digits), this option may be necessary for some applications.
+Note that this option may prevent OpenJPA from executing meaningful numeric
+queries against the columns. Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.StringLengthFunction">
@@ -1738,8 +1746,12 @@
SupportsDeferredConstraints
</secondary>
</indexterm>
-<literal>SupportsDeferredConstraints</literal>: Whether the database supports
-deferred constraints. Defaults to true.
+<literal>SupportsDeferredConstraints</literal>: When true, the database
+supports deferred constraints. The
+database supports deferred constraints by checking for constraint
+violations when the transaction commits, rather than checking for
+violations immediately after receiving each SQL statement within the
+transaction. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsForeignKeys">
@@ -2053,9 +2065,9 @@
SupportsSelectForUpdate
</secondary>
</indexterm>
-<literal>SupportsSelectForUpdate</literal>: If true, then the database supports
-<literal>SELECT</literal> statements with a pessimistic locking clause.
Defaults
-to true.
+<literal>SupportsSelectForUpdate</literal>: When true, the database supports
+<literal>SELECT</literal> statements with a pessimistic locking
+(<literal>FOR UPDATE</literal>) clause. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsSelectStartIndex">
