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 2013/11/20 16:22:45 UTC

svn commit: r1543842 - in /db/derby/docs/branches/10.10/src: adminguide/ ref/

Author: chaase3
Date: Wed Nov 20 15:22:44 2013
New Revision: 1543842

URL: http://svn.apache.org/r1543842
Log:
DERBY-6403  Doc for export/import in ref man should mention automatic commit after operation.

Merged DERBY-6403-2.diff to 10.10 doc branch from trunk revision 1543835.

Modified:
    db/derby/docs/branches/10.10/src/adminguide/cadminimport27052.dita
    db/derby/docs/branches/10.10/src/ref/rrefexportproc.dita
    db/derby/docs/branches/10.10/src/ref/rrefexportproctablelobs.dita
    db/derby/docs/branches/10.10/src/ref/rrefexportselectionproc.dita
    db/derby/docs/branches/10.10/src/ref/rrefexportselectionproclobs.dita
    db/derby/docs/branches/10.10/src/ref/rrefimportdataproc.dita
    db/derby/docs/branches/10.10/src/ref/rrefimportdataproclobs.dita
    db/derby/docs/branches/10.10/src/ref/rrefimportproc.dita
    db/derby/docs/branches/10.10/src/ref/rrefimporttableproclobs.dita

Modified: db/derby/docs/branches/10.10/src/adminguide/cadminimport27052.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/adminguide/cadminimport27052.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/adminguide/cadminimport27052.dita (original)
+++ db/derby/docs/branches/10.10/src/adminguide/cadminimport27052.dita Wed Nov 20 15:22:44 2013
@@ -34,12 +34,15 @@ and export procedures.</shortdesc>
 <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>
+<dd><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or
+a ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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. An error in an import or export procedure and the ensuing
+ROLLBACK would throw away any changes performed before the procedure was called,
+and vice versa: any unsound changes before the import or export procedure call
+that should not be committed could be committed automatically.</dd>
 </dlentry><dlentry>
 <dt>Database connections</dt>
 <dd>To invoke a <ph conref="../conrefs.dita#prod/productshortname"></ph> import

Modified: db/derby/docs/branches/10.10/src/ref/rrefexportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefexportproc.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefexportproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefexportproc.dita Wed Nov 20 15:22:44 2013
@@ -32,7 +32,17 @@ exports all of the data from a table to 
 EXPORT procedure  does not export data into an existing file. You must specify
 a filename in the  EXPORT procedure that does not exist. When you run the
 procedure the file is created and the data is exported  into the new file.</p><p>The
-data is exported using a delimited file format.</p></section>
+data is exported using a delimited file format.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_EXPORT_TABLE (IN SCHEMANAME  VARCHAR(128),
 IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672),
 IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1),
@@ -88,10 +98,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have SELECT
 privileges on the table.</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/branches/10.10/src/ref/rrefexportproctablelobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefexportproctablelobs.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefexportproctablelobs.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefexportproctablelobs.dita Wed Nov 20 15:22:44 2013
@@ -34,7 +34,17 @@ procedures</indexterm></indexterm></keyw
 EXPORT procedure  does not export data into an existing file. You must specify
 a filename in the  EXPORT procedure that does not exist. When you run the
 procedure the file is created and the data is exported  into the new file.</p><p>The
