db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r599880 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefattribtracedirectory.dita rrefattribtracefile.dita rrefattribtracefileappend.dita rrefattribtracelevel.dita
Date Fri, 30 Nov 2007 17:32:15 GMT
Author: dyre
Date: Fri Nov 30 09:32:06 2007
New Revision: 599880

URL: http://svn.apache.org/viewvc?rev=599880&view=rev
Log:
DERBY-3168: Reference Manual lacks topics on trace-related connection URL 
attributes. Patch file: DERBY-3168-3.diff

Patch contributed by Kim Haase

Added:
    db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefattribtracefile.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita   (with props)
Modified:
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=599880&r1=599879&r2=599880&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Fri Nov 30 09:32:06 2007
@@ -610,6 +610,14 @@
 </topicref>
 <topicref href="rrefattrib56769.dita" navtitle="territory=ll_CC attribute">
 </topicref>
+<topicref href="rrefattribtracedirectory.dita" navtitle="traceDirectory=path attribute">
+</topicref>
+<topicref href="rrefattribtracefile.dita" navtitle="traceFile=path attribute">
+</topicref>
+<topicref href="rrefattribtracefileappend.dita" navtitle="traceFileAppend=true attribute">
+</topicref>
+<topicref href="rrefattribtracelevel.dita" navtitle="traceLevel=value attribute">
+</topicref>
 <topicref href="rrefattribupgrade.dita" navtitle="upgrade=true attribute">
 </topicref>
 <topicref href="rrefattrib10035.dita" navtitle="user=userName attribute">

Added: db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita?rev=599880&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita Fri Nov 30 09:32:06 2007
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<reference id="rrefattribtracedirectory" xml:lang="en-us">
+<title>traceDirectory=path attribute</title>
+<prolog>
+<metadata><keywords>
+<indexterm>traceDirectory=path database connection URL attribute</indexterm>
+</keywords></metadata>
+</prolog>
+<refbody>
+<section><title>Function</title>
+<p>Specifies a directory to which the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client will
+send JDBC trace information. If the program or session has multiple connections,
+the Network Client creates a separate file for each connection. By default, the
+files are named <codeph>_driver_0</codeph>, <codeph>_driver_1</codeph>,
and so
+on. Use the 
+<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>
+attribute to specify a file name for the trace file.</p>
+<p>If the directory does not exist,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> issues an error
+message. If you do not specify an absolute path name, the directory is assumed
+to be relative to the current directory.</p>
+<p>For more information about tracing, see "Network client tracing" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>. See
+<i>traceFile=path</i>,
+<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
+and
+<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
+for other attributes related to tracing.
+</p>
+</section>
+<section><title>Combining with other attributes</title>
+<p>You can combine this attribute with other attributes.</p>
+</section>
+<example><title>Examples</title>
+<codeblock><b>-- enable tracing on an existing database that will have multiple
connections
+jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir
+-- specify a trace file name within the directory
+jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir;traceFile=trace.out
+-- append to the default trace file
+jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir;traceFileAppend=true
+</b></codeblock>
+</example>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefattribtracefile.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracefile.dita?rev=599880&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracefile.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefattribtracefile.dita Fri Nov 30 09:32:06 2007
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<reference id="rrefattribtracefile" xml:lang="en-us">
+<title>traceFile=path attribute</title>
+<prolog>
+<metadata><keywords>
+<indexterm>traceFile=path database connection URL attribute</indexterm>
+</keywords></metadata>
+</prolog>
+<refbody>
+<section><title>Function</title>
+<p>Specifies a file to which the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client will
+send JDBC trace information. If you do not specify an absolute path name, the
+file is placed in the <i>derby.system.home</i> directory (see "Defining the
+system directory" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph> for
+details).</p>
+<p>If you specify both <i>traceFile=path</i> and
+<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
+the output is appended to the specified file, if it exists. If you specify
+<i>traceFile=path</i> but do not specify <i>traceFileAppend=true</i>,
any previous version of the file
+of the file is overwritten.</p>
+<p>For more information about tracing, see "Network client tracing" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>. See
+<i><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
+and
+<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
+for other attributes related to tracing.</p>
+</section>
+<section><title>Combining with other attributes</title>
+<p>You can combine this attribute with other attributes.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>-- enable tracing on a new database
+jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out
+</b></codeblock>
+</example>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefattribtracefile.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita?rev=599880&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita Fri Nov 30 09:32:06 2007
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<reference id="rrefattribtracefileappend" xml:lang="en-us">
+<title>traceFileAppend=true attribute</title>
+<prolog>
+<metadata><keywords>
+<indexterm>traceFileAppend=true database connection URL attribute</indexterm>
+</keywords></metadata>
+</prolog>
+<refbody>
+<section><title>Function</title>
+<p>Specifies that the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+Network Client should append JDBC trace information to a trace file. The file
+can be specified by the
+<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>
+attribute. If you do not specify a trace file but you specify the
+<i><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
+attribute, the trace information is appended to the default file. If you do not
+specify <i>traceFileAppend=true</i>, any previous version of the trace file is
+overwritten.</p>
+<p>For more information about tracing, see "Network client tracing" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>. See <i>traceDirectory=path</i>
+and
+<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
+for other attributes related to tracing.</p>
+</section>
+<section><title>Combining with other attributes</title>
+<p>This attribute must be specified in conjunction with either the 
+<i>traceFile=path</i> attribute or the <i>traceDirectory=path</i>
attribute. You
+can also combine this attribute with other attributes.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>-- enable tracing on an existing database, appending to the
+--   specified file
+jdbc:derby://localhost:1527/mydb;traceFile=trace.out;traceFileAppend=true
+-- enable tracing on an existing database, appending to the default file 
+--   within the specified directory, relative to the Derby home directory
+jdbc:derby://localhost:1527/mydb;traceDirectory=mytracedir;traceFileAppend=true
+</b></codeblock>
+</example>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita?rev=599880&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita Fri Nov 30 09:32:06 2007
@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<reference id="rrefattribtracelevel" xml:lang="en-us">
+<title>traceLevel=value attribute</title>
+<prolog>
+<metadata><keywords>
+<indexterm>traceLevel=value database connection URL attribute</indexterm>
+</keywords></metadata>
+</prolog>
+<refbody>
+<section><title>Function</title>
+<p>If tracing is enabled, specifies the level of tracing to be used by the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client. The

