db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scotsmat...@apache.org
Subject svn commit: r546665 [2/3] - in /db/derby/docs/trunk/src: getstart/ tools/
Date Tue, 12 Jun 2007 23:24:39 GMT
Modified: db/derby/docs/trunk/src/getstart/rgslib27507.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgslib27507.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgslib27507.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgslib27507.dita Tue Jun 12 16:24:36 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!--  
@@ -20,8 +20,11 @@
 -->
 <reference id="rgslib27507" xml:lang="en-us">
 <title>Scripts included with Derby</title>
-<shortdesc>The <ph conref="gsconrefs.dita#prod/productshortname"></ph> scripts
-are located in the <filepath>/bin</filepath> directory.</shortdesc>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> includes
+scripts that start the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools,
+add the appropriate libraries to the CLASSPATH, and start and stop the Network
+Server. These scripts available only when you download the <i>bin</i> distribution
+of <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Derby<indexterm>scripts</indexterm></indexterm><indexterm>scripts<indexterm>in
 Derby</indexterm></indexterm><indexterm>dblook script<indexterm>in Derby</indexterm></indexterm>
@@ -38,24 +41,44 @@
 <indexterm>scripts<indexterm>stopNetworkServer</indexterm></indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<section><p>The complete list of scripts that are included with Derby are:
-  <ul>
-<li><i>bin/dblook</i>  <p>Runs the <cmdname>dblook</cmdname> tool.</p></li>
-<li><i>bin/ij</i>   <p>Starts the <cmdname>ij</cmdname> tool.</p></li>
-<li><i>bin/NetworkServerControl</i> <p>Runs NetworkServerControl.</p></li>
-<li><i>bin/setEmbeddedCP</i>   <p>Puts all of the <ph conref="gsconrefs.dita#prod/productshortname"></ph> libraries
-for an embedded environment in the classpath.</p></li>
-<li><i>bin/setNetworkClientCP</i> <p>Puts the libraries needed to connect
-to the <ph conref="gsconrefs.dita#prod/productshortname"></ph> Network Server
-into the classpath.</p></li>
-<li><i>bin/setNetworkServerCP</i> <p>Puts the libraries needed to start the <ph
-conref="gsconrefs.dita#prod/productshortname"></ph> Network Server into the
-classpath.</p></li>
-<li><i>bin/startNetworkServer</i> <p>Starts the Network Server on the local
-machine.</p></li>
-<li><i>bin/stopNetworkServer</i> <p>Stops the Network Server on the local
-machine.</p></li>
-<li><i>bin/sysinfo</i>   <p>Runs the <cmdname>sysinfo</cmdname> tool.</p></li>
-</ul></p></section>
+<section><p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
+are located in the <filepath>/bin</filepath> directory where you installed <ph
+conref="../conrefs.dita#prod/productshortname"></ph>. To run the scripts,
+you need to set several environment variables so that the scripts run correctly.
+See <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir"></xref> to set the
+environment variables. </p><p>You must run the <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
+in an appropriate command line environment, such as a Windows command prompt
+or a UNIX shell.</p><p>The complete list of scripts that are included with <ph
+conref="../conrefs.dita#prod/productshortname"></ph> is:   <dl><dlentry>
+<dt><i>bin/dblook</i></dt>
+<dd>Runs the <codeph>dblook</codeph> tool.</dd>
+</dlentry><dlentry>
+<dt><i>bin/ij</i></dt>
+<dd>Starts the <codeph>ij</codeph> tool.</dd>
+</dlentry><dlentry>
+<dt><i>bin/NetworkServerControl</i> </dt>
+<dd>Runs NetworkServerControl.</dd>
+</dlentry><dlentry>
+<dt><i>bin/setEmbeddedCP</i></dt>
+<dd>Puts all of the <ph conref="../conrefs.dita#prod/productshortname"></ph> libraries
+for an embedded environment in the CLASSPATH.</dd>
+</dlentry><dlentry>
+<dt><i>bin/setNetworkClientCP</i></dt>
+<dd>Puts the libraries needed to connect to the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
+Server into the CLASSPATH.</dd>
+</dlentry><dlentry>
+<dt><i>bin/setNetworkServerCP</i> </dt>
+<dd>Puts the libraries needed to start the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
+Server into the CLASSPATH.</dd>
+</dlentry><dlentry>
+<dt><i>bin/startNetworkServer</i></dt>
+<dd>Starts the Network Server on the local machine.</dd>
+</dlentry><dlentry>
+<dt><i>bin/stopNetworkServer</i></dt>
+<dd>Stops the Network Server on the local machine.</dd>
+</dlentry><dlentry>
+<dt><i>bin/sysinfo</i></dt>
+<dd>Runs the <codeph>sysinfo</codeph> tool.</dd>
+</dlentry></dl></p></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/getstart/rgslib46043.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgslib46043.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgslib46043.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgslib46043.dita Tue Jun 12 16:24:36 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!--  
@@ -19,68 +20,83 @@
 -->
 <reference id="rgslib46043" xml:lang="en-us">
 <title>Libraries provided by Derby</title>
-<shortdesc>This section shows the different libraries used by <ph conref="gsconrefs.dita#prod/productshortname"></ph> and
-their function.</shortdesc>
+<shortdesc>This section shows the different libraries used by <ph conref="../conrefs.dita#prod/productshortname"></ph> and
+their purposes.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>derbyclient.jar</indexterm><indexterm>derby.jar</indexterm>
 <indexterm>derbytools.jar</indexterm><indexterm>Sample application libraries</indexterm>
-<indexterm>Sample database libraries</indexterm><indexterm>derbyrun.jar</indexterm></keywords>
+<indexterm>Sample database libraries</indexterm><indexterm>derbyrun.jar</indexterm>
+</keywords>
 </metadata></prolog>
 <refbody>
-<table frame="all"><title>Derby libraries and their use</title>
-<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="50*"/>
-<colspec colname="2" colnum="2" colwidth="50*"/>
-<thead>
-<row>
-<entry colname="1">Library name</entry>
-<entry colname="2">Use</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry nameend="2" namest="1"><b>Engine library</b>   <p>You always need
-this library for embedded environments. For client/server environments, you
-only need this library on the server.</p></entry>
-</row>
-<row>
-<entry colname="1">derby.jar</entry>
-<entry colname="2">For embedded databases </entry>
-</row>
-<row>
-<entry nameend="2" namest="1"><b>Tools libraries</b>   <p>For embedded environments,
-you need a library in the classpath to use a tool. For a client/server environment,
-you need a library on the client only.</p></entry>
-</row>
-<row>
-<entry colname="1">derbytools.jar</entry>
-<entry colname="2">Required for running all the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools
-(such as ij, dblook, and import/export). </entry>
-</row>
-<row>
-<entry colname="1">derbyrun.jar</entry>
-<entry colname="2">Executable jar file that can be used to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools. </entry>
-</row>
-<row>
-<entry nameend="2" namest="1"><b>The Network Server library</b></entry>
-</row>
-<row>
-<entry colname="1">derbynet.jar</entry>
-<entry colname="2">Required to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> Network
-Server.</entry>
-</row>
-<row>
-<entry nameend="2" namest="1"><b>The network client library</b></entry>
-</row>
-<row>
-<entry colname="1">derbyclient.jar</entry>
-<entry colname="2">Required to use the <ph conref="gsconrefs.dita#prod/productshortname"></ph> network
-client driver.</entry>
-</row>
-<row>
-<entry nameend="2" namest="1"><b>The locale libraries</b></entry>
-</row>
-<row>
-<entry colname="1"><ul>
+<section><dl><dlentry>
+<dt>Engine library</dt>
+<dd><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Library Name</stentry>
+<stentry>Use</stentry>
+</sthead>
+<strow>
+<stentry>derby.jar</stentry>
+<stentry>For embedded databases. <p>You always need this library for embedded
+environments. For client/server environments, you only need this library on
+the server.</p></stentry>
+</strow>
+</simpletable></dd>
+</dlentry><dlentry>
+<dt>Tools libraries</dt>
+<dd>For embedded environments, you need a library in the classpath to use
+a tool. For a client/server environment, you need a library on the client
+only.<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Library Names</stentry>
+<stentry>Use</stentry>
+</sthead>
+<strow>
+<stentry>derbytools.jar</stentry>
+<stentry>Required for running all the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+(such as <codeph>ij</codeph>, <codeph>dblook</codeph>, and import/export). </stentry>
+</strow>
+<strow>
+<stentry>derbyrun.jar</stentry>
+<stentry>Executable jar file that can be used to start the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools. </stentry>
+</strow>
+</simpletable></dd>
+</dlentry><dlentry>
+<dt>The Network Server library</dt>
+<dd><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Library Name</stentry>
+<stentry>Use</stentry>
+</sthead>
+<strow>
+<stentry>derbyclient.jar</stentry>
+<stentry>Required to start the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
+Server.</stentry>
+</strow>
+</simpletable></dd>
+</dlentry><dlentry>
+<dt>The network client library</dt>
+<dd><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Library Name</stentry>
+<stentry>Use</stentry>
+</sthead>
+<strow>
+<stentry>derbyclient.jar</stentry>
+<stentry>Required to use the <ph conref="../conrefs.dita#prod/productshortname"></ph> network
+client driver.</stentry>
+</strow>
+</simpletable></dd>
+</dlentry><dlentry>
+<dt>The locale libraries</dt>
+<dd><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Library Names</stentry>
+<stentry>Use</stentry>
+</sthead>
+<strow>
+<stentry><ul>
 <li>derbyLocale_cs.jar</li>
 <li>derbyLocale_de_DE.jar</li>
 <li>derbyLocale_es.jar</li>