-data is exported using a delimited file format.</p></section>
+data is exported using a delimited file format.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE (
     IN SCHEMANAME VARCHAR(128), 
     IN TABLENAME VARCHAR(128), 
@@ -108,10 +118,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have SELECT
 privileges on the table.</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/branches/10.10/src/ref/rrefexportselectionproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefexportselectionproc.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefexportselectionproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefexportselectionproc.dita Wed Nov 20 15:22:44 2013
@@ -32,7 +32,17 @@ exports the results of a SELECT statemen
 EXPORT procedure  does not export data into an existing file. You must specify
 a filename in the  EXPORT procedure that does not exist. When you run the
 procedure the file is created and the data is exported  into the new file.</p><p>The
-data is exported using a delimited file format.</p></section>
+data is exported using a delimited file format.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_EXPORT_QUERY(IN SELECTSTATEMENT VARCHAR(32672),
 IN FILENAME VARCHAR(32672), IN COLUMNDELIMITER CHAR(1),
 IN CHARACTERDELIMITER CHAR(1), IN CODESET VARCHAR(128)) </codeblock> <p>No
@@ -79,10 +89,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have SELECT
 privileges on the table.</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/branches/10.10/src/ref/rrefexportselectionproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefexportselectionproclobs.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefexportselectionproclobs.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefexportselectionproclobs.dita Wed Nov 20 15:22:44 2013
@@ -34,7 +34,17 @@ procedures</indexterm></indexterm></keyw
 EXPORT procedure does not export data into an existing file. You must specify
 a filename in the  EXPORT procedure that does not exist. When you run the
 procedure the file is created and the data is exported  into the new file.</p><p>The
-data is exported using a delimited file format.</p></section>
+data is exported using a delimited file format.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE (
     IN SELECTSTATEMENT VARCHAR(32672),
     IN FILENAME VARCHAR(32672), 
@@ -96,10 +106,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have SELECT
 privileges on the table.</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/branches/10.10/src/ref/rrefimportdataproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefimportdataproc.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefimportdataproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefimportdataproc.dita Wed Nov 20 15:22:44 2013
@@ -20,11 +20,22 @@ limitations under the License.
 -->
 <reference id="rrefimportdataproc" xml:lang="en-us">
 <title>SYSCS_UTIL.SYSCS_IMPORT_DATA system procedure</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_IMPORT_DATA</codeph> system procedure
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_IMPORT_DATA</codeph> system procedure
 imports data to a subset of columns in a table. You choose the subset of columns
 by specifying insert columns. This procedure is also used to import a subset
-of column data from a file by specifying column indexes.</p></section>
+of column data from a file by specifying column indexes.</shortdesc>
+<refbody>
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_IMPORT_DATA (IN SCHEMANAME VARCHAR(128),
 IN TABLENAME VARCHAR(128), IN INSERTCOLUMNS VARCHAR(32672),
 IN COLUMNINDEXES VARCHAR(32672), IN FILENAME VARCHAR(32672),
@@ -97,10 +108,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have INSERT
 privileges on the table.</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/branches/10.10/src/ref/rrefimportdataproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefimportdataproclobs.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefimportdataproclobs.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefimportdataproclobs.dita Wed Nov 20 15:22:44 2013
@@ -25,6 +25,17 @@ procedure to import data to a subset of 
 data is stored in a separate file. The main import file contains all of the
 other data and a reference to the location of the LOB data. </shortdesc>
 <refbody>
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE (
    IN SCHEMANAME VARCHAR(128), 
    IN TABLENAME VARCHAR(128), 
@@ -117,9 +128,7 @@ 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
-"Importing and exporting data" in the
-<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
+</ul></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/branches/10.10/src/ref/rrefimportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefimportproc.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefimportproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefimportproc.dita Wed Nov 20 15:22:44 2013
@@ -20,11 +20,22 @@ limitations under the License.
 -->
 <reference id="rrefimportproc" xml:lang="en-us">
 <title>SYSCS_UTIL.SYSCS_IMPORT_TABLE system procedure</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_IMPORT_TABLE</codeph> system procedure
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_IMPORT_TABLE</codeph> system procedure
 imports data from an input file into all of the columns of a table. If the
 table receiving the imported data already contains data, you can either replace
-or append to the existing data.</p></section>
+or append to the existing data.</shortdesc>
+<refbody>
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_IMPORT_TABLE (IN SCHEMANAME VARCHAR(128),
 IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672),
 IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1),
@@ -85,10 +96,6 @@ authentication" and "Setting the SQL sta
 database owner can grant access to other users. The user must also have INSERT
 privileges on the table.</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/branches/10.10/src/ref/rrefimporttableproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefimporttableproclobs.dita?rev=1543842&r1=1543841&r2=1543842&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefimporttableproclobs.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefimporttableproclobs.dita Wed Nov 20 15:22:44 2013
@@ -25,6 +25,17 @@ procedure to import data to a table, whe
 file. The main import file contains all of the other data and a reference
 to the location of the LOB data.</shortdesc>
 <refbody>
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> issues a COMMIT or a
+ROLLBACK statement after each import and export procedure is run (a COMMIT if
+the procedure completes successfully, a ROLLBACK if it fails). For this reason,
+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.</p>
+<p>For more 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>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE (
    IN SCHEMANAME VARCHAR(128), 
    IN TABLENAME VARCHAR(128), 
@@ -103,9 +114,8 @@ 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
-"Importing and exporting data" in the
-<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
+</ul>
+</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