db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r603587 - in /db/derby/docs/trunk/src: adminguide/ ref/ tools/ tuning/
Date Wed, 12 Dec 2007 12:15:41 GMT
Author: dyre
Date: Wed Dec 12 04:15:40 2007
New Revision: 603587

URL: http://svn.apache.org/viewvc?rev=603587&view=rev
Log:
DERBY-3262: Documentation is missing cross-references for connection URL attributes
Patch contributed by Kim Haase
Patch file: DERBY-3262.diff

Modified:
    db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita
    db/derby/docs/trunk/src/adminguide/cadminlog98.dita
    db/derby/docs/trunk/src/adminguide/cadminrollforward.dita
    db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita
    db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita
    db/derby/docs/trunk/src/adminguide/tadminlog800206.dita
    db/derby/docs/trunk/src/ref/rrefattrib72457.dita
    db/derby/docs/trunk/src/ref/rrefcreatefrom.dita
    db/derby/docs/trunk/src/ref/rrefrestorefrom.dita
    db/derby/docs/trunk/src/ref/rrefrollforward.dita
    db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
    db/derby/docs/trunk/src/tuning/ctunsetprop38343.dita

Modified: db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita Wed Dec 12 04:15:40 2007
@@ -27,10 +27,15 @@
 </metadata></prolog>
 <refbody>
 <section><p>There are various ways to obtain trace output. However, the easiest
-way to obtain trace output is to use the <codeph>traceFile</codeph> attribute
+way to obtain trace output is to use the <codeph>traceFile=<i>path</i></codeph>
attribute
 on the URL in <codeph>ij</codeph>. The following example shows all tracing
 going to the file <codeph>trace.out</codeph> from an <codeph>ij</codeph>
session.<codeblock>ij>connect 'jdbc:derby://localhost:1527/mydb;
-create=true;traceFile=trace.out;user=user1;password=secret4me';</codeblock></p></section>
+create=true;traceFile=trace.out;user=user1;password=secret4me';</codeblock></p>
+<p>To append trace information to the specified file, use the
+<codeph>traceFileAppend=true</codeph> URL attribute in addition to 
+<codeph>traceFile=<i>path</i></codeph>.</p>
+<p>For more information, see "traceFile=path attribute" and "traceFileAppend=true
+attribute" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p></section>
 <section><title>Implementing ClientDataSource tracing</title><p>You
can use
 one of three methods to collect tracing data while obtaining connections from
 the ClientDataSource:<ul>
@@ -46,13 +51,15 @@
 connections using the DriverManager:<ul>
 <li>Use the <codeph>setLogWriter(java.io.PrintWriter)</codeph> method of
DriverManager
 and set the <codeph>PrintWriter</codeph> to a non null-value.</li>
-<li>Use the <codeph>traceFile</codeph> or <codeph>traceDirectory</codeph>
URL
-attributes to set these properties prior to creating the connection with the <codeph>DriverManager.getConnection()</codeph>
method.</li>
+<li>Use the <codeph>traceFile=<i>path</i></codeph> or <codeph>traceDirectory=<i>path</i></codeph>
URL
+attributes to set these properties prior to creating the connection with the <codeph>DriverManager.getConnection()</codeph>
method.
+For more information, see "traceFile=path attribute" and "traceDirectory=path
+attribute" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</li>
 </ul></p></section>
 <section><title>Changing the default trace level</title><p>The default
trace
 level is <codeph>ClientDataSource.TRACE_ALL</codeph>. You can choose the tracing
 level by calling the <codeph>setTraceLevel(int level)</codeph> method or by
-setting the <codeph>traceLevel</codeph> URL attribute:<codeblock>String
url = "jdbc:derby://samplehost.sampledomain.com:1528/mydb" +
+setting the <codeph>traceLevel=<i>value</i></codeph> URL attribute:<codeblock>String
url = "jdbc:derby://samplehost.sampledomain.com:1528/mydb" +
  ";traceFile=/u/user1/trace.out" +
  ";traceLevel=" +
  org.apache.derby.jdbc.ClientDataSource.TRACE_PROTOCOL_FLOWS;
@@ -124,6 +131,8 @@
 <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></p></section>
+</ul></p>
+<p>For more information, see "traceLevel=value attribute" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/adminguide/cadminlog98.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminlog98.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminlog98.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminlog98.dita Wed Dec 12 04:15:40 2007
@@ -33,7 +33,7 @@
 <p>By default, the transaction log is in the <i>log</i> subdirectory
 of the database directory. Use either of the following methods to store this <i>log</i>
subdirectory in another location:</p>
 <ul>
-<li>Specify the non-default location by using the <i>logDevice</i> attribute
on the database connection URL when you create the database.</li>
+<li>Specify the non-default location by using the <i>logDevice=logDirectoryPath</i>
attribute on the database connection URL when you create the database.</li>
 <li>If the database is already created, move the log manually and update the <i>service.properties</i>
file.</li>
 </ul>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/adminguide/cadminrollforward.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminrollforward.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminrollforward.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminrollforward.dita Wed Dec 12 04:15:40 2007
