db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r610042 - in /db/derby/docs/trunk/src: getstart/cgsusingtoolsutils.dita getstart/tgsrunningdblook.dita tools/ctoolsdblook.dita tools/ctoolsusingdblook.dita
Date Tue, 08 Jan 2008 16:18:21 GMT
Author: dyre
Date: Tue Jan  8 08:18:20 2008
New Revision: 610042

URL: http://svn.apache.org/viewvc?rev=610042&view=rev
Log:
DERBY-3298: Getting Started manual needs clearer introduction to connection URL
Patch contributed by Kim Haase
Patch file: DERBY-3298.diff

Modified:
    db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
    db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita
    db/derby/docs/trunk/src/tools/ctoolsdblook.dita
    db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita

Modified: db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita?rev=610042&r1=610041&r2=610042&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita Tue Jan  8 08:18:20 2008
@@ -50,11 +50,11 @@
 engine. Use the instructions below to run the scripts with the Network Server.</p>
 <section><title>Running the scripts with the Network Server</title><p>To
run
 the scripts with the Network Server, use the following commands: <ul>
-<li>For the <codeph>dblook</codeph> tool, call the script and specify the
<codeph>-d</codeph> option
-and the full URL to the Network Server database. For  example: <codeblock>dblook -d
'jdbc:derby://localhost/myDB;user=usr'</codeblock> </li>
+<li>For the <codeph>sysinfo</codeph> tool, issue the command  <codeblock>NetworkServerControl
sysinfo</codeblock></li>
 <li>For the <codeph>ij</codeph> tool, issue the command  <codeblock>set
DERBY_OPTS=-Dij.protocol=jdbc:derby://localhost/</codeblock> and
 then start <codeph>ij</codeph> by issuing the command <codeph>ij</codeph>.</li>
-<li>For the <codeph>sysinfo</codeph> tool, issue the command  <codeblock>NetworkServerControl
sysinfo</codeblock></li>
+<li>For the <codeph>dblook</codeph> tool, call the script and specify the
<codeph>-d</codeph> option
+and the full connection URL to the Network Server database. For  example: <codeblock>dblook
-d 'jdbc:derby://localhost/myDB;user=usr'</codeblock> </li>
 </ul></p></section>
 <section><title>Additional <ph conref="../conrefs.dita#prod/productshortname"></ph>
utilities</title><p>In
 addition, there are Derby utilities that are system procedures that you can

Modified: db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita?rev=610042&r1=610041&r2=610042&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita (original)
+++ db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita Tue Jan  8 08:18:20 2008
@@ -47,7 +47,7 @@
 <stentry>You must <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir">set
 your environment variables</xref> before you can run the <codeph>dblook</codeph>
utility
 using this method. <p>To run the <codeph>dblook</codeph> script from the
command
-line use:</p><codeblock>dblook -d databaseURL [options]</codeblock><p>The
<codeph>dblook</codeph> script
+line use:</p><codeblock>dblook -d <i>connectionURL</i> [<i>options</i>]</codeblock><p>The
<codeph>dblook</codeph> script
 sets the appropriate environment variables, including the CLASSPATH, and runs
 the <codeph>dblook</codeph> utility. </p></stentry>
 </strow>
@@ -58,21 +58,24 @@
 but are familiar with the Java programming language.  </stentry>
 <stentry>You must set the <ph conref="../conrefs.dita#prod/productinstallpath"></ph>
environment
 variable before you can run the <codeph>dblook</codeph> utility using this
-method. <p>On UNIX, the command is:</p><codeblock>java [options] -jar $DERBY_HOME/lib/derbyrun.jar
dblook -d databaseURL [options]</codeblock><p>On
-Windows, the command is:</p><codeblock>java [options] -jar %DERBY_HOME%\lib\derbyrun.jar
dblook -d databaseURL [options]</codeblock></stentry>
+method. <p>On UNIX, the command is:</p><codeblock>java [options] -jar $DERBY_HOME/lib/derbyrun.jar
dblook -d <i>connectionURL</i> [<i>options</i>]</codeblock><p>On
+Windows, the command is:</p><codeblock>java [options] -jar %DERBY_HOME%\lib\derbyrun.jar
dblook -d <i>connectionURL</i> [<i>options</i>]</codeblock></stentry>
 </strow>
 <strow>
 <stentry>Run <codeph>dblook</codeph> using the <codeph>java</codeph>
