traceDirectory=path 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 @@ + + + +traceDirectory=path attribute + + +traceDirectory=path database connection URL attribute + + + +

Function +

Specifies a directory to which the + 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 _driver_0, _driver_1, and so +on. Use the +traceFile=path +attribute to specify a file name for the trace file.

If the directory does not exist, + issues an error +message. If you do not specify an absolute path name, the directory is assumed +to be relative to the current directory.

For more information about tracing, see "Network client tracing" in the +. See +traceFile=path, +traceFileAppend=true, +and +traceLevel=value +for other attributes related to tracing. +

Combining with other attributes +

You can combine this attribute with other attributes.

+Examples +-- 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 + + + + 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 @@ + + + +traceFile=path attribute + + +traceFile=path database connection URL attribute + + + +

Function +

Specifies a file to which the + Network Client will +send JDBC trace information. If you do not specify an absolute path name, the +file is placed in the derby.system.home directory (see "Defining the +system directory" in the for +details).

If you specify both traceFile=path and +traceFileAppend=true, +the output is appended to the specified file, if it exists. If you specify +traceFile=path but do not specify traceFileAppend=true, any previous version of the file +of the file is overwritten.

For more information about tracing, see "Network client tracing" in the +. See +traceDirectory=path +and +traceLevel=value +for other attributes related to tracing.

Combining with other attributes +

You can combine this attribute with other attributes.

+Example +-- enable tracing on a new database +jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out + + + + 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 @@ + + + +traceFileAppend=true attribute + + +traceFileAppend=true database connection URL attribute + + + +

Function +

Specifies that the +Network Client should append JDBC trace information to a trace file. The file +can be specified by the +traceFile=path +attribute. If you do not specify a trace file but you specify the +traceDirectory=path +attribute, the trace information is appended to the default file. If you do not +specify traceFileAppend=true, any previous version of the trace file is +overwritten.

For more information about tracing, see "Network client tracing" in the +. See traceDirectory=path +and +traceLevel=value +for other attributes related to tracing.

Combining with other attributes +

This attribute must be specified in conjunction with either the +traceFile=path attribute or the traceDirectory=path attribute. You +can also combine this attribute with other attributes.

+Example +-- 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 + + + + 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 @@ + + + +traceLevel=value attribute + + +traceLevel=value database connection URL attribute + + + +

Function +

If tracing is enabled, specifies the level of tracing to be used by the + Network Client. The +value is numeric. If you +do not specify a trace level, the default is TRACE_ALL. +

For more information about tracing, see "Network client tracing" in the +. See +traceFile=path, +traceFileAppend=true, +and +traceDirectory=path +for other attributes related to tracing. +

Tracing levels +

The following table shows the available tracing levels and their values.

+Available tracing levels and values + + + + + +Trace level +Hex value +Decimal value + + + + +org.apache.derby.jdbc.ClientDataSource.TRACE_NONE +0x0 +0 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_CONNECTION_CALLS +0x1 +1 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_STATEMENT_CALLS +0x2 +2 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_RESULT_SET_CALLS +0x4 +4 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_DRIVER_CONFIGURATION +0x10 +16 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_CONNECTS +0x20 +32 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_PROTOCOL_FLOWS +0x40 +64 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_RESULT_SET_META_DATA +0x80 +128 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_PARAMETER_META_DATA +0x100 +256 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_DIAGNOSTICS +0x200 +512 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_XA_CALLS +0x800 +2048 + + +org.apache.derby.jdbc.ClientDataSource.TRACE_ALL +0xFFFFFFFF +-1 + + + +

To specify more than one trace level, use one of the following techniques: +

If you are using the ij 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.
If you are running a JDBC program, do one of the following: +
- Use bitwise OR operators ( | ) with two or more trace values. For example, +to trace protocol flows and connection calls, specify this value for +traceLevel:TRACE_PROTOCOL_FLOWS | TRACE_CONNECTION_CALLS +
- 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: +~TRACE_PROTOCOL_FLOWS
+

Combining with other attributes +

If you specify this attribute, you must also specify either the +traceFile=path attribute or the traceDirectory=path attribute.

+Example +-- enable tracing on a new database +jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out;traceLevel=65 + + + + Propchange: db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita ------------------------------------------------------------------------------ svn:eol-style = native