@@ -106,10 +106,13 @@
 <p><b>Performing roll-forward recovery:</b></p>
 <p>By using the full backup copy, archived logs, and active logs, you can
 restore a database to its most recent state by performing roll-forward recovery.
-You perform a roll-forward recovery by specifying a connection URL attribute <i>rollForwardRecoveryFrom=&lt;BackupPath&gt;</i>
at
+You perform a roll-forward recovery by specifying the connection URL attribute <i>rollForwardRecoveryFrom=path</i>
at
 boot time. This brings the database to its most recent state by using full
 backup copy, archived logs, and active logs. All the log files should be in
 the database log path directory.</p>
+<p>For more information, see "rollForwardRecoveryFrom=path attribute"
+in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
+
 <p><b>Backing up a database:</b></p>
 <p>In the following example, a database named wombat is backed up to the d:/backup
 directory with log archive mode enabled:<codeblock>connect 'jdbc:derby:wombat;create=true';
@@ -127,11 +130,6 @@
 after a media failure:<codeblock>connect 'jdbc:derby:wombat;rollForwardRecoveryFrom=d:/backup/wombat';
 select * from t1;
 ---------------DML/DDL Operations</codeblock></p>
-<p>The following attribute can be specified in the JDBC boot time connection
-URL:</p>
-<p><i>rollForwardRecoveryFrom=&lt;Path&gt;</i></p>
-<p>For more information, see the rollForwardRecoveryFrom=&lt;Path&gt; section
-in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 <p>After a database is restored from full backup, transactions from the online
 archived logs and active logs are replayed.</p>
 </conbody>

Modified: db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita Wed Dec 12 04:15:40 2007
@@ -36,6 +36,9 @@
 logs in a different location. With the <codeph>createFrom=Path</codeph> attribute,
 you do not need to copy the individual log files to the log directory.</p> </context>
 <example>For example, to create the sample database from a backup copy in <filepath>c:\mybackups\sample</filepath>,
-the connection URL should be:  <codeblock>jdbc:derby:sample;createFrom=c:\mybackups\sample</codeblock></example>
+the connection URL should be:  <codeblock>jdbc:derby:sample;createFrom=c:\mybackups\sample</codeblock>
+<p>For more information, see "createFrom=path attribute" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
+</example>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita Wed Dec 12 04:15:40 2007
@@ -30,7 +30,9 @@
 in conjunction with the <codeph>restoreFrom=<i>Path</i></codeph>
attribute
 to store logs in a different location.</p></context>
 <example> For example, to restore the sample database by using a backup copy
-in <filepath>c:\mybackups\sample</filepath>, the connection URL should be: <codeblock>jdbc:derby:sample;restoreFrom=c:\mybackups\sample</codeblock
-></example>
+in <filepath>c:\mybackups\sample</filepath>, the connection URL should be: <codeblock>jdbc:derby:sample;restoreFrom=c:\mybackups\sample</codeblock>
+<p>For more information, see "restoreFrom=path attribute" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
+</example>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/adminguide/tadminlog800206.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminlog800206.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminlog800206.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminlog800206.dita Wed Dec 12 04:15:40 2007
@@ -19,9 +19,9 @@
 limitations under the License.
 -->
 <task id="tadminlog800206" xml:lang="en-us">
-<title>Using the logDevice attribute</title>
+<title>Using the logDevice=logDirectoryPath attribute</title>
 <shortdesc>To specify a non-default location for the log directory, set
-the logDevice attribute on the database connection URL when
+the <codeph>logDevice=<i>logDirectoryPath</i></codeph> attribute
on the database connection URL when
 you create the database.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>logDevice</indexterm><indexterm>service.properties
file<indexterm>setting
@@ -29,15 +29,18 @@
 </metadata></prolog>
 <taskbody>
 <context> <p>This attribute is meaningful only when you are creating
-a database. You can specify <codeph>logDevice</codeph> as either an absolute
-path or as a path that is relative to the directory where the JVM is executed.</p>
<p>Setting logDevice on
-the database connection URL adds an entry to the service.properties file.
-If you ever move the log manually, you will need to alter the entry in service.properties.
-If you move the log back to the default location, remove the logDevice entry
-from the service.properties file.</p> </context>
+a database. You can specify <codeph>logDevice=<i>logDirectoryPath</i></codeph>
as either an absolute
+path or as a path that is relative to the directory where the JVM is executed.</p>
<p>Setting <codeph>logDevice=<i>logDirectoryPath</i></codeph>
on
+the database connection URL adds an entry to the <i>service.properties</i> file.
+If you ever move the log manually, you will need to alter the entry in <i>service.properties</i>.
+If you move the log back to the default location, remove the <i>logDevice</i>
entry
+from the <i>service.properties</i> file.</p> </context>
 <example><p>To check the log location for an existing database, you can retrieve
