From c4e9860b687432374ac4fd1c7581dd4e76b436a2 Mon Sep 17 00:00:00 2001 From: David Ezzio Date: Thu, 10 Jul 2008 19:48:28 +0000 Subject: [PATCH] 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 --- .../src/doc/manual/ref_guide_dbsetup.xml | 56 +++++++++++-------- 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml b/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml index 9ef0e9066..ddb002ad5 100644 --- a/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml +++ b/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml @@ -760,7 +760,7 @@ to be overridden, and is only used when the schema is generated using the AutoAssignTypeName: The column type name for auto-increment -columns. For example, " SERIAL " for PostgreSQL. This +columns. For example, " BIGSERIAL " 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 mappingtool. @@ -1069,8 +1069,9 @@ generated by the mappingtool. DriverVendor: The vendor of the particular JDBC driver you are using. Some dictionaries must alter their behavior depending on the driver -vendor. See the VENDOR_XXX constants defined in your -dictionary's Javadoc for available options. +vendor. Dictionaries usually detect the driver vendor and set this property +themselves. See the VENDOR_XXX constants defined in the +DBDictionary Javadoc for available options. @@ -1207,7 +1208,7 @@ See . LastGeneratedKeyQuery: The query to issue to obtain the last automatically generated key for an auto-increment column. For example, " -select @@identity " for Sybase. This property is set +SELECT LAST_INSERT_ID() " for MySQL. This property is set automatically in the dictionary, and should not need to be overridden. @@ -1252,7 +1253,7 @@ schema is generated by the mappingtool. MaxAutoAssignNameLength: 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 31. @@ -1346,7 +1347,8 @@ table name. Defaults to 128. NextSequenceQuery: A SQL string for obtaining a native sequence value. May use a placeholder of {0} for the variable -sequence name. Defaults to a database-appropriate value. +sequence name. Defaults to a database-appropriate value. For example, +" SELECT {0}.NEXTVAL FROM DUAL " for Oracle. @@ -1555,10 +1557,13 @@ statement as a SELECT statement rather than an UPDATE statement. SimulateLocking: Some databases do not support pessimistic -locking, which will result in an exception when you attempt a pessimistic -transaction. Setting this property to true bypasses the -locking check to allow pessimistic transactions even on databases that do not -support locking. Defaults to false. +locking, which will result in an exception when you attempt a +transaction while using the pessimistic lock manager. +Setting this property to true 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 false. @@ -1617,13 +1622,16 @@ a warning. StoreLargeNumbersAsStrings -StoreLargeNumbersAsStrings: 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 -BigInteger and BigDecimal 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 false. +StoreLargeNumbersAsStrings: When true, the dictionary +prefers to store Java fields of +type BigInteger and BigDecimal) +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 false. @@ -1738,8 +1746,12 @@ the SET DEFAULT foreign key delete action. Defaults to true. SupportsDeferredConstraints -SupportsDeferredConstraints: Whether the database supports -deferred constraints. Defaults to true. +SupportsDeferredConstraints: 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 true. @@ -2053,9 +2065,9 @@ select that is limited to the first N results. SupportsSelectForUpdate -SupportsSelectForUpdate: If true, then the database supports -SELECT statements with a pessimistic locking clause. Defaults -to true. +SupportsSelectForUpdate: When true, the database supports +SELECT statements with a pessimistic locking +(FOR UPDATE) clause. Defaults to true.