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

Many copy-edit corrections. 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/branches/1.1.x@677746 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
David Ezzio 2008-07-17 21:40:48 +00:00
parent c7e85d169f
commit 639463187f
1 changed files with 121 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

233
openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
View File

@ -114,8 +114,8 @@ plugin parameters described in <xref linkend="ref_guide_conf_plugins"/>.
ConnectionProperties
</primary>
</indexterm>
<link linkend="openjpa.ConnectionProperties"><literal>
openjpa.ConnectionProperties</literal></link>: If the listed driver is an
<link linkend="openjpa.ConnectionProperties">
<literal>openjpa.ConnectionProperties</literal></link>: If the listed driver is an
instance of <classname>java.sql.Driver</classname>, this string will be parsed
into a <classname>Properties</classname> instance, which will then be used to
obtain database connections through the <methodname>Driver.connect(String url,
@ -132,8 +132,8 @@ as a plugin properties string, and matched to the bean setter methods of the
ConnectionFactoryProperties
</primary>
</indexterm>
<link linkend="openjpa.ConnectionFactoryProperties"><literal>
openjpa.ConnectionFactoryProperties</literal></link>: OpenJPA's built-in
<link linkend="openjpa.ConnectionFactoryProperties">
<literal>openjpa.ConnectionFactoryProperties</literal></link>: OpenJPA's built-in
<classname>DataSource</classname> allows you to set the following options via
this plugin string:
</para>
@ -236,12 +236,12 @@ Persistence.createEntityManagerFactory</methodname> under the
</primary>
</indexterm>
Bind the <classname>DataSource</classname> into JNDI, and then specify its
location in the <literal>jta-data-source</literal> or <literal>
non-jta-data-source</literal> element of the
location in the <literal>jta-data-source</literal> or
<literal>non-jta-data-source</literal> element of the
<link linkend="jpa_overview_persistence_xml">JPA XML format</link> (depending on
whether the <classname>DataSource</classname> is managed by JTA), or in the
<link linkend="openjpa.ConnectionFactoryName"><literal>
openjpa.ConnectionFactoryName</literal></link> property.
<link linkend="openjpa.ConnectionFactoryName">
<literal>openjpa.ConnectionFactoryName</literal></link> property.
</para>
</listitem>
<listitem>
@ -252,13 +252,13 @@ openjpa.ConnectionFactoryName</literal></link> property.
</primary>
</indexterm>
Specify the full class name of the <classname>DataSource</classname>
implementation in the <link linkend="openjpa.ConnectionDriverName"><literal>
openjpa.ConnectionDriverName</literal></link> property in place of a JDBC
implementation in the <link linkend="openjpa.ConnectionDriverName">
<literal>openjpa.ConnectionDriverName</literal></link> property in place of a JDBC
driver. In this configuration OpenJPA will instantiate an instance of the named
class via reflection. It will then configure the <classname>DataSource
</classname> with the properties in the
<link linkend="openjpa.ConnectionProperties"><literal>
openjpa.ConnectionProperties</literal></link> setting.
<link linkend="openjpa.ConnectionProperties">
<literal>openjpa.ConnectionProperties</literal></link> setting.
</para>
</listitem>
</itemizedlist>
@ -315,9 +315,9 @@ to the application server. To notify OpenJPA that your third-party <classname>
DataSource</classname> is managed by the application server, use the
<literal>jta-data-source</literal> element of your <filename>
persistence.xml</filename> file or set the
<link linkend="openjpa.ConnectionFactoryMode"><literal>
openjpa.ConnectionFactoryMode</literal></link> property to <literal>
managed</literal>.
<link linkend="openjpa.ConnectionFactoryMode">
<literal>openjpa.ConnectionFactoryMode</literal></link> property to
<literal>managed</literal>.
</para>
<para>
Note that OpenJPA can only use managed <classname>DataSource</classname>s when
@ -777,8 +777,8 @@ to be overridden, and is only used when the schema is generated using the
The column type name for auto-increment
columns. For example, <literal>"BIGSERIAL"</literal> for PostgreSQL. This
property is set automatically in the dictionary and should not need to be
overridden. It is used only when the schema is generated using the <literal>
mappingtool</literal>.
overridden. It is used only when the schema is generated using the
<literal>mappingtool</literal>.
</para>
</listitem>
<listitem id="DBDictionary.BatchLimit">
@ -838,8 +838,8 @@ generated by the <literal>mappingtool</literal>.
BitTypeName
</secondary>
</indexterm>
<literal>BitTypeName</literal>: The overridden default column type for <literal>
java.sql.Types.BIT</literal>. This is used only when the schema is generated by
<literal>BitTypeName</literal>: The overridden default column type for
<literal>java.sql.Types.BIT</literal>. This is used only when the schema is generated by
the <literal>mappingtool</literal>.
</para>
</listitem>
@ -893,8 +893,8 @@ generated by the <literal>mappingtool</literal>.
</secondary>
</indexterm>
<literal>BooleanTypeName</literal>:
The overridden default column type for <literal>
java.sql.Types.BOOLEAN</literal>. This is used only when the schema
The overridden default column type for
<literal>java.sql.Types.BOOLEAN</literal>. This is used only when the schema
is generated by the <literal>mappingtool</literal>.
</para>
</listitem>
@ -1015,7 +1015,8 @@ Usually the pool of connections to the database is closed when the
application is ending. For embedded databases, whose lifecycle is
coterminous with the application, there may be a special
command, usually <literal>"SHUTDOWN"</literal>,
that will cause the embedded database to close cleanly. Defaults to null.
that will cause the embedded database to close cleanly.
Defaults to <literal>null</literal>.
</para>
</listitem>
<listitem id="DBDictionary.ConcatenateFunction">
@ -1033,7 +1034,7 @@ The SQL function call or operation to concatenate two strings.
Use the tokens <literal>{0}</literal> and <literal>{1}</literal> to represent
the two arguments. The result of the function or operation is to concatenate
the <literal>{1}</literal> string to the end of the <literal>{0}</literal>
string. Defaults to <literal>"({0}||{1})</literal>".
string. Defaults to <literal>"({0}||{1})"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.ConstraintNameMode">
@ -1047,10 +1048,10 @@ string. Defaults to <literal>"({0}||{1})</literal>".
</secondary>
</indexterm>
<literal>ConstraintNameMode</literal>: When creating constraints, whether to
put the constraint name before the definition (<literal>before</literal>),
just after the constraint type name (<literal>mid</literal>), or after the
constraint definition (<literal>after</literal>). Defaults to <literal>before
</literal>.
put the constraint name before the definition (<literal>"before"</literal>),
just after the constraint type name (<literal>"mid"</literal>), or after the
constraint definition (<literal>"after"</literal>).
Defaults to <literal>"before"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.CreatePrimaryKeys">
@ -1063,7 +1064,7 @@ constraint definition (<literal>after</literal>). Defaults to <literal>before
CreatePrimaryKeys
</secondary>
</indexterm>
<literal>CreatePrimaryKeys</literal>: If <literal>false</literal>, then do not
<literal>CreatePrimaryKeys</literal>: When false, do not
create database primary keys for identifiers. Defaults to <literal>true
</literal>.
</para>
@ -1079,7 +1080,7 @@ create database primary keys for identifiers. Defaults to <literal>true
</secondary>
</indexterm>
<literal>CrossJoinClause</literal>: The clause to use for a cross join
(cartesian product). Defaults to <literal>CROSS JOIN</literal>.
(cartesian product). Defaults to <literal>"CROSS JOIN"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.CurrentDateFunction">
@ -1190,7 +1191,8 @@ generated by the <literal>mappingtool</literal>.
</indexterm>
<literal>DistinctCountColumnSeparator</literal>: The string the database uses
to delimit between column expressions in a <literal>SELECT COUNT(DISTINCT
column-list)</literal> clause. Defaults to null for most databases, meaning that
column-list)</literal> clause. Defaults to <literal>null</literal>
for most databases, meaning that
multiple columns in a distinct COUNT clause are not supported.
</para>
</listitem>
@ -1276,7 +1278,7 @@ and <literal>INTEGER</literal>.
Each database dictionary has its own internal set of fixed size type names
that include the names mentioned here and many others.
Names added to this property are added to the dictionary's internal set.
Defaults to null.
Defaults to <literal>null</literal>.
</para>
</listitem>
<listitem id="DBDictionary.FloatTypeName">
@ -1314,7 +1316,7 @@ generated by the <literal>mappingtool</literal>.
</indexterm>
<literal>ForUpdateClause</literal>: The clause to append to <literal>SELECT
</literal> statements to issue queries that obtain pessimistic locks. Defaults
to <literal>FOR UPDATE</literal>.
to <literal>"FOR UPDATE"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.GetStringVal">
@ -1401,7 +1403,7 @@ database whenever a connection is retrieved from the <classname>DataSource
</secondary>
</indexterm>
<literal>InnerJoinClause</literal>: The clause to use for an inner join.
Defaults to <literal>INNER JOIN</literal>.
Defaults to <literal>"INNER JOIN"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.IntegerTypeName">
@ -1509,7 +1511,7 @@ schema is generated by the <literal>mappingtool</literal>.
</indexterm>
<literal>MaxAutoAssignNameLength</literal>: Set this property to the maximum
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 31.
</para>
</listitem>
<listitem id="DBDictionary.MaxColumnNameLength">
@ -1698,7 +1700,7 @@ generated by the <literal>mappingtool</literal>.
</secondary>
</indexterm>
<literal>OuterJoinClause</literal>: The clause to use for an left outer join.
Defaults to <literal>LEFT OUTER JOIN</literal>.
Defaults to <literal>"LEFT OUTER JOIN"</literal>.
</para>
</listitem>
<listitem id="DBDictionary.Platform">
@ -1733,8 +1735,9 @@ of the result rows to be returned.
When limiting the number of returned result rows to a subset of all those
that satisfy the query's conditions, the position of the range clause
varies by database.
Defaults to 0 (<literal>RANGE_POST_SELECT</literal>), meaning that the range
Defaults to 0, meaning that the range
is expressed at the end of the select statement but before any locking clause.
See the RANGE_XXX constants defined in <classname>DBDictionary</classname>.
</para>
</listitem>
<listitem id="DBDictionary.RealTypeName">
@ -1762,8 +1765,8 @@ generated by the <literal>mappingtool</literal>.
RefTypeName
</secondary>
</indexterm>
<literal>RefTypeName</literal>: The overridden default column type for <literal>
java.sql.Types.REF</literal>. This is used only when the schema is generated by
<literal>RefTypeName</literal>: The overridden default column type for
<literal>java.sql.Types.REF</literal>. This is used only when the schema is generated by
the <literal>mappingtool</literal>.
</para>
</listitem>
@ -1788,7 +1791,7 @@ the <literal>mappingtool</literal>.
RequiresAliasForSubselect
</tertiary>
</indexterm>
<literal>RequiresAliasForSubselect</literal>: If true, then the database
<literal>RequiresAliasForSubselect</literal>: When true, the database
requires that subselects in a FROM clause be assigned an alias.
</para>
</listitem>
@ -1805,7 +1808,7 @@ requires that subselects in a FROM clause be assigned an alias.
RequiresAutoCommitForMetaData
</tertiary>
</indexterm>
<literal>RequiresAutoCommitForMetadata</literal>: If true, then the JDBC driver
<literal>RequiresAutoCommitForMetadata</literal>: When true, the JDBC driver
requires that autocommit be enabled before any schema interrogation operations
can take place.
</para>
@ -1823,7 +1826,7 @@ can take place.
<literal>RequiresCastForComparisons</literal>:
When true, comparisons of two values of different types or
of two literals requires a cast in the generated SQL.
Defaults to false.
Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.RequiresCastForMathFunctions">
@ -1839,7 +1842,7 @@ Defaults to false.
<literal>RequiresCastForMathFunctions</literal>:
When true, math operations on two values of different types or
on two literals requires a cast in the generated SQL.
Defaults to false.
Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.RequiresConditionForCrossJoin">
@ -1869,7 +1872,7 @@ ensures that there will always be some condition to the join clause.
</indexterm>
<literal>RequiresTargetForDelete</literal>:
When true, the database requires a target for delete statements. Defaults
to false.
to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.ReservedWords">
@ -1955,7 +1958,7 @@ statement as a SELECT statement rather than an UPDATE statement.
</indexterm>
<literal>SequenceNameSQL</literal>:
Additional phrasing to use with <literal>SequenceSQL</literal>.
Defaults to null.
Defaults to <literal>null</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SequenceSQL">
@ -1974,7 +1977,8 @@ Defaults to null.
<literal>SequenceSQL</literal>:
General structure of the SQL query to use when interrogating the database
for sequence names.
As there is no standard way to obtain sequence names, it defaults to null.
As there is no standard way to obtain sequence names,
it defaults to <literal>null</literal>.
</para>
</listitem>
@ -1993,7 +1997,7 @@ As there is no standard way to obtain sequence names, it defaults to null.
</indexterm>
<literal>SequenceSchemaSQL</literal>:
Additional phrasing to use with <literal>SequenceSQL</literal>.
Defaults to null.
Defaults to <literal>null</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SimulateLocking">
@ -2012,7 +2016,8 @@ 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
property to <literal>true</literal> means that you do not obtain the semantics
of a pessimistic
transaction with the database. Defaults to <literal>false</literal>.
</para>
</listitem>
@ -2041,7 +2046,7 @@ is generated by the <literal>mappingtool</literal>.
StorageLimitationsFatal
</secondary>
</indexterm>
<literal>StorageLimitationsFatal</literal>: If true, then any data
<literal>StorageLimitationsFatal</literal>: When true, any data
truncation/rounding that is performed by the dictionary in order to store a
value in the database will be treated as a fatal error, rather than just issuing
a warning.
@ -2138,9 +2143,9 @@ the substring of a string.
SupportsAlterTableWithAddColumn
</secondary>
</indexterm>
<literal>SupportsAlterTableWithAddColumn</literal>: Whether the database
supports adding a new column in an ALTER TABLE statement. Defaults to <literal>
true</literal>.
<literal>SupportsAlterTableWithAddColumn</literal>: When true, the database
supports adding a new column in an ALTER TABLE statement.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsAlterTableWithDropColumn">
@ -2153,9 +2158,9 @@ true</literal>.
SupportsAlterTableWithDropColumn
</secondary>
</indexterm>
<literal>SupportsAlterTableWithDropColumn</literal>: Whether the database
supports dropping a column in an ALTER TABLE statement. Defaults to <literal>
true</literal>.
<literal>SupportsAlterTableWithDropColumn</literal>: When true, the database
supports dropping a column in an ALTER TABLE statement.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsAutoAssign">
@ -2171,7 +2176,7 @@ true</literal>.
<literal>SupportsAutoAssign</literal>:
When true, the database supports auto-assign columns, where the value of
column is assigned upon insertion of the row into the database.
Defaults to false.
Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsCascadeDeleteAction">
@ -2186,7 +2191,7 @@ Defaults to false.
</indexterm>
<literal>SupportsCascadeDeleteAction</literal>: When true, the database supports
the <literal>CASCADE</literal> delete action on foreign keys.
Defaults to true.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsCascadeUpdateAction">
@ -2201,7 +2206,7 @@ Defaults to true.
</indexterm>
<literal>SupportsCascadeUpdateAction</literal>:
When true, the database supports the <literal>CASCADE</literal>
update action on foreign keys. Defaults to true.
update action on foreign keys. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsComments">
@ -2216,7 +2221,7 @@ update action on foreign keys. Defaults to true.
</indexterm>
<literal>SupportsComments</literal>:
When true, comments can be associated with the table in the table creation
statement. Defaults to false.
statement. Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsCorrelatedSubselect">
@ -2234,7 +2239,7 @@ When true, the database supports correlated subselects. Correlated
subselects are select statements nested within select statements that
refers to a column in the outer select statement. For performance
reasons, correlated subselects are generally a last resort.
Defaults to true.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsDefaultDeleteAction">
@ -2249,7 +2254,7 @@ Defaults to true.
</indexterm>
<literal>SupportsDefaultDeleteAction</literal>: When true, the database supports
the <literal>SET DEFAULT</literal> delete action on foreign keys.
Defaults to true.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsDefaultUpdateAction">
@ -2264,7 +2269,7 @@ Defaults to true.
</indexterm>
<literal>SupportsDefaultUpdateAction</literal>:
When true, the database supports the <literal>SET DEFAULT</literal> update
action on foreign keys. Defaults to true.
action on foreign keys. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsDeferredConstraints">
@ -2295,8 +2300,8 @@ transaction. Defaults to <literal>true</literal>.
SupportsForeignKeys
</secondary>
</indexterm>
<literal>SupportsForeignKeys</literal>: Whether the database supports foreign
keys. Defaults to true.
<literal>SupportsForeignKeys</literal>: When true, the database supports foreign
keys. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsHaving">
@ -2312,7 +2317,7 @@ keys. Defaults to true.
SupportsHaving
</tertiary>
</indexterm>
<literal>SupportsHaving</literal>: Whether this database supports HAVING
<literal>SupportsHaving</literal>: When true, the database supports HAVING
clauses in selects.
</para>
</listitem>
@ -2326,9 +2331,9 @@ clauses in selects.
SupportsLockingWithDistinctClause
</secondary>
</indexterm>
<literal>SupportsLockingWithDistinctClause</literal>: If true, then the
database supports <literal>FOR UPDATE</literal> select clauses with <literal>
DISTINCT</literal> clauses.
<literal>SupportsLockingWithDistinctClause</literal>: When true, the
database supports <literal>FOR UPDATE</literal> select clauses with
<literal>DISTINCT</literal> clauses.
</para>
</listitem>
<listitem id="DBDictionary.SupportsLockingWithInnerJoin">
@ -2341,7 +2346,7 @@ DISTINCT</literal> clauses.
SupportsLockingWithInnerJoin
</secondary>
</indexterm>
<literal>SupportsLockingWithInnerJoin</literal>: If true, then the database
<literal>SupportsLockingWithInnerJoin</literal>: When true, the database
supports <literal>FOR UPDATE</literal> select clauses with inner join queries.
</para>
</listitem>
@ -2355,7 +2360,7 @@ supports <literal>FOR UPDATE</literal> select clauses with inner join queries.
SupportsLockingWithMultipleTables
</secondary>
</indexterm>
<literal>SupportsLockingWithMultipleTables</literal>: If true, then the
<literal>SupportsLockingWithMultipleTables</literal>: When true, the
database supports <literal>FOR UPDATE</literal> select clauses that select from
multiple tables.
</para>
@ -2370,7 +2375,7 @@ multiple tables.
SupportsLockingWithOrderClause
</secondary>
</indexterm>
<literal>SupportsLockingWithOrderClause</literal>: If true, then the database
<literal>SupportsLockingWithOrderClause</literal>: When true, the database
supports <literal>FOR UPDATE</literal> select clauses with <literal>ORDER BY
</literal> clauses.
</para>
@ -2385,7 +2390,7 @@ supports <literal>FOR UPDATE</literal> select clauses with <literal>ORDER BY
SupportsLockingWithOuterJoin
</secondary>
</indexterm>
<literal>SupportsLockingWithOuterJoin</literal>: If true, then the database
<literal>SupportsLockingWithOuterJoin</literal>: When true, the database
supports <literal>FOR UPDATE</literal> select clauses with outer join queries.
</para>
</listitem>
@ -2399,10 +2404,10 @@ supports <literal>FOR UPDATE</literal> select clauses with outer join queries.
SupportsLockingWithSelectRange
</secondary>
</indexterm>
<literal>SupportsLockingWithSelectRange</literal>: If true, then the database
<literal>SupportsLockingWithSelectRange</literal>: When true, the database
supports <literal>FOR UPDATE</literal> select clauses with queries that select a
range of data using <literal>LIMIT</literal>, <literal>TOP</literal> or the
database equivalent. Defaults to true.
database equivalent. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsModOperator">
@ -2417,14 +2422,15 @@ database equivalent. Defaults to true.
</indexterm>
<literal>SupportsModOperator</literal>:
When true, the database supports the modulus operator (<literal>%</literal>)
instead of the <literal>MOD</literal> function. Defaults to false.
instead of the <literal>MOD</literal> function.
Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsMultipleNontransactionalResultSets">
<para>
<literal>SupportsMultipleNontransactionalResultSets</literal>: If true, then a
nontransactional connection is capable of having multiple open <classname>
ResultSet</classname> instances.
<literal>SupportsMultipleNontransactionalResultSets</literal>: When true, a
nontransactional connection is capable of having multiple open
<classname>ResultSet</classname> instances.
</para>
</listitem>
<listitem id="DBDictionary.SupportsNullDeleteAction">
@ -2439,7 +2445,7 @@ ResultSet</classname> instances.
</indexterm>
<literal>SupportsNullDeleteAction</literal>: When true, the database supports
the <literal>SET NULL</literal> delete action on foreign keys.
Defaults to true.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsNullTableForGetColumns">
@ -2455,7 +2461,7 @@ Defaults to true.
SupportsNullTableForGetColumns
</tertiary>
</indexterm>
<literal>SupportsNullTableForGetColumns</literal>: If true, then the database
<literal>SupportsNullTableForGetColumns</literal>: When true, the database
supports passing a <literal>null</literal> parameter to <methodname>
DatabaseMetaData.getColumns</methodname> as an optimization to get information
about all the tables. Defaults to <literal>true</literal>.
@ -2474,7 +2480,7 @@ about all the tables. Defaults to <literal>true</literal>.
SupportsNullTableForGetImportedKeys
</tertiary>
</indexterm>
<literal>SupportsNullTableForGetImportedKeys</literal>: If true, then the
<literal>SupportsNullTableForGetImportedKeys</literal>: When true, the
database supports passing a <literal>null</literal> parameter to <methodname>
DatabaseMetaData.getImportedKeys</methodname> as an optimization to get
information about all the tables. Defaults to <literal>false</literal>.
@ -2493,7 +2499,7 @@ information about all the tables. Defaults to <literal>false</literal>.
SupportsNullTableForGetIndexInfo
</tertiary>
</indexterm>
<literal>SupportsNullTableForGetIndexInfo</literal>: If true, then the database
<literal>SupportsNullTableForGetIndexInfo</literal>: When true, the database
supports passing a <literal>null</literal> parameter to <methodname>
DatabaseMetaData.getIndexInfo</methodname> as an optimization to get information
about all the tables. Defaults to <literal>false</literal>.
@ -2512,7 +2518,7 @@ about all the tables. Defaults to <literal>false</literal>.
SupportsNullTableForGetPrimaryKeys
</tertiary>
</indexterm>
<literal>SupportsNullTableForGetPrimaryKeys</literal>: If true, then the
<literal>SupportsNullTableForGetPrimaryKeys</literal>: When true, the
database supports passing a <literal>null</literal> parameter to <methodname>
DatabaseMetaData.getPrimaryKeys</methodname> as an optimization to get
information about all the tables. Defaults to <literal>false</literal>.
@ -2530,7 +2536,7 @@ information about all the tables. Defaults to <literal>false</literal>.
</indexterm>
<literal>SupportsNullUpdateAction</literal>:
When true, the database supports the <literal>SET NULL</literal> update
action on foreign keys. Defaults to true.
action on foreign keys. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsQueryTimeout">
@ -2546,7 +2552,7 @@ action on foreign keys. Defaults to true.
SupportsQueryTimeout
</tertiary>
</indexterm>
<literal>SupportsQueryTimeout</literal>: If true, then the JDBC driver supports
<literal>SupportsQueryTimeout</literal>: When true, the JDBC driver supports
calls to <methodname> java.sql.Statement.setQueryTimeout</methodname>.
</para>
</listitem>
@ -2562,7 +2568,7 @@ calls to <methodname> java.sql.Statement.setQueryTimeout</methodname>.
</indexterm>
<literal>SupportsRestrictDeleteAction</literal>: When true, the database
supports the <literal>RESTRICT</literal> delete action on foreign keys.
Defaults to true.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsRestrictUpdateAction">
@ -2576,8 +2582,8 @@ Defaults to true.
</secondary>
</indexterm>
<literal>SupportsRestrictUpdateAction</literal>:
When true, the database supports the <select>RESTRICT</select> update
action on foreign keys. Defaults to true.
When true, the database supports the <literal>RESTRICT</literal> update
action on foreign keys. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsSchemaForGetColumns">
@ -2593,7 +2599,7 @@ action on foreign keys. Defaults to true.
SupportsSchemaForGetColumns
</tertiary>
</indexterm>
<literal>SupportsSchemaForGetColumns</literal>: If false, then the database
<literal>SupportsSchemaForGetColumns</literal>: When false, the database
driver does not support using the schema name for schema reflection on column
names.
</para>
@ -2629,7 +2635,7 @@ names.
SupportsSelectEndIndex
</tertiary>
</indexterm>
<literal>SupportsSelectEndIndex</literal>: Whether this database can create a
<literal>SupportsSelectEndIndex</literal>: When true, the database can create a
select that is limited to the first N results.
</para>
</listitem>
@ -2661,7 +2667,7 @@ select that is limited to the first N results.
SupportsSelectStartIndex
</tertiary>
</indexterm>
<literal>SupportsSelectStartIndex</literal>: Whether this database can create a
<literal>SupportsSelectStartIndex</literal>: When true, the database can create a
select that skips the first N results.
</para>
</listitem>
@ -2686,7 +2692,7 @@ select that skips the first N results.
SupportsSubselect
</tertiary>
</indexterm>
<literal>SupportsSubselect</literal>: Whether this database supports subselects
<literal>SupportsSubselect</literal>: When true, the database supports subselects
in queries.
</para>
</listitem>
@ -2697,7 +2703,9 @@ in queries.
SupportsTimestampNanos
</primary>
</indexterm>
<literal>SupportsTimestampNanos</literal>: Whether the database supports nanoseconds with TIMESTAMP columns. Defaults to true.
<literal>SupportsTimestampNanos</literal>: When true, the database supports
nanoseconds with TIMESTAMP columns.
Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsUniqueConstraints">
@ -2710,8 +2718,8 @@ in queries.
SupportsUniqueConstraints
</secondary>
</indexterm>
<literal>SupportsUniqueConstraints</literal>: Whether the database supports
unique constraints. Defaults to true.
<literal>SupportsUniqueConstraints</literal>: When true, the database supports
unique constraints. Defaults to <literal>true</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SupportsXMLColumn">
@ -2727,7 +2735,7 @@ unique constraints. Defaults to true.
<literal>SupportsXMLColumn</literal>:
When true, the database supports an XML column type. See
<xref linkend="ref_guide_xmlmapping"/>
for information on using this capability. Defaults to false.
for information on using this capability. Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="DBDictionary.SystemSchemas">
@ -2783,7 +2791,8 @@ should be ignored.
</secondary>
</indexterm>
<literal>TableForUpdateClause</literal>: The clause to append to the end of
each table alias in queries that obtain pessimistic locks. Defaults to null.
each table alias in queries that obtain pessimistic locks.
Defaults to <literal>null</literal>.
</para>
</listitem>
<listitem id="DBDictionary.TableTypes">
@ -2953,7 +2962,7 @@ Defaults to <literal>"TRIM(TRAILING {1} FROM {0})"</literal>.
UseGetBestRowIdentifierForPrimaryKeys
</tertiary>
</indexterm>
<literal>UseGetBestRowIdentifierForPrimaryKeys</literal>: If true, then
<literal>UseGetBestRowIdentifierForPrimaryKeys</literal>: When true,
metadata queries will use <methodname>DatabaseMetaData.getBestRowIdentifier
</methodname> to obtain information about primary keys, rather than <methodname>
DatabaseMetaData.getPrimaryKeys</methodname>.
@ -2969,7 +2978,7 @@ DatabaseMetaData.getPrimaryKeys</methodname>.
UseGetBytesForBlobs
</secondary>
</indexterm>
<literal>UseGetBytesForBlobs</literal>: If true, then <methodname>
<literal>UseGetBytesForBlobs</literal>: When true, <methodname>
ResultSet.getBytes</methodname> will be used to obtain blob data rather than
<methodname>ResultSet.getBinaryStream</methodname>.
</para>
@ -2984,7 +2993,7 @@ ResultSet.getBytes</methodname> will be used to obtain blob data rather than
UseGetObjectForBlobs
</secondary>
</indexterm>
<literal>UseGetObjectForBlobs</literal>: If true, then <methodname>
<literal>UseGetObjectForBlobs</literal>: When true, <methodname>
ResultSet.getObject</methodname> will be used to obtain blob data rather than
<methodname>ResultSet.getBinaryStream</methodname>.
</para>
@ -2999,7 +3008,7 @@ ResultSet.getObject</methodname> will be used to obtain blob data rather than
UseGetStringForClobs
</secondary>
</indexterm>
<literal>UseGetStringForClobs</literal>: If true, then <methodname>
<literal>UseGetStringForClobs</literal>: When true, <methodname>
ResultSet.getString</methodname> will be used to obtain clob data rather than
<methodname>ResultSet.getCharacterStream</methodname>.
</para>
@ -3029,7 +3038,7 @@ including the schema name in table name references. Defaults to <literal>true
UseSetBytesForBlobs
</secondary>
</indexterm>
<literal>UseSetBytesForBlobs</literal>: If true, then <methodname>
<literal>UseSetBytesForBlobs</literal>: When true, <methodname>
PreparedStatement.setBytes</methodname> will be used to set blob data, rather
than <methodname>PreparedStatement.setBinaryStream</methodname>.
</para>
@ -3044,7 +3053,7 @@ than <methodname>PreparedStatement.setBinaryStream</methodname>.
UseSetStringForClobs
</secondary>
</indexterm>
<literal>UseSetStringForClobs</literal>: If true, then <methodname>
<literal>UseSetStringForClobs</literal>: When true, <methodname>
PreparedStatement.setString</methodname> will be used to set clob data, rather
than <methodname>PreparedStatement.setCharacterStream</methodname>.
</para>
@ -3115,8 +3124,8 @@ generated by the <literal>mappingtool</literal>.
<literal>XmlTypeName</literal>:
The column type name for XML columns. This
property is set automatically in the dictionary and should not need to be
overridden. It is used only when the schema is generated using the <literal>
mappingtool</literal>. Defaults to <literal>"XML"</literal>.
overridden. It is used only when the schema is generated using the
<literal>mappingtool</literal>. Defaults to <literal>"XML"</literal>.
</para>
</listitem>
<!-- Please keep the list of dictionary properties
@ -3154,8 +3163,8 @@ properties:
deserialize BLOBs on calls to <methodname>ResultSet.getObject</methodname>. The
<classname>MySQLDictionary</classname> overrides the standard <methodname>
DBDictionary.getBlobObject</methodname> method to take this into account. If
your driver does not deserialize automatically, set this property to <literal>
false</literal>.
your driver does not deserialize automatically, set this property to
<literal>false</literal>.
</para>
</listitem>
<listitem id="MySQLDictionary.TableType">
@ -3169,7 +3178,7 @@ false</literal>.
</secondary>
</indexterm>
<literal>TableType</literal>: The MySQL table type to use when creating tables.
Defaults to <literal>innodb</literal>.
Defaults to <literal>"innodb"</literal>.
</para>
</listitem>
<listitem id="MySQLDictionary.UseClobs">
@ -3183,8 +3192,8 @@ Defaults to <literal>innodb</literal>.
</secondary>
</indexterm>
<literal>UseClobs</literal>: Some older versions of MySQL do not handle clobs
correctly. To enable clob functionality, set this to true. Defaults to <literal>
false</literal>.
correctly. To enable clob functionality, set this to <literal>true</literal>.
Defaults to <literal>false</literal>.
</para>
</listitem>
<listitem id="MySQLDictionary.OptimizeMultiTableDeletes">
@ -3248,7 +3257,7 @@ properties:
UseTriggersForAutoAssign
</tertiary>
</indexterm>
<literal>UseTriggersForAutoAssign</literal>: If true, then OpenJPA will allow
<literal>UseTriggersForAutoAssign</literal>: When true, OpenJPA will allow
simulation of auto-increment columns by the use of Oracle triggers. OpenJPA will
assume that the current sequence value from the sequence specified in the
<literal>AutoAssignSequenceName</literal> parameter will hold the value of the
@ -3338,7 +3347,7 @@ CLOB to persist with the embedded method. Defaults to 4000 characters.
executed against unicode capable columns (the <literal>NCHAR</literal>,
<literal>NVARCHAR</literal>, <literal>NCLOB</literal> Oracle types) required
special handling to be able to store unicode values. Setting this property to
true (the default) will cause OpenJPA to attempt to detect when the column of
<literal>true</literal> (the default) will cause OpenJPA to attempt to detect when the column of
one of these types, and if so, will attempt to correctly configure the statement
using the <methodname> OraclePreparedStatement.setFormOfUse</methodname>. For
more details, see the Oracle
@ -4274,7 +4283,7 @@ following important properties:
<itemizedlist>
<listitem>
<para>
<literal>ForeignKeys</literal>: Set to <literal> true</literal> to automatically
<literal>ForeignKeys</literal>: Set to <literal>true</literal> to automatically
read foreign key information during schema validation.
</para>
</listitem>