command.</stentry>
 <stentry>Use this method if you are familiar with both the Java programming
 language and <ph conref="../conrefs.dita#prod/productshortname"></ph>, and
-you have already set the <codeph>java.exe</codeph> file in your command execution
-PATH.</stentry>
+you have already set your command execution PATH to the location of your 
+<codeph>java</codeph> command.</stentry>
 <stentry>You must set your CLASSPATH. Use the steps specified in <xref href="tgs26250.dita#tgs26250"></xref>.
-Then specify the class name in the <codeph>java</codeph> command.  For example:<codeblock>java
org.apache.derby.tools.dblook -d databaseURL [options]</codeblock
+Then specify the class name in the <codeph>java</codeph> command.  For example:<codeblock>java
org.apache.derby.tools.dblook -d <i>connectionURL</i> [<i>options</i>]</codeblock
 ></stentry>
 </strow>
 </simpletable></context>
-<postreq>See "Using dblook" in the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite>
for
+<postreq>See <xref href="cgsusingtoolsutils.dita#cgsusingtoolsutils"></xref>
+for an example of the use of the <i>connectionURL</i>. See "dblook" and its
+subtopics in the
+<cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite>
for
 more information about using the <codeph>dblook</codeph> utility.</postreq>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/tools/ctoolsdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsdblook.dita?rev=610042&r1=610041&r2=610042&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsdblook.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsdblook.dita Tue Jan  8 08:18:20 2008
@@ -35,17 +35,17 @@
 and <codeph>JAVA_HOME</codeph> environment variables and to add
 <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
 to your path. Then use the following command:
-<codeblock><b>dblook -d <i>databaseURL</i> [<i>options</i>]</b></codeblock>
+<codeblock><b>dblook -d <i>connectionURL</i> [<i>options</i>]</b></codeblock>
 </li>
 <li>If you are a regular Java user but are new to Derby, set the 
 <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph>
 environment variable, then use a <codeph>java</codeph> command to invoke the

 <codeph>derbyrun.jar</codeph> file (all on one line):
 <codeblock>(UNIX) <b>java [<i>options</i>] -jar $DERBY_HOME/lib/derbyrun.jar
dblook
-          -d <i>databaseURL</i> [<i>options</i>]</b>
+          -d <i>connectionURL</i> [<i>options</i>]</b>
 </codeblock>
 <codeblock>(Windows) <b>java [<i>options</i>] -jar %DERBY_HOME%\lib\derbyrun.jar
dblook
-          -d <i>databaseURL</i> [<i>options</i>]</b>
+          -d <i>connectionURL</i> [<i>options</i>]</b>
 </codeblock>
 </li>
 <li>If you are familiar with both the Java programming language and Derby, 
@@ -55,6 +55,6 @@
 <ph conref="../conrefs.dita#prod/productshortname"></ph>
 jar files. Then use a <codeph>java</codeph> command to invoke the 
 <codeph>dblook</codeph> class directly.
-<codeblock><b>java org.apache.derby.tools.dblook -d <i>databaseURL</i>
[<i>options</i>]</b></codeblock></li>
+<codeblock><b>java org.apache.derby.tools.dblook -d <i>connectionURL</i>
[<i>options</i>]</b></codeblock></li>
 </ul>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita?rev=610042&r1=610041&r2=610042&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita Tue Jan  8 08:18:20 2008
@@ -23,10 +23,12 @@
 <conbody>
 <p>The syntax for the command to launch the <codeph>dblook</codeph> utility
 is:</p>
-<codeblock>dblook -d <i>databaseURL</i> [<i>options</i>]</codeblock>
-<p>The value for <varname>databaseURL</varname> is the complete URL
-for the database. Where appropriate, the URL includes any connection attributes
-or properties that might be required to access the database. </p>
+<codeblock>dblook -d <i>connectionURL</i> [<i>options</i>]</codeblock>
+<p>The value for <varname>connectionURL</varname> is the complete URL
+for the database. Where appropriate, the URL includes any connection URL attributes
+that might be required to access the database. For complete 
+information on connection URL attributes, see "Setting attributes for the database
+connection URL" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 <p>For example, to connect to the database 'myDB', the URL would simply be <codeph>'jdbc:derby:myDB';</codeph>
to
 connect using the Network Server to a database 'C:\private\tmp\myDB' on a
 remote server (port 1527), the URL would be:</p>



Mime
View raw message