svn commit: r964596 - in /openjpa/branches/1.3.x/openjpa-project/src/doc/manual: ref_guide_dbsetup.xml ref_guide_logging.xml

[mi...@apache.org]

Author: mikedd
Date: Thu Jul 15 21:03:08 2010
New Revision: 964596

URL: http://svn.apache.org/viewvc?rev=964596&view=rev
Log:
OPENJPA-1678: update documentation

Modified:
    openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
    openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_logging.xml

Modified: openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml?rev=964596&r1=964595&r2=964596&view=diff
==============================================================================
--- openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml (original)
+++ openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml Thu Jul 15 21:03:08 2010
@@ -180,6 +180,22 @@ logged SQL statements.
 each pretty-printed SQL line.
                         </para>
                     </listitem>
+                    <listitem>
+                        <para>
+                        <indexterm>
+                            <primary>
+                                SQL
+                            </primary>
+                            <secondary>
+                                PrintParameters
+                            </secondary>
+                        </indexterm>
+<literal>PrintParameters</literal>: A boolean indicating whether SQL parameter 
+values will be included in exception text and when logging is enabled. Since 
+the parameter values may contain sensitive information the default value is 
+false. 
+                        </para>
+                    </listitem>
                 </itemizedlist>
             </listitem>
         </itemizedlist>
@@ -193,7 +209,7 @@ each pretty-printed SQL line.
 &lt;property name="openjpa.ConnectionURL" value="jdbc:hsqldb:db-hypersonic"/&gt;
 &lt;property name="openjpa.ConnectionDriverName" value="org.hsqldb.jdbcDriver"/&gt;
 &lt;property name="openjpa.ConnectionFactoryProperties" 
-    value="PrettyPrint=true, PrettyPrintLineLength=80"/&gt;
+    value="PrettyPrint=true, PrettyPrintLineLength=80, PrintParameters=true"/&gt;
 </programlisting>
         </example>
     </section>

Modified: openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_logging.xml
URL: http://svn.apache.org/viewvc/openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_logging.xml?rev=964596&r1=964595&r2=964596&view=diff
==============================================================================
--- openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_logging.xml (original)
+++ openjpa/branches/1.3.x/openjpa-project/src/doc/manual/ref_guide_logging.xml Thu Jul 15 21:03:08 2010
@@ -177,6 +177,16 @@ about possible performance concerns will
 use. Detailed information about the execution of SQL statements will be sent to
 the <literal>TRACE</literal> level. It is useful to enable this channel if you
 are curious about the exact SQL that OpenJPA issues to the datastore.
+<note>
+The SQL issued to the database may contain sensitive information. By default the
+parameter values used in the prepared statements generated by OpenJPA will not 
+be printed in the SQL log - instead you will see a ? for each value. The actual 
+values may be printed by adding <literal>PrintParameters=True</literal> to the
+<link linkend="openjpa.ConnectionFactoryProperties">
+<literal>openjpa.ConnectionFactoryProperties</literal></link> property. Also
+see <link linkend="ref_guide_dbsetup_builtin"><literal>Using the OpenJPA
+DataSource</literal></link>
+</note>
                 </para>
                 <para>
 When using the built-in OpenJPA logging facilities, you can enable SQL logging