+<i>value</i> is numeric. If you 
+do not specify a trace level, the default is TRACE_ALL.
+</p>
+<p>For more information about tracing, see "Network client tracing" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>. See 
+<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>,
+<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
+and 
+<i><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
+for other attributes related to tracing.
+</p></section>
+<section><title>Tracing levels</title>
+<p>The following table shows the available tracing levels and their values.</p>
+<table frame="all" pgwide="1"><title>Available tracing levels and values</title>
+<tgroup cols="3"><colspec colname="col1" colwidth="136*"/>
+<colspec colname="col2" colwidth="15*"/>
+<colspec colname="col3" colwidth="15*"/>
+<thead>
+<row valign="bottom">
+<entry colname="col1">Trace level</entry>
+<entry colname="col2">Hex value</entry>
+<entry colname="col3">Decimal value</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_NONE</entry>
+<entry colname="col2">0x0</entry>
+<entry colname="col3">0</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_CONNECTION_CALLS</entry>
+<entry colname="col2">0x1</entry>
+<entry colname="col3">1</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_STATEMENT_CALLS</entry>
+<entry colname="col2">0x2</entry>
+<entry colname="col3">2</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_RESULT_SET_CALLS</entry>
+<entry colname="col2">0x4</entry>
+<entry colname="col3">4</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_DRIVER_CONFIGURATION</entry>
+<entry colname="col2">0x10</entry>
+<entry colname="col3">16</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_CONNECTS</entry>
+<entry colname="col2">0x20</entry>
+<entry colname="col3">32</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_PROTOCOL_FLOWS</entry>
+<entry colname="col2">0x40</entry>
+<entry colname="col3">64</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_RESULT_SET_META_DATA</entry>
+<entry colname="col2">0x80</entry>
+<entry colname="col3">128</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_PARAMETER_META_DATA</entry>
+<entry colname="col2">0x100</entry>
+<entry colname="col3">256</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_DIAGNOSTICS</entry>
+<entry colname="col2">0x200</entry>
+<entry colname="col3">512</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_XA_CALLS</entry>
+<entry colname="col2">0x800</entry>
+<entry colname="col3">2048</entry>
+</row>
+<row>
+<entry colname="col1">org.apache.derby.jdbc.ClientDataSource.TRACE_ALL</entry>
+<entry colname="col2">0xFFFFFFFF</entry>
+<entry colname="col3">-1</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<p>To specify more than one trace level, use one of the following techniques:
+</p>
+<ul>
+<li>If you are using the <codeph>ij</codeph> tool, add the decimal values

+together and specify the sum. For example, to trace both PROTOCOL flows and 
+connection calls, add the values for TRACE_PROTOCOL_FLOWS (64) and 
+TRACE_CONNECTION_CALLS (1). Specify the sum, the value 65.</li>
+<li>If you are running a JDBC program, do one of the following:
+<ul>
+<li>Use bitwise OR operators ( | ) with two or more trace values. For example,
+to trace protocol flows and connection calls, specify this value for 
+traceLevel:<codeblock>TRACE_PROTOCOL_FLOWS | TRACE_CONNECTION_CALLS</codeblock>
+</li> 
+<li>Use a bitwise complement operator ( ~ ) with a trace value to specify
+all except a certain trace. For example, to trace everything except protocol
+flows, specify this value for traceLevel:
+<codeblock>~TRACE_PROTOCOL_FLOWS</codeblock></li>
+</ul>
+</li>
+</ul>
+</section>
+<section><title>Combining with other attributes</title>
+<p>If you specify this attribute, you must also specify either the 
+<i>traceFile=path</i> attribute or the <i>traceDirectory=path</i>
attribute.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>-- enable tracing on a new database
+jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out;traceLevel=65
+</b></codeblock>
+</example>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message