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

OPENJPA-1678: Update documentation re: PrintParameters 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@955383 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Dick 2010-06-16 21:03:04 +00:00
parent cb099098ca
commit 7028247229
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -180,6 +180,22 @@ logged SQL statements.
each pretty-printed SQL line. each pretty-printed SQL line.
</para> </para>
</listitem> </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> </itemizedlist>
</listitem> </listitem>
</itemizedlist> </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.ConnectionURL" value="jdbc:hsqldb:db-hypersonic"/&gt;
&lt;property name="openjpa.ConnectionDriverName" value="org.hsqldb.jdbcDriver"/&gt; &lt;property name="openjpa.ConnectionDriverName" value="org.hsqldb.jdbcDriver"/&gt;
&lt;property name="openjpa.ConnectionFactoryProperties" &lt;property name="openjpa.ConnectionFactoryProperties"
value="PrettyPrint=true, PrettyPrintLineLength=80"/&gt; value="PrettyPrint=true, PrettyPrintLineLength=80, PrintParameters=true"/&gt;
</programlisting> </programlisting>
</example> </example>
</section> </section>

10
openjpa-project/src/doc/manual/ref_guide_logging.xml
View File

@ -177,6 +177,16 @@ about possible performance concerns will be logged to the <literal>INFO
use. Detailed information about the execution of SQL statements will be sent to 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 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. 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>
<para> <para>
When using the built-in OpenJPA logging facilities, you can enable SQL logging When using the built-in OpenJPA logging facilities, you can enable SQL logging