@@ -94,12 +110,10 @@
 <li>derbyLocale_ru.jar</li>
 <li>derbyLocale_zh_CN.jar</li>
 <li>derbyLocale_zh_TW.jar</li>
-</ul></entry>
-<entry colname="2">Required to provide translated messages for the indicated
-locales.</entry>
-</row>
-</tbody>
-</tgroup>
-</table>
+</ul></stentry>
+<stentry>Required to provide translated messages for the indicated locales.</stentry>
+</strow>
+</simpletable></dd>
+</dlentry></dl></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/getstart/rgsquck30197.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsquck30197.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsquck30197.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsquck30197.dita Tue Jun 12 16:24:36 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!--  
@@ -19,7 +20,7 @@
 -->
 <reference id="rgsquck30197" xml:lang="en-us">
 <title>Database connection URL</title>
-<shortdesc>You must use a database connection URL when using the <ph conref="gsconrefs.dita#prod/productshortname"></ph>-provided
+<shortdesc>You must use a database connection URL when using the <ph conref="../conrefs.dita#prod/productshortname"></ph>-provided
 embedded driver to connect to a database.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Protocol</indexterm><indexterm>Database connection URL<indexterm>supported
@@ -27,21 +28,23 @@
 </metadata></prolog>
 <refbody>
 <section><p>The format for the database connection URL for connecting to a
-database is:   <codeblock>jdbc:derby:<i>databaseName</i>;<i>URLAttributes</i></codeblock>where:<ul>
-<li><i>databaseName</i>   <p>The name of the database that you want to connect
-to</p></li>
-<li><i>URLAttributes</i>   <p>One or more of the supported attributes of the
-database connection URL, such as ;<i>locale=ll_CC</i> or ;<i>create=true</i>. </p><p>For
-more information, see the <cite><ph conref="gsconrefs.dita#pub/citdevelop"></ph></cite>.</p></li>
+database is:   <codeblock>jdbc:derby:<codeph><varname>databaseName</varname></codeph>;<codeph><varname>URLAttributes</varname></codeph></codeblock
+>where:<ul>
+<li><codeph><varname>databaseName</varname></codeph>   <p>The name of the
+database that you want to connect to</p></li>
+<li><codeph><varname>URLAttributes</varname></codeph>   <p>One or more of
+the supported attributes of the database connection URL, such as <codeph><varname>;locale=ll_CC</varname></codeph> or <codeph><varname>;create=true</varname
+></codeph>. </p><p>For more information, see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p></li>
 </ul></p></section>
-<section><p>For the <ph conref="gsconrefs.dita#prod/productshortname"></ph>-provided
+<section><p>For the <ph conref="../conrefs.dita#prod/productshortname"></ph>-provided
 network client driver, the format for the database connection URL for connecting
-to a database is this:   <codeblock>jdbc:derby://&lt;server>[:&lt;port>]/<i>databaseName</i>[;<i>URLAttributes</i>=&lt;value>[;...]]</codeblock>where
-the &lt;server> and &lt;port> specify the host name (or IP address) and port
-number where the server is listening for requests and <i>databaseName</i> is the 
-name of the database you want to connect to. The <i>URLAttributes</i> can
-be either <ph conref="gsconrefs.dita#prod/productshortname"></ph> embedded
-or network client attributes. See the <ph conref="gsconrefs.dita#pub/citadmin"></ph> for
+to a database is this:   <codeblock>jdbc:derby://<varname>server</varname>[:<varname>port</varname>]/<varname>databaseName</varname>[;<varname>URLAttributes</varname
+>=<varname>value</varname>[;...]]</codeblock>where the <codeph><varname>server</varname></codeph> and <codeph><varname>port</varname></codeph> specify
+the host name (or IP address) and port number where the server is listening
+for requests and <codeph><varname>databaseName</varname></codeph> is the 
+name of the database you want to connect to. The <codeph><varname>URLAttributes</varname></codeph> can
+be either <ph conref="../conrefs.dita#prod/productshortname"></ph> embedded
+or network client attributes. See the <ph conref="../conrefs.dita#pub/citadmin"></ph> for
 more information on accessing the Network Server by using the network client.</p></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/getstart/rgsquck35368.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsquck35368.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsquck35368.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsquck35368.dita Tue Jun 12 16:24:36 2007
@@ -20,11 +20,11 @@
 <reference id="rgsquck35368" xml:lang="en-us">
 <title>Available drivers</title>
 <shortdesc>Different JDBC drivers are available depending on the environment
-you choose for <ph conref="gsconrefs.dita#prod/productshortname"></ph>.</shortdesc>
+you choose for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
 <refbody>
 <section><ul>
 <li>org.apache.derby.jdbc.EmbeddedDriver   <p> A driver for embedded environments,
-when <ph conref="gsconrefs.dita#prod/productshortname"></ph> runs in the same
+when <ph conref="../conrefs.dita#prod/productshortname"></ph> runs in the same
 JVM as the application.</p></li>
 <li>org.apache.derby.jdbc.ClientDriver   <p>A driver for the Network Server
 environment. The Network Server sets up a client/server environment.</p></li>

Modified: db/derby/docs/trunk/src/getstart/rgstrademderby.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgstrademderby.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgstrademderby.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgstrademderby.dita Tue Jun 12 16:24:36 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN"
  "../dtd/topic.dtd">
 <!--  
@@ -21,7 +22,7 @@
 <title>Trademarks</title>
 <body>
 <p>The following terms are trademarks or registered trademarks of other companies
-and have been used in at least one of the documents in the <ph conref="gsconrefs.dita#prod/productlongname"></ph> documentation
+and have been used in at least one of the documents in the <ph conref="../conrefs.dita#prod/productlongname"></ph> documentation
 library:</p>
 <p>Cloudscape, DB2, DB2 Universal Database, DRDA, and IBM are trademarks of
 International Business Machines Corporation in the United States, other countries,

Added: db/derby/docs/trunk/src/getstart/rwwdactivity3.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rwwdactivity3.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/rwwdactivity3.dita (added)
+++ db/derby/docs/trunk/src/getstart/rwwdactivity3.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<reference id="rwwdactivity3" xml:lang="en-us">
+<title>The gsEmbedded program</title>
+<shortdesc>This section describes the <codeph>gsEmbedded.java</codeph> program,
+highlighting details specific to accessing a <ph conref="../conrefs.dita#prod/productshortname"></ph> database
+from a JDBC program.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>gsEmbedded.java program<indexterm>code description</indexterm><indexterm>org.apache.derby.jdbc.EmbeddedDriver</indexterm></indexterm>
+<indexterm>Database<indexterm>shutdown</indexterm></indexterm><indexterm>JDBC</indexterm>
+<indexterm>SQLException</indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> Most of the code related to the database activities performed is
+included in this section, but you might find it helpful to open the program
+file and follow along in a text viewer or editor. The <cite>SECTION NAMES</cite> referred
+to in this section can be found in the comments within the program code and
+serve as cross-reference points between this section and the Java program.
+The program uses methods from the <codeph>gsUtils</codeph> class. The utility
+class code is not described here but is available for review in the file <codeph>gsUtils.java</codeph>.</section>
+<section><title>Initialize the program</title><p><cite>INITIALIZATION SECTION</cite>:
+The initial lines of code identify the Java packages used in the program,
+then set up the Java class <codeph>gsEmbedded</codeph> and the <codeph>main</codeph> method
+signature.  Refer to a Java programming guide for information on these program
+constructs.</p> <codeblock>import java.sql.*;
+
+public class gsEmbedded   
+{
+    public static void main(String[] args)
+   {</codeblock> </section>
+<section><title>Define key variables and objects</title><p><cite>DEFINE VARIABLES
+SECTION</cite>: The initial lines of the <codeph>main</codeph> method define
+the variables and objects used in the  program. This example uses variables
+to store the information needed to connect  to the <ph conref="../conrefs.dita#prod/productshortname"></ph> database.
+The use of variables for this information makes it easy to adapt the program
+to other configurations and other databases.</p><dl><dlentry>
+<dt><codeph>driver</codeph></dt>
+<dd>Stores the name of the <ph conref="../conrefs.dita#prod/productshortname"></ph> embedded
+driver.</dd>
+</dlentry><dlentry>
+<dt><codeph>dbName</codeph></dt>
+<dd>Stores the name of the database.</dd>
+</dlentry><dlentry>
+<dt><codeph>connectionURL</codeph></dt>
+<dd>Stores the <ph conref="../conrefs.dita#prod/productshortname"></ph>  connection
+URL that is used to access the database.</dd>
+</dlentry><dlentry>
+<dt><codeph>createString</codeph></dt>
+<dd>Stores the SQL <codeph>CREATE</codeph> statement for the <codeph>WISH_LIST</codeph> table.</dd>
+</dlentry></dl> <codeblock>String driver = "org.apache.derby.jdbc.EmbeddedDriver";
+String dbName="jdbcDemoDB";
+String connectionURL = "jdbc:derby:" + dbName + ";create=true";
+...
+String createString = "CREATE TABLE WISH_LIST  "
+  +  "(WISH_ID INT NOT NULL GENERATED ALWAYS AS IDENTITY " 
+  ...
+  +  " WISH_ITEM VARCHAR(32) NOT NULL) " ;</codeblock></section>
+<section><title>Start the  <ph conref="../conrefs.dita#prod/productshortname"></ph> engine</title><p><cite>LOAD
+DRIVER SECTION</cite>: Loading the <ph conref="../conrefs.dita#prod/productshortname"></ph> embedded
+JDBC driver starts the <ph conref="../conrefs.dita#prod/productshortname"></ph> database
+engine. The <codeph>try</codeph> and <codeph>catch</codeph> block (the Java
+error-handling construct) catches the exceptions that may occur. A problem
+here  is usually due to an incorrect classpath setting.</p>  <codeblock>String driver = "org.apache.derby.jdbc.EmbeddedDriver";
+...
+try {
+    Class.forName(driver); 
+} catch(java.lang.ClassNotFoundException e) {
+  ...
+}</codeblock></section>
+<section><title>Boot the database</title><p><cite>BOOT DATABASE SECTION</cite>:
+The <codeph>DriverManager</codeph> class  loads the database using the <ph
+conref="../conrefs.dita#prod/productshortname"></ph> connection URL stored
+ in the variable <codeph>connectionURL</codeph>. This URL includes the parameter <codeph>;create=true</codeph> so
+that the database will be created if it does not already exist. The primary <codeph>try</codeph> and <codeph>catch</codeph> block
+begins here. This construct handles errors for the database access code.</p> <codeblock>String connectionURL = "jdbc:derby:" + dbName + ";create=true";
+...
+try {
+    conn = DriverManager.getConnection(connectionURL);
+    ...  <i>&lt;most of the program code is contained here></i>
+}  catch (Throwable e)  {   
+   ...
+}</codeblock></section>
+<section><title>Set up program to execute SQL</title> <p><cite>INITIAL SQL
+SECTION</cite>: The program initializes the objects needed to perform subsequent
+SQL operations and checks to see if the required data  table exists.</p> <p>The
+statement object <codeph>s</codeph> is initialized. If the utility method <codeph>gsUtils.gsChk4Table</codeph> does
+not find the <codeph>WISH_LIST</codeph> table, the statement object's  <codeph>execute</codeph> method
+creates the table by executing the SQL stored  in the variable <codeph>createString</codeph>.</p> <codeblock>s = conn.createStatement();
+if (! gsUtils.gsChk4Table(conn))
+{  
+   System.out.println (" . . . . creating table WISH_LIST");
+   s.execute(createString);
+}</codeblock> <p>The <codeph>INSERT</codeph> statement used to add data to
+the table is bound to the prepared statement object <codeph>psInsert</codeph>.
+The prepared  statement uses the question mark parameter <codeph>?</codeph> to
+represent the data that will be inserted by the user. The program sets the
+actual value to be  inserted later on, before executing the SQL. This is the
+most efficient way to execute SQL statements that will be used multiple times.</p> <codeblock>psInsert = conn.prepareStatement
+   ("insert into WISH_LIST(WISH_ITEM) values (?)");
+</codeblock></section>
+<section><title>Interact with the database</title> <p><cite>ADD / DISPLAY
+RECORD SECTION</cite>: This section uses the utility method <codeph>gsUtils.getWishItem</codeph> to
+gather information from the user. It then uses the objects set up previously
+to insert the data into the <codeph>WISH_LIST</codeph> table and then display
+all records. A standard <codeph>do</codeph> loop causes the program to repeat
+this series of steps until the user types <codeph>exit</codeph>.  The data-related
+activities performed in this section are as follows:</p> <ul>
+<li><p>The <codeph>setString</codeph> method sets the substitution parameter
+of the <codeph>psInsert</codeph> object to the value typed by the user. Then
+the <codeph>executeUpdate</codeph> method performs the database insert. <codeblock>psInsert.setString(1,answer);
+psInsert.executeUpdate();  
+</codeblock></p></li>
+<li><p>The statement object <codeph>s</codeph> is used to select all the records
+in the <codeph>WISH_LIST</codeph> table and store them in the  <codeph>ResultSet</codeph> named <codeph>myWishes</codeph>. <codeblock>myWishes = s.executeQuery("select ENTRY_DATE, WISH_ITEM 
+               from WISH_LIST order by ENTRY_DATE");
+</codeblock> The <codeph>while</codeph> loop reads each record in turn by
+calling the <codeph>next</codeph> method. The <codeph>getTimestamp</codeph> and <codeph>getString</codeph> methods
+return specific fields in the record in the proper format. The fields are
+displayed using rudimentary formatting. <codeblock>while (myWishes.next())
+{
+    System.out.println("On " + myWishes.getTimestamp(1) +
+       " I wished for " + myWishes.getString(2));
+}</codeblock> Close the <codeph>ResultSet</codeph> to release the memory being
+used. <codeblock>myWishes.close();
+</codeblock></p></li>
+</ul> </section>
+<section><title>Shut down the database</title> <p><cite>DATABASE SHUTDOWN
+SECTION</cite>: If an application starts the <ph conref="../conrefs.dita#prod/productshortname"></ph> engine,
+the application should shut down all databases before exiting. The attribute <codeph>;shutdown=true</codeph> in
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> connection URL
+performs the shutdown. The shutdown process cleans up records in the  transaction
+log to ensure a faster startup the next time the database is booted.</p><p>This
+section verifies that the embedded driver is being used, then issues the shutdown
+command and catches the shutdown exception to confirm that the database shut
+down cleanly. The shutdown status is displayed before the program exits.</p> <codeblock>if (driver.equals("org.apache.derby.jdbc.EmbeddedDriver")) {
+   boolean gotSQLExc = false;
+   try {
+      DriverManager.getConnection("jdbc:derby:;shutdown=true");
+   } catch (SQLException se)  {
+      if ( se.getSQLState().equals("XJ015") ) {
+         gotSQLExc = true;
+      }
+   }
+   if (!gotSQLExc) {
+      System.out.println("Database did not shut down normally");
+   }  else  {
+      System.out.println("Database shut down normally");
+   }
+}</codeblock> <note type="important">The XJ015 error is the only exception
+thrown by <ph conref="../conrefs.dita#prod/productshortname"></ph> that indicates
+that an operation succeeded. All other exceptions indicate that an operation
+failed. </note></section>
+<section><title>The errorPrint and SQLExceptionPrint methods</title><p><cite>DERBY
+EXCEPTION REPORTING CLASSES</cite>: The two methods at the end of the file, <codeph>errorPrint</codeph> and <codeph>SQLExceptionPrint</codeph>,
+are generic exception-reporting methods that can be used with any JDBC program.
+This type of exception handling is required because often multiple exceptions
+(<codeph>SQLException</codeph>) are chained together and then thrown. A <codeph>while</codeph> loop
+is used to report on each error in the chain. The  program starts this process
+by calling the <codeph>errorPrint</codeph> method from the <codeph>catch</codeph> block
+of the code that accesses the database.</p> <codeblock>//  Beginning of the primary catch block: uses errorPrint method
+}  catch (Throwable e)  {   
+   /*    Catch all exceptions and pass them to 
+   **    the exception reporting method   */ 
+   System.out.println(" . . . exception thrown:");
+   errorPrint(e);
+}</codeblock><p>The <codeph>errorPrint</codeph> method prints a stack trace
+for all exceptions except a <codeph>SQLException</codeph>. Each <codeph>SQLException</codeph> is
+passed to the  <codeph>SQLExceptionPrint</codeph> method.</p><codeblock>static void errorPrint(Throwable e) {
+   if (e instanceof SQLException) 
+      SQLExceptionPrint((SQLException)e);
+   else {
+      System.out.println("A non SQL error occured.");
+      e.printStackTrace();
+   }   
+}  // END errorPrint </codeblock> <p>The <codeph>SQLExceptionPrint</codeph> method
+iterates through each of the exceptions on the stack. For each error, the
+method displays the codes, message, and stacktrace.</p> <codeblock>//  Iterates through a stack of SQLExceptions 
+static void SQLExceptionPrint(SQLException sqle) {
+   while (sqle != null) {
+      System.out.println("\n---SQLException Caught---\n");
+      System.out.println("SQLState:   " + (sqle).getSQLState());
+      System.out.println("Severity: " + (sqle).getErrorCode());
+      System.out.println("Message:  " + (sqle).getMessage()); 
+      sqle.printStackTrace();  
+      sqle = sqle.getNextException();
+   }
+}  //  END SQLExceptionPrint</codeblock> <p>To see the output produced by
+this method, type a wish-list item with more  than 32 characters, such as <userinput>I
+wish to see a Java program fail</userinput>.</p> </section>
+</refbody>
+</reference>

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

Modified: db/derby/docs/trunk/src/getstart/tgs26250.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgs26250.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgs26250.dita (original)
+++ db/derby/docs/trunk/src/getstart/tgs26250.dita Tue Jun 12 16:24:36 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
  "../dtd/task.dtd">
 <!--  
@@ -19,12 +19,10 @@
 limitations under the License.
 -->
 <task id="tgs26250" xml:lang="en-us">
-<title>Setting the classpath</title>
-<shortdesc>The classpath is a list of the class libraries that are needed
-by the JVM and other Java applications to run your program. The scripts that
-are included with Derby set up their own classpath for running the tools.
-However, to call the tools directly using Java and not using the scripts,
-you need to manually set the CLASSPATH environment variable.</shortdesc>
+<title>Manually setting the CLASSPATH environment variable</title>
+<shortdesc>You can set the CLASSPATH environment variable in the operating
+system either temporarily, permanently, or at run time when you start your
+Java application and the JVM. </shortdesc>
 <prolog><metadata>
 <keywords><indexterm>classpath<indexterm>setting</indexterm></indexterm><indexterm>environment
 variables<indexterm>CLASSPATH</indexterm></indexterm><indexterm>scripts<indexterm>setEmbeddedCP</indexterm></indexterm>
@@ -32,25 +30,32 @@
 </keywords>
 </metadata></prolog>
 <taskbody>
-<context><p>You can set the CLASSPATH environment variable in the operating
-system either temporarily, permanently, or at run time when you start your
-Java application and the JVM. </p><p>In most development environments, it
-is best to temporarily set the CLASSPATH environment variable in the command
-line shell where you are entering commands. <ph conref="gsconrefs.dita#prod/productshortname"></ph> provides
-several scripts in the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
+<context><p>The classpath is a list of the class libraries that are needed
+by the JVM and other Java applications to run your program. There are scripts
+that are included with <ph conref="../conrefs.dita#prod/productshortname"></ph> that
+can set up the classpath to run the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools. </p><p>If
+you want to call the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+directly using Java and not using the scripts, you must manually set the CLASSPATH
+environment variable.</p><p>In most development environments, it is best to
+temporarily set the CLASSPATH environment variable in the command line shell
+where you are entering commands.</p><p> <ph conref="../conrefs.dita#prod/productshortname"></ph> provides
+several scripts in the <ph conref="../conrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
 to help you set your classpath quickly. These scripts are: <dl><dlentry>
 <dt>setEmbeddedCP</dt>
-<dd>The <cmdname>setEmbeddedCP</cmdname> script adds the derby.jar and derbytools.jar
-files to the classpath, when the database engine is used in embedded mode. </dd>
+<dd>Use the <cmdname>setEmbeddedCP</cmdname> script to set the classpath when
+the database engine is used in embedded mode. This script adds the <filepath>derby.jar</filepath> and <filepath>derbytools.jar</filepath> files
+to the classpath. </dd>
 </dlentry><dlentry>
 <dt>setNetworkServerCP</dt>
-<dd>The <cmdname>setNetworkServerCP</cmdname> script adds the 
-derbynet.jar file to the classpath, so that you can start the network server. </dd>
+<dd>Use the <cmdname>setNetworkServerCP</cmdname> script to set the classpath
+when you want to start the network server. This script adds the <filepath>derbynet.jar</filepath> file
+to the classpath. </dd>
 </dlentry><dlentry>
 <dt>setNetworkClientCP</dt>
-<dd>The <cmdname>setNetworkClientCP</cmdname> script adds the derbyclient.jar
-and derbytools.jar files to the classpath, so that you can access databases
-using the network client. </dd>
+<dd>Use the <cmdname>setNetworkClientCP</cmdname> script to set the classpath
+when you want to access databases using the network client. This script adds
+the <filepath>derbyclient.jar</filepath> and <filepath>derbytools.jar</filepath> files
+to the classpath. </dd>
 </dlentry></dl></p><p>To set the classpath temporarily, run the script that
 is appropriate for your environment every time that you open a new command
 window.</p><p>To see the classpath that the script sets, issue the following
@@ -58,7 +63,7 @@
 <li>On UNIX, use <codeph>echo $CLASSPATH</codeph></li>
 <li>On Windows, use <codeph>echo %CLASSPATH%</codeph></li>
 </ul></p></context>
-<postreq>For more information on running the <filepath>ij</filepath> and <filepath>sysinfo</filepath> utilities,
-see the <cite><ph conref="gsconrefs.dita#pub/citutilities"></ph></cite></postreq>
+<postreq>For more information on running the <codeph>ij</codeph> and <codeph>sysinfo</codeph> utilities,
+see the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite></postreq>
 </taskbody>
 </task>

Added: db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita (added)
+++ db/derby/docs/trunk/src/getstart/tgsrunningdblook.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--  
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+   http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<task id="tgsrunningdblook" xml:lang="en-us">
+<title>Running dblook</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> <codeph>dblook</codeph> utility
+is a Data Definition Language (DDL) generation utility.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm><indexterm>Derby</indexterm>tools, dblook</indexterm>
+<indexterm><indexterm><indexterm>Derby</indexterm>utilities, dblook</indexterm><indexterm>dblook
+tool</indexterm>running</indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context><p>The <codeph>dblook</codeph> utility is a simple utility that dumps
+all or parts of the DDL of a user-specified database to either a console or
+a file. The generated DDL can then be used for such things as recreating all
+or parts of a database, viewing a subset of the objects in a database (for
+example, those objects that pertain to specific tables and schemas), or documenting
+the schema of a database. </p><p>Choose the method that you can use to run
+the <codeph>dblook</codeph> script:</p><simpletable relcolwidth="1* 2*">
+<sthead>
+<stentry>Method</stentry>
+<stentry>When to Use</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Run <codeph>dblook</codeph> as a standalone command.</stentry>
+<stentry>Use this method if you are relatively new to the Java programming
+language and new to <ph conref="../conrefs.dita#prod/productshortname"></ph>.</stentry>
+<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
+sets the appropriate environment variables, including the CLASSPATH, and runs
+the <codeph>dblook</codeph> utility. </p></stentry>
+</strow>
+<strow>
+<stentry>Run <codeph>dblook</codeph> using the jar file that is located in
+the directory where <codeph>dblook</codeph> resides.</stentry>
+<stentry>Use this method if you are new to <ph conref="../conrefs.dita#prod/productshortname"></ph>,
+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>
+</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>
+<stentry>You must set your CLASSPATH to include the <codeph>derbyrun.jar</codeph> file
+and then specify the class name in the <codeph>java</codeph> command.  For
+example:<codeblock>java org.apache.derby.tools.dblook -d databaseURL [options]</codeblock></stentry>
+</strow>
+</simpletable></context>
+<postreq>See "Using dblook" in the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite> for
+more information about using the <codeph>dblook</codeph> utility.</postreq>
+</taskbody>
+</task>

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

Modified: db/derby/docs/trunk/src/getstart/tgsrunningij.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgsrunningij.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgsrunningij.dita (original)
+++ db/derby/docs/trunk/src/getstart/tgsrunningij.dita Tue Jun 12 16:24:36 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
  "../dtd/task.dtd">
 <!--  
@@ -20,30 +20,59 @@
 -->
 <task id="tgsrunningij" xml:lang="en-us">
 <title>Running ij</title>
-<shortdesc>You can use the <cmdname>ij</cmdname> tool to connect to a <ph
-conref="gsconrefs.dita#prod/productshortname"></ph> database.</shortdesc>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> <codeph>ij</codeph> tool
+is a JDBC tool that you can use to run scripts or interactive queries against
+a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm><indexterm>Derby</indexterm>tools, ij</indexterm><indexterm><indexterm>ij
 tool</indexterm>running</indexterm></keywords>
 </metadata></prolog>
 <taskbody>
-<context> <p>You must add the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
-in your PATH environment variable before you can run the <cmdname>ij</cmdname> tool.</p> </context>
+<context></context>
 <steps-unordered>
-<step><cmd>To start the <cmdname>ij</cmdname> tool, run the <cmdname>ij</cmdname> script
-from the command line. </cmd><stepxmp>For example:<codeblock>ij</codeblock></stepxmp>
-<stepresult>The <cmdname>ij</cmdname> script starts the <cmdname>ij</cmdname> tool
-and sets up the environment variables like CLASSPATH.</stepresult></step>
-<step><cmd>To create a database with the <cmdname>ij</cmdname> tool, type
-the following command:</cmd><stepxmp><codeblock>ij&gt; connect 'jdbc:derby:testdb;create=true';</codeblock></stepxmp>
-<stepresult>This command creates a database called <codeph>testdb</codeph> in
-the current directory, populates the system tables, and connects to the database.
-You can then run any SQL statements from the <cmdname>ij</cmdname> command
-line.</stepresult></step>
-<step><cmd>When you are ready to leave the <cmdname>ij</cmdname> tool, type: </cmd>
+<step><cmd>Choose the method that you can use to run the <codeph>ij</codeph> script:</cmd>
+<info><simpletable relcolwidth="1* 2*">
+<sthead>
+<stentry>Method</stentry>
+<stentry>When to Use</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Run <codeph>ij</codeph> as a standalone command.</stentry>
+<stentry>Use this method if you are relatively new to the Java programming
+language and new to <ph conref="../conrefs.dita#prod/productshortname"></ph>.</stentry>
+<stentry>You must <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir">set
+your environment variables</xref> before you can run the <codeph>ij</codeph> tool
+using this method. To run the <codeph>ij</codeph> script from the command
+line use:<codeblock>ij</codeblock><p>You must add the <ph conref="../conrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
+in your PATH environment variable before you can run the <codeph>ij</codeph> tool. </p><p>The <codeph>ij</codeph> script
+sets up the environment variables like CLASSPATH and starts the <codeph>ij</codeph> tool.</p></stentry>
+</strow>
+<strow>
+<stentry>Run <codeph>ij</codeph> using the jar file that is located in the
+directory where <codeph>ij</codeph> resides.</stentry>
+<stentry>Use this method if you are new to <ph conref="../conrefs.dita#prod/productshortname"></ph>,
+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>ij</codeph> tool using this method. <p>On
+UNIX, the command is:<codeblock>java -jar $DERBY_HOME/lib/derbyrun.jar ij </codeblock></p><p>On
+Windows, the command is:</p><codeblock>java -jar %DERBY_HOME%\lib\derbyrun.jar ij </codeblock></stentry>
+</strow>
+<strow>
+<stentry>Run <codeph>ij</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>
+<stentry>You must set your CLASSPATH to include the <codeph>derbyrun.jar</codeph> file
+and then specify the class name in the <codeph>java</codeph> command.  For
+example:<codeblock>java org.apache.derby.tools.ij </codeblock></stentry>
+</strow>
+</simpletable></info></step>
+<step><cmd>When you are ready to leave the <codeph>ij</codeph> tool, type: </cmd>
 <stepxmp><codeblock>ij&gt; exit;</codeblock></stepxmp></step>
 </steps-unordered>
-<postreq>See the <cite><ph conref="gsconrefs.dita#pub/citutilities"></ph></cite> for
-more information about <cmdname>ij</cmdname>.</postreq>
+<postreq>See the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite> for
+more information about the <codeph>ij</codeph> tool.</postreq>
 </taskbody>
 </task>

Added: db/derby/docs/trunk/src/getstart/tgsrunningsysinfo.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgsrunningsysinfo.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgsrunningsysinfo.dita (added)
+++ db/derby/docs/trunk/src/getstart/tgsrunningsysinfo.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--  
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+   http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<task id="tgsrunningsysinfo" xml:lang="en-us">
+<title>Running sysinfo</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> <codeph>sysinfo</codeph> tool
+displays information about your Java environment and your version of <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm><indexterm>Derby</indexterm>tools, sysinfo</indexterm>
+<indexterm><indexterm>Derby</indexterm>utilities, sysinfo</indexterm><indexterm><indexterm>sysinfo
+tool</indexterm>running</indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context>The <codeph>sysinfo</codeph> utility prints system information to
+a console.<p>Choose the method that you can use to run the <codeph>sysinfo</codeph> script:</p><simpletable
+relcolwidth="1* 2* 1*">
+<sthead>
+<stentry>Method</stentry>
+<stentry>When to Use</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Run <codeph>sysinfo</codeph> as a standalone command.</stentry>
+<stentry>Use this method if you are relatively new to the Java programming
+language and new to <ph conref="../conrefs.dita#prod/productshortname"></ph>.</stentry>
+<stentry>You must <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir">set
+your environment variables</xref> before you can run the <codeph>sysinfo</codeph> utility
+using this method. <p>To run the <codeph>sysinfo</codeph> script from the
+command line us:</p><codeblock>sysinfo</codeblock><p>The <codeph>sysinfo</codeph> script
+sets the appropriate environment variables, including the CLASSPATH, and runs
+the <codeph>sysinfo</codeph> utility. </p></stentry>
+</strow>
+<strow>
+<stentry>Run <codeph>sysinfo</codeph> using the jar file that is located in
+the directory where <codeph>sysinfo</codeph> resides.</stentry>
+<stentry>Use this method if you are new to <ph conref="../conrefs.dita#prod/productshortname"></ph>,
+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>sysinfo</codeph> utility using this
+method. <p>On UNIX, the command is:</p><codeblock>java [options] -jar $DERBY_HOME/lib/derbyrun.jar sysinfo</codeblock><p>On
+Windows, the command is:</p><codeblock>java [options] -jar %DERBY_HOME%\lib\derbyrun.jar sysinfo</codeblock></stentry>
+</strow>
+<strow>
+<stentry>Run <codeph>sysinfo</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>
+<stentry>You must set your CLASSPATH to include the <codeph>derbyrun.jar</codeph> file
+and then specify the class name in the <codeph>java</codeph> command.  For
+example:<codeblock>java org.apache.derby.tools.sysinfo</codeblock></stentry>
+</strow>
+</simpletable></context>
+<postreq>See "sysinfo" in the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite> for
+more information about using the <codeph>sysinfo</codeph> utility.</postreq>
+</taskbody>
+</task>

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

Added: db/derby/docs/trunk/src/getstart/tgsruntoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgsruntoolsutils.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgsruntoolsutils.dita (added)
+++ db/derby/docs/trunk/src/getstart/tgsruntoolsutils.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--  
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<task id="tgsruntoolsutils" xml:lang="en-us">
+<title>Choosing a method to run the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+and startup utilities</title>
+<shortdesc>There are several ways that you can run the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+and startup utilities. </shortdesc>
+<prolog><metadata>
+<keywords><indexterm>Derby<indexterm>tools, running</indexterm></indexterm>
+<indexterm>tools<indexterm>in Derby</indexterm></indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context> <p>The method that you choose to run the tools and utilities determines
+the environment variables that you set for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></context>
+<steps>
+<step><cmd>Choose the method that you want to use:</cmd><info><simpletable
+relcolwidth="1.5* 1.5* 2*">
+<sthead>
+<stentry>Method</stentry>
+<stentry>When to Use</stentry>
+<stentry>Requirements</stentry>
+</sthead>
+<strow>
+<stentry>Run the tools using the shell scripts provided.</stentry>
+<stentry>Use this method when you want to run the tools with the least amount
+of typing and have installed the full <codeph>bin</codeph> distribution of <ph
+conref="../conrefs.dita#prod/productshortname"></ph>.</stentry>
+<stentry><ul>
+<li>Set the DERBY_HOME environment variable</li>
+<li>Include the <codeph>java.exe</codeph> file in the PATH environment variable</li>
+<li>Include the <codeph>DERBY_HOME\bin</codeph> directory in the PATH environment
+variable</li>
+</ul></stentry>
+</strow>
+<strow>
+<stentry>Run the tools using the <codeph>derbyrun.jar</codeph> archive file. </stentry>
+<stentry>Use this method when:<ul>
+<li>You have only the <codeph>derbyrun.jar</codeph> file available, and do
+not have the full <codeph>bin</codeph> distribution of <ph conref="../conrefs.dita#prod/productshortname"></ph></li>
+<li>You do not want to use the scripts that are provided with <ph conref="../conrefs.dita#prod/productshortname"></ph></li>
+</ul></stentry>
+<stentry><ul>
+<li>Set the DERBY_HOME environment variable</li>
+<li>Include the <codeph>java.exe</codeph> file in the PATH environment variable</li>
+</ul> <p>The <codeph>derbyrun.jar</codeph> file must be in the same folder
+as the other <ph conref="../conrefs.dita#prod/productshortname"></ph> .jar
+files.</p><p>For more information see the <xref href="rgsderbyrunjarsyntax.dita#rgsderbyrunjarsyntax">syntax
+for the <codeph>derbyrun.jar</codeph> file</xref>.</p></stentry>
+</strow>
+<strow>
+<stentry>Run the tools using the complete <codeph>java</codeph> syntax or
+use <ph conref="../conrefs.dita#prod/productshortname"></ph> in a Java program.</stentry>
+<stentry>Use this method when: <ul>
+<li>You do not have the <codeph>derbyrun.jar</codeph> file or the <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
+installed. </li>
+<li>You want to learn the full syntax of each command and understand the details
+of setting up the execution environment.  </li>
+<li>You are developing application programs with <ph conref="../conrefs.dita#prod/productshortname"></ph></li>
+</ul></stentry>
+<stentry><ul>
+<li>Set the DERBY_HOME environment variable</li>
+<li>Include the <codeph>java.exe</codeph>file in the PATH environment variable</li>
+<li>You must know the full package name for the Java class that supports the
+tool</li>
+<li>The CLASSPATH environment variable must be set to include the required
+JAR files.</li>
+</ul><p>For details on setting the CLASSPATH, see  <xref href="tgs26250.dita#tgs26250"></xref>.</p></stentry>
+</strow>
+</simpletable></info></step>
+<step><cmd>Based on the method that you chose to run the tools, follow the
+instructions to <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir">set
+the environment variables</xref>.</cmd></step>
+</steps>
+</taskbody>
+</task>

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

Added: db/derby/docs/trunk/src/getstart/tgssetupenvironment.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgssetupenvironment.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgssetupenvironment.dita (added)
+++ db/derby/docs/trunk/src/getstart/tgssetupenvironment.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--  
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<task id="tgssetupenvironment" xml:lang="en-us">
+<title>Setting up your environment</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> includes
+several scripts that run the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+and utilities. How you run those scripts depends on the configuration that
+you want to use to access the <ph conref="../conrefs.dita#prod/productshortname"></ph> database
+and tools.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm><indexterm></indexterm></indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context>To set up your environment:</context>
+<steps>
+<step><cmd><xref href="tgsruntoolsutils.dita#tgsruntoolsutils">Choose the
+method that you want to use to run the Derby tools and utilities</xref>.</cmd>
+</step>
+<step><cmd><xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir">Set the environment
+variables</xref>.</cmd></step>
+</steps>
+</taskbody>
+</task>

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

Modified: db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita?view=diff&rev=546665&r1=546664&r2=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita (original)
+++ db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita Tue Jun 12 16:24:36 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+<!--Arbortext, Inc., 1988-2006, v.4002-->
 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
  "../dtd/task.dtd">
 <!--  
@@ -19,10 +19,10 @@
 limitations under the License.
 -->
 <task id="tgssetupjavaenvir" xml:lang="en-us">
-<title>Setting up your environment</title>
-<shortdesc>You need to set several environment variables so that the scripts
-that are included with the <ph conref="gsconrefs.dita#prod/productshortname"></ph> <codeph>bin</codeph> distribution
-run correctly. These scripts need to be run in an appropriate command line environment, i.e. a "Command Prompt" on Windows or a shell on Unix.</shortdesc>
+<title>Setting the environment variables</title>
+<shortdesc>There are several environment variables that must be set depending
+on the method that you selected to run the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+and startup utilities.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Derby<indexterm>environment setup</indexterm></indexterm>
 <indexterm>environment variables<indexterm>DERBY_HOME</indexterm></indexterm>
@@ -34,56 +34,84 @@
 variable, setting</indexterm></indexterm></keywords>
 </metadata></prolog>
 <taskbody>
-<context> <p>To set the environment variables:</p></context>
+<context>As mentioned in <xref href="tgsruntoolsutils.dita#tgsruntoolsutils">choosing
+a method to run the Derby tools and startup utilities</xref>, you must set
+the DERBY_HOME environment variable so that you can use the command examples
+that are presented in this manual.  Adding the <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
+directory to your command execution PATH makes the scripts are easier to use
+and enables you to use the script examples in this manual.  The CLASSPATH
+environment variable must be set if you are using <ph conref="../conrefs.dita#prod/productshortname"></ph> in
+a Java program or executing the tools using the <codeph>java</codeph> command.<p> If
+you decide not to set the environment variables, you will need to <xref href="cgsusingtoolsutils.dita#cgsusingtoolsutils">run
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools</xref> manually.</p><p>The
+steps below show you how to set the environment variables in a command window.
+The settings are only valid for that window. If you close the command window
+or open a new command window, you must set the environment variables again.<note
+type="tip"> You can also set environment variables permanently. For example,
+on Windows you can use the Control Panel to permanently set the environment
+variables.</note></p><p>To set the environment variables:</p></context>
 <steps>
-<step><cmd>Set the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph> environment
-variable to the location where you extracted the <ph conref="gsconrefs.dita#prod/productshortname"></ph> bin
-distribution.</cmd><stepxmp>For example, if you installed <ph conref="gsconrefs.dita#prod/productshortname"></ph> in
-the c:\<ph conref="gsconrefs.dita#prod/productinstallname"></ph> directory on Windows, or the /opt/<ph conref="gsconrefs.dita#prod/productinstallname"></ph> directory on Unix,
-use the following command to set the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph> environment
-variable:</stepxmp> 
-<choicetable>
+<step><cmd>Set the <ph conref="../conrefs.dita#prod/productinstallpath"></ph> environment
+variable to the location where you extracted the <ph conref="../conrefs.dita#prod/productshortname"></ph> <i> bin</i> distribution.</cmd>
+<stepxmp>For example, if you installed <ph conref="../conrefs.dita#prod/productshortname"></ph> in
+the <codeph>/opt/<ph conref="../conrefs.dita#prod/productinstallname"></ph></codeph> directory
+on UNIX or in the <codeph>c:\<ph conref="../conrefs.dita#prod/productinstallname"></ph></codeph> directory
+on Windows, use the following command to set the <ph conref="../conrefs.dita#prod/productinstallpath"></ph> environment
+variable:</stepxmp>
+<choicetable relcolwidth="1* 3*">
 <chhead><choptionhd>Operating System</choptionhd><chdeschd>Command</chdeschd>
 </chhead>
-<chrow><choption>UNIX</choption><chdesc><codeph>export <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>=/opt/<ph conref="gsconrefs.dita#prod/productinstallname"></ph></codeph></chdesc>
+<chrow><choption>UNIX</choption><chdesc><codeph>export <ph conref="../conrefs.dita#prod/productinstallpath"></ph>=/opt/<ph
+conref="../conrefs.dita#prod/productinstallname"></ph></codeph></chdesc></chrow>
+<chrow><choption>Windows</choption><chdesc><codeph>set <ph conref="../conrefs.dita#prod/productinstallpath"></ph>=c:\<ph
+conref="../conrefs.dita#prod/productinstallname"></ph></codeph>. </chdesc>
 </chrow>
-<chrow><choption>Windows</choption><chdesc><codeph>set <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>=c:\<ph conref="gsconrefs.dita#prod/productinstallname"></ph></codeph></chdesc></chrow>
 </choicetable>
 </step>
-<step><cmd>Set the JAVA_HOME environment variable. The JAVA_HOME environment
-variable is used by the scripts to locate the JVM and Java applications. </cmd>
-<choicetable>
-<chhead><choptionhd>Operating System</choptionhd><chdeschd>Command</chdeschd>
-</chhead>
-<chrow><choption>UNIX</choption><chdesc><codeph>export JAVA_HOME=/usr/j2se</codeph></chdesc>
-</chrow>
-<chrow><choption>Windows</choption><chdesc><codeph>set JAVA_HOME=C:\Program
-Files\Java\j2se1.4.2_05</codeph></chdesc></chrow>
-</choicetable>
+<step><cmd>Be certain that the <codeph>java.exe</codeph> file, version 1.4.2
+or, higher is in your command execution PATH.</cmd>
+<substeps>
+<substep><cmd>Open a command window and run the <codeph>java -version</codeph> command.</cmd>
+</substep>
+<substep><cmd>If the JAVA_HOME environment variable is not set, use the following
+command to set the environment variable.</cmd><stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeph>export JAVA_HOME=/usr/j2sdk</codeph></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeph>set JAVA_HOME=C:\Program Files\Java\j2sdk1.4.2_14</codeph>. </stentry>
+</strow>
+</simpletable></stepxmp></substep>
+</substeps>
 </step>
-<step><cmd>Add the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
-to the PATH environment variable so that you can run the <ph conref="gsconrefs.dita#prod/productshortname"></ph> scripts
+<step><cmd>Add the <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph> directory
+to the PATH environment variable so that you can run the <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
 from any directory.</cmd>
-<choicetable>
+<choicetable relcolwidth="1* 3*">
 <chhead><choptionhd>Operating System</choptionhd><chdeschd>Command</chdeschd>
 </chhead>
-<chrow><choption>UNIX</choption><chdesc><codeph>export PATH="$<ph conref="gsconrefs.dita#prod/productinstallpath"></ph>/bin:$PATH"</codeph></chdesc>
-</chrow>
-<chrow><choption>Windows</choption><chdesc><codeph>set PATH=%<ph conref="gsconrefs.dita#prod/productinstallpath"></ph>%\bin;%PATH%</codeph></chdesc>
+<chrow><choption>UNIX</choption><chdesc><codeph>export PATH="$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin:$PATH"</codeph></chdesc>
 </chrow>
+<chrow><choption>Windows</choption><chdesc><codeph>set PATH=%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\bin;%PATH%</codeph>.
+If you use the Control Panel to update your system PATH, add <codeph>%<ph
+conref="../conrefs.dita#prod/productinstallpath"></ph>%\bin</codeph> to the
+end of the PATH environment variable</chdesc></chrow>
 </choicetable>
-<info>When the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph> environment
-variable is set and the underlying bin directory is included in the PATH environment variable, you can use shortened commands
-to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools. </info>
-</step>
-<step><cmd>Verify that the DERBY_HOME and the JAVA_HOME environment variables
-are set correctly, and that the DERBY_HOME/bin directory is added to the
-PATH environment variable. </cmd><stepxmp>Use the following command to check
-the settings: <codeblock>sysinfo </codeblock></stepxmp><stepresult>If the
-environment variables are set correctly, the sysinfo command displays information
-about your JVM and the version of Derby you have installed. </stepresult>
-</step>
+<info><note type="tip">When the <ph conref="../conrefs.dita#prod/productinstallpath"></ph> environment
+variable is set and the underlying <codeph>/bin</codeph> directory is included
+in the PATH environment variable, you can use shortened commands to start
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools. Otherwise,
+either you must be in the directory where the script that starts the <ph conref="../conrefs.dita#prod/productshortname"></ph> tool
+is located, or you must specify the full path to the location of the script
+when you want to start the tool.</note></info></step>
 </steps>
-<postreq>For more information on the scripts included in the bin distribution, see <xref href="rgslib27507.dita#rgslib27507"></xref>.</postreq>
+<postreq>For more information on the scripts included in the <i>bin</i> distribution,
+see <xref href="rgslib27507.dita#rgslib27507"></xref>.</postreq>
 </taskbody>
 </task>

Added: db/derby/docs/trunk/src/getstart/tgssetupverify.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgssetupverify.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgssetupverify.dita (added)
+++ db/derby/docs/trunk/src/getstart/tgssetupverify.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<task id="tgssetupverify" xml:lang="en-us">
+<title>Verifying the Derby system configuration</title>
+<shortdesc>You should confirm that your computer has the correct software
+installed and that the environment variables are set before you start working
+with <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>Java Development Kit version<indexterm>verifying</indexterm></indexterm>
+<indexterm>JDK version<indexterm>verifying</indexterm></indexterm><indexterm>Working
+with Derby activities<indexterm>prerequisites</indexterm></indexterm><indexterm>prerequisites<indexterm>Working
+with Derby activities</indexterm></indexterm><indexterm>environment variables<indexterm>verifying</indexterm></indexterm>
+<indexterm>JAVA_HOME environment variable<indexterm>verifying</indexterm></indexterm>
+<indexterm>DERBY_HOME environment variable<indexterm>verifying</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<taskbody>
+<context> <p>To check the <ph conref="../conrefs.dita#prod/productshortname"></ph> system
+configuration:</p></context>
+<steps>
+<step><cmd>Verify that the <codeph>JAVA_HOME</codeph> environment variable
+is set properly.</cmd>
+<substeps>
+<substep><cmd>Verify that the <codeph>JAVA_HOME</codeph> executable is set.
+Open a command window and run the command using the syntax that is appropriate
+for your system:</cmd><stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating system</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX</stentry>
+<stentry><codeblock>% echo $JAVA_HOME</codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock>echo %JAVA_HOME%</codeblock></stentry>
+</strow>
+</simpletable></stepxmp></substep>
+<substep><cmd>Verify that the <codeph>java.exe</codeph> file, version 1.4.2
+or, higher is in your command execution PATH by opening a command window and
+running the <codeph>java -version</codeph> command.</cmd><stepresult>The output
+from the command looks something like this:<codeblock><systemoutput>java version &quot;1.4.2_04&quot;  
+Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_04-b05)  
+Java HotSpot(TM) Client VM (build 1.4.2_04-b05, mixed mode)</systemoutput></codeblock> The
+output you see might be different from what is shown here because the <codeph>java
+-version</codeph> command outputs vendor-specific information. If the command
+produces an error or the version listed is not 1.4 or higher, install a JDK
+before continuing.</stepresult></substep>
+</substeps>
+</step>
+<step><cmd>Verify that the  <ph conref="../conrefs.dita#prod/productinstallpath"></ph> 
+environment variable is set and points to the root directory of the  <ph conref="../conrefs.dita#prod/productshortname"></ph>&nbsp;<ph
+conref="../conrefs.dita#vers/shortversionnumber"></ph>  installation. Open
+a command window and run the appropriate command for your system. </cmd><info>If
+you installed <ph conref="../conrefs.dita#prod/productshortname"></ph> in
+the /opt/<ph conref="../conrefs.dita#prod/productinstallname"></ph> directory
+on UNIX or the c:\<ph conref="../conrefs.dita#prod/productinstallname"></ph> directory
+on Windows, the command that you use and the expected output are shown in
+the following table:</info><stepxmp><table>
+<tgroup cols="3"><colspec colname="col1"/><colspec colname="col2"/><colspec
+colname="col3"/>
+<thead>
+<row valign="bottom">
+<entry colname="col1">Operating System</entry>
+<entry colname="col2">Command</entry>
+<entry colname="col3">Output</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="col1">UNIX (Korn Shell)</entry>
+<entry colname="col2"><userinput>echo $DERBY_HOME</userinput></entry>
+<entry colname="col3"><systemoutput>/opt/Derby_10</systemoutput></entry>
+</row>
+<row>
+<entry colname="col1">Windows</entry>
+<entry colname="col2"><userinput>echo %DERBY_HOME%</userinput></entry>
+<entry colname="col3"><systemoutput>C:\Derby_10</systemoutput></entry>
+</row>
+</tbody>
+</tgroup>
+</table></stepxmp><stepresult>If you receive an error or do not see the expected
+output, ensure that you have set the <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph> environment
+variable, as described in <xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir"></xref>. </stepresult>
+</step>
+</steps>
+<postreq><note>You can also use the <codeph>sysinfo</codeph> utility to verify
+that the environment variables are set correctly. If the environment variables
+are set correctly, the <codeph>sysinfo</codeph> command displays information
+about your Java virtual machine (JVM) and the version of <ph conref="../conrefs.dita#prod/productshortname"></ph> that
+you have installed.</note></postreq>
+</taskbody>
+</task>

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

Added: db/derby/docs/trunk/src/getstart/twwdactivity1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity1.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity1.dita (added)
+++ db/derby/docs/trunk/src/getstart/twwdactivity1.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<task id="twwdactivity1" xml:lang="en-us">
+<title>Creating a Derby database and running SQL statements</title>
+<shortdesc> Now, you will use the  <ph conref="../conrefs.dita#prod/productshortname"></ph>&nbsp;<codeph>ij</codeph> 
+tool to load the <ph conref="../conrefs.dita#prod/productshortname"></ph> 
+database engine. You will use the  <ph conref="../conrefs.dita#prod/productshortname"></ph> embedded
+driver to create and connect to the <codeph>firstdb</codeph> database. You
+will also use a few basic SQL statements to create and populate a table. </shortdesc>
+<prolog><metadata>
+<keywords><indexterm>Connection URL<indexterm>embedded driver</indexterm><indexterm>create=true</indexterm></indexterm>
+<indexterm>ij</indexterm><indexterm>Database<indexterm>creating</indexterm><indexterm>connecting
+to</indexterm></indexterm><indexterm>Derby<indexterm>logfile, message and
+error</indexterm></indexterm><indexterm>SQL<indexterm>create table</indexterm><indexterm>insert</indexterm><indexterm>select</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<taskbody>
+<steps>
+<step><cmd>Run the  <ph conref="../conrefs.dita#prod/productshortname"></ph>&nbsp;<codeph>ij</codeph> 
+tool. </cmd><stepxmp>If you included the <codeph>DERBY_HOME/bin</codeph> directory
+in your PATH environment variable, type: <codeblock>ij</codeblock> Otherwise,
+you can use the java command to start the <codeph>ij</codeph> tool.<simpletable
+relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar ij</userinput></b>
+<systemoutput>ij version 10.2</systemoutput></codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</userinput></b>
+<systemoutput>ij version 10.2</systemoutput></codeblock></stentry>
+</strow>
+</simpletable></stepxmp></step>
+<step><cmd>Create the database and open a connection to the database using
+the embedded driver.</cmd><stepxmp><codeblock><b><userinput>CONNECT 'jdbc:derby:firstdb;create=true';</userinput></b></codeblock></stepxmp>
+<info> <dl><dlentry>
+<dt>Description of connection command:  </dt>
+<dd> <dl><dlentry>
+<dt><codeph>connect</codeph></dt>
+<dd>The <codeph>ij</codeph> command to establish a connection to a database.
+The <ph conref="../conrefs.dita#prod/productshortname"></ph> connection URL
+is enclosed in single quotation marks. An <codeph>ij</codeph> command can
+be in either uppercase or lowercase.</dd>
+</dlentry><dlentry>
+<dt><codeph>jdbc:derby:</codeph></dt>
+<dd>The JDBC protocol specification for the  <ph conref="../conrefs.dita#prod/productshortname"></ph> driver.</dd>
+</dlentry><dlentry>
+<dt><codeph>firstdb</codeph></dt>
+<dd>The name of the database. The name can be any string. Because no filepath
+is specified, the database is created in the default working directory  (<codeph>DERBYTUTOR</codeph>).</dd>
+</dlentry><dlentry>
+<dt><codeph>;create=true</codeph></dt>
+<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph>&nbsp;<varname>URL
+attribute</varname> that is used to create a database.  <ph conref="../conrefs.dita#prod/productshortname"></ph> does
+not have an SQL  <codeph>create database</codeph> command.</dd>
+</dlentry><dlentry>
+<dt><codeph>;</codeph></dt>
+<dd>The semicolon is the <codeph>ij</codeph> command terminator.</dd>
+</dlentry></dl> </dd>
+</dlentry></dl> </info></step>
+<step><cmd>Create a table with two columns using standard SQL.</cmd><stepxmp><codeblock><b><userinput>CREATE TABLE FIRSTTABLE
+    (ID INT PRIMARY KEY,
+    NAME VARCHAR(12));</userinput></b>
+<systemoutput>0 rows inserted/updated/deleted</systemoutput></codeblock></stepxmp>
+</step>
+<step><cmd>Insert three records.</cmd><stepxmp><codeblock><b><userinput>INSERT INTO FIRSTTABLE VALUES 
+    (10,'TEN'),(20,'TWENTY'),(30,'THIRTY');</userinput></b>
+<systemoutput>3 rows inserted/updated/deleted</systemoutput></codeblock></stepxmp>
+</step>
+<step><cmd>Perform a simple select of all records in the table.</cmd><stepxmp><codeblock><b><userinput>SELECT * FROM FIRSTTABLE;</userinput></b>
+<systemoutput>ID         |NAME
+------------------------
+10         |TEN
+20         |TWENTY
+30         |THIRTY
+
+3 rows selected</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Perform a qualified select of the record with column ID=20.</cmd>
+<stepxmp><codeblock><b><userinput>SELECT * FROM FIRSTTABLE
+WHERE ID=20;</userinput></b>
+<systemoutput>ID         |NAME
+------------------------
+20         |TWENTY
+
+1 row selected</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Optional: Create and populate additional tables and other schema
+objects. </cmd><stepxmp></stepxmp>
+<substeps>
+<substep><cmd>Load the SQL script <codeph>ToursDB_schema.sql</codeph>.</cmd>
+<stepxmp><codeblock><b><userinput>run 'ToursDB_schema.sql';</userinput></b>
+<systemoutput>
+ij> ...
+CREATE TABLE AIRLINES
+   (  
+      AIRLINE CHAR(2) NOT NULL ,
+      AIRLINE_FULL VARCHAR(24),
+      BASIC_RATE DOUBLE PRECISION,
+   ...
+0 rows inserted/updated/deleted</systemoutput>
+   <i>... Other output messages not shown ...</i>
+</codeblock></stepxmp></substep>
+<substep><cmd>Populate the tables with data by running the script <codeph>loadTables.sql</codeph>.</cmd>
+<stepxmp><codeblock><b><userinput>run 'loadTables.sql';</userinput></b>
+<systemoutput>
+ij> run 'loadCOUNTRIES.sql';
+ij> insert into COUNTRIES values ( 'Afghanistan','AF','Asia');
+1 row inserted/updated/deleted
+ij> insert into COUNTRIES values ( 'Albania','AL','Europe');
+1 row inserted/updated/deleted</systemoutput>
+   <i>... Other output messages not shown ...</i>
+</codeblock></stepxmp></substep>
+</substeps>
+</step>
+<step><cmd>Exit the <codeph>ij</codeph> tool.</cmd><stepxmp><codeblock><b><userinput>exit;</userinput></b></codeblock></stepxmp>
+<stepresult>You should be returned to the <codeph>DERBYTUTOR</codeph> directory.</stepresult>
+</step>
+<step><cmd>Browse the most important files created by this activity:</cmd>
+<stepxmp><ul>
+<li>The <codeph>derby.log</codeph> file. This file is a message and error
+log that, under normal circumstances, contains a set of startup messages and
+a shutdown message. <codeblock><systemoutput>----------------------------------------------------------------
+2007-05-10 19:55:20.837 GMT:
+ Booting Derby version The Apache Software Foundation 
+   - Apache Derby - 10.2.2.0 - (485682): 
+   instance c013800d-0109-7f82-e11f-000000119a68
+    on database directory C:\Derby_10\db-derby-10.2.2.0-bin\derbytutor\firstdb 
+
+Database Class Loader started - derby.database.classpath=''
+
+2007-05-104 20:00:12.640 GMT:
+Shutting down instance c013800d-0109-7f82-e11f-000000119a68
+----------------------------------------------------------------</systemoutput></codeblock></li>
+<li>The <codeph>firstdb</codeph> database directory. Within the directory
+are the subdirectories <codeph>seg0</codeph> (containing the data files) and <codeph>log</codeph> (containing
+the transaction log files).</li>
+</ul></stepxmp></step>
+</steps>
+</taskbody>
+</task>

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

Added: db/derby/docs/trunk/src/getstart/twwdactivity1_Setup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity1_Setup.dita?view=auto&rev=546665
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity1_Setup.dita (added)
+++ db/derby/docs/trunk/src/getstart/twwdactivity1_Setup.dita Tue Jun 12 16:24:36 2007
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2006, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<task id="twwdactivity1_Setup" xml:lang="en-us">
+<title>Creating a directory and copying scripts into the directory</title>
+<shortdesc>To help you complete this activity, you must create a directory
+and copy several scripts into the new directory. You will use these scripts
+to quickly add tables and data to a new <ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm></indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context><note type="tip">A command prompt appears after each command is run.
+If an error occurs, verify the syntax and retype the command.</note></context>
+<steps>
+<step><cmd>Open a command window and change to a directory where you want
+to store the files that you create during the self-study tutorial activities.</cmd>
+</step>
+<step><cmd>Create the <codeph>DERBYTUTOR</codeph> directory. <codeph>DERBYTUTOR</codeph> will
+be your working directory for this activity.</cmd><stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>mkdir DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>md DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp></step>
+<step><cmd>Change to the <codeph>DERBYTUTOR</codeph> directory.</cmd><stepxmp><simpletable
+relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cd DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>cd DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp></step>
+<step><cmd>Copy the SQL scripts from the <ph conref="../conrefs.dita#prod/productshortname"></ph>&nbsp; <codeph>demo\programs\toursdb</codeph> subdirectory
+into the  <codeph>DERBYTUTOR</codeph> directory. You will use these scripts
+to create tables and add data to a new database, <codeph>toursdb</codeph>.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cp $DERBY_HOME/demo/programs/toursdb/*.sql .</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>copy %DERBY_HOME%\demo\programs\toursdb\*.sql .</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp></step>
+<step><cmd>Verify that the files were copied to the <codeph>DERBYTUTOR</codeph> directory.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>ls DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>dir DERBYTUTOR</userinput></b></codeblock></stentry>
+</strow>
+</simpletable><note type="important">Include the dot (<codeph>.</codeph>)
+at the end of each command so that your current working directory is included
+in the classpath and the files are copied to the correct location. </note></stepxmp>
+</step>
+</steps>
+</taskbody>
+</task>

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



Mime
View raw message