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 2007/05/21 18:19:35 UTC
svn commit: r540191 [1/2] - /db/derby/docs/trunk/src/tools/
Author: scotsmatrix
Date: Mon May 21 09:19:33 2007
New Revision: 540191
URL: http://svn.apache.org/viewvc?view=rev&rev=540191
Log:
DERBY-2527: Added import and export procedures for LOBs. Patch Derby2527_2.diff was contributed by me.
Added:
db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita (with props)
db/derby/docs/trunk/src/tools/ttoolsexporting.dita (with props)
db/derby/docs/trunk/src/tools/ttoolsimporting.dita (with props)
Removed:
db/derby/docs/trunk/src/tools/ctoolsimport13648.dita
Modified:
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/ctoolsimportnulls.dita
db/derby/docs/trunk/src/tools/derbytools.ditamap
db/derby/docs/trunk/src/tools/rtoolsexportarguements.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
Modified: db/derby/docs/trunk/src/tools/ctoolsimport16245.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimport16245.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimport16245.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimport16245.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,17 +18,30 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsimport16245">
+<concept id="ctoolsimport16245" xml:lang="en-us">
<title>Using the bulk import and export procedures</title>
+<shortdesc>You can import and export large amounts of data between files and
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> database. Instead
+of having to use INSERT and SELECT statements, you can use <ph conref="../conrefs.dita#prod/productshortname"></ph> system
+procedures to import data directly from files into tables and to export data
+from tables into files.</shortdesc>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>bulk import and export<indexterm>overview</indexterm></indexterm>
+<indexterm>import procedures<indexterm>overview</indexterm></indexterm><indexterm>export
+procedures<indexterm>overview</indexterm></indexterm><indexterm>system procedures<indexterm>import
+and export, overview</indexterm></indexterm></keywords>
+</metadata></prolog>
<conbody>
-<p>You might want to import or export a large
-amount of data between files and the database. Instead of having to use INSERT
-and SELECT statements, you can use <ph conref="../conrefs.dita#prod/productshortname"></ph> procedures to import data directly
-from files into tables and to export data from tables into files.</p>
-</conbody></concept>
+<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> system procedures
+import and export data in delimited data file format. </p>
+<ul>
+<li>Use the export system procedures to write data from a database to one
+or more files that are stored outside of the database. You can use a procedure
+to export data from a table into a file or export data from a SELECT statement
+result into a file.</li>
+<li>Use the import system procedures to import data from a file into a table.
+If the target table already contains data, you can replace or append to the
+existing data.</li>
+</ul>
+</conbody>
+</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsimport27052.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimport27052.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimport27052.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimport27052.dita Mon May 21 09:19:33 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-
+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -19,34 +19,56 @@
limitations under the License.
-->
<concept id="ctoolsimport27052" xml:lang="en-us">
-<title>Bulk import/export requirements and considerations</title>
+<title>Bulk import and export requirements and considerations</title>
+<shortdesc>There are requirements and limitations that you must consider before
+you use the <ph conref="../conrefs.dita#prod/productshortname"></ph> import
+and export procedures.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>import<indexterm>requirements</indexterm></indexterm>
-<indexterm>import<indexterm>limitations</indexterm></indexterm></keywords>
+<keywords><indexterm>bulk import and export<indexterm>requirements</indexterm></indexterm>
+<indexterm>import procedures<indexterm>requirements</indexterm></indexterm>
+<indexterm>import procedures<indexterm>limitations</indexterm></indexterm>
+<indexterm>export procedures<indexterm>requirements</indexterm><indexterm>export
+procedures<indexterm>limitations</indexterm></indexterm></indexterm><indexterm>system
+procedures<indexterm>import and export, requirements</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<conbody>
<dl><dlentry>
+<dt>Database transactions</dt>
+<dd>You should issue either a COMMIT or ROLLBACK statement to complete all
+transactions and release all table-level locks before you invoke an import
+or export procedure. <ph conref="../conrefs.dita#prod/productshortname"></ph> issues
+a COMMIT or a ROLLBACK statement after each import and export procedure is
+run.<note>Imports are transactional. If an error occurs during bulk import,
+all changes are rolled back.</note></dd>
+</dlentry><dlentry>
+<dt>Database connections</dt>
+<dd>To invoke a <ph conref="../conrefs.dita#prod/productshortname"></ph> import
+or export procedure, you must be connected to the database into which the
+data is imported or from which the data is exported. Other user applications
+that access the table with a separate connection do not need to disconnect.</dd>
+</dlentry><dlentry>
+<dt>Classpath</dt>
+<dd>You must have the <filepath>derbytools.jar</filepath> file in your classpath
+before you can use the import or export procedures from <codeph>ij</codeph>.</dd>
+</dlentry><dlentry>
<dt>The table must exist</dt>
-<dd>For you to import data into a table, the table must already exist in <ph
-conref="../conrefs.dita#prod/productshortname"></ph>. The table does not
-have to be empty. If the table is not empty, bulk import performs single inserts
-which results in slower performance.</dd>
-</dlentry><dlentry>
-<dt>Create indexes and primary key, foreign key, and unique constraints first</dt>
-<dd> To avoid a separate create index step, create indexes and primary keys
-on tables before you import data. However, if your memory and disk spaces
-resources are limited, you can build the indexes and primary keys after importing
-data.</dd>
+<dd>To import data into a table, the table must already exist in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
+The table does not have to be empty. If the table is not empty, bulk import
+performs single row inserts which results in slower performance.</dd>
+</dlentry><dlentry>
+<dt>Create indexes, keys, and unique constraints before you import</dt>
+<dd>To avoid a separate step, create the indexes, keys (primary and foreign),
+and unique constraints on tables before you import data. However, if your
+memory and disk spaces resources are limited, you can build the indexes and
+primary keys after importing data.</dd>
</dlentry><dlentry>
<dt>Data types</dt>
-<dd>You can import and export only data of the non-binary, <i>built-in</i> data
-types. <ph conref="../conrefs.dita#prod/productshortname"></ph> implicitly
-converts the strings to the data type of the receiving column. If any of the
-implicit conversions fail, the whole import is aborted. For example, "3+7"
-cannot be converted into an integer. An export that encounters a runtime error
-stops. <note>You cannot import or export the binary data types: BLOB, CLOB,
-CHAR FOR BIT DATA, VARCHAR FOR BIT DATA, or LONG VARCHAR FOR BIT DATA. Additionally,
-you cannot import or export the XML data type.</note></dd>
+<dd><ph conref="../conrefs.dita#prod/productshortname"></ph> implicitly converts
+the strings to the data type of the receiving column. If any of the implicit
+conversions fail, the whole import is aborted. For example, "3+7" cannot be
+converted into an integer. An export that encounters a runtime error stops.
+ <note>You cannot import or export the XML data type.</note></dd>
</dlentry><dlentry>
<dt>Locking during import</dt>
<dd>Import procedures use the same isolation level as the connection in which
@@ -58,16 +80,16 @@
they are executed to fetch data from tables.</dd>
</dlentry><dlentry>
<dt>Import behavior on tables with triggers</dt>
-<dd>The import procedure fires INSERT triggers when data is appended to the
-table. The REPLACE option is not allowed when triggers are enabled on the
-table.</dd>
-</dlentry><dlentry>
-<dt>Restrictions on the REPLACE option</dt>
-<dd>If a table that receives imported data already contains data, you can
-either replace or append to the existing data. You can use the REPLACE option
-on tables that have dependent tables, but the replaced data must maintain
-referential integrity, otherwise the import operation will be rolled back.
-You cannot use the REPLACE option if the table has enabled triggers.</dd>
+<dd>The import procedures enables INSERT triggers when data is appended to
+the table. The REPLACE parameter is not allowed when triggers are enabled
+on the table.</dd>
+</dlentry><dlentry>
+<dt>Restrictions on the REPLACE parameter</dt>
+<dd>If you import data into a table that already contains data, you can either
+replace or append to the existing data. You can use the REPLACE parameter
+on tables that have dependent tables. The replaced data must maintain referential
+integrity, otherwise the import operation will be rolled back. You cannot
+use the REPLACE parameter if the table has triggers enabled.</dd>
</dlentry><dlentry>
<dt>Restrictions on tables</dt>
<dd>You cannot use import procedures to import data into a system table or
Modified: db/derby/docs/trunk/src/tools/ctoolsimport98264.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimport98264.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimport98264.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimport98264.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,24 +18,30 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsimport98264">
-<title>Options for running the import and export procedures</title>
+<concept id="ctoolsimport98264" xml:lang="en-us">
+<title>Methods for running the import and export procedures</title>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>bulk import and export<indexterm>methods for running
+procedures</indexterm></indexterm><indexterm>import procedures<indexterm>methods
+for running</indexterm></indexterm><indexterm>export procedures<indexterm>methods
+for running</indexterm></indexterm><indexterm>bulk import and export<indexterm>client/server
+mode</indexterm></indexterm><indexterm>import procedures<indexterm>client/server
+mode</indexterm></indexterm><indexterm>export procedures<indexterm>client/server
+mode</indexterm></indexterm></keywords>
+</metadata></prolog>
<conbody>
-<p>You can run the import/export procedures from within an SQL statement
+<p>You can run the import and export procedures from within an SQL statement
using <codeph>ij</codeph> or any Java application.</p>
-<p>Import/Export reads and writes only text files. Import does not support
-read-once streams (live data feeds), because it reads the first line of the
-file to determine the number of columns, then reads it again to import the
-data.
-<note>These server-side utilities exhibit different behavior
-in client/server mode. Typically, you use them to import data into and export
-data from a locally running <ph conref="../conrefs.dita#prod/productshortname"></ph>. However, you can use the import/export
-procedures when <ph conref="../conrefs.dita#prod/productshortname"></ph> is running in a server framework if you specify
-import and export files that are accessible to the server.</note></p>
-</conbody></concept>
+<p>The import and export procedures read and write text files, and if you
+use an external file when you import or export data, you can also import and
+export blob data. The import procedures do not support read-once streams (live
+data feeds), because the procedures read the first line of the file to determine
+the number of columns, then read the file again to import the data. </p>
+<note>The import and export procedures are server-side utilities that exhibit
+different behavior in client/server mode. Typically, you use these procedures
+to import data into and export data from a locally running <ph conref="../conrefs.dita#prod/productshortname"></ph> database.
+However, you can use the import and export procedures when <ph conref="../conrefs.dita#prod/productshortname"></ph> is
+running in a server framework if you specify import and export files that
+are accessible to the server.</note>
+</conbody>
+</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsimportdefaultformat.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimportdefaultformat.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimportdefaultformat.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimportdefaultformat.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,55 +18,53 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsimportdefaultformat">
+<concept id="ctoolsimportdefaultformat" xml:lang="en-us">
<title>File format for input and output</title>
+<shortdesc>There are specific requirements for the format of the input and
+output files when you import and export data.</shortdesc>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>import and export procedures<indexterm>input and output
+file format</indexterm></indexterm><indexterm>importing data<indexterm>required
+file format</indexterm></indexterm><indexterm>exporting data<indexterm>required
+file format</indexterm></indexterm><indexterm>system procedures<indexterm>import
+using</indexterm></indexterm></keywords>
+</metadata></prolog>
<conbody>
-<p>The default file format is a delimited text file with the following characteristics:
-
+<p>The default file format is a delimited text file with the following characteristics:</p>
<ul>
-<li>Rows are separated by a new line.</li>
+<li>Rows are separated by a new line</li>
<li>Fields are separated by a comma (,)</li>
<li>Character-based fields are delimited with double quotes (")</li>
-</ul></p>
-<p>Before performing import or export operations, you must ensure that the
-chosen delimiter character is not contained in the data to be imported or
-exported. If you chose a delimiter character that is part of the data to be
-imported/exported unexpected errors might occur. The following restrictions
-apply to column and character delimiters:
-<ul>
+</ul>
+<note type="restriction">Before you perform import or export operations, you
+must ensure that the chosen delimiter character is not contained in the data
+to be imported or exported. If you chose a delimiter character that is part
+of the data to be imported or exported unexpected errors might occur. The
+following restrictions apply to column and character delimiters: <ul>
<li>Delimiters are mutually exclusive</li>
<li>A delimiter cannot be a line-feed character, a carriage return, or a blank
-space.</li>
-<li>The default decimal point (.) cannot be a character delimiter.</li>
-</ul>The record delimiter is assumed to be a new-line character. The record
+space</li>
+<li>The default decimal point (.) cannot be a character delimiter</li>
+<li>Delimiters cannot be hex decimal characters (0-9, a-f, A-F).</li>
+</ul></note>
+<p>The record delimiter is assumed to be a new-line character. The record
delimiter should not be used as any other delimiter.</p>
<p>Character delimiters are permitted with the character-based fields (CHAR,
-VARCHAR, and LONG VARCHAR) of a file during import, any pair of character
+VARCHAR, and LONG VARCHAR) of a file during import. Any pair of character
delimiters found between the enclosing character delimiters is imported into
-the database. For example, suppose you have the following character string:
-<codeblock>"what a ""great"" day!"</codeblock> The preceding character string gets imported
-into the database as:
-<codeblock>What a "great" day!</codeblock></p>
+the database. For example, suppose that you have the following character string: <codeblock>"what a ""great"" day!"</codeblock> The
+preceding character string gets imported into the database as: <codeblock>What a "great" day!</codeblock></p>
<p>During export, the rule applies in reverse. For example, suppose you have
-the following character string:
-<codeblock>"The boot has a 3" heel."</codeblock> The preceding
-character string gets exported to a file as:
-<codeblock>"The boot has a 3""heel."</codeblock></p>
-<p>The following example file shows four rows and four columns in default
-file format:
-<codeblock><b>1,abc,22,def
+the following character string: <codeblock>"The boot has a 3" heel."</codeblock> The
+preceding character string gets exported to a file as: <codeblock>"The boot has a 3""heel."</codeblock></p>
+<p>The following example file shows four rows and four columns in the default
+file format: <codeblock>1,abc,22,def
22,,,"a is a zero-length string, b is null"
13,"hello",454,"world"
-4,b and c are both null,,</b></codeblock></p>
-<p>The export procedure outputs the following values:
-<codeblock><b>1,"abc",22,"def"
+4,b and c are both null,,</codeblock></p>
+<p>The export procedure outputs the following values: <codeblock>1,"abc",22,"def"
22,,,"a is a zero-length string, b is null"
13,"hello",454,"world"
-4,"b and c are both null",,</b></codeblock></p>
-</conbody></concept>
+4,"b and c are both null",,</codeblock></p>
+</conbody>
+</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsimportidentitycol.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimportidentitycol.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimportidentitycol.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimportidentitycol.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -18,44 +19,52 @@
limitations under the License.
-->
<concept id="ctoolsimportidentitycol" xml:lang="en-us">
-<title>Importing into tables with identity columns</title>
+<title>Import into tables that contain identity columns</title>
+<shortdesc>You can use the either the SYSCS_UTIL.SYSCS_IMPORT_DATA procedure
+or the SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE procedure to import
+data into a table that contains an identity column. </shortdesc>
+<prolog><metadata>
+<keywords><indexterm>importing data<indexterm>tables with identity columns</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<conbody>
-<p>You can use the SYSCS_UTIL.SYSCS_IMPORT_DATA procedure to import data into
-a table that contains an identity column. If the identity column is defined
-as GENERATED ALWAYS, an identity value is generated for a table row whenever
-the corresponding row field in the input file does not contain a value for
-the identity column. When a corresponding row field in the input file already
-contains a value for the identity column, the row cannot be inserted into
-the table and the import operation will fail. To prevent such scenarios, the
-following examples show how to specify arguments in the SYSCS_UTIL.SYSCS_IMPORT_DATA
-procedure to ignore data for the identity column from the file, and/or omit
-the column name from the insert column list.</p>
-<p>If the REPLACE option is used during import, <ph conref="../conrefs.dita#prod/productshortname"></ph> resets
-its internal counter of the last identity value for a column to the initial
-value defined for the identity column.</p>
-<p>Consider the following table that contains an identity column, <i>c2</i>:</p>
-<codeblock><b>CREATE TABLE tab1 (c1 CHAR(30), c2 INT GENERATED ALWAYS AS IDENTITY, c3 REAL,
- c4 CHAR(1))</b></codeblock>
+<p>If the identity column is defined as GENERATED ALWAYS, an identity value
+is generated for a table row whenever the corresponding row field in the input
+file does not contain a value for the identity column. When a corresponding
+row field in the input file already contains a value for the identity column,
+the row cannot be inserted into the table and the import operation will fail.
+To prevent such scenarios, the following examples show how to specify parameters
+in the SYSCS_UTIL.SYSCS_IMPORT_DATA and SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE
+procedures to ignore data for the identity column from the file, or omit the
+column name from the insert column list.</p>
+<p>If the <parmname>REPLACE</parmname> parameter is used during import, <ph
+conref="../conrefs.dita#prod/productshortname"></ph> resets its internal counter
+of the last identity value for a column to the initial value defined for the
+identity column.</p>
+<p>The following table definition contains an identity column, <codeph>c2</codeph> and
+is used in the examples below:</p>
+<codeblock>CREATE TABLE tab1 (c1 CHAR(30), c2 INT GENERATED ALWAYS AS IDENTITY,
+ c3 REAL, c4 CHAR(1))</codeblock>
<ul>
-<li>Suppose you want to import data into <i>tab1</i> from a file <codeph>myfile.del</codeph> that
-does not have identity column information and <codeph>myfile.del</codeph> contains
-three fields with the following data: <codeblock><b>Robert,45.2,J
+<li>Suppose that you want to import data into <codeph>tab1</codeph> from a
+file <codeph>myfile.del</codeph> that does not have identity column information.
+The <codeph>myfile.del</codeph> file contains three fields with the following
+data: <codeblock>Robert,45.2,J
Mike,76.9,K
-Leo,23.4,I</b> </codeblock> To import data from <codeph>myfile.del</codeph> into
-the <i>tab1</i> table, explicitly list the column names for <i>tab1</i> without
-the identity column <i>c2</i> and execute the SYSCS_UTIL.SYSCS_IMPORT_DATA
-procedure as follows: <codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA (NULL, 'TAB1', 'C1,C3,C4' , null,
-'myfile.del',null, null,null,0)</b> </codeblock></li>
-<li>Suppose you want import data into <i>tab1</i> from a file <codeph>empfile.del</codeph> that
-also has identity column information and the file contains three fields with
-the following data: <codeblock><b>Robert,1,45.2,J
+Leo,23.4,I </codeblock> To import the data, you must explicitly list the
+column names in the <codeph>tab1</codeph> table except for the identity column <codeph>c2</codeph> when
+you call the procedure. For example: <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA (NULL, 'TAB1', 'C1,C3,C4',
+ null, 'myfile.del',null, null, null, 0)
+ </codeblock></li>
+<li>Suppose that you want import data into <codeph>tab1</codeph> from a file <codeph>empfile.del</codeph> that
+also has identity column information. The file contains three fields with
+the following data: <codeblock>Robert,1,45.2,J
Mike,2,23.4,I
-Leo,3,23.4,I</b> </codeblock> To import data from <codeph>empfile.del</codeph> into
-the <i>tab1</i> table, explicitly specify an insert column list without the
-identity column <i>c2</i> and specify the column indexes without identity
-column data and execute the SYSCS_UTIL.SYSCS_IMPORT_DATA procedure as follows:
- <codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA (NULL, 'TAB1', 'C1,C3,C4' , '1,3,4',
-'empfile.del',null, null,null,0) </b> </codeblock></li>
+Leo,3,23.4,I </codeblock> To import the data, you must explicitly specify
+an insert column list without the identity column <codeph>c2</codeph> and
+specify the column indexes without identity column data when you call the
+procedure. For example: <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA (NULL, 'TAB1', 'C1,C3,C4',
+ '1,3,4', 'empfile.del',null, null, null, 0)</codeblock></li>
</ul>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsimportjdbc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimportjdbc.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimportjdbc.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimportjdbc.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,27 +18,27 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsimportjdbc">
-<title>Executing import/export procedures from JDBC</title>
+<concept id="ctoolsimportjdbc" xml:lang="en-us">
+<title>Import and export procedures from JDBC</title>
+<shortdesc>You can run import and export procedures from a JDBC program. </shortdesc>
<prolog><metadata>
-<keywords>
+<keywords><indexterm>import and export procedures<indexterm>running from JDBC</indexterm></indexterm>
+<indexterm>JDBC<indexterm>running import and export procedures</indexterm></indexterm>
</keywords>
-</metadata>
-</prolog>
+</metadata></prolog>
<conbody>
-<p>You can execute import and export procedures from a JDBC program. The following
-code fragment shows how you might call the SYSCS_UTIL.SYSCS_EXPORT_TABLE procedure
-from Java. In this example, the procedure exports the <i>staff</i> table data in the default schema to the <codeph>staff.dat</codeph> file,
-using a percentage (%) character to specify a column delimiter.
-<codeblock><b>PreparedStatement ps=conn.prepareStatement("CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE
-(?,?,?,?,?,?)");
-ps.setString(1,null);
-ps.setString(2,"STAFF");
-ps.setString(3,"staff.dat");
-ps.setString(4,"%");
-ps.setString(5,null);
-ps.setString(6,null);
-ps.execute();
-</b></codeblock></p>
-</conbody></concept>
+<p>The following code fragment shows how you might call the SYSCS_UTIL.SYSCS_EXPORT_TABLE
+procedure from Java. In this example, the procedure exports the data in the <codeph>staff</codeph> table
+in the default schema to the <codeph>staff.dat</codeph> file. A percentage
+(%) character is used to specify the column delimiter. <codeblock>PreparedStatement ps=conn.prepareStatement(
+ "CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE ?,?,?,?,?,?)");
+ ps.setString(1,null);
+ ps.setString(2,"STAFF");
+ ps.setString(3,"staff.dat");
+ ps.setString(4,"%");
+ ps.setString(5,null);
+ ps.setString(6,null);
+ ps.execute();
+</codeblock></p>
+</conbody>
+</concept>
Added: db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita?view=auto&rev=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita (added)
+++ db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita Mon May 21 09:19:33 2007
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<concept id="ctoolsimportlobs" xml:lang="en-us">
+<title>Bulk import and export of large objects</title>
+<shortdesc>You can import and export large objects (LOBs) using the <ph conref="../conrefs.dita#prod/productshortname"></ph> system
+procedures.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>bulk import and export<indexterm>large objects</indexterm></indexterm>
+<indexterm>large objects <indexterm>importing and exporting</indexterm></indexterm>
+<indexterm>importing data<indexterm>large objects</indexterm></indexterm>
+<indexterm>exporting data<indexterm>large objects</indexterm></indexterm>
+<indexterm>CLOB data<indexterm>importing and exporting</indexterm></indexterm>
+<indexterm>BLOB data<indexterm>importing and exporting</indexterm></indexterm>
+<indexterm>CHAR FOR BIT DATA<indexterm>importing and exporting</indexterm></indexterm>
+<indexterm>VARCHAR FOR BIT DATA<indexterm>importing and exporting</indexterm></indexterm>
+<indexterm>LONG VARCHAR FOR BIT DATA<indexterm>importing and exporting</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<conbody>
+<section><title>Importing and exporting CLOB and BLOB data</title><p>CLOB
+and BLOB can be exported to the same file as the rest of the column data,
+or the LOB column data can be exported to separate external file. When the
+LOB column data is exported to separate external file, reference to the location
+of the LOB data is placed in the LOB column in the main export file.</p><p>Importing
+and exporting LOB data using an separate external file might be faster than
+storing the LOB data in the same file as the rest of the column data: <ul>
+<li>The CLOB data does not have to be scanned for the delimiters inside the
+data</li>
+<li>The BLOB data does not need to be converted into a hexadecimal format</li>
+</ul></p></section>
+<section><title>Importing and exporting other binary data</title><p>When you
+export columns that contain the data types CHAR FOR BIT DATA, VARCHAR FOR
+BIT DATA, and LONG VARCHAR FOR BIT DATA, the column data is always exported
+to the main export file. The data is written in the hexadecimal format. To
+import data into a table that has columns of these data types, the data in
+the import file for those column must be in the hexadecimal format.</p></section>
+<section><title>Importing LOB data from a file that contains all of the data</title><p>You
+can use the SYSCS_UTIL.SYSCS_IMPORT_TABLE and SYSCS_UTIL.SYSCS_IMPORT_DATA
+procedures to import data into a table that contains a LOB column. The LOB
+data must be stored in the same file as the other column data that you are
+importing. If you are importing data from a file that was exported from a
+non-Derby source, the binary data must be in the hexadecimal format.</p></section>
+<section><title>Importing LOB data from a separate external file</title><p>You
+can use the SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE and SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE
+procedures to import LOB data that is stored in a file that is separate from
+the main import file. These procedures read the LOB data using the reference
+that is stored in the main import file. If you are importing data from a
+non-Derby source, the references to the LOB data must be in the main import
+file in the format <parmname>lobsFileName.Offset.length/</parmname>. This
+is the same method that the Derby export procedures use to export the LOB
+data to a separate external file.</p></section>
+<section><title>Exporting LOB data to the same file as the other column data</title><p>You
+can use the SYSCS_UTIL.SYSCS_EXPORT_TABLE and SYSCS_UTIL.SYSCS_EXPORT_QUERY
+procedures to write LOB data, along with rest of the column data, to a single
+export file. </p><p>CLOB column data is treated same as other character data.
+Character delimiters are allowed inside the CLOB data. The export procedures
+write the delimiter inside the data as a double-delimiter.</p><p>BLOB column
+data is written to the export file in the hexadecimal format. For each byte
+of BLOB data, two characters are generated. The first character represents
+the high nibble (4 bits) in hexadecimal and the second character represents
+the low nibble.</p></section>
+<section><title>Exporting LOB data to a separate external file from the other
+column data</title><p>You can use the SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE
+and SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE procedures to write LOB
+data to a separate external file. These procedures include the <parmname>lobFileName</parmname> parameter,
+which specifies the name of external file for the LOB data. </p><p>When you
+use these procedures, the location of the LOB data is written to the main
+export file. The format of the reference to the LOB stored in the main export
+file is <parmname>lobsFileName.Offset.length/</parmname>. </p><ul>
+<li><parmname>Offset</parmname> is the position in the external file in bytes</li>
+<li><parmname>length</parmname> is the size of the LOB column data in bytes</li>
+</ul><p>If a LOB column value is NULL, length is written as -1. No data conversion
+is performed when you export LOB data to an external file. BLOB data is written
+in binary format and CLOB data is written using the codeset that you specify.</p><p>See <xref
+href="rtoolsimport91458.dita#rtoolsimport91458"></xref> for examples using
+each of the import and export procedures.</p></section>
+</conbody>
+</concept>
Propchange: db/derby/docs/trunk/src/tools/ctoolsimportlobs.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/tools/ctoolsimportnulls.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsimportnulls.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsimportnulls.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsimportnulls.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,18 +18,18 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsimportnulls">
-<title>Treatment of NULLS</title>
+<concept id="ctoolsimportnulls" xml:lang="en-us">
+<title>How the Import and export procedures process NULL values</title>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>import and export procedures<indexterm>NULL values</indexterm></indexterm>
+<indexterm>importing data<indexterm>NULL values</indexterm></indexterm><indexterm>exporting
+data<indexterm>NULL values</indexterm></indexterm></keywords>
+</metadata></prolog>
<conbody>
<p>In a delimited file, a NULL value is exported as an empty field. The following
-example shows the export of a four-column row in which the third column is
-NULL:
-<codeblock><b>7,95,,Happy Birthday</b></codeblock></p>
-<p>Import works the same way; an empty field is imported as a NULL value.</p>
-</conbody></concept>
+example shows the export of a four-column row where the third column is empty:
+ <codeblock>7,95,,Happy Birthday</codeblock></p>
+<p>The import procedures work the same way; an empty field is imported as
+a NULL value.</p>
+</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?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/trunk/src/tools/derbytools.ditamap Mon May 21 09:19:33 2007
@@ -1,5 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "../dtd/map.dtd">
+
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
+ "../dtd/map.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -27,38 +29,167 @@
<vrmlist><vrm version="10"/></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">
-<topicref href="ctoolspre11181.dita" navtitle="Purpose of this document"></topicref>
+<topicref href="ctoolspre11181.dita" navtitle="Purpose of this document">
+</topicref>
<topicref href="ctoolspre22460.dita" navtitle="Audience"></topicref>
-<topicref href="ctoolspre23947.dita" navtitle="How this guide is organized"></topicref>
+<topicref href="ctoolspre23947.dita" navtitle="How this guide is organized">
+</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsijtools26429.dita" navtitle="What are the Derby tools and utilities?">
<topicref collection-type="family" href="ctoolsijtools30948.dita" navtitle="Overview">
<topicref collection-type="family" href="ctoolsijtools37363.dita" navtitle="Environment setup and the Derby tools">
-<topicref collection-type="family" href="ctools1003034.dita" navtitle="Java 2 Platform, Standard Edition, Version 1.3"></topicref>
+<topicref collection-type="family" href="ctools1003034.dita" navtitle="Java 2 Platform, Standard Edition, Version 1.3">
+</topicref>
<topicref href="rtools1003161.dita" navtitle="Classpath"></topicref>
</topicref>
</topicref>
-<topicref href="ctoolsijtools25085.dita" navtitle="About Derby databases"></topicref>
+<topicref href="ctoolsijtools25085.dita" navtitle="About Derby databases">
+</topicref>
<topicref href="ctoolsijtools20118.dita" navtitle="JDBC connection basics">
-<topicref href="rtoolsijtools16879.dita" navtitle="JDBC drivers overview"></topicref>
-<topicref href="ctoolsijtools16011.dita" navtitle="Database connection URLs"></topicref>
+<topicref href="rtoolsijtools16879.dita" navtitle="JDBC drivers overview">
+</topicref>
+<topicref href="ctoolsijtools16011.dita" navtitle="Database connection URLs">
+</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsijtools11318.dita" navtitle="Tools and localization">
<topicref href="ctools1004764.dita" navtitle="About locales"></topicref>
<topicref href="ctoolsijtools45180.dita" navtitle="Database territory"></topicref>
-<topicref href="ctoolsijtools70959.dita" navtitle="Specifying an alternate codeset"></topicref>
-<topicref collection-type="family" href="ctoolsijtools90477.dita" navtitle="Formatting display of locale-sensitive data"></topicref>
+<topicref href="ctoolsijtools70959.dita" navtitle="Specifying an alternate codeset">
+</topicref>
+<topicref collection-type="family" href="ctoolsijtools90477.dita" navtitle="Formatting display of locale-sensitive data">
+</topicref>
</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsij34525.dita" navtitle="Using ij">
<topicref href="ttoolsij11815.dita" navtitle="Starting ij"></topicref>
-<topicref href="ttoolsij30600.dita" navtitle="Starting ij using properties"></topicref>
+<topicref href="ttoolsij30600.dita" navtitle="Starting ij using properties">
+</topicref>
<topicref href="ctoolsij32837.dita" navtitle="Getting started with ij">
<topicref collection-type="family" href="ttoolsij97656.dita" navtitle="Connecting to a Derby database">
-<topicref href="rtoolsdrvrnmeurl.dita" navtitle="Specifying the driver name and database connection URL"></topicref>
+<topicref href="rtoolsdrvrnmeurl.dita" navtitle="Specifying the driver name and database connection URL">
+</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsij25986.dita" navtitle="Using ij commands">
<topicref href="ctoolsij12001.dita" navtitle="Other uses for ij"></topicref>
@@ -67,48 +198,68 @@
</topicref>
</topicref>
<topicref collection-type="family" href="rtoolsijpropref29864.dita" navtitle="ij properties reference">
-<topicref href="rtoolsijpropref10135.dita" navtitle="ij.connection.connectionName property"></topicref>
-<topicref href="rtoolsijpropref28146.dita" navtitle="ij.database property"></topicref>
-<topicref href="rtoolsijproprefdatasource.dita" navtitle="ij.dataSource property"></topicref>
-<topicref href="rtoolsijpropref41073.dita" navtitle="ij.driver property"></topicref>
-<topicref href="rtoolsijpropref28788.dita" navtitle="ij.maximumDisplayWidth property"></topicref>
-<topicref href="rtoolsijpropref32585.dita" navtitle="ij.outfile property"></topicref>
-<topicref href="rtoolsijproprefpassword.dita" navtitle="ij.password property"></topicref>
-<topicref href="rtoolsijpropref35032.dita" navtitle="ij.protocol property"></topicref>
-<topicref href="rtoolsijpropref12236.dita" navtitle="ij.protocol.protocolName property"></topicref>
-<topicref href="rtoolsijpropref25589.dita" navtitle="ij.showErrorCode property"></topicref>
-<topicref href="rtoolsijpropref38481.dita" navtitle="ij.URLCheck property"></topicref>
+<topicref href="rtoolsijpropref10135.dita" navtitle="ij.connection.connectionName property">
+</topicref>
+<topicref href="rtoolsijpropref28146.dita" navtitle="ij.database property">
+</topicref>
+<topicref href="rtoolsijproprefdatasource.dita" navtitle="ij.dataSource property">
+</topicref>
+<topicref href="rtoolsijpropref41073.dita" navtitle="ij.driver property">
+</topicref>
+<topicref href="rtoolsijpropref28788.dita" navtitle="ij.maximumDisplayWidth property">
+</topicref>
+<topicref href="rtoolsijpropref32585.dita" navtitle="ij.outfile property">
+</topicref>
+<topicref href="rtoolsijproprefpassword.dita" navtitle="ij.password property">
+</topicref>
+<topicref href="rtoolsijpropref35032.dita" navtitle="ij.protocol property">
+</topicref>
+<topicref href="rtoolsijpropref12236.dita" navtitle="ij.protocol.protocolName property">
+</topicref>
+<topicref href="rtoolsijpropref25589.dita" navtitle="ij.showErrorCode property">
+</topicref>
+<topicref href="rtoolsijpropref38481.dita" navtitle="ij.URLCheck property">
+</topicref>
<topicref href="rtoolsijproprefuser.dita" navtitle="ij.user property"></topicref>
-<topicref href="rtoolsijpropref97949.dita" navtitle="derby.ui.codeset property"></topicref>
+<topicref href="rtoolsijpropref97949.dita" navtitle="derby.ui.codeset property">
+</topicref>
</topicref>
<topicref collection-type="family" href="rtoolsijcomref25570.dita" navtitle="ij commands and errors reference">
<topicref href="ctoolsijcomref23268.dita" navtitle="ij commands">
-<topicref href="rtoolsijcomref1003067.dita" navtitle="Conventions for ij examples"></topicref>
+<topicref href="rtoolsijcomref1003067.dita" navtitle="Conventions for ij examples">
+</topicref>
<topicref collection-type="family" href="ctoolsijcomref15645.dita" navtitle="ij SQL command behavior">
-<topicref href="rtoolsijcomref1003444.dita" navtitle="ij command example"></topicref>
+<topicref href="rtoolsijcomref1003444.dita" navtitle="ij command example">
+</topicref>
</topicref>
</topicref>
<topicref href="rtoolsijcomref94092.dita" navtitle="Absolute command"></topicref>
<topicref href="rtoolsijcomref11943.dita" navtitle="After Last command"></topicref>
<topicref href="rtoolsijcomref37862.dita" navtitle="Async command"></topicref>
<topicref href="rtoolsijcomref25753.dita" navtitle="Autocommit command"></topicref>
-<topicref href="rtoolsijcomref79286.dita" navtitle="Before First command"></topicref>
+<topicref href="rtoolsijcomref79286.dita" navtitle="Before First command">
+</topicref>
<topicref href="rtoolsijcomref24423.dita" navtitle="Close command"></topicref>
<topicref href="rtoolsijcomref31510.dita" navtitle="Commit command"></topicref>
<topicref href="rtoolsijcomref22318.dita" navtitle="Connect command"></topicref>
-<topicref href="rtoolsijcomrefdescribe.dita" navtitle="Describe command"></topicref>
+<topicref href="rtoolsijcomrefdescribe.dita" navtitle="Describe command">
+</topicref>
<topicref href="rtoolsijcomref20382.dita" navtitle="Disconnect command"></topicref>
<topicref href="rtoolsijcomref39042.dita" navtitle="Driver command"></topicref>
-<topicref href="rtoolsijcomref18077.dita" navtitle="Elapsedtime command"></topicref>
+<topicref href="rtoolsijcomref18077.dita" navtitle="Elapsedtime command">
+</topicref>
<topicref href="rtoolsijcomref30679.dita" navtitle="Execute command"></topicref>
<topicref href="rtoolsijcomref33358.dita" navtitle="Exit command"></topicref>
<topicref href="rtoolsijcomref61708.dita" navtitle="First command"></topicref>
<topicref href="rtoolsijcomref36618.dita" navtitle="Get Cursor command"></topicref>
-<topicref href="rtoolsijcomref62772.dita" navtitle="Get Scroll Insensitive Cursor command"></topicref>
+<topicref href="rtoolsijcomref62772.dita" navtitle="Get Scroll Insensitive Cursor command">
+</topicref>
<topicref href="rtoolsijcomref10316.dita" navtitle="Help command"></topicref>
<topicref href="rtoolsijcomref53869.dita" navtitle="Last command"></topicref>
-<topicref href="rtoolsijcomref88554.dita" navtitle="LocalizedDisplay command"></topicref>
-<topicref href="rtoolsijcomref12281.dita" navtitle="MaximumDisplayWidth command"></topicref>
+<topicref href="rtoolsijcomref88554.dita" navtitle="LocalizedDisplay command">
+</topicref>
+<topicref href="rtoolsijcomref12281.dita" navtitle="MaximumDisplayWidth command">
+</topicref>
<topicref href="rtoolsijcomref11128.dita" navtitle="Next command"></topicref>
<topicref href="rtoolsijcomref12333.dita" navtitle="Prepare command"></topicref>
<topicref href="rtoolsijcomref44032.dita" navtitle="Previous command"></topicref>
@@ -118,12 +269,16 @@
<topicref href="rtoolsijcomref33373.dita" navtitle="Remove command"></topicref>
<topicref href="rtoolsijcomref12297.dita" navtitle="Rollback command"></topicref>
<topicref href="rtoolsijcomref28886.dita" navtitle="Run command"></topicref>
-<topicref href="rtoolsijcomref39198.dita" navtitle="Set Connection command"></topicref>
+<topicref href="rtoolsijcomref39198.dita" navtitle="Set Connection command">
+</topicref>
<topicref href="rtoolsijcomrefshow.dita" navtitle="Show command"></topicref>
<topicref href="rtoolsijcomref17631.dita" navtitle="Wait For command"></topicref>
-<topicref href="rtoolsijcomref16653.dita" navtitle="Syntax for comments in ij commands"></topicref>
-<topicref href="rtoolsijcomref40155.dita" navtitle="Syntax for identifiers in ij commands"></topicref>
-<topicref href="rtoolsijcomref34110.dita" navtitle="Syntax for strings in ij commands"></topicref>
+<topicref href="rtoolsijcomref16653.dita" navtitle="Syntax for comments in ij commands">
+</topicref>
+<topicref href="rtoolsijcomref40155.dita" navtitle="Syntax for identifiers in ij commands">
+</topicref>
+<topicref href="rtoolsijcomref34110.dita" navtitle="Syntax for strings in ij commands">
+</topicref>
<topicref href="ctoolsijcomref18998.dita" navtitle="ij errors">
<topicref href="ctoolsijcomref36744.dita" navtitle="ERROR SQLState"></topicref>
<topicref href="ctoolsijcomref21190.dita" navtitle="WARNING SQLState"></topicref>
@@ -133,39 +288,52 @@
</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsimport16245.dita" navtitle="Using the bulk import and export procedures">
-<topicref collection-type="family" href="ctoolsimport13648.dita" navtitle="Bulk Import/Export overview">
-<topicref href="ctoolsimport98264.dita" navtitle="Options for running the import and export procedures"></topicref>
-<topicref href="ctoolsimport27052.dita" navtitle="Bulk import/export requirements and considerations"></topicref>
-</topicref>
-<topicref collection-type="family" href="ctoolsimport12925.dita" navtitle="Bulk import and export">
-<topicref href="rtoolsimport57005.dita" navtitle="Bulk-Import">
-<topicref href="rtoolsimport64241.dita" navtitle="Arguments to the import procedure"></topicref>
-</topicref>
-<topicref collection-type="family" href="rtoolsimport92876.dita" navtitle="Bulk-Export">
-<topicref href="rtoolsexportarguements.dita" navtitle="Arguments to the export procedure"></topicref>
-</topicref>
-<topicref href="rtoolsimport91458.dita" navtitle="Examples of bulk import and export"></topicref>
-<topicref href="ctoolsimportidentitycol.dita" navtitle="Importing into tables with identity columns"></topicref>
-<topicref href="ctoolsimportjdbc.dita" navtitle="Executing import/export procedures from JDBC"></topicref>
-<topicref href="ctoolsimportdefaultformat.dita" navtitle="File format for input and output"></topicref>
-<topicref href="ctoolsimportnulls.dita" navtitle="Treatment of NULLS"></topicref>
-<topicref href="rtoolsimportcodeset.dita" navtitle="CODESET values for import/export"></topicref>
+<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="ctoolsstorejardb.dita" navtitle="Storing jar files in a database ">
<topicref href="ttoolsjarload1002986.dita" navtitle="Adding a Jar File"></topicref>
-<topicref href="ttoolsjarload1003059.dita" navtitle="Removing a jar file"></topicref>
-<topicref href="ttoolsjarload1003120.dita" navtitle="Replacing a jar file"></topicref>
-<topicref href="rtoolsjarload3284.dita" navtitle="Installing a jar example"></topicref>
+<topicref href="ttoolsjarload1003059.dita" navtitle="Removing a jar file">
+</topicref>
+<topicref href="ttoolsjarload1003120.dita" navtitle="Replacing a jar file">
+</topicref>
+<topicref href="rtoolsjarload3284.dita" navtitle="Installing a jar example">
+</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"></topicref>
+<topicref href="ctoolssysinfo1002931.dita" navtitle="Using sysinfo to check the classpath">
+</topicref>
</topicref>
<topicref collection-type="family" href="ctoolsdblook.dita" navtitle="dblook">
<topicref href="ctoolsusingdblook.dita" navtitle="Using dblook"></topicref>
<topicref href="rtoolsdblookoptions.dita" navtitle="dblook options"></topicref>
-<topicref href="ctoolsgenddldb.dita" navtitle="Generating the DDL for a database"></topicref>
+<topicref href="ctoolsgenddldb.dita" navtitle="Generating the DDL for a database">
+</topicref>
<topicref href="rtoolsdblookexamples.dita" navtitle="dblook examples"></topicref>
</topicref>
<topicref href="rtoolstrademderby.dita" navtitle="Trademarks"></topicref>
Modified: db/derby/docs/trunk/src/tools/rtoolsexportarguements.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsexportarguements.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsexportarguements.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsexportarguements.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -18,44 +19,75 @@
limitations under the License.
-->
<reference id="rtoolsexportarguements" xml:lang="en-us">
-<title>Arguments to the export procedure</title>
+<title>Parameters for the export procedures</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> export
+procedures use specific parameters.</shortdesc>
<prolog><metadata>
-<keywords></keywords>
+<keywords><indexterm>import and export procedures<indexterm>export parameters</indexterm></indexterm>
+<indexterm>bulk export<indexterm>procedure parameters</indexterm></indexterm>
+<indexterm>exporting data<indexterm>procedure parameters</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section> <ul>
-<li><i id="rtoolsexportschemaname">schemaName</i> <p>Specifies the schema
-of the table. You can pass a NULL value to use the default schema name.</p></li>
-<li><i id="rtoolsexportselectstatement">selectStatement</i> <p>Specifies
-the SELECT statement query that returns the data to be exported. Passing a
-NULL value will result in an error.</p></li>
-<li><i id="rtoolsexporttablename">tableName</i> <p>Specifies the table name
-of the table or view from which the data is to be exported. This table cannot
-be a system table or a declared temporary table. The string must exactly
-match the case of the table name. Passing a null will result in an error.</p></li>
-<li><i id="rtoolsexportfilename">fileName</i> <p>Specifies the file to which
-the data is to be exported. If the path is omitted, the current working directory
-is used. If the name of a file that already exists is specified, the export
-utility overwrites the contents of the file; it does not append the information.
-The specified location of the file should refer to the server-side location
-if using the Network Server. Passing a null will result in an error.</p></li>
-<li><i id="rtoolsexportcolumndelimiter">columnDelimiter</i> <p>Specifies
-a column delimiter. The specified character is used in place of a comma to
-signify the end of a column. You can pass a NULL value to use the default
-value of a comma.</p></li>
-<li><i id="rtoolsexportcharacterdelimiter">characterDelimiter</i> <p>Specifies
-a character delimiter. The specified character is used in place of double
-quotation marks to enclose a character string. You can pass a NULL value to
-use the default value of a double quotation mark.</p></li>
-<li><i id="rtoolsexportcodeset">codeset</i> <p>Specifies the code set of
-the data in the export file. The code set name should be one of the Java-supported
-character encoding sets. Data is converted from the database code page to
-the specified code page before writing to the file. You can pass a NULL value
-to write the data in the same code page as the JVM in which it is being executed.</p></li>
-</ul>If you create a schema, table, or column name as a non-delimited identifier,
-you must pass the name to the export procedure using all upper-case characters.
-If you created a schema or table name as a delimited identifier,
+<section><dl><dlentry>
+<dt id="rtoolsexportschemaname">SCHEMANAME</dt>
+<dd>Specifies the schema of the table. You can specify a NULL value to use
+the default schema name. The <parmname>SCHEMANAME</parmname> parameter takes
+an input argument that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportselectstatement">SELECTSTATEMENT</dt>
+<dd>Specifies the SELECT statement query that returns the data to be exported.
+Specifying a NULL value will result in an error. The <parmname>SELECTSTATEMENT</parmname> parameter
+takes an input argument that is a VARCHAR (32672) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexporttablename">TABLENAME</dt>
+<dd>Specifies the table name of the table or view from which the data is to
+be exported. This table cannot be a system table or a declared temporary table.
+ The string must exactly match the case of the table name. Specifying a NULL
+value results in an error. The <parmname>TABLENAME</parmname> parameter takes
+an input argument that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportfilename">FILENAME</dt>
+<dd>Specifies the file to which the data is to be exported. If the path is
+omitted, the current working directory is used. If the name of a file that
+already exists is specified, the export utility overwrites the contents of
+the file; it does not append the information. The specified location of the
+file should refer to the server-side location if you are using the Network
+Server. Specifying a NULL value results in an error. The <parmname>FILENAME</parmname> parameter
+takes an input argument that is a VARCHAR (32672) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportcolumndelimiter">COLUMNDELIMITER</dt>
+<dd>Specifies a column delimiter. The specified character is used in place
+of a comma to signify the end of a column. You can specify a NULL value to
+use the default value of a comma. The <parmname>COLUMNDELIMITER</parmname> parameter
+must be a CHAR (1) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportcharacterdelimiter">CHARACTERDELIMITER</dt>
+<dd>Specifies a character delimiter. The specified character is used in place
+of double quotation marks to enclose a character string. You can specify a
+NULL value to use the default value of a double quotation mark. The <parmname>CHARACTERDELIMITER</parmname> parameter
+takes an input argument that is a CHAR (1) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportcodeset">CODESET</dt>
+<dd>Specifies the code set of the data in the export file. The code set name
+should be one of the Java-supported character encoding sets. Data is converted
+from the database code page to the specified code page before writing to the
+file. You can specify a NULL value to write the data in the same code page
+as the JVM in which it is being executed. The <parmname>CODESET</parmname> parameter
+takes an input argument that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsexportlobsfilename">LOBSFILENAME</dt>
+<dd>Specifies the file that the large object data is exported to. If the
+path is omitted, the lob file is created in the same directory as the main
+export file. If you specify the name of an existing file, the export utility
+overwrites the contents of the file. The data is not appended to the file.
+If you are using the Network Server, the file should be in a server-side location.
+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><p>If you create a schema, table, or column name as a non-delimited
+identifier, you must pass the name to the export procedure using all uppercase
+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.</section>
+used when it was created.</p> </section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/tools/rtoolsimport64241.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsimport64241.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsimport64241.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsimport64241.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -18,55 +19,81 @@
limitations under the License.
-->
<reference id="rtoolsimport64241" xml:lang="en-us">
-<title>Arguments to the import procedure</title>
+<title>Parameters for the import procedures</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> import
+procedures use specific parameters.</shortdesc>
<prolog><metadata>
-<keywords></keywords>
+<keywords><indexterm>import and export procedures<indexterm>import parameters</indexterm></indexterm>
+<indexterm>bulk import<indexterm>procedure parameters</indexterm></indexterm>
+<indexterm>importing data<indexterm>procedure paremeters</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section> <ul>
-<li><i id="rtoolsimportschemaname">schemaName</i> <p>Specifies the schema
-of the table. You can pass a NULL value to use the default schema name.</p></li>
-<li><i id="rtoolsimport27122">tableName</i> <p>Specifies the table name
-of the table into which the data is to be imported. This table cannot be a
-system table or a declared temporary table. The string must exactly match
-case of the table name. Passing a null will result in an error.</p></li>
-<li><i id="rtoolsimportinsertcolumns">insertColumns</i> <p>Specifies the
-comma separated column names of the table into which the data will be imported.
-You can pass a NULL value to import into all columns of the table.</p></li>
-<li><i id="rtoolsimportcolumnindexes">columnIndexes</i> <p>Specifies the
-comma separated column indexes (numbered from one) of the input data fields
-that will be imported. You can pass a NULL value to use all input data fields
-in the file.</p></li>
-<li><i id="rtoolsimportfilename">fileName</i> <p>Specifies the file that
-contains the data to be imported. If the path is omitted, the current working
-directory is used. The specified location of the file should refer to the
-server side location if using the Network Server. Passing a null will result
-in an error.</p></li>
-<li><i id="rtoolsimportcolumndelimiter">columnDelimiter</i> <p>Specifies
-a column delimiter. The specified character is used in place of a comma to
-signify the end of a column. You can pass a NULL value to use the default
-value of a comma.</p></li>
-<li><i id="rtoolsimportcharacterdelimiter">characterDelimiter</i> <p>Specifies
-a character delimiter. The specified character is used in place of double
-quotation marks to enclose a character string. You can pass a NULL value to
-use the default value of a double quotation mark.</p></li>
-<li><i id="rtoolsimportcodesetarg">codeset</i> <p>Specifies the code set of
-the data in the input file. The code set name should be one of the Java-supported
-character encoding sets. Data is converted from the specified code set to
-the database code set (<codeph>UTF-8</codeph>). You can pass a NULL value
-to interpret the data file in the same code set as the JVM in which it is
-being executed.</p></li>
-<li><i id="rtoolsimportreplace">replace</i> <p>A non-zero value for the <codeph>replace</codeph> parameter
-will import in REPLACE mode, while a zero value will import in INSERT mode.
-REPLACE mode deletes all existing data from the table by truncating the table
-and inserts the imported data. The table definition and the index definitions
-are not changed. You can only import with REPLACE mode if the table already
-exists. INSERT mode adds the imported data to the table without changing the
-existing table data. Passing a null value will result in an error.</p></li>
-</ul>If you create a schema, table, or column name as a non-delimited identifier,
-you must pass the name to the import procedure using all upper-case 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> <dl><dlentry>
+<dt id="rtoolsimportschemaname">SCHEMANAME</dt>
+<dd>Specifies the schema of the table. You can specify a NULL value to use
+the default schema name. The <parmname>SCHEMANAME</parmname> parameter takes
+an input argument that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimport27122">TABLENAME</dt>
+<dd>Specifies the name of the table into which the data is to be imported.
+This table cannot be a system table or a declared temporary table. The string
+must exactly match case of the table name. Specifying a NULL value results
+in an error. The <parmname>TABLENAME</parmname> parameter takes an input argument
+that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportinsertcolumns">INSERTCOLUMNS</dt>
+<dd>Specifies the comma separated column names of the table into which the
+data will be imported. You can specify a NULL value to import into all columns
+of the table. The <parmname>INSERTCOLUMNS</parmname> parameter takes an input
+argument that is a VARCHAR (32672) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportcolumnindexes">COLUMNINDEXES</dt>
+<dd>Specifies the comma separated column indexes (numbered from one) of the
+input data fields that will be imported. You can specify a NULL value to use
+all input data fields in the file. The <parmname>COLUMNINDEXES</parmname> parameter
+takes an input argument that is a VARCHAR (32762) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportfilename">FILENAME</dt>
+<dd>Specifies the name of the file that contains the data to be imported.
+If the path is omitted, the current working directory is used. The specified
+location of the file should refer to the server side location if using the
+Network Server. Specifying a NULL value results in an error. The <parmname>FILENAME</parmname> parameter
+takes an input argument that is a VARCHAR (32672) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportcolumndelimiter">COLUMNDELIMITER</dt>
+<dd>Specifies a column delimiter. The specified character is used in place
+of a comma to signify the end of a column. You can specify a NULL value to
+use the default value of a comma. The <parmname>COLUMNDELIMITER</parmname> parameter
+takes an input argument that is a CHAR (1) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportcharacterdelimiter">CHARACTERDELIMITER</dt>
+<dd>Specifies a character delimiter. The specified character is used in place
+of double quotation marks to enclose a character string. You can specify a
+NULL value to use the default value of a double quotation mark. The <parmname>CHARACTERDELIMITER</parmname> parameter
+takes an input argument that is a CHAR (1) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportcodesetarg">CODESET</dt>
+<dd>Specifies the code set of the data in the input file. The code set name
+should be one of the Java-supported character encoding sets. Data is converted
+from the specified code set to the database code set (UTF-8). You can specify
+a NULL value to interpret the data file in the same code set as the JVM in
+which it is being executed. The <parmname>CODESET</parmname> parameter takes
+an input argument that is a VARCHAR (128) data type.</dd>
+</dlentry><dlentry>
+<dt id="rtoolsimportreplace">REPLACE</dt>
+<dd>A non-zero value for the replace parameter will import in REPLACE mode,
+while a zero value will import in INSERT mode. REPLACE mode deletes all existing
+data from the table by truncating the table and inserts the imported data.
+The table definition and the index definitions are not changed. You can only
+import with REPLACE mode if the table already exists. INSERT mode adds the
+imported data to the table without changing the existing table data. Specifying
+a NULL value results in an error. The <parmname>REPLACE</parmname> parameter
+takes an input argument that is a SMALLINT data type.</dd>
+</dlentry></dl><p>If you create a schema, table, or column name as a non-delimited
+identifier, you must pass the name to the import procedure using all uppercase
+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>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/tools/rtoolsimport91458.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsimport91458.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsimport91458.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsimport91458.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -17,31 +18,73 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<reference xml:lang="en-us" id="rtoolsimport91458">
+<reference id="rtoolsimport91458" xml:lang="en-us">
<title>Examples of bulk import and export</title>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>import and export procedures<indexterm>examples</indexterm></indexterm>
+<indexterm>bulk export<indexterm>examples</indexterm></indexterm><indexterm>exporting
+data<indexterm>examples</indexterm></indexterm><indexterm>bulk import<indexterm>examples</indexterm></indexterm>
+<indexterm>importing data<indexterm>examples</indexterm></indexterm></keywords>
+</metadata></prolog>
<refbody>
-<section><p>All examples in this section are run using the <codeph>ij</codeph> utility.</p></section>
-<section><p>The following example shows how to import data into the <i>staff</i> table in a sample database from the <ph><codeph>myfile.del</codeph></ph> file.</p></section><example>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE (null,'staff','myfile.del',null,null,
-null,0);</b></codeblock></example>
-<section><p>The following example shows how to import data into the <i>staff</i> table in a sample database from a delimited data file<ph><codeph> myfile.del</codeph></ph>. This example defines the percentage character (%)
-as the string delimiter, and a semicolon as the column delimiter.</p></section><example>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE (null,'staff','c:\output\myfile.del',';','%',
-null,0);</b></codeblock></example>
-<section><p>The following example shows how to export data from the <i>staff</i> table in a sample database to the file <ph><codeph>myfile.del</codeph></ph>.</p></section><example>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE (null,'staff','myfile.del',null,null,null);</b></codeblock></example>
-<section><p>The following example shows how to export employee data in department 20
-from the <i>staff</i> table in a sample database to the file <codeph>awards.del</codeph>.</p></section><example>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY ('select * from staff where dept=20',
-'c:\output\awards.del',null,null,null);</b></codeblock></example>
-<section><p>The following example shows how to export data from the <i>staff</i> table to a delimited data file <ph><codeph>myfile.del</codeph></ph> with
-the percentage character (%) as the character delimiter, and a semicolon
-as the column delimiter from the <i>staff</i> table.</p></section><example>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE (null,'staff','c:\output\myfile.del',';','%',
-null);</b></codeblock></example>
-</refbody></reference>
+<section><p>All of the examples in this section are run using the <codeph>ij</codeph> utility.</p></section>
+<section><title>Example importing all data from a file</title><p>The following
+example shows how to import data into the STAFF table in a sample database
+from the <codeph>myfile.del</codeph> file. The data will be appended to the
+existing data in the table.</p><codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE
+ (null,'STAFF','myfile.del',null,null,null,0);</codeblock></section>
+<section><title>Example importing all data from a delimited file</title><p>The
+following example shows how to import data into the STAFF table in a sample
+database from a delimited data file <codeph>myfile.del</codeph>. This example
+defines the percentage character (%) as the string delimiter, and a semicolon
+as the column delimiter. The data will be appended to the existing data in
+the table.</p><codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE
+ (null,'STAFF','c:\output\myfile.del',';','%',null,0);</codeblock></section>
+<section><title>Example importing all data from a table, using a separate
+import file for the LOB data</title><p>The following example shows how to
+import data into the STAFF table in a sample database from a delimited data
+file <codeph>staff.del</codeph>. The import file <codeph>staff.del</codeph> is
+the main import file and contains references that point to a separate file
+which contains the LOB data. This example specifies a comma as the column
+delimiter. The data will be appended to the existing data in the table.</p><codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(
+ 'APP','STAFF','c:\data\staff.del',',','"','UTF-8',0); </codeblock></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
+column in a sample database. The import file <codeph>staff.del</codeph> is
+a delimited data file. The <codeph>staff.del</codeph> file contains references
+that point to a separate file which contains the LOB data. The data in the
+import file is formatted using double quotation marks (") as the string delimiter
+and a comma (,) as the column delimiter. The data will be appended to the
+existing data in the STAFF table. <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE
+ (null, 'STAFF', 'NAME,DEPT,SALARY,PICTURE', '2,3,4,6',
+ 'c:\data\staff.del', ',','"','UTF-8', 0);</codeblock> </section>
+<section><title>Example exporting all data from a table to a single export
+file</title><p>The following example shows how to export data from the STAFF
+table in a sample database to the file <codeph>myfile.del</codeph>.</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE
+ (null,'STAFF','myfile.del',null,null,null);</codeblock></section>
+<section><title>Example exporting data from a table to a single delimited
+export file</title><p>The following example shows how to export data from
+the STAFF table to a delimited data file <codeph>myfile.del</codeph> with
+the percentage character (%) as the character delimiter, and a semicolon as
+the column delimiter from the STAFF table.</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE
+ (null,'STAFF','c:\output\myfile.del',';','%',null);</codeblock></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
+the LOB export file <codeph>pictures.dat</codeph>.</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE('APP','STAFF'
+ 'c:\data\staff.del',',','"','UTF-8', 'c:\data\pictures.dat'); </codeblock></section>
+<section><title>Example exporting data from a query to a single export file</title><p>The
+following example shows how to export employee data in department 20 from
+the STAFF table in a sample database to the file <codeph>awards.del</codeph>.</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY
+ ('SELECT * FROM STAFF WHERE dept=20',
+ 'c:\output\awards.del',null,null,null);</codeblock></section>
+<section><title>Example exporting data from a query, using a separate export
+file for the LOB data </title><p>The following example shows how to export
+employee data in department 20 from the STAFF table in a sample database to
+the main file <codeph>staff.del</codeph> and the lob data to the file <codeph>pictures.dat</codeph>.</p><codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE(
+ 'SELECT * FROM STAFF WHERE dept=20',
+ 'c:\data\staff.del', ',' ,'"',
+ 'UTF-8','c:\data\pictures.dat'); </codeblock></section>
+</refbody>
+</reference>
Modified: db/derby/docs/trunk/src/tools/rtoolsimport92876.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsimport92876.dita?view=diff&rev=540191&r1=540190&r2=540191
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsimport92876.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsimport92876.dita Mon May 21 09:19:33 2007
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,31 +18,36 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
-<reference xml:lang="en-us" id="rtoolsimport92876">
-<title>Bulk-Export</title>
+<reference id="rtoolsimport92876" xml:lang="en-us">
+<title>Exporting bulk data</title>
+<shortdesc>You can use the <ph conref="../conrefs.dita#prod/productshortname"></ph> export
+procedures to export all of the data in a table, or to export LOB data separately
+from other data.</shortdesc>
<prolog><metadata>
-<keywords>
-</keywords>
-</metadata>
-</prolog>
+<keywords><indexterm>import and export procedures<indexterm>bulk export</indexterm></indexterm>
+<indexterm>bulk export</indexterm></keywords>
+</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides two export procedures you can use to perform bulk-export
-operations:
-<ol>
+<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
+several procedures that you can use to perform bulk-export operations. <ol>
<li>To export all the data from a table to a file, use the SYSCS_UTIL.SYSCS_EXPORT_TABLE
-procedure. The procedure definition is:
-<codeblock><b>SYSCS_UTIL.SYSCS_EXPORT_TABLE (IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportschemaname">schemaName</xref> VARCHAR(128),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexporttablename">tableName</xref> VARCHAR(128), IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportfilename">fileName</xref> VARCHAR(32672),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcolumndelimiter">columnDelimiter</xref> CHAR(1), IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcharacterdelimiter">characterDelimiter</xref> CHAR(1),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcodeset">codeset</xref> VARCHAR(128))</b></codeblock>No Result
-is returned from the procedure.</li>
+procedure. The procedure definition is: <codeblock><b>SYSCS_UTIL.SYSCS_EXPORT_TABLE (IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportschemaname">schemaName</xref> VARCHAR(128),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexporttablename">tableName</xref> VARCHAR(128), IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportfilename">fileName</xref> VARCHAR(32672),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcolumndelimiter">columnDelimiter</xref> CHAR(1), IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcharacterdelimiter">characterDelimiter</xref> CHAR(1),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcodeset">codeset</xref> VARCHAR(128))</b></codeblock>No
+Result is returned from the procedure.</li>
<li>To export the result of a SELECT statement to a file, use the SYSCS_UTIL.SYSCS_EXPORT_QUERY
-procedure. The procedure definition is:
-<codeblock><b>SYSCS_UTIL.SYSCS_EXPORT_QUERY(IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportselectstatement">selectStatement</xref> VARCHAR(32672),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexporttablename">tableName</xref> VARCHAR(128), IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportfilename">fileName</xref> VARCHAR(32672),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcolumndelimiter">columnDelimiter</xref> CHAR(1), IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcharacterdelimiter">characterDelimiter</xref> CHAR(1),
-IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcodeset">codeset</xref> VARCHAR(128))</b></codeblock>No result
-is returned from the procedure. </li>
+procedure. The procedure definition is: <codeblock><b>SYSCS_UTIL.SYSCS_EXPORT_QUERY(IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportselectstatement">selectStatement</xref> VARCHAR(32672),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexporttablename">tableName</xref> VARCHAR(128), IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportfilename">fileName</xref> VARCHAR(32672),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcolumndelimiter">columnDelimiter</xref> CHAR(1), IN <xref
+href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcharacterdelimiter">characterDelimiter</xref> CHAR(1),
+IN <xref href="rtoolsexportarguements.dita#rtoolsexportarguements/rtoolsexportcodeset">codeset</xref> VARCHAR(128))</b></codeblock>No
+result is returned from the procedure. </li>
</ol></p></section>
-</refbody></reference>
+</refbody>
+</reference>