db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1129834 - /db/derby/docs/trunk/src/tools/
Date Tue, 31 May 2011 18:30:11 GMT
Author: chaase3
Date: Tue May 31 18:30:10 2011
New Revision: 1129834

URL: http://svn.apache.org/viewvc?rev=1129834&view=rev
Log:
DERBY-1780  Document all supplied system procedures in the Server and Administration Guide
(e.g. class loading utils and import/export)

This patch deletes 17 topics from the Tools Guide and modifies 10 (including the map file).

Patches: DERBY-1780-2.diff

Removed:
    db/derby/docs/trunk/src/tools/ctoolsimport12925.dita
    db/derby/docs/trunk/src/tools/ctoolsimport16245.dita
    db/derby/docs/trunk/src/tools/ctoolsimport27052.dita
    db/derby/docs/trunk/src/tools/ctoolsimport98264.dita
    db/derby/docs/trunk/src/tools/ctoolsimportdefaultformat.dita
    db/derby/docs/trunk/src/tools/ctoolsimportidentitycol.dita
    db/derby/docs/trunk/src/tools/ctoolsimportjdbc.dita
    db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita
    db/derby/docs/trunk/src/tools/ctoolsimportnulls.dita
    db/derby/docs/trunk/src/tools/rtoolsexportarguements.dita
    db/derby/docs/trunk/src/tools/rtoolsimport57005.dita
    db/derby/docs/trunk/src/tools/rtoolsimport64241.dita
    db/derby/docs/trunk/src/tools/rtoolsimport91458.dita
    db/derby/docs/trunk/src/tools/rtoolsimport92876.dita
    db/derby/docs/trunk/src/tools/rtoolsimportcodeset.dita
    db/derby/docs/trunk/src/tools/ttoolsexporting.dita
    db/derby/docs/trunk/src/tools/ttoolsimporting.dita
Modified:
    db/derby/docs/trunk/src/tools/ctools1004764.dita
    db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
    db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
    db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita
    db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita
    db/derby/docs/trunk/src/tools/ctoolspre11181.dita
    db/derby/docs/trunk/src/tools/ctoolspre22460.dita
    db/derby/docs/trunk/src/tools/ctoolspre23947.dita
    db/derby/docs/trunk/src/tools/derbytools.ditamap
    db/derby/docs/trunk/src/tools/rtools1003161.dita

Modified: db/derby/docs/trunk/src/tools/ctools1004764.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctools1004764.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctools1004764.dita (original)
+++ db/derby/docs/trunk/src/tools/ctools1004764.dita Tue May 31 18:30:10 2011
@@ -26,15 +26,16 @@ limitations under the License.
 <conbody>
 <p>In the <ph conref="../conrefs.dita#prod/productshortname"></ph> documentation,
we refer to three locales:  
 <ul>
-<li><i id="rtoolsijtools91283">Java System locale</i>  
+<li><i>Java System locale</i>  
 <p>This is the locale of your machine, which is automatically
 detected by your JVM.   For <ph conref="../conrefs.dita#prod/productshortname"></ph>
and <ph conref="../conrefs.dita#prod/productshortname"></ph> tools, the Java system
 locale determines the default locale.</p></li>
 <li><i>Database territory</i>  
 <p>This is the territory associated
-with your database when it is created. By default, this is the same as the <xref href="ctools1004764.dita#ctools1004764/rtoolsijtools91283">java
system locale</xref>. The database territory determines
+with your database when it is created. By default, this is the same as the 
+Java System locale. The database territory determines
 the language of database errors.</p></li>
-<li><i id="rtoolsijtools74061">Tools Session locale</i>  
+<li><i>Tools Session locale</i>  
     <p>This locale is associated with your session,
         when using <ph conref="../conrefs.dita#prod/productshortname"></ph>
         tools such as <codeph>ij</codeph> or <codeph>dblook</codeph>.

Modified: db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita Tue May 31 18:30:10 2011
@@ -20,8 +20,10 @@ limitations under the License.
 <concept id="ctoolsijtools26429" xml:lang="en-us">
 <title>What are the Derby tools and utilities?</title>
 <shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph>

-tools and utilities are a set of routines supplied with <ph conref="../conrefs.dita#prod/productshortname"></ph>
that
-are typically used to setup and update a <ph conref="../conrefs.dita#prod/productshortname"></ph>
database.</shortdesc>
+tools and utilities are a set of routines supplied with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> that are typically used
+to create, inspect, and update a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Tools<indexterm>how to use</indexterm></indexterm></keywords>
 </metadata></prolog>