-the <codeph>logDevice</codeph> attribute as a database property by using the
-following statement:</p><codeblock>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('logDevice')</codeblock></example>
+the <codeph>logDevice=<i>logDirectoryPath</i></codeph> attribute
as a database property by using the
+following statement:</p><codeblock>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('logDevice')</codeblock>
+<p>For more information, see "logDevice=logDirectoryPath attribute" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
+</example>
 </taskbody>
 </task>
 

Modified: db/derby/docs/trunk/src/ref/rrefattrib72457.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib72457.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib72457.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib72457.dita Wed Dec 12 04:15:40 2007
@@ -28,7 +28,11 @@
 <section><title>Function</title> <p>The <i>logDirectoryPath</i>
specifies
 the path to the directory on which to store the database log during database
 creation or restore. Even if specified as a relative path, the <i>logDirectoryPath</i>
is
-stored internally as an absolute path.</p> </section>
+stored internally as an absolute path.</p> 
+<p>For more information about using this attribute, see "Using the
+logDevice=logDirectoryPath attribute" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
+</section>
 <section><title>Combining with other attributes</title> <p>Use
 in conjunction with <i><xref href="rrefattrib26867.dita#rrefattrib26867">create</xref>,
 <xref href="rrefcreatefrom.dita#rrefcreatefrom">createFrom</xref>, 

Modified: db/derby/docs/trunk/src/ref/rrefcreatefrom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcreatefrom.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcreatefrom.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcreatefrom.dita Wed Dec 12 04:15:40 2007
@@ -34,7 +34,10 @@
 location and started. </p> <p>The Log files are copied to the default location.
 The logDevice attribute can be used in conjunction with <i>createFrom=path</i>
to
 store logs in a different location. With <i>createFrom=path</i> you do not
-need to copy the individual log files to the log directory.</p> </section>
+need to copy the individual log files to the log directory.</p> 
+<p>For more information about using this attribute, see "Creating a database
+from a backup copy" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
+</section>
 <section><title>Combining with other attributes</title> <p>Do
 not combine this attribute with <i>rollForwardRecoveryFrom</i>, <i>restoreFrom</i>,
or 
 <i>create</i>.</p> </section>

Modified: db/derby/docs/trunk/src/ref/rrefrestorefrom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefrestorefrom.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefrestorefrom.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefrestorefrom.dita Wed Dec 12 04:15:40 2007
@@ -32,7 +32,10 @@
 backup location, and then restarted.</p> <p>The log files are copied to the
 same location they were in when the backup was taken. The logDevice attribute
 can be used in conjunction with <i>restoreFrom=path</i> to store logs in a
-different location.</p> </section>
+different location.</p> 
+<p>For more information about using this attribute, see "Restoring a database
+from a backup copy" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
+</section>
 <section><title>Combining with other attributes</title> <p>Do
 not combine this attribute with <i>createFrom</i>, 
 <i>rollForwardRecoveryFrom</i>, or <i>create</i>.</p> </section>

Modified: db/derby/docs/trunk/src/ref/rrefrollforward.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefrollforward.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefrollforward.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefrollforward.dita Wed Dec 12 04:15:40 2007
@@ -32,7 +32,10 @@
 all the archived logs since then, and the active log files. All the log files
 should be in the database log directory.</p> <p>After a database is restored
 from full backup, transactions from the online archived logs and the active
-logs are replayed.</p> </section>
+logs are replayed.</p> 
+<p>For more information about using this attribute, see "Roll-forward recovery"
+in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
+</section>
 <section><title>Combining with other attributes</title> <p>Do
 not combine this attribute with <i>createFrom</i>, <i>restoreFrom</i>,
or 
 <i>create</i>.</p> </section>

Modified: db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita Wed Dec 12 04:15:40 2007
@@ -48,8 +48,9 @@
 you want to connect to. This might also include the file system path to the
 database.</p></li>
 <li><i id="rtoolsijtools12861">URLAttributes</i>   <p>One or more
of the supported
-attributes of the database connection URL, such as ;<i>upgrade=true</i>, <i>create=true</i>
or <i>territory=ll_CC</i>.
-For more information, see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p></li>
+attributes of the database connection URL, such as <i>upgrade=true</i>, <i>create=true</i>
or <i>territory=ll_CC</i>.
+For more information, see "Setting attributes for the database connection URL"
+in the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>.</p></li>
 <li><i>host</i>   <p>The name of the machine where the server is
running.
 It can be the name of the machine or the address.</p></li>
 <li><i id="rtoolsijtools27024">port</i>   <p>The port number used
by the server

Modified: db/derby/docs/trunk/src/tuning/ctunsetprop38343.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunsetprop38343.dita?rev=603587&r1=603586&r2=603587&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunsetprop38343.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunsetprop38343.dita Wed Dec 12 04:15:40 2007
@@ -35,5 +35,7 @@
 <note>If you pass in a <i>Properties</i> object
 as an argument to the <i>DriverManager.getConnection</i> call
 when connecting to a database, those properties are used as database connection URL attributes,
-not as properties of the type discussed in this book.</note>
+not as properties of the type discussed in this book. For more information, see
+"java.sql.DriverManager.getConnection method" and "Setting attributes for the
+database connection URL" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</note>
 </conbody></concept>



Mime
View raw message