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 ch...@apache.org on 2011/05/31 21:08:45 UTC
svn commit: r1129857 - in /db/derby/docs/trunk/src: getstart/ ref/ tuning/
Author: chaase3
Date: Tue May 31 19:08:45 2011
New Revision: 1129857
URL: http://svn.apache.org/viewvc?rev=1129857&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 modifies 8 topics in the Reference Manual, 2 in Getting Started, and 1 in the Tuning Guide.
Patches: DERBY-1780-3.diff
Modified:
db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
db/derby/docs/trunk/src/getstart/rgsdocs17307.dita
db/derby/docs/trunk/src/ref/rrefexportproc.dita
db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita
db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita
db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita
db/derby/docs/trunk/src/ref/rrefimportdataproc.dita
db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita
db/derby/docs/trunk/src/ref/rrefimportproc.dita
db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita
db/derby/docs/trunk/src/tuning/ctunperf16800.dita
Modified: db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita Tue May 31 19:08:45 2011
@@ -60,7 +60,8 @@ and the full connection URL to the Netwo
addition, there are Derby utilities that are system procedures that you can
call by using the <codeph>ij</codeph> tool. For example, there are system
procedures that you can use to import and export external files. Instructions
-on how to use these system procedures are included in the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite> and
-the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>.</p></section>
+on how to use these system procedures are included in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> and the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p></section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/getstart/rgsdocs17307.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsdocs17307.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsdocs17307.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsdocs17307.dita Tue May 31 19:08:45 2011
@@ -56,17 +56,17 @@ about the <ph conref="../conrefs.dita#pr
</dlentry><dlentry>
<dt><ph conref="../conrefs.dita#pub/citutilities"></ph></dt>
<dd>Describes how to use the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
-such as <codeph>dblook</codeph>, <codeph>ij</codeph>, and <codeph>sysinfo</codeph>,
-and how to use the system procedures to import and export data, and how to
-store Java code in the database.</dd>
+such as <codeph>dblook</codeph>, <codeph>ij</codeph>, and
+<codeph>sysinfo</codeph>.</dd>
</dlentry><dlentry>
<dt><ph conref="../conrefs.dita#pub/citadmin"></ph></dt>
<dd>Part One of this guide discusses configuring servers, how to program client
applications, and database administration. In addition, some systems might
require administrative tasks such as backing up databases. These tasks are
independent of any server framework but are unique to multi-user or large
-systems. <p>Part Two of this guide discusses administrative issues such as
-backups and debugging deadlocks.</p></dd>
+systems. <p>Part Two of this guide discusses administrative tasks such as
+backing up and restoring databases, importing and exporting data, storing
+Java code in the database, and debugging deadlocks.</p></dd>
</dlentry><dlentry>
<dt><ph conref="../conrefs.dita#prod/productshortname"></ph> API Reference</dt>
<dd>An API Reference that is automatically generated for all public <ph conref="../conrefs.dita#prod/productshortname"></ph> classes.
Modified: db/derby/docs/trunk/src/ref/rrefexportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportproc.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportproc.dita Tue May 31 19:08:45 2011
@@ -79,8 +79,10 @@ you must pass the name to the export pro
If you created a schema, table, or column name as a delimited identifier,
you must pass the name to the export procedure using the same case that was
used when it was created.</section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example</title><p>The following example shows how to export
information from the STAFF table in a SAMPLE database to the <codeph>myfile.del</codeph> file.
</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE (null, 'STAFF', 'myfile.del', null, null, null);</codeblock></section>
Modified: db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita Tue May 31 19:08:45 2011
@@ -99,8 +99,10 @@ identifier, you must pass the name to th
characters. If you created a schema or table name as a delimited identifier,
you must pass the name to the export procedure using the same case that was
used when it was created.</p></section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example exporting all data from a table, using a separate
export file for the LOB data</title><p>The following example shows how to
export data from the STAFF table in a sample database to the main file <codeph>staff.del</codeph> and
Modified: db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita Tue May 31 19:08:45 2011
@@ -70,8 +70,10 @@ Java-supported character encodings. Data
set to the specified code set before writing to the file. Passing a NULL value
will write the data in the same code set as the JVM in which it is being executed.</dd>
</dlentry></dl></section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example</title> <p>The following example shows how to export
the information about employees in Department 20 from the STAFF table in the
SAMPLE database to the <codeph>myfile.del</codeph> file. </p> <codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY('select * from staff where dept =20',
Modified: db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita Tue May 31 19:08:45 2011
@@ -87,8 +87,10 @@ If you are using the Network Server, the
Specifying a NULL value results in an error. The <parmname>LOBSFILENAME</parmname> parameter
takes an input argument that is a VARCHAR (32672) data type.</dd>
</dlentry></dl></section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example exporting data from a query using a separate export
file for the LOB data</title>The following example shows how to export employee
data in department 20 from the STAFF table in a sample database to the main
Modified: db/derby/docs/trunk/src/ref/rrefimportdataproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportdataproc.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportdataproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimportdataproc.dita Tue May 31 19:08:45 2011
@@ -88,8 +88,10 @@ identifier, you must pass the name to th
characters. If you created a schema, table, or column name as a delimited
identifier, you must pass the name to the import procedure using the same
case that was used when it was created.</p></section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example</title><p>The following example imports some of the
data fields from a delimited data file called <codeph>data.del</codeph> into
the <codeph>STAFF</codeph> table: <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA
Modified: db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita Tue May 31 19:08:45 2011
@@ -108,8 +108,9 @@ the reference that is stored in the main
to the LOB stored in the main import file must be <codeph>lobsFileName.Offset.length/</codeph>. </p><ul>
<li><codeph>Offset</codeph> is position in the external file in bytes</li>
<li><codeph>length</codeph> is the size of the LOB column data in bytes</li>
-</ul><p>For additional information on using this procedure see the section
-"Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+</ul><p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example importing data into specific columns, using a separate
import file for the LOB data</title>The following example shows how to import
data into several columns of the STAFF table. The STAFF table includes a LOB
Modified: db/derby/docs/trunk/src/ref/rrefimportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportproc.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimportproc.dita Tue May 31 19:08:45 2011
@@ -76,8 +76,10 @@ identifier, you must pass the name to th
characters. If you created a schema, table, or column name as a delimited
identifier, you must pass the name to the import procedure using the same
case that was used when it was created.</section>
-<section><title>Usage</title><p>For additional information on using this procedure
-see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>Usage</title>
+<p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example</title><p>The following example imports data into
the <codeph>STAFF</codeph> table from a delimited data file called <codeph>myfile.del</codeph> with
the percentage character (%) as the string delimiter, and a semicolon (;)
Modified: db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita Tue May 31 19:08:45 2011
@@ -94,8 +94,9 @@ from a non-Derby source, the format of t
the main import file must be <codeph>lobsFileName.Offset.length/</codeph>. </p><ul>
<li><codeph>Offset</codeph> is position in the external file in bytes</li>
<li><codeph>length</codeph> is the size of the LOB column data in bytes</li>
-</ul><p>For additional information on using this procedure see the section
-"Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+</ul><p>For additional information on using this procedure, see the section
+"Importing and exporting data" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section><title>Example importing data from a main import file that contains
references which point to a separate file that contains LOB data</title><p>The
following example shows how to import data into the <i>STAFF</i> table in
Modified: db/derby/docs/trunk/src/tuning/ctunperf16800.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunperf16800.dita?rev=1129857&r1=1129856&r2=1129857&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunperf16800.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunperf16800.dita Tue May 31 19:08:45 2011
@@ -29,9 +29,11 @@ not return until a physical disk write i
<li>Run in autocommit false mode, execute a number of inserts in one transaction,
and then explicitly issue a commit.</li>
<li>If your application allows an initial load into the table, you can use
-the import procedures to insert data into a table. <ph conref="../conrefs.dita#prod/productshortname"></ph> will
+the import procedures to insert data into a table.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> will
not log the individual inserts when loading into an empty table using these
-interfaces. See the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph> Guide</cite> for
+interfaces. See the <ph conref="../conrefs.dita#pub/citref"></ph> and the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for
more information on the import procedures.</li>
</ul></p>
</conbody>