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 jt...@apache.org on 2006/04/14 04:08:01 UTC

svn commit: r394000 - in /db/derby/docs/trunk: ./ src/workingwithderby/

Author: jta
Date: Thu Apr 13 19:07:59 2006
New Revision: 394000

URL: http://svn.apache.org/viewcvs?rev=394000&view=rev
Log:
DERBY-913 DITA source for first two chapters for the new Working With Derby doc.

Patch by Stanley Bradbury <St...@gmail.com>.

Added:
    db/derby/docs/trunk/src/workingwithderby/
    db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap   (with props)
    db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita   (with props)
    db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita   (with props)
    db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita   (with props)
    db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita   (with props)
    db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita   (with props)
Modified:
    db/derby/docs/trunk/build.xml

Modified: db/derby/docs/trunk/build.xml
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/build.xml?rev=394000&r1=393999&r2=394000&view=diff
==============================================================================
--- db/derby/docs/trunk/build.xml (original)
+++ db/derby/docs/trunk/build.xml Thu Apr 13 19:07:59 2006
@@ -16,7 +16,7 @@
     <ant dir="src/pt_BR"/>
   </target>
 
-  <target name="html" depends="init,html.getstart,html.tools,html.devguide,html.adminguide,html.ref,html.tuning"/>
+  <target name="html" depends="init,html.workingwithderby,html.getstart,html.tools,html.devguide,html.adminguide,html.ref,html.tuning"/>
 
   <target name="init" depends="check.dita,unpack.dita,check.regex.done,dita.regex">
     <available classname="org.apache.fop.tools.anttasks.Fop"
@@ -33,7 +33,14 @@
     <copy file="${dita.lib.dir}/dita2fo-shell.xsl" todir="${dita.dir}/xsl"/>
   </target>
  
-  <target name="html.getstart" depends="init">
+ <target name="html.workingwithderby" depends="init">
+    <antcall target="html.dita">
+      <param name="manual.name" value="workingwithderby"/>
+      <param name="manual.ditamap" value="workingwithderby.ditamap"/>
+    </antcall>
+  </target>
+
+ <target name="html.getstart" depends="init">
     <antcall target="html.dita">
       <param name="manual.name" value="getstart"/>
       <param name="manual.ditamap" value="getstartderby.ditamap"/>
@@ -101,8 +108,15 @@
     <touch file="${dita.script.dir}/regex.done"/>
   </target>
 
-  <target name="pdf" depends="init,pdf.getstart,pdf.tools,pdf.devguide,pdf.adminguide,pdf.ref,pdf.tuning"/>
+  <target name="pdf" depends="init,pdf.workingwithderby,pdf.getstart,pdf.tools,pdf.devguide,pdf.adminguide,pdf.ref,pdf.tuning"/>
 
+ <target name="pdf.workingwithderby" depends="init">
+    <antcall target="pdf.dita">
+      <param name="manual.name" value="workingwithderby"/>
+      <param name="manual.ditamap" value="workingwithderby.ditamap"/>
+    </antcall>
+  </target>
+    
   <target name="pdf.getstart" depends="init">
     <antcall target="pdf.dita">
       <param name="manual.name" value="getstart"/>
@@ -154,7 +168,14 @@
     </ant>
   </target>
 
-  <target name="monohtml" depends="monohtml.adminguide,monohtml.devguide,monohtml.getstart,monohtml.ref,monohtml.tools,monohtml.tuning"/>
+  <target name="monohtml" depends="monohtml.workingwithderby,monohtml.adminguide,monohtml.devguide,monohtml.getstart,monohtml.ref,monohtml.tools,monohtml.tuning"/>
+
+  <target name="monohtml.workingwithderby" depends="init,pdf.workingwithderby">
+    <antcall target="monohtml.dita">
+      <param name="manual.name" value="workingwithderby"/>
+      <param name="manual.fo" value="workingwithderby.fo"/>
+    </antcall>
+  </target>
 
   <target name="monohtml.adminguide" depends="init,pdf.adminguide">
     <antcall target="monohtml.dita">

Added: db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap (added)
+++ db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap Thu Apr 13 19:07:59 2006
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
+ "../dtd/map.dtd">
+<!-- 
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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.
+-->
+<map collection-type="sequence" linking="normal" title="Working With Derby - partial (Intro and Activity 1)">
+<topicmeta>
+<copyright>
+<copyryear year="2006"/>
+<copyrholder>Apache Software Foundation</copyrholder>
+</copyright>
+<prodinfo>
+<prodname>Working With Derby - partial (Intro and Activity 1)</prodname>
+<vrmlist><vrm version="10.3"/></vrmlist>
+<brand>Apache Derby</brand></prodinfo>
+</topicmeta>
+<topicref href="rwwdcopyright.dita" navtitle="Copyright"></topicref>
+<topicref href="twwdIntro.dita" navtitle="Introduction and prerequisites">
+<topicref href="cwwdactivities.dita" navtitle="Activity overview"></topicref>
+</topicref>
+<topicref href="twwdactivity1_Setup.dita" navtitle="Activity 1: Run SQL using the Embedded driver">
+<topicref href="twwdactivity1.dita" navtitle="Creating the database and running SQL">
+</topicref>
+</topicref>
+</map>

Propchange: db/derby/docs/trunk/src/workingwithderby/WorkingWithDerby.ditamap
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita (added)
+++ db/derby/docs/trunk/src/workingwithderby/cwwdactivities.dita Thu Apr 13 19:07:59 2006
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<!-- 
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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.
+-->
+<concept id="cwwdactivities" rev="1.0" xml:lang="en-us">
+<title>Activity overview</title>
+<shortdesc>What you can expect to learn in each activity.</shortdesc>
+<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 work in a Client-Server.
+The program will load the client driver and connect to the database via the
+Derby Network Server. Compile the altered program and test that it operates
+as it did in the previous activity. Verify that two instances of the program
+can be used at the same time.</p></dd>
+</dlentry></dl>
+</conbody>
+</concept>

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

Added: db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita (added)
+++ db/derby/docs/trunk/src/workingwithderby/rwwdcopyright.dita Thu Apr 13 19:07:59 2006
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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="rwwdcopyright" xml:lang="en-us">
+<title>Copyright</title>
+<shortdesc>First Edition (June 2006)</shortdesc>
+<refbody>
+<section><p>Copyright 2006 The Apache Software Foundation or its licensors,
+as applicable.</p><p>Licensed 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   <codeblock>http://www.apache.org/licenses/LICENSE-2.0</codeblock></p><p>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.</p></section>
+</refbody>
+</reference>

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

Added: db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita (added)
+++ db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita Thu Apr 13 19:07:59 2006
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!--
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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="twwdIntro" rev="1.4" xml:lang="en-us">
+<title>Introduction and prerequisites</title>
+<shortdesc>Welcome to Derby!  We think you'll find Derby to be an easy to
+use and fully functional RDBMS.  Through the activities in this document we
+hope to help you get up and running with  Derby as quickly as possible. In
+way of introduction this sections provides a brief description of Derby. This
+is followed by information on the skills and software required to perform
+the activities presented in this document. The section ends with a brief description
+of what is presented by each of the Working With Derby activities .</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>JAVA<indexterm>verifying</indexterm></indexterm><indexterm>Derby<indexterm>downloading</indexterm><indexterm>getting
+help</indexterm></indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<context><p>Derby is a full featured, open source relational database engine
+that is written and implemented completely in Java. It provides users with
+a small footprint, standards-based Java database that can be tightly embedded
+into any Java based solution.  Derby insures data integrity and provides sophisticated
+transactional support. In it's 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
+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
+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 SDK version 1.3 or higher</li>
+<li>The binary (<codeph>bin</codeph>) installation of Apache Derby</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>
+</ul></li>
+</ul></p><p>If unsure about the Java or Derby environments installed preform
+the following steps to obtain the information necessary to perform the subsequent
+activities:</p></context>
+<steps>
+<step><cmd>Verify that the JAVA_HOME environment variable is set and points
+to a Java SDK 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><codeblock frame="topbot"><b><apiname>On Windows platforms:</apiname></b>
+C:\> "%JAVA_HOME%\bin\java" -version
+
+<b><apiname>On UNIX Korn Shell platforms:</apiname></b>
+$ "$JAVA_HOME/bin/java" -version
+
+</codeblock></stepxmp><stepresult>The output from the command will look something
+like this:<codeblock frame="topbot"><i>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>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 SDK before continuing.</stepresult>
+</step>
+<step><cmd>Note the filesystem path to the Derby installation (referred to
+as <b>DERBY_HOME</b>).</cmd><info>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 Downloads page use the link to the 'Latest
+Official Release' then locate the <codeph>bin</codeph> distribution (e.g.
+db-derby-10.2.0-bin). Download the file and unbundle the release.</info></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
+and feedback received will be used to make this document even more useful. </postreq>
+</taskbody>
+</task>

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

Added: db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita (added)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita Thu Apr 13 19:07:59 2006
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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" rev="1.4" xml:lang="en-us">
+<title>Creating the database and running SQL</title>
+<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 Derby IJ tool.</cmd><stepxmp><dl><dlentry>
+<dt>On Windows platforms:</dt>
+<dd><codeblock frame="topbot"><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</userinput>
+<i><systemoutput>ij version 10.2</systemoutput></i>
+</codeblock></dd>
+</dlentry></dl><dl><dlentry>
+<dt>On UNIX Korn Shell platforms:</dt>
+<dd><codeblock frame="topbot"><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar ij</userinput>
+<i><systemoutput>ij version 10.2</systemoutput></i></codeblock></dd>
+</dlentry></dl></stepxmp></step>
+<step><cmd>Create the database and open a connection to it using the embedded
+driver.</cmd><stepxmp><codeblock><userinput>CONNECT 'jdbc:derby:firstdb;create=true';</userinput></codeblock></stepxmp>
+</step>
+<step><cmd>Create a table with two columns using standard SQL.</cmd><stepxmp><codeblock
+frame="topbot"><userinput>CREATE TABLE FIRSTTABLE
+    (ID INT PRIMARY KEY,
+    NAME VARCHAR(12));</userinput>
+<i><systemoutput>0 rows inserted/updated/deleted</systemoutput></i></codeblock></stepxmp>
+</step>
+<step><cmd>Insert three records.</cmd><stepxmp><codeblock frame="topbot"><userinput>INSERT INTO FIRSTTABLE VALUES 
+    (10,'TEN'),(20,'TWENTY'),(30,'THIRTY');</userinput>
+<i><systemoutput>3 rows inserted/updated/deleted</systemoutput></i></codeblock></stepxmp>
+</step>
+<step><cmd>Perform a simple select of all records in the table.</cmd><stepxmp><codeblock
+frame="topbot">ij> <userinput>SELECT * FROM FIRSTTABLE;</userinput>
+<i><systemoutput> ID         |NAME
+    ------------------------
+    10         |TEN
+    20         |TWENTY
+    30         |THIRTY
+
+3 rows selected</systemoutput></i></codeblock></stepxmp></step>
+<step><cmd>Preform a qualified select of the record with column ID=20.</cmd>
+<stepxmp><codeblock frame="topbot"><userinput>SELECT * FROM FIRSTTABLE
+WHERE ID=20;</userinput>
+<i><systemoutput>    ID         |NAME
+    ------------------------
+    20         |TWENTY
+
+1 row selected</systemoutput></i></codeblock></stepxmp></step>
+<step><cmd>Load the SQL script <userinput>toursDB.sql</userinput> to create
+other tables and load data to work with (this step is optional).</cmd><stepxmp><codeblock
+frame="topbot"><userinput>run 'toursDB.sql';</userinput>
+
+<i><systemoutput>0 rows inserted/updated/deleted
+1 row inserted/updated/deleted
+</systemoutput>
+<b><apiname>===> Other output messages not shown &lt;=====</apiname></b></i>
+</codeblock></stepxmp></step>
+<step><cmd>Exit the IJ tool.</cmd><stepxmp><codeblock frame="topbot"><userinput>exit;</userinput>
+</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-12-18 23:33:37.564 GMT:
+ Booting Derby version The Apache Software Foundation 
+   - Apache Derby - 10.2.1.0 - (398064): 
+   instance c013800d-0109-7f82-e11f-000000119a68
+    on database directory C:\DERBYDBS\FIRSTDB 
+Database Class Loader started - derby.database.classpath=''
+
+2006-12-18 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
+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>

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

Added: db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita?rev=394000&view=auto
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita (added)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity1_Setup.dita Thu Apr 13 19:07:59 2006
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.  
+
+Licensed 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" 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>
+<prolog><metadata>
+<keywords><indexterm>DERBY_HOME</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 show</p> </context>
+<steps>
+<step><cmd>Setting the <varname>DERBY_HOME</varname> environment variable.</cmd>
+</step>
+<step><cmd>Creating the <codeph>DERBYDBS</codeph> work directory</cmd></step>
+<step><cmd>Change directory (<userinput>cd</userinput>) to the work directory</cmd>
+</step>
+<step><cmd>Copy the <userinput>toursDB.sql</userinput> script from the Derby <codeph>demo</codeph> subdirectory
+into the <codeph>DERBYDBS</codeph> directory.</cmd></step>
+</steps>
+</taskbody>
+<task id="activity_setup">
+<title>Setup Activities</title>
+<taskbody>
+<example>Open a command window and perform the following activity sequence:<codeblock
+frame="topbot"><b><apiname>On Windows platforms:</apiname></b>
+<userinput>   set DERBY_HOME=C:\derby</userinput>
+<userinput>   md DERBYDBS</userinput>
+<userinput>   cd DERBYDBS</userinput>
+<userinput>   copy %DERBY_HOME%\demo\scripts\toursDB.sql . </userinput>
+
+<b><apiname>On UNIX Korn Shell platforms:</apiname></b>
+<userinput>   export DERBY_HOME=/opt/derby</userinput>
+<userinput>   mkdir DERBYDBS</userinput>
+<userinput>   cd DERBYDBS</userinput>
+<userinput>   cp $DERBY_HOME/demo/scripts/toursDB.sql . </userinput>
+
+</codeblock><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>
+</task>

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