Modified: db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita Tue May 31 18:30:10 2011
@@ -28,7 +28,8 @@ API.</shortdesc>
 <conbody>
 <p>Included with the product are some standalone Java tools and utilities
 that make it easier to use and develop applications for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
-<p>These tools and utilities include:   <ul>
+<p>These tools and utilities include:</p>
+<ul>
 <li><i><ph><indexterm>ij<indexterm>description</indexterm></indexterm></ph>ij</i>
 <p><codeph>ij</codeph> is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
 interactive JDBC scripting tool. It is a simple utility for running scripts
@@ -36,12 +37,6 @@ against a <ph conref="../conrefs.dita#pr
 You can also use it interactively to run ad hoc queries. <codeph>ij</codeph>
provides
 several commands for ease in accessing a variety of JDBC features.</p> <p><codeph>ij</codeph>
can
 be used in an embedded or a client/server environment.</p></li>
-<li><i>The import and export utilities</i>   <p>These server-side
utilities
-allow you to import data directly from files into tables and to export data
-from tables into files. Server-side utilities can be in a client/server environment
-but require that all files referenced be on the Server machine.</p></li>
-<li><i>The jar file utilities</i>   <p>These utilities allow you
-to store jar files in a database.</p></li>
 <li><i><ph><indexterm>sysinfo<indexterm>description</indexterm></indexterm></ph>sysinfo</i>

  <p><codeph>sysinfo</codeph> provides information about your version of
<ph
 conref="../conrefs.dita#prod/productshortname"></ph> and your environment.</p></li>
@@ -56,6 +51,6 @@ or documenting a database's schema.</p><
 <li><i><ph><indexterm>SignatureChecker<indexterm>description</indexterm></indexterm></ph>SignatureChecker</i>
 <p>The <codeph>SignatureChecker</codeph> tool identifies any SQL functions
 and procedures in a database that do not follow the SQL Standard argument
-matching rules.</p></li></ul></p>
+matching rules.</p></li></ul>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita Tue May 31 18:30:10 2011
@@ -18,15 +18,12 @@ See the License for the specific languag
 limitations under the License.
 -->
 <concept id="ctoolsijtools37363" xml:lang="en-us">
-<title>Environment setup and the Derby tools</title>
+<title>Environment setup and the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> tools</title>
 <prolog></prolog>
 <conbody>
-<p><codeph>ij</codeph>, <codeph>sysinfo</codeph>, <codeph>dblook</codeph>,
-and <codeph>SignatureChecker</codeph> are
-tools that can be used in an embedded or a client/server environment. The
-import and export utilities and jar file utilities are database-side
-utilities, which means that they run in the same JVM as <ph conref="../conrefs.dita#prod/productshortname"></ph>
(that is,
-on the server). This means when used in a client/server environment all files
-imported, exported, or loaded must be local to the server machine.</p>
+<p>The tools <codeph>ij</codeph>, <codeph>sysinfo</codeph>,
+<codeph>dblook</codeph>, and <codeph>SignatureChecker</codeph> can
all be used
+in either an embedded or a client/server environment.</p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita Tue May 31 18:30:10 2011
@@ -28,12 +28,12 @@ the data.</note></p>
 <codeblock>ij&gt; <b>VALUES CURRENT_DATE;</b>
 1
 ----------
-2001-09-06
+2011-05-23
 1 row selected
 ij&gt; <b>localizeddisplay on;</b>
 ij&gt; <b>VALUES CURRENT_DATE;</b>
 1
 ------------------
-September 6, 2001
+May 23, 2011
 1 row selected</codeblock></p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolspre11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre11181.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre11181.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre11181.dita Tue May 31 18:30:10 2011
@@ -22,14 +22,12 @@ limitations under the License.
 </prolog>
 <conbody>
 <p>This book describes how to use the <ph conref="../conrefs.dita#prod/productshortname"></ph>
tools and utilities. The
-tools and utilities covered in this book include:  
+tools and utilities covered in this book include:</p>
 <ul>
