mirror of https://github.com/apache/openjpa.git
Corrected descriptions of a few existing properties
git-svn-id: https://svn.apache.org/repos/asf/openjpa/branches/1.1.x@675700 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
aa28cbe80e
commit
c4e9860b68
|
@ -760,7 +760,7 @@ to be overridden, and is only used when the schema is generated using the
|
||||||
</tertiary>
|
</tertiary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>AutoAssignTypeName</literal>: The column type name for auto-increment
|
<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
|
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>
|
overridden, and is only used when the schema is generated using the <literal>
|
||||||
mappingtool</literal>.
|
mappingtool</literal>.
|
||||||
|
@ -1069,8 +1069,9 @@ generated by the <literal>mappingtool</literal>.
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>DriverVendor</literal>: The vendor of the particular JDBC driver you
|
<literal>DriverVendor</literal>: The vendor of the particular JDBC driver you
|
||||||
are using. Some dictionaries must alter their behavior depending on the driver
|
are using. Some dictionaries must alter their behavior depending on the driver
|
||||||
vendor. See the <literal>VENDOR_XXX</literal> constants defined in your
|
vendor. Dictionaries usually detect the driver vendor and set this property
|
||||||
dictionary's Javadoc for available options.
|
themselves. See the <literal>VENDOR_XXX</literal> constants defined in the
|
||||||
|
<classname>DBDictionary</classname> Javadoc for available options.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.FloatTypeName">
|
<listitem id="DBDictionary.FloatTypeName">
|
||||||
|
@ -1207,7 +1208,7 @@ See <xref linkend="ref_guide_dbsetup_sql92"/>.
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>LastGeneratedKeyQuery</literal>: The query to issue to obtain the last
|
<literal>LastGeneratedKeyQuery</literal>: The query to issue to obtain the last
|
||||||
automatically generated key for an auto-increment column. For example, "
|
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.
|
automatically in the dictionary, and should not need to be overridden.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -1252,7 +1253,7 @@ schema is generated by the <literal>mappingtool</literal>.
|
||||||
</secondary>
|
</secondary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>MaxAutoAssignNameLength</literal>: Set this property to the maximum
|
<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>.
|
this value are truncated. Defaults to <literal>31</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -1346,7 +1347,8 @@ table name. Defaults to 128.
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>NextSequenceQuery</literal>: A SQL string for obtaining a native
|
<literal>NextSequenceQuery</literal>: A SQL string for obtaining a native
|
||||||
sequence value. May use a placeholder of <literal>{0}</literal> for the variable
|
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>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.NullTypeName">
|
<listitem id="DBDictionary.NullTypeName">
|
||||||
|
@ -1555,10 +1557,13 @@ statement as a SELECT statement rather than an UPDATE statement.
|
||||||
</secondary>
|
</secondary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>SimulateLocking</literal>: Some databases do not support pessimistic
|
<literal>SimulateLocking</literal>: Some databases do not support pessimistic
|
||||||
locking, which will result in an exception when you attempt a pessimistic
|
locking, which will result in an exception when you attempt a
|
||||||
transaction. Setting this property to <literal>true</literal> bypasses the
|
transaction while using the pessimistic lock manager.
|
||||||
locking check to allow pessimistic transactions even on databases that do not
|
Setting this property to <literal>true</literal> suppresses the
|
||||||
support locking. Defaults to <literal>false</literal>.
|
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>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.SmallintTypeName">
|
<listitem id="DBDictionary.SmallintTypeName">
|
||||||
|
@ -1617,13 +1622,16 @@ a warning.
|
||||||
StoreLargeNumbersAsStrings
|
StoreLargeNumbersAsStrings
|
||||||
</secondary>
|
</secondary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>StoreLargeNumbersAsStrings</literal>: Many databases have limitations
|
<literal>StoreLargeNumbersAsStrings</literal>: When true, the dictionary
|
||||||
on the number of digits that can be stored in a numeric field (for example,
|
prefers to store Java fields of
|
||||||
Oracle can only store 38 digits). For applications that operate on very large
|
type <classname>BigInteger</classname> and <classname>BigDecimal</classname>)
|
||||||
<classname>BigInteger</classname> and <classname>BigDecimal</classname> values,
|
as string values in the database. Likewise, the dictionary will instruct
|
||||||
it may be necessary to store these objects as string fields rather than the
|
the mapping tool to map these Java types to character columns.
|
||||||
database's numeric type. Note that this may prevent meaningful numeric queries
|
Because some databases have limitations on the number of digits that can
|
||||||
from being executed against the database. Defaults to <literal>false</literal>.
|
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>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.StringLengthFunction">
|
<listitem id="DBDictionary.StringLengthFunction">
|
||||||
|
@ -1738,8 +1746,12 @@ the SET DEFAULT foreign key delete action. Defaults to <literal>true</literal>.
|
||||||
SupportsDeferredConstraints
|
SupportsDeferredConstraints
|
||||||
</secondary>
|
</secondary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>SupportsDeferredConstraints</literal>: Whether the database supports
|
<literal>SupportsDeferredConstraints</literal>: When true, the database
|
||||||
deferred constraints. Defaults to true.
|
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>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.SupportsForeignKeys">
|
<listitem id="DBDictionary.SupportsForeignKeys">
|
||||||
|
@ -2053,9 +2065,9 @@ select that is limited to the first N results.
|
||||||
SupportsSelectForUpdate
|
SupportsSelectForUpdate
|
||||||
</secondary>
|
</secondary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
<literal>SupportsSelectForUpdate</literal>: If true, then the database supports
|
<literal>SupportsSelectForUpdate</literal>: When true, the database supports
|
||||||
<literal>SELECT</literal> statements with a pessimistic locking clause. Defaults
|
<literal>SELECT</literal> statements with a pessimistic locking
|
||||||
to true.
|
(<literal>FOR UPDATE</literal>) clause. Defaults to <literal>true</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem id="DBDictionary.SupportsSelectStartIndex">
|
<listitem id="DBDictionary.SupportsSelectStartIndex">
|
||||||
|
|
Loading…
Reference in New Issue