You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by sc...@apache.org on 2006/12/16 01:22:54 UTC
svn commit: r487729 [1/2] - /db/derby/docs/trunk/src/workingwithderby/
Author: scotsmatrix
Date: Fri Dec 15 16:22:53 2006
New Revision: 487729
URL: http://svn.apache.org/viewvc?view=rev&rev=487729
Log:
Derby-1972: Updates formatting and wording issues in the Working with Derby guide. Patch contribution was made by Kim Haase.
Modified:
db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita
db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita
db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita
db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita
db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita
db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita
db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita
db/derby/docs/trunk/src/workingwithderby/twwdactivity3_Setup.dita
db/derby/docs/trunk/src/workingwithderby/twwdactivity4.dita
db/derby/docs/trunk/src/workingwithderby/wwdconrefs.dita
Modified: db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -18,32 +17,61 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<concept id="cwwdactivities" rev="1.0" xml:lang="en-us">
+<concept id="cwwdactivities" xml:lang="en-us">
<title>Activity overview</title>
-<shortdesc>What you can expect to learn in each activity.</shortdesc>
+<shortdesc>This section describes what you can expect to learn in each activity.</shortdesc>
+<prolog><metadata>
+<keywords>
+<indexterm>Working with Derby activities<indexterm>overview</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<conbody>
-<dl><dlentry>
-<dt></dt>
-<dt></dt>
-<dd><p><b>Activity 1:</b> Use the Derby <codeph>ij</codeph> tool to load
-the Derby embedded driver and start the Derby database engine. Create the
-database firstdb and the table FIRSTTABLE. Use a few basic SQL commands to
-insert and select data. The Derby message log <codeph>derby.log</codeph> and
-the database directories and files are introduced.</p></dd>
-<dd><p><b>Activity 2:</b> Use Derby within a Client-Server configuration.
-Start the Derby Network Server which will embed the Derby engine. In a separate
-process use the Derby <codeph>ij</codeph> tool to load the Derby client driver
-and connect to the Server. Create a database called <codeph>seconddb</codeph> and
-the table SECONDTABLE. Use a few basic SQL commands to insert and select data.</p></dd>
-<dd><p><b>Activity 3:</b> Load the Derby database engine from a simple Java
-JDBC program. Use the embedded driver to create the database jdbcDemoDB and
-the WISH_LIST table. Populate the table with text entered from the keyboard
-then view a list of the records in the table. Walk through the code to understand
-the basic structure of a JDBC program that accesses a Derby database. The <codeph>CLASSPATH</codeph> variable
-and connection URL attribute <codeph>;shutdown=true</codeph> are introduced.</p></dd>
-<dd><p><b>Activity 4:</b> Modify the Java JDBC program to load the client
-driver and connect to the Derby Network Server. Compile the altered program
-and test that it operates as it did in the previous activity.</p></dd>
-</dlentry></dl>
+<dl>
+<dlentry>
+<dt>Activity 1:</dt>
+<dd>Use the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> <codeph>ij</codeph>
+tool to load the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+embedded driver and start the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> database engine.
+Create the database <codeph>firstdb</codeph> and the table
+<codeph>FIRSTTABLE</codeph>. Use a few basic SQL commands to insert and select
+data. The <ph conref="wwdconrefs.dita#prod/productshortname"></ph> message log
+<codeph>derby.log</codeph> and the database directories and files are
+introduced.</dd>
+</dlentry>
+<dlentry>
+<dt>Activity 2:</dt>
+<dd>Use <ph conref="wwdconrefs.dita#prod/productshortname"></ph> within a
+client/server configuration. Start the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server, which
+will embed the <ph conref="wwdconrefs.dita#prod/productshortname"></ph> engine.
+In a separate process, use the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> <codeph>ij</codeph>
+tool to load the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+client driver and connect to the Server. Create a database called
+<codeph>seconddb</codeph> and the table <codeph>SECONDTABLE</codeph>. Use a few
+basic SQL commands to insert and select data.</dd>
+</dlentry>
+<dlentry>
+<dt>Activity 3:</dt>
+<dd>Load the <ph conref="wwdconrefs.dita#prod/productshortname"></ph> database
+engine from a simple Java JDBC program. Use the embedded driver to create the
+database <codeph>jdbcDemoDB</codeph> and the <codeph>WISH_LIST</codeph> table.
+Populate the table with text entered from the keyboard, then view a list of the
+records in the table. Walk through the code to understand the basic structure
+of a JDBC program that accesses a
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> database. The
+<codeph>CLASSPATH</codeph> variable and connection URL attribute
+<codeph>;shutdown=true</codeph> are introduced.</dd>
+</dlentry>
+<dlentry>
+<dt>Activity 4:</dt>
+<dd>Modify the Java JDBC program to load the client driver and connect to the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server.
+Compile the altered program and test that it operates as it did in the previous
+activity.</dd>
+</dlentry>
+</dl>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -18,35 +17,50 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<concept id="cwwdsummary" rev="1.0" xml:lang="en-us">
-<title>What next with Derby</title>
-<shortdesc>Congratulations on completing the activities in this workbook.
-You now have experience with using Derby in both the embedded and Client-Server
-architectures. With this basic knowledge you are ready to begin using
-Derby to address your own specific needs. We recommend visiting the Apache
-Derby website as your next step in learning about this lightweight and powerful
-tool.</shortdesc>
+<concept id="cwwdsummary" xml:lang="en-us">
+<title>What next with <ph conref="wwdconrefs.dita#prod/productshortname"></ph>?</title>
+<shortdesc>Congratulations on completing the activities in this workbook. You
+now have experience with using
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> in both the embedded
+and client/server architectures. </shortdesc>
<conbody>
-<lines frame="topbot" importance="high" scale="120"> <b>Use this link:</b> <xref
+<p>With this basic knowledge, you are ready to begin using
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> to address your own
+specific needs. As your next step in learning about this lightweight and
+powerful tool, visit the
+<ph conref="wwdconrefs.dita#prod/productlongname"></ph> Web site.</p>
+<lines importance="high"> <b>Use this link:</b> <xref
format="html" href="http://wiki.apache.org/db-derby/WorkingWithDerby" importance="high"
-scope="local"><b>WorkingWithDerby Resources page</b></xref>
- browser URL: <codeph><b>http://wiki.apache.org/db-derby/WorkingWithDerby</b></codeph></lines>
-<section><title>Activities Summary</title><p>We hope you have found these
-activities useful in understanding the steps needed to create and access Derby
-databases. Though simple to setup and use you will find that Derby has the
-features and reliability of much larger database systems. The examples presented
-here do not begin to scratch the surface of what can be done. Please take
-a few moments to become familiar with the many online resources available
-to Derby users and developers by browsing the Derby website at Apache. Whether
-you are performing a general evaluation of Derby or have a specific need to
-address, the above link is a good stepping stone to finding additional information
-of interest. The <xref format="html" href="http://db.apache.org/derby/quick_start.html"
-scope="local">Derby Quick Start page</xref> is a good reference page organized
-by area of interest. You will find many content rich areas such as the <cite>Derby
-Wiki</cite> and the <cite>Derby Users mailing list</cite> available to you.
-If you are interested in how others are using Derby see the <cite>Uses of
-Derby</cite> page on the WIKI. This page contains informational links to development
-projects and products that use Derby. When you implement a system using Derby
-please add it to this list.</p></section>
+scope="external"><b>WorkingWithDerby Resources page</b></xref>
+ <b>Browser URL</b>: <codeph><b>http://wiki.apache.org/db-derby/WorkingWithDerby</b></codeph></lines>
+<section><title>Activities summary</title>
+<p>We hope these activities have helped you understand the steps needed to
+create and access <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+databases. Although <ph conref="wwdconrefs.dita#prod/productshortname"></ph> is
+easy to set up and use, you will find that it has the features and reliability
+of much larger database systems. The examples presented here do not begin to
+scratch the surface of what can be done.</p>
+<p>Please take a few moments to become familiar with the many online resources
+available to <ph conref="wwdconrefs.dita#prod/productshortname"></ph> users and
+developers by browsing the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Web site at Apache.
+Whether you are performing a general evaluation of
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> or have a specific
+need to address, the link to the
+WorkingWith<ph conref="wwdconrefs.dita#prod/productshortname"></ph> resources
+page is a good stepping stone to finding additional information of interest.
+The <xref format="html" href="http://db.apache.org/derby/quick_start.html"
+scope="external"><ph conref="wwdconrefs.dita#prod/productshortname"></ph> Quick
+Start page</xref> is a good reference page organized by area of interest. You
+will find that many content-rich areas, such as the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Wiki and the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Users mailing list,
+are available to you. If you are interested in how others are using
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph>, see the Uses of
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> page on the Wiki. This
+page contains informational links to development projects and products that use
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph>. When you implement a
+system using <ph conref="wwdconrefs.dita#prod/productshortname"></ph>, please
+add it to this list.</p></section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -18,70 +17,98 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<reference id="rwwdactivity3" rev="1.1" xml:lang="en-us">
+<reference id="rwwdactivity3" xml:lang="en-us">
<title>The WwdEmbedded program</title>
<shortdesc>This section describes the <codeph>WwdEmbedded.java</codeph> program,
-highlighting details specific to accessing a Derby database from a JDBC program.</shortdesc>
+highlighting details specific to accessing a <ph conref="wwdconrefs.dita#prod/productshortname"></ph> database from a JDBC program.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>WwdEmbedded.java<indexterm>code description</indexterm><indexterm>org.apache.derby.jdbc.EmbeddedDriver</indexterm></indexterm>
-<indexterm>Database<indexterm>shutdown</indexterm></indexterm><indexterm>JDBC</indexterm>
+<keywords><indexterm>WwdEmbedded.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 document
-but you may 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
-text can be found in the comments within the program code and serve as cross-reference
-points between this document and the Java program. The program utilizes routines
-from the <codeph>WwdUtils</codeph> class. The utility class code is not described
-here but is available for review in the file <codeph>WwdUtils.java</codeph></section>
-<section><title>Initialize the program</title> <cite>INITIALIZATION SECTION</cite>:
-The initial lines of code identify the Java libraries used in the program,
-then set up the Java class <codeph>WwdEmbedded</codeph> and the <codeph>main</codeph> method
-signature. Refer to a standard Java programming guide for information on these
-program constructs.<codeblock frame="topbot">import java.sql.*;
+Most of the code related to the database activities performed is included in
+this section, but you may 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>WwdUtils</codeph> class. The utility class code
+is not described here but is available for review in the file
+<codeph>WwdUtils.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>WwdEmbedded</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 WwdEmbedded
{
public static void main(String[] args)
- {</codeblock></section>
-<section><title>Define key variables and Objects</title><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 Derby database. Using variables
-for this information makes it easy to adapt the program to other configurations
-and other databases.<ul>
-<li><varname>driver</varname> - stores the name of the Derby embedded driver.</li>
-<li><varname>dbName</varname> - stores the name of the database.</li>
-<li><varname>connectionURL</varname> - stores the Derby connection URL that
-will be used to access the database.</li>
-<li><varname>createString</varname> - stores the SQL CREATE statement for
-the <varname>WISH_LIST</varname> table .</li>
-</ul><codeblock frame="topbot">String driver = "org.apache.derby.jdbc.EmbeddedDriver";
+ {</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="wwdconrefs.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="wwdconrefs.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="wwdconrefs.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 Derby engine</title><cite>LOAD DRIVER SECTION</cite>:
-Loading the Derby embedded JDBC driver starts the Derby 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 generally due to an incorrect CLASSPATH setting. <codeblock
-frame="topbot">String driver = "org.apache.derby.jdbc.EmbeddedDriver";
+<section><title>Start the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> engine</title>
+<p><cite>LOAD DRIVER SECTION</cite>: Loading the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> embedded JDBC driver
+starts the <ph conref="wwdconrefs.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><cite>BOOT DATABASE SECTION</cite>:
-The DriverManager class loads the database using the Derby connection URL
-stored in the variable <codeph>connectionURL</codeph>. This URL includes the
-parameter <varname>;create=true</varname> so 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
-.<codeblock frame="topbot">String connectionURL = "jdbc:derby:" + dbName + ";create=true";
+<section><title>Boot the database</title>
+<p><cite>BOOT DATABASE SECTION</cite>: The <codeph>DriverManager</codeph> class
+loads the database using the
+<ph conref="wwdconrefs.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);
@@ -89,59 +116,79 @@
} catch (Throwable e) {
...
}</codeblock></section>
-<section><title>Set up to execute SQL</title><cite>INITIAL SQL SECTION</cite>:
-Program objects needed to perform subsequent SQL operations are initialized
-here and a check is made to see if the required data table exists.<p>The statement
-object <codeph>s</codeph> is initialized. If the utility method <codeph>WwdUtils.wwdChk4Table</codeph> does
-not find the <varname>WISH_LIST</varname> table it is created by executing
-the SQL stored in the variable <varname>createString</varname> via this statement
-object. </p><codeblock frame="topbot">s = conn.createStatement();
+<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>WwdUtils.wwdChk4Table</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 (! WwdUtils.wwdChk4Table(conn))
{
System.out.println (" . . . . creating table WISH_LIST");
s.execute(createString);
-}</codeblock>The insert statement used to add data to the table is bound to
-the prepared statement object <codeph>psInsert</codeph>. The prepared statement
-uses the <codeph>?</codeph> parameter to represent the data that will be inserted
-by the user. The actual value that is inserted is <codeph>set</codeph> later
-in the code prior to executing the SQL. This is the most efficient way to
-execute SQL statements that will be used multiple times.<codeblock frame="topbot">psInsert = conn.prepareStatement
+}</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><cite>ADD / DISPLAY RECORD
-SECTION</cite>: This section uses the utility method <codeph>WwdUtils.getWishItem</codeph> to
-gather information from the User. It then utilizes the objects set up previously
-to insert the data into the <varname>WISH_LIST</varname> table and then display
-all records. A standard <codeph>do</codeph> loop causes the program to repeat
-this series of steps until <userinput>exit</userinput> is entered. The data
-related activities performed in this section are:<p>The <codeph>setString</codeph> method
-sets the substitution parameter of the <codeph>psInsert</codeph> object to
-the value entered by the User. Then <codeph>executeUpdate</codeph> is called
-to perform the database insert.<codeblock frame="topbot">psInsert.setString(1,answer);
+<section><title>Interact with the database</title>
+<p><cite>ADD / DISPLAY RECORD SECTION</cite>: This section uses the utility
+method <codeph>WwdUtils.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><p>The statement object <codeph>s</codeph> is used to select
-all the records in the <varname>WISH_LIST</varname> table and store them in
-the ResultSet <varname>myWishes</varname>.<codeblock frame="topbot">myWishes = s.executeQuery("select ENTRY_DATE, WISH_ITEM
+</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 frame="topbot">while (myWishes.next())
+</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 ResultSet to release the memory being used.<codeblock
-frame="topbot">myWishes.close();
-</codeblock></p></section>
-<section><title>Shutdown the Database</title><cite>DATABASE SHUTDOWN SECTION</cite>:
-When an application starts the Derby engine it should shutdown all databases
-prior to exiting. The attribute <codeph>;shutdown=true</codeph> in the Derby
-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>This section verifies that the embedded driver is being used
-then issues the shutdown command and catches the shutdown exception to confirm
-the database shutdown cleanly. The shutdown status is displayed before the
-program exits.</p><codeblock frame="topbot">if (driver.equals("org.apache.derby.jdbc.EmbeddedDriver")) {
+}</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="wwdconrefs.dita#prod/productshortname"></ph> engine, it should shut
+down all databases before exiting. The attribute
+<codeph>;shutdown=true</codeph> in the
+<ph conref="wwdconrefs.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");
@@ -155,34 +202,43 @@
} else {
System.out.println("Database shut down normally");
}
-}</codeblock><note type="important">The <codeph>XJ015</codeph> error is the
-only exception thrown by Derby that signifies an operation succeeded. All
-other exceptions indicate an operation failed.</note></section>
-<section><title>The errorPrint and SQLExceptionPrint methods</title><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 routines that can be used with any JDBC program.
+}</codeblock>
+<note type="important">The XJ015 error is the only exception thrown by
+<ph conref="wwdconrefs.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 then thrown. A <codeph>while</codeph> loop
-is used to report on each error in the chain. These classes are used by calling
-the <codeph>errorPrint</codeph> method from the <codeph>catch</codeph> block
-of the code that accesses the database. <codeblock frame="topbot">// Beginning of the primary catch block: uses errorPrint method
+(<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>The <codeph>errorPrint</codeph> routine prints a stack trace
-for all exceptions except a <codeph>SQLException</codeph>. All SQLExceptions
-are passed to the <codeph>SQLExceptionPrint</codeph> method.<codeblock frame="topbot">static void errorPrint(Throwable 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>The <codeph>SQLExceptionPrint</codeph> method
-iterates through each of the exceptions on the stack. For each error the codes,
-message then stacktrace are printed. <codeblock frame="topbot">// Iterates through a stack of SQLExceptions
+} // 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");
@@ -192,8 +248,10 @@
sqle.printStackTrace();
sqle = sqle.getNextException();
}
-} // END SQLExceptionPrint </codeblock>If you wish to see the output produced
-by this method enter a wish list item with more than 32 characters like: <userinput>I
-wish to see a Java program fail</userinput>.</section>
+} // 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>
Modified: db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
Modified: db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"../dtd/task.dtd">
<!--
@@ -18,98 +17,136 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<task id="twwdIntro" rev="1.4" xml:lang="en-us">
+<task id="twwdIntro" xml:lang="en-us">
<title>Introduction and prerequisites</title>
-<shortdesc>Welcome to Derby!
-To help you get up and running with Derby as quickly as possible,
-this self-study guide highlights some of the more important features of Derby
-through a series of activities designed to demonstrate the use of Derby in
-embedded and client-server configurations.
-After performing these activities, you will find Derby to be an easy to use and
-fully functional RDBMS.
-This section provides a brief description of Derby, followed by information on
-the skills and software required to perform the activities presented in this
-document, and ends with a brief description of what is presented by each of the
-Working With Derby activities.</shortdesc>
+<shortdesc>Welcome to <ph conref="wwdconrefs.dita#prod/productshortname"></ph>!
+To help you get up and running with <ph conref="wwdconrefs.dita#prod/productshortname"></ph> as quickly as possible,
+this self-study guide highlights some of the more important features of
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph>.
+</shortdesc>
<prolog><metadata>
-<keywords><indexterm>JAVA<indexterm>verifying</indexterm></indexterm><indexterm>Derby<indexterm>downloading</indexterm><indexterm>getting
-help</indexterm></indexterm></keywords>
+<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>Derby is a full featured, open source relational database engine.
-It is written and implemented completely in Java, and provides users with a
-small footprint standards-based database engine that can be tightly embedded
-into any Java based solution. Derby ensures data integrity and provides sophisticated
+<context>
+<p>
+This guide uses a series of activities designed to demonstrate the use of
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> in embedded and
+client/server configurations. After performing these activities, you will
+find <ph conref="wwdconrefs.dita#prod/productshortname"></ph> to be an
+easy-to-use and fully functional relational database management system (RDBMS).
+</p>
+<p>This section provides the following:
+<ul>
+<li>A brief description of <ph conref="wwdconrefs.dita#prod/productshortname"></ph></li>
+<li>Information on the skills and software required to perform the activities
+presented in this document</li>
+<li>A brief description of what is presented by each of the
+Working With <ph conref="wwdconrefs.dita#prod/productshortname"></ph> activities</li>
+</ul>
+</p>
+<p><ph conref="wwdconrefs.dita#prod/productshortname"></ph> is a full-featured, open source relational database engine that
+is written and implemented completely in the Java programming language. It provides users with a
+small-footprint standards-based database engine that can be tightly embedded
+into any Java based solution. <ph conref="wwdconrefs.dita#prod/productshortname"></ph> ensures data integrity and provides sophisticated
transaction support. In its default configuration there is no separate
database server to be installed or maintained by the end user. For more information
-on Derby visit the Derby website at: <xref format="html" href="http://db.apache.org/derby"
-scope="local">http://db.apache.org/derby</xref>.</p><p>Performing the Working
-With Derby activities requires no prior knowledge of Java, JDBC or SQL. Each
+on <ph conref="wwdconrefs.dita#prod/productshortname"></ph>, visit the <ph conref="wwdconrefs.dita#prod/productshortname"></ph> Web site at <xref format="html" href="http://db.apache.org/derby/"
+scope="external">http://db.apache.org/derby</xref>.</p><p>To perform the Working
+With <ph conref="wwdconrefs.dita#prod/productshortname"></ph> activities, you need no prior knowledge of Java software, the Java Database Connectivity (JDBC) API, or SQL. Each
Activity Sequence section provides the complete command syntax needed to execute
-each operation on a Windows machine or in a UNIX/Linux Korn shell. This document
-demonstrates, but does not teach, the Java, JDBC and SQL presented, so readers
+each operation on a Windows machine or in a UNIX Korn shell. This document
+demonstrates, but does not teach, the Java, JDBC and SQL code presented, so readers
wishing a deeper understanding of these topics will need additional reference
-materials.</p><p>Performing the Working With Derby activities does require
-that Java and Derby software be installed on the computer, and the ability
-to enter computer operating system commands. Specifically:<ul>
-<li>A Java development kit version 1.3 or higher</li>
-<li>The binary (<codeph>bin</codeph>) installation of Apache Derby version
+materials.</p><p>To perform the Working With <ph conref="wwdconrefs.dita#prod/productshortname"></ph> activities, you must have
+Java and <ph conref="wwdconrefs.dita#prod/productshortname"></ph> software installed on your computer, and you must be able
+to enter computer operating system commands. Specifically, the activities require:<ul>
+<li>A Java Development Kit (JDK) version 1.3 or higher</li>
+<li>The binary (<codeph>bin</codeph>) installation of <ph conref="wwdconrefs.dita#prod/productlongname"></ph> version
<ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph></li>
-<li>A basic knowledge of the computer command line interface<ul>
-<li>how to start a command shell or window</li>
-<li>how to navigate the filesystem hierarchy</li>
+<li>A basic knowledge of the computer command line interface:<ul>
+<li>How to start a command shell or window</li>
+<li>How to navigate the file system hierarchy</li>
</ul></li>
-</ul></p><p>If unsure about the Java or Derby environments installed, perform
-the following steps before attempting the subsequent activities:</p></context>
+</ul></p><p>If you are not sure about the Java or <ph conref="wwdconrefs.dita#prod/productshortname"></ph> environments installed,
+follow these steps before you perform the subsequent activities:</p></context>
<steps>
-<step><cmd>Verify that the JAVA_HOME environment variable is set and points
-to a Java development kit version 1.3 or higher.</cmd><info>Open a command
+<step><cmd>Verify that the <codeph>JAVA_HOME</codeph> environment variable is set and points
+to a JDK version 1.3 or higher.</cmd><info>Open a command
window and run the command <codeph>java -version</codeph> using the appropriate
-syntax for your system:</info><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>"%JAVA_HOME%\bin\java" -version</b></codeblock></dd>
-</dlentry><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>"$JAVA_HOME/bin/java" -version</b></codeblock></dd>
-</dlentry></dl></stepxmp><stepresult>The output from the command will look
-something like this:<codeblock frame="topbot"><i>java version "1.4.2_04"
+syntax for your system:</info>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>"%JAVA_HOME%\bin\java" -version</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>"$JAVA_HOME/bin/java" -version</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+<stepresult>The output from the command looks
+something like this:<codeblock><systemoutput>java version "1.4.2_04"
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)</i></codeblock>
+Java HotSpot(TM) Client VM (build 1.4.2_04-b05, mixed mode)</systemoutput></codeblock>
The output you see
-may be different from what is shown here, because the <userinput>java -version</userinput> command
-outputs vendor-specific information. If the command produced an error or the
-version listed is not 1.3 or higher, please install a Java development kit
+may 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.3 or higher, install a JDK
before continuing.</stepresult></step>
-<step><cmd>Verify that the DERBY_HOME environment variable is set and points to
-the filesystem path to the root directory of the Derby <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph> installation:</cmd>
+<step><cmd>Verify that the
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable is set and points to the root directory of the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph>
+installation.</cmd>
<info>Open a command window and run the appropriate command for your system:</info>
-<stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>echo %DERBY_HOME%</b></codeblock></dd>
-</dlentry><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>echo $DERBY_HOME</b></codeblock></dd>
-</dlentry></dl>
-</stepxmp>
-<stepresult>The output from the command will look something like this:
-<codeblock frame="topbot"><i>Windows: C:\derby
-Unix/Linux: /opt/derby</i></codeblock>
-If Derby is not installed or cannot be found, please install a copy now.
-The most recent version of Derby can be downloaded from:
-<xref format="html" href="http://db.apache.org/derby/derby_downloads.html"
-scope="local"></xref>. From the Download page use the link to the 'Latest
-Official Release', then locate the <codeph>bin</codeph> distribution (e.g.
-db-derby-<version>-bin.zip and db-derby-<version>-bin.tar.gz).
-Download the appropriate file for your platform, '-bin.zip' for Windows or
-'-bin.tar.gz' for Unix/Linux, and unzip/untar this file. After decompressing
-the downloaded file, move the directory created to the filesystem path chosen
-to be the root directory of the Derby installation
-(e.g. move db-derby-<version>-bin C:\derby).
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>echo %DERBY_HOME%</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>echo $DERBY_HOME</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+<stepresult>The output from the command looks something like this:
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Output</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><systemoutput>C:\derby</systemoutput></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><systemoutput>/opt/derby</systemoutput></stentry>
+</strow>
+</simpletable>
+If <ph conref="wwdconrefs.dita#prod/productshortname"></ph> is not installed or cannot be found, install a copy now.
+For instructions, see <ph conref="wwdconrefs.dita#pub/citgetstart"></ph>.
</stepresult>
</step>
</steps>
<postreq>Anyone having problems with any aspect of these activities can gain
-assistance via e-mail by writing to derby-user@db.apache.org. The questions
+assistance by sending an e-mail message to <codeph>derby-user@db.apache.org</codeph>. The questions
and feedback received will be used to make this document even more useful. </postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"../dtd/task.dtd">
<!--
@@ -18,126 +17,174 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<task id="twwdactivity1" rev="1.4" xml:lang="en-us">
+<task id="twwdactivity1" xml:lang="en-us">
<title>Creating the database and running SQL</title>
+<shortdesc>
+Now, you will use the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> <codeph>ij</codeph>
+tool to load the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+database engine. You will use the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> embedded driver to
+create and connect to the database <codeph>firstdb</codeph>. You will also use
+a few basic SQL commands.
+</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>
+<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 Derby ij tool.</cmd><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</b>
-
-<i>ij version <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph></i>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbyrun.jar ij</b>
-
-<i>ij version <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph></i></codeblock></dd>
-</dlentry></dl></stepxmp></step>
+<step><cmd>Run the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+<codeph>ij</codeph> tool.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<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>
+<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>
+</simpletable></stepxmp>
+</step>
<step><cmd>Create the database and open a connection to it using the embedded
-driver.</cmd><stepxmp><codeblock frame="topbot"><b>CONNECT 'jdbc:derby:firstdb;create=true';</b></codeblock></stepxmp>
+driver.</cmd>
+<stepxmp><codeblock><b><userinput>CONNECT 'jdbc:derby:firstdb;create=true';</userinput></b></codeblock></stepxmp>
+<info>
+<dl>
+<dlentry>
+<dt>Description of connection command:
+<codeph>connect 'jdbc:derby:firstdb;create=true';</codeph></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="wwdconrefs.dita#prod/productshortname"></ph> connection URL
+is enclosed in single quotation marks.</dd>
+</dlentry>
+<dlentry>
+<dt><codeph>jdbc:derby:</codeph></dt>
+<dd>The JDBC protocol specification for the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> driver.</dd>
+</dlentry>
+<dlentry>
+<dt><codeph>firstdb</codeph></dt>
+<dd>The name of the database; this can be any string. Because no filepath
+is specified, the database is created in the default working directory
+(<codeph>DERBYDBS</codeph>).</dd>
+</dlentry>
+<dlentry>
+<dt><codeph>;create=true</codeph></dt>
+<dd>The <ph conref="wwdconrefs.dita#prod/productshortname"></ph> <varname>URL
+attribute</varname> used to create databases.
+<ph conref="wwdconrefs.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
-frame="topbot"><b>CREATE TABLE FIRSTTABLE
+<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));</b>
+ NAME VARCHAR(12));</userinput></b>
-<i>0 rows inserted/updated/deleted</i></codeblock></stepxmp></step>
-<step><cmd>Insert three records.</cmd><stepxmp><codeblock frame="topbot"><b>INSERT INTO FIRSTTABLE VALUES
- (10,'TEN'),(20,'TWENTY'),(30,'THIRTY');</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>
-<i>3 rows inserted/updated/deleted</i></codeblock></stepxmp></step>
-<step><cmd>Perform a simple select of all records in the table.</cmd><stepxmp><codeblock
-frame="topbot"><b>SELECT * FROM FIRSTTABLE;</b>
-
-<i> ID |NAME
+<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</i></codeblock></stepxmp></step>
-<step><cmd>Preform a qualified select of the record with column ID=20.</cmd>
-<stepxmp><codeblock frame="topbot"><b>SELECT * FROM FIRSTTABLE
-WHERE ID=20;</b>
-
-<i> ID |NAME
+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</i></codeblock></stepxmp></step>
-<step><cmd>Load the SQL script <userinput>ToursDB_schema.sql</userinput> to
+1 row selected</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Load the SQL script <codeph>ToursDB_schema.sql</codeph> to
create the tables and other schema objects (this step is optional).</cmd>
-<stepxmp><codeblock frame="topbot"><b>run 'ToursDB_schema.sql';</b>
-
-<i>ij> CREATE TABLE AIRLINES
+<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
- . . .
-
-<b><apiname>===> Other output messages not shown <=====</apiname></b></i>
+ ...
+0 rows inserted/updated/deleted</systemoutput>
+ <i>... Other output messages not shown ...</i>
</codeblock></stepxmp>
<substeps>
-<substep><cmd>Populate the tables with data by running the script <userinput>loadTables.sql</userinput></cmd>
-<stepxmp><codeblock frame="topbot"><b>run 'loadTables.sql';</b>
-
-<i>ij> run 'loadCOUNTRIES.sql';
+<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
- . . .
-<b><apiname>===> Other output messages not shown <=====</apiname></b></i>
+1 row inserted/updated/deleted</systemoutput>
+ <i>... Other output messages not shown ...</i>
</codeblock></stepxmp></substep>
</substeps>
</step>
-<step><cmd>Exit the ij tool.</cmd><stepxmp><codeblock frame="topbot"><b>exit;</b>
-</codeblock></stepxmp></step>
-<step><cmd>Browse the key files created by the activity.</cmd><stepxmp><ul>
-<li>The <b><filepath><varname>derby.log</varname></filepath></b> message and
-error log file. Under normal circumstances it will contain a set of startup
-messages and a shutdown message.<codeblock frame="topbot">----------------------------------------------------------------
-2006-09-21 23:33:37.564 GMT:
+<step><cmd>Exit the <codeph>ij</codeph> tool.</cmd>
+<stepxmp><codeblock><b><userinput>exit;</userinput></b></codeblock></stepxmp>
+</step>
+<step><cmd>Browse the most important files created by the activity.</cmd>
+<stepxmp><ul>
+<li>The <codeph>derby.log</codeph> message and
+error log file. Under normal circumstances, this file contains a set of startup
+messages and a shutdown message.
+<codeblock><systemoutput>----------------------------------------------------------------
+<varname>date</varname> 23:33:37.564 GMT:
Booting Derby version The Apache Software Foundation
- - Apache Derby - <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph>.1.6 - (452058):
+ - Apache Derby - <varname>version</varname> - (<varname>tag</varname>):
instance c013800d-0109-7f82-e11f-000000119a68
on database directory C:\DERBYDBS\FIRSTDB
Database Class Loader started - derby.database.classpath=''
-2006-09-21 23:44:13.178 GMT:
+<varname>date</varname> 23:44:13.178 GMT:
Shutting down instance c013800d-0109-7f82-e11f-000000119a68
-----------------------------------------------------------------</codeblock></li>
-<li>The <b><filepath><varname>firstdb</varname></filepath></b> database directory.
-Within the directory are the subdirectories <b><filepath><varname>seg0</varname></filepath></b> (containing
-the data files) and <b><filepath><varname>log</varname></filepath></b> (containing
+----------------------------------------------------------------</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>
-<postreq><dl><dlentry>
-<dt>Description of connection command:
-<codeph>connect 'jdbc:derby:firstdb;create=true';</codeph></dt>
-<dd><codeph>connect</codeph> - the ij command to establish a connection to
-a database</dd>
-<dd>The Derby connection URL enclosed in single quotes:<ul>
-<li><codeph>jdbc:derby:</codeph> - JDBC protocol specification for the Derby
-driver.</li>
-<li><codeph>firstdb</codeph> - the name of the database, this can be any string.
-Because no filepath is specified the database will be created in the default
-working directory (<codeph>DERBYDBS</codeph>).</li>
-<li><codeph>;create=true</codeph> - The Derby <varname>URL attribute</varname> used
-to create databases. Derby does not have an SQL <varname>create database</varname> command.</li>
-</ul></dd>
-<dd><codeph><b>;</b></codeph> (semicolon) - the ij command terminator.</dd>
-</dlentry></dl></postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"../dtd/task.dtd">
<!--
@@ -18,59 +17,115 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<task id="twwdactivity1_setup" rev="1.4" xml:lang="en-us">
-<title>Activity 1: Run SQL using the Embedded driver</title>
-<shortdesc>In this section the Derby database engine is loaded by the Derby
-IJ tool. The Derby embedded driver is used to create and connect to the database
-firstdb. A few basic SQL commands are demonstrated.</shortdesc>
+<task id="twwdactivity1_setup" xml:lang="en-us">
+<title>Activity 1: Run SQL using the embedded driver</title>
+<shortdesc>In this activity, you load the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> database engine,
+create and connect to a database, and use some basic SQL
+commands. First, you set up your environment to run
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph>.
+</shortdesc>
<prolog><metadata>
-<keywords><indexterm>DERBY_HOME</indexterm><indexterm>IJ tool</indexterm>
+<keywords><indexterm>DERBY_HOME environment variable</indexterm>
+<indexterm>ij tool</indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context>In preparation for performing this activity the environment variable <varname>DERBY_HOME</varname> needs
-to be set and an empty working directory (<codeph>DERBYDBS</codeph>) created.
-The <varname>DERBY_HOME</varname> variable defines the filesystem path to
-the root directory of the Derby installation. The <codeph>DERBYDBS</codeph> directory
-is where the files created during the activities are stored.<p>The example
-commands defining <varname>DERBY_HOME</varname> use the fictitious filesystem
-paths <userinput>C:\derby</userinput> for Windows examples and <userinput>/opt/derby</userinput> for
-UNIX examples. Be sure to adjust these commands so <varname>DERBY_HOME</varname> indicates
-the location of the Derby installation on the system being used. The following
-activity sequence shows</p> </context>
+<prereq>In preparation for performing this activity, you must set the
+environment variable
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph> and
+create an empty working directory, <codeph>DERBYDBS</codeph>. The
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+variable defines the file system path to the root directory of the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> installation. The
+<codeph>DERBYDBS</codeph> directory is where the files created during the
+activities are stored.
+</prereq>
+<context>The example commands defining
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph> use
+the fictitious file system paths <codeph>C:\derby</codeph> for Windows examples
+and <codeph>/opt/derby</codeph> for UNIX examples. Be sure to adjust these
+commands so that
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+indicates the location of the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> installation on the
+system you are using.
+<note type="important">A command prompt appears after
+each command is executed. If an error appears, verify the
+spelling and retype the command.</note>
+</context>
<steps>
-<step><cmd>Setting the <varname>DERBY_HOME</varname> environment variable.</cmd>
+<step><cmd>Set the
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>set DERBY_HOME=C:\derby</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>export DERBY_HOME=/opt/derby</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
</step>
-<step><cmd>Creating the <codeph>DERBYDBS</codeph> work directory</cmd></step>
-<step><cmd>Changing the directory (<userinput>cd</userinput>) to the work
-directory</cmd></step>
-<step><cmd>Copying the SQL scripts that create the tables and data for toursdb
-from the Derby <codeph>demo\programs\toursdb</codeph> subdirectory into the <codeph>DERBYDBS</codeph> directory.</cmd>
+<step><cmd>Create the <codeph>DERBYDBS</codeph> work directory.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>md DERBYDBS</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>mkdir DERBYDBS</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+</step>
+<step><cmd>Change the directory (<codeph>cd</codeph>) to the work
+directory.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>cd DERBYDBS</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cd DERBYDBS</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+</step>
+<step><cmd>Copy the SQL scripts that create the tables and data for
+<codeph>toursdb</codeph>
+from the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+<codeph>demo\programs\toursdb</codeph> subdirectory into the
+<codeph>DERBYDBS</codeph> directory.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>copy %DERBY_HOME%\demo\programs\toursdb\*.sql .</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cp $DERBY_HOME/demo/programs/toursdb/*.sql .</userinput></b></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
</step>
</steps>
-<example>Open a command window and perform the following activity sequence:<dl>
-<dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>set DERBY_HOME=C:\derby
-
-md DERBYDBS
-
-cd DERBYDBS
-
-copy %DERBY_HOME%\demo\programs\toursdb\*.sql . </b>
-</codeblock></dd>
-</dlentry><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>export DERBY_HOME=/opt/derby
-
-mkdir DERBYDBS
-
-cd DERBYDBS
-
-cp $DERBY_HOME/demo/programs/toursdb/*.sql . </b>
-</codeblock></dd>
-</dlentry></dl><note type="important">A command prompt will be displayed after
-each command is executed. If an error is displayed please double check the
-spelling and reenter the command.</note></example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- File Edit date of Contribution: May 10, 2006 -->
+<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"../dtd/task.dtd">
<!--
@@ -18,133 +17,179 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<task id="twwdactivity2" rev="1.1" xml:lang="en-us">
-<title>Activity 2: Run SQL using the Client driver</title>
-<shortdesc>This activity uses Derby within a Client-Server configuration by
-using the Network Server. The <codeph>ij</codeph> tool is the client application
-that connects to the Derby Network Server. A database called <codeph>seconddb</codeph> is
-created and some basic SQL commands are executed.</shortdesc>
+<task id="twwdactivity2" xml:lang="en-us">
+<title>Activity 2: Run SQL using the client driver</title>
+<shortdesc>This activity uses
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> within a client/server
+configuration by using the Network Server. The <codeph>ij</codeph> tool is the
+client application that connects to the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server. In
+this activity, you create a database called <codeph>seconddb</codeph> and
+execute some basic SQL commands.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>Network Server</indexterm><indexterm>Client driver</indexterm>
+<keywords><indexterm>Network Server</indexterm>
+<indexterm>Client driver</indexterm>
</keywords>
</metadata></prolog>
<taskbody>
<prereq>This activity assumes that you know how to open a command shell, change
-directory (<userinput>cd</userinput>) to the <codeph>DERBYDBS</codeph> directory
-and set the <varname>DERBY_HOME</varname> environment variable.</prereq>
-<context>Two command windows (labelled <codeph>Shell-1</codeph> and <codeph>Shell-2</codeph>)
-are used in this activity. <codeph>Shell-1</codeph> is used to start the Derby
-Network Server and display Network Server messages. <codeph>Shell-2</codeph> is
-used to establish a client connection to the Network Server using <codeph>ij</codeph> and
-then perform some basic SQL operations.</context>
+directory (<codeph>cd</codeph>) to the <codeph>DERBYDBS</codeph> directory,
+and set the
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable.</prereq>
+<context>You use two command windows (referred to as Shell-1 and Shell-2) in this
+activity. You use Shell-1 to start the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server and
+display Network Server messages. You use Shell-2 to establish a client
+connection to the Network Server using <codeph>ij</codeph> and then perform
+some basic SQL operations.</context>
<steps>
-<step><cmd>Open a command window that we'll call <codeph>Shell-1</codeph>.
-Change directory (<userinput>cd</userinput>) to the <codeph>DERBYDBS</codeph> directory
-and set the <varname>DERBY_HOME</varname> environment variable.</cmd></step>
-<step><cmd>Start the Network Server.</cmd><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbynet.jar start</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) started and
- ready to accept connections on port 1527 at 2006-09-22
- 00:08:30.049 GMT</i></codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbynet.jar start</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) started and
- ready to accept connections on port 1527 at 2006-09-22
- 00:08:30.049 GMT</i></codeblock></dd>
-<dd></dd>
-</dlentry></dl></stepxmp><stepresult>A Network Server startup message is displayed
-in the <codeph>Shell-1</codeph> command window.</stepresult></step>
-<step><cmd>Open another command window that we'll call <codeph>Shell-2</codeph>.
-Change directory (<userinput>cd</userinput>) to the <codeph>DERBYDBS</codeph> directory
-and set the <varname>DERBY_HOME</varname> environment variable.</cmd></step>
-<step><cmd>Start <codeph>ij</codeph>.</cmd><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</b>
-
-<i>ij version <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph></i>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbyrun.jar ij</b>
-
-<i>ij version <ph conref="wwdconrefs.dita#vers/shortversionnumber"></ph></i></codeblock></dd>
-</dlentry></dl></stepxmp><stepresult>All subsequent commands are entered from
-the network client, and are therefore entered in the <codeph>Shell-2</codeph> command
+<step><cmd>Open a command window (Shell-1). Change directory
+(<codeph>cd</codeph>) to the <codeph>DERBYDBS</codeph> directory and set the
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable.</cmd></step>
+<step><cmd>Start the Network Server.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbynet.jar start</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) started and
+ ready to accept connections on port 1527 at <varname>date</varname>
+ 00:08:30.049 GMT</systemoutput></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbynet.jar start</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) started and
+ ready to accept connections on port 1527 at <varname>date</varname>
+ 00:08:30.049 GMT</systemoutput></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+<stepresult>A Network Server startup message appears in the Shell-1 command
window.</stepresult></step>
-<step><cmd>Create and open a connection to the database using the client driver.</cmd>
-<stepxmp><codeblock frame="topbot"><b>CONNECT 'jdbc:derby://localhost:1527/seconddb;create=true';
-</b></codeblock><note type="remember">A client connection URL contains a hostname
-and a port number: <codeph>//localhost:1527/</codeph>.</note></stepxmp></step>
-<step><cmd>Create a table with two columns (<codeph>ID</codeph> and <codeph>NAME</codeph>)
-using SQL.</cmd><stepxmp><codeblock frame="topbot"><b>CREATE TABLE SECONDTABLE
+<step><cmd>Open another command window (Shell-2). Change directory
+(<codeph>cd</codeph>) to the <codeph>DERBYDBS</codeph> directory and set the
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable.</cmd></step>
+<step><cmd>Start <codeph>ij</codeph>.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<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>
+<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>
+</simpletable></stepxmp>
+<stepresult>You will enter all subsequent commands from the network client, so
+you will type the commands in the Shell-2 command window.</stepresult></step>
+<step><cmd>Create and open a connection to the database using the client
+driver.</cmd>
+<stepxmp><codeblock><b><userinput>CONNECT 'jdbc:derby://localhost:1527/seconddb;create=true';
+</userinput></b></codeblock>
+<note type="remember">A client connection URL contains a hostname and a port
+number: <codeph>//localhost:1527/</codeph>.</note>
+</stepxmp></step>
+<step><cmd>Create a table with two columns (ID and NAME) using SQL.</cmd>
+<stepxmp><codeblock><b><userinput>CREATE TABLE SECONDTABLE
(ID INT PRIMARY KEY,
- NAME VARCHAR(14));</b>
+ NAME VARCHAR(14));</userinput></b>
-<i>0 rows inserted/updated/deleted</i>
-</codeblock></stepxmp></step>
-<step><cmd>Insert three records into the table.</cmd><stepxmp><codeblock frame="topbot"><b>INSERT INTO SECONDTABLE VALUES
- (100,'ONE HUNDRED'),(200,'TWO HUNDRED'),(300,'THREE HUNDRED');</b>
-
-<i>3 rows inserted/updated/deleted</i>
-</codeblock></stepxmp></step>
-<step><cmd>Select all of the records in the table.</cmd><stepxmp><codeblock
-frame="topbot"><b>SELECT * FROM SECONDTABLE;</b>
-
-<i> ID |NAME
+<systemoutput>0 rows inserted/updated/deleted
+</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Insert three records into the table.</cmd>
+<stepxmp><codeblock><b><userinput>INSERT INTO SECONDTABLE VALUES
+ (100,'ONE HUNDRED'),(200,'TWO HUNDRED'),(300,'THREE HUNDRED');</userinput></b>
+
+<systemoutput>3 rows inserted/updated/deleted
+</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Select all of the records in the table.</cmd>
+<stepxmp><codeblock><b><userinput>SELECT * FROM SECONDTABLE;</userinput></b>
+<systemoutput>
+ ID |NAME
------------------------
100 |ONE HUNDRED
200 |TWO HUNDRED
300 |THREE HUNDRED
-3 rows selected</i></codeblock></stepxmp></step>
-<step><cmd>Select a subset of records from the table by qualifying the command.</cmd>
-<stepxmp><codeblock frame="topbot">ij> <b>SELECT * FROM SECONDTABLE WHERE ID=200;</b>
-
-<i> ID |NAME
+3 rows selected</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Select a subset of records from the table by specifying a
+<codeph>WHERE</codeph> clause.</cmd>
+<stepxmp><codeblock><b><userinput>SELECT * FROM SECONDTABLE WHERE ID=200;</userinput></b>
+<systemoutput>
+ ID |NAME
------------------------
200 |TWO HUNDRED
-1 row selected</i> </codeblock></stepxmp></step>
-<step><cmd>Exit <codeph>ij</codeph>.</cmd><stepxmp><codeblock frame="topbot"><b>exit;</b></codeblock></stepxmp>
+1 row selected</systemoutput></codeblock></stepxmp></step>
+<step><cmd>Exit <codeph>ij</codeph>.</cmd>
+<stepxmp><codeblock><b><userinput>exit;</userinput></b></codeblock></stepxmp>
</step>
-<step><cmd>Shut down the Derby Network Server.</cmd><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbynet.jar shutdown</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) shutdown
- at 2006-09-22 00:16:44.223 GMT</i>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbynet.jar shutdown</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) shutdown
- at 2006-09-22 00:16:44.223 GMT</i>
-</codeblock></dd>
-</dlentry></dl></stepxmp><stepresult>The server shutdown confirmation appears
+<step><cmd>Shut down the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbynet.jar shutdown</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) shutdown
+ at <varname>date</varname> 00:16:44.223 GMT
+</systemoutput></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbynet.jar shutdown</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) shutdown
+ at <varname>date</varname> 00:16:44.223 GMT
+</systemoutput></codeblock></stentry>
+</strow>
+</simpletable></stepxmp>
+<stepresult>The server shutdown confirmation appears
in both command windows.</stepresult></step>
</steps>
-<postreq><b>Activity notes</b><p>The client connection URL contains network
-information (a hostname and portnumber) not found in the URL for an embedded
-connection. This information tells the client driver the "location" of the
-Network Server. The client driver sends requests to and receives responses
-from the Network Server.</p><p>In this activity the Derby database engine
-is embedded in the Network Server and returns data to the <codeph>ij</codeph> client
-(a client/server configuration). In contrast, establishing a connection using
-an embedded URL (one without <codeph>//localhost:1527/</codeph>) would have
-caused the Derby engine to be embedded in the <codeph>ij</codeph> application
-(an embedded configuration).</p><p>Network Server start up and shutdown messages
-are written to the <codeph>derby.log</codeph> log file along with the standard
-database engine messages. For example:<codeblock frame="topbot"><i>Apache Derby Network Server - 10.2.1.6 - (452058) started and ready to
- accept connections on port 1527 at 2006-09-22 00:08:30.049 GMT</i>
- ...( database engine messages not shown )...
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) shutdown
- at 2006-09-22 00:16:44.223 GMT</i></codeblock></p><p>Though not demonstrated here,
-multiple client programs can connect to Network Server and access the database
-simultaneously in this configuration.</p></postreq>
+<postreq><b>Activity notes</b>
+<p>The client connection URL contains network information (a hostname and
+portnumber) not found in the URL for an embedded connection. This information
+tells the client driver the location of the Network Server. The client driver
+sends requests to and receives responses from the Network Server.</p>
+<p>In this activity the <ph conref="wwdconrefs.dita#prod/productshortname"></ph>
+database engine is embedded in the Network Server and returns data to the
+<codeph>ij</codeph> client (a client/server configuration). In contrast,
+establishing a connection using an embedded URL (one without
+<codeph>//localhost:1527/</codeph>) would have caused the
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> engine to be embedded
+in the <codeph>ij</codeph> application (an embedded configuration).</p>
+<p>Network Server startup and shutdown messages are written to the
+<codeph>derby.log</codeph> log file along with the standard database engine
+messages. For example:
+<codeblock><systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) started and ready to
+ accept connections on port 1527 at <varname>date</varname> 00:08:30.049 GMT</systemoutput>
+ <i>... Database engine messages not shown ...</i>
+<systemoutput>Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>) shutdown
+ at <varname>date</varname> 00:16:44.223 GMT</systemoutput></codeblock>
+</p>
+<p>In this configuration, multiple client programs can connect to the Network
+Server and access the database simultaneously. (This example does not
+demonstrate this capability.)</p></postreq>
</taskbody>
</task>