-<li>ij</li>
-<li>the import and export utilities</li>
-<li>the jar file utilities</li>
-<li>sysinfo</li>
-<li>dblook</li>
-<li>SignatureChecker</li>
-<li>PlanExporter</li>
-</ul></p>
+<li><codeph>ij</codeph></li>
+<li><codeph>sysinfo</codeph></li>
+<li><codeph>dblook</codeph></li>
+<li><codeph>SignatureChecker</codeph></li>
+<li><codeph>PlanExporter</codeph></li>
+</ul>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolspre22460.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre22460.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre22460.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre22460.dita Tue May 31 18:30:10 2011
@@ -21,12 +21,12 @@ limitations under the License.
 <prolog>
 </prolog>
 <conbody>
-<p>This book is for:  
+<p>This book is for:</p> 
 <ul>
-<li>developers, who might use the tools when developing applications</li>
-<li>system administrators, who might use the tools to run backup scripts or
-to import large amounts of data</li>
-<li>end-users, who might use one of the tools to run ad-hoc queries against
+<li>Developers, who might use the tools when developing applications</li>
+<li>System administrators, who might use the tools to run scripts that perform
+administrative tasks such as backups or importing and exporting data</li>
+<li>End-users, who might use one of the tools to run ad-hoc queries against
 a database</li>
-</ul></p>
+</ul>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolspre23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre23947.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre23947.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre23947.dita Tue May 31 18:30:10 2011
@@ -21,7 +21,8 @@ limitations under the License.
 <title>How this guide is organized</title>
 <prolog></prolog>
 <conbody>
-<p>This guide includes the following sections: <ul>
+<p>This guide includes the following sections:</p>
+<ul>
 <li><xref href="ctoolsijtools26429.dita#ctoolsijtools26429"></xref>   <p>Overview
 of the tools and utilities, and <ph conref="../conrefs.dita#prod/productshortname"></ph>
and
 JDBC basics for new or infrequent users.</p></li>
@@ -31,8 +32,6 @@ started with <codeph>ij</codeph>, a JDBC
 for <codeph>ij</codeph> properties.</p></li>
 <li><xref href="rtoolsijcomref25570.dita#rtoolsijcomref25570"></xref> 
 <p>Reference
 for <codeph>ij</codeph> commands and errors.</p></li>
-<li><xref href="ctoolsimport16245.dita#ctoolsimport16245"></xref>   <p>Reference
-and how-to instructions for using bulk import and export.</p></li>
 <li><xref href="rtoolssysinfo41288.dita#rtoolssysinfo41288"></xref>   <p>Reference
 information on the utility that provides information about your <ph conref="../conrefs.dita#prod/productshortname"></ph>
environment.</p></li>
 <li><xref href="ctoolsdblook.dita#ctoolsdblook"></xref>   <p>Reference
@@ -45,6 +44,6 @@ matching rules.</p></li>
 <li><xref href="ctoolsplanexp.dita#ctoolsplanexp"></xref> <p>Reference
 information for a tool that exports query plan data for further
 analysis.</p></li>
-</ul></p>
+</ul>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/tools/derbytools.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/derbytools.ditamap?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/trunk/src/tools/derbytools.ditamap Tue May 31 18:30:10 2011
@@ -29,125 +29,6 @@ limitations under the License.
 <vrmlist><vrm version="@RELEASE_ID_SHORT@"/></vrmlist>
 <brand>Apache Derby</brand></prodinfo>
 </topicmeta>
-<!--The following relationship table is only for the Import and Export topics.  The remaining
topics need to be added to this table.-->
-<reltable>
-<!---->
-<relrow>
-<relcell>
-<topicref collection-type="family" href="ctoolsimport16245.dita" navtitle="Using the bulk
import and export procedures">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimport98264.dita" navtitle="Methods for running the import and export
procedures">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimport27052.dita" navtitle="Bulk import and export requirements
and considerations">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimportlobs.dita" navtitle="Bulk import and export of large objects">
-</topicref>
-</relcell>
-<relcell>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export">
-</topicref>
-</relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimportdefaultformat.dita" navtitle="File format for input and output">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ttoolsimporting.dita" navtitle="Importing data using the built-in procedures">
-</topicref>
-</relcell>
-<relcell>
-<topicref href="ctoolsimport27052.dita" navtitle="Bulk import and export requirements
and considerations">
-</topicref>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export">
-</topicref>
-<topicref href="rtoolsimport64241.dita" navtitle="Parameters for the import procedures">
-</topicref>
-</relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="rtoolsimport64241.dita" navtitle="Parameters for the import procedures">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimportidentitycol.dita" navtitle="Import into tables that contain
identity columns">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ttoolsexporting.dita" navtitle="Exporting data using the built-in procedures">
-</topicref>
-</relcell>
-<relcell>
-<topicref href="ctoolsimport27052.dita" navtitle="Bulk import and export requirements
and considerations">
-</topicref>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export">
-</topicref>
-<topicref href="rtoolsexportarguements.dita" navtitle="Parameters for the export procedures">
-</topicref>
-</relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="rtoolsexportarguements.dita" navtitle="Parameters for the export procedures">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimportjdbc.dita" navtitle="Import and export procedures from JDBC">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="ctoolsimportnulls.dita" navtitle="How the Import and export procedures
process NULL values">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-<relrow>
-<relcell>
-<topicref href="rtoolsimportcodeset.dita" navtitle="CODESET values for import and export
procedures">
-</topicref>
-</relcell>
-<relcell></relcell>
-</relrow>
-</reltable>
 <topicref href="rtoolscopyright.dita" navtitle="Copyright"></topicref>
 <topicref href="rtoolslicense.dita" navtitle="License"></topicref>
 <topicref collection-type="family" href="ctoolspre29520.dita" navtitle="About this guide">
@@ -297,34 +178,6 @@ limitations under the License.
 <topicref href="ctoolsijcomref14191.dita" navtitle="JAVA ERROR"></topicref>
 </topicref>
 </topicref>
-<topicref collection-type="family" href="ctoolsimport16245.dita" navtitle="Using the bulk
import and export procedures">
-<topicref href="ctoolsimport98264.dita" navtitle="Methods for running the import and export
procedures">
-</topicref>
-<topicref href="ctoolsimport27052.dita" navtitle="Bulk import and export requirements
and considerations">
-</topicref>
-<topicref href="ctoolsimportlobs.dita" navtitle="Bulk import and export of large objects">
-</topicref>
-<topicref href="ctoolsimportdefaultformat.dita" navtitle="File format for input and output">
-</topicref>
-<topicref href="ttoolsimporting.dita" navtitle="Importing data using the built-in procedures">
-<topicref href="rtoolsimport64241.dita" navtitle="Parameters for the import procedures">
-</topicref>
-<topicref href="ctoolsimportidentitycol.dita" navtitle="Import into tables that contain
identity columns">
-</topicref>
-</topicref>
-<topicref href="ttoolsexporting.dita" navtitle="Exporting data using the built-in procedures">
-<topicref href="rtoolsexportarguements.dita" navtitle="Parameters for the export procedures">
-</topicref>
-</topicref>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export">
-</topicref>
-<topicref href="ctoolsimportjdbc.dita" navtitle="Import and export procedures from JDBC">
-</topicref>
-<topicref href="ctoolsimportnulls.dita" navtitle="How the Import and export procedures
process NULL values">
-</topicref>
-<topicref href="rtoolsimportcodeset.dita" navtitle="CODESET values for import and export
procedures">
-</topicref>
-</topicref>
 <topicref collection-type="family" href="rtoolssysinfo41288.dita" navtitle="sysinfo">
 <topicref href="rtoolssysinfo1002629.dita" navtitle="sysinfo example"></topicref>
 <topicref href="ctoolssysinfo1002931.dita" navtitle="Using sysinfo to check the classpath">

Modified: db/derby/docs/trunk/src/tools/rtools1003161.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtools1003161.dita?rev=1129834&r1=1129833&r2=1129834&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtools1003161.dita (original)
+++ db/derby/docs/trunk/src/tools/rtools1003161.dita Tue May 31 18:30:10 2011
@@ -23,11 +23,9 @@ limitations under the License.
 <keywords></keywords>
 </metadata></prolog>
 <refbody>
-<section><p>To simplify the process of setting up the
-<codeph>CLASSPATH</codeph> environment variable to run
-<ph conref="../conrefs.dita#prod/productshortname"></ph> and the tools, a new
-jar file, <codeph>derbyrun.jar</codeph>, has been added to the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> distribution. Adding
+<section><p>The jar file <codeph>derbyrun.jar</codeph> simplifies
the process of
+setting up the <codeph>CLASSPATH</codeph> environment variable to run
+<ph conref="../conrefs.dita#prod/productshortname"></ph> and the tools. Adding
 this jar file to your classpath has the effect of putting all the 
 <ph conref="../conrefs.dita#prod/productshortname"></ph> jar files in your
 classpath.</p>



Mime
View raw message