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:28:18 UTC
svn commit: r540195 - /db/derby/docs/trunk/src/ref/
Author: scotsmatrix
Date: Mon May 21 09:28:17 2007
New Revision: 540195
URL: http://svn.apache.org/viewvc?view=rev&rev=540195
Log:
DERBY-2527: Added import and export procedures for LOBs. Patch Derby2527_2.diff was contributed by me.
Added:
db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita (with props)
db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita (with props)
db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita (with props)
db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita (with props)
Modified:
db/derby/docs/trunk/src/ref/refderby.ditamap
db/derby/docs/trunk/src/ref/rrefdmdfns1.dita
db/derby/docs/trunk/src/ref/rrefexportproc.dita
db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita
db/derby/docs/trunk/src/ref/rrefimportdataproc.dita
db/derby/docs/trunk/src/ref/rrefimportproc.dita
db/derby/docs/trunk/src/ref/rrefsql9241891.dita
Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Mon May 21 09:28:17 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
"map.dtd">
<!--
@@ -313,11 +313,19 @@
</topicref>
<topicref href="rrefexportproc.dita" navtitle="SYSCS_UTIL.SYSCS_EXPORT_TABLE system procedure">
</topicref>
+<topicref href="rrefexportproctablelobs.dita" navtitle="SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE system procedure">
+</topicref>
<topicref href="rrefexportselectionproc.dita" navtitle="SYSCS_UTIL.SYSCS_EXPORT_QUERY system procedure">
</topicref>
+<topicref href="rrefexportselectionproclobs.dita" navtitle="SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE ( system procedure">
+</topicref>
<topicref href="rrefimportdataproc.dita" navtitle="SYSCS_UTIL.SYSCS_IMPORT_DATA system procedure">
</topicref>
+<topicref href="rrefimportdataproclobs.dita" navtitle="SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE system procedure">
+</topicref>
<topicref href="rrefimportproc.dita" navtitle="SYSCS_UTIL.SYSCS_IMPORT_TABLE system procedure">
+</topicref>
+<topicref href="rrefimporttableproclobs.dita" navtitle="SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE system procedure">
</topicref>
<topicref href="rreffreezedbproc.dita" navtitle="SYSCS_UTIL.SYSCS_FREEZE_DATABASE system procedure">
</topicref>
Modified: db/derby/docs/trunk/src/ref/rrefdmdfns1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdmdfns1.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdmdfns1.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdmdfns1.dita Mon May 21 09:28:17 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
Modified: db/derby/docs/trunk/src/ref/rrefexportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportproc.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportproc.dita Mon May 21 09:28:17 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -63,14 +64,15 @@
Java-supported character encodings. Data is converted from the database code
set to the specified code set before writing to the file. Passing a NULL value
will write the data in the same code set as the JVM in which it is being executed.</dd>
-</dlentry></dl>If you create a schema or table 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, table, or column name as a delimited
-identifier, you must pass the name to the export procedure using the same
-case that was used when it was created.</section>
+</dlentry></dl>If you create a schema or table name as a non-delimited identifier,
+you must pass the name to the export 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 export procedure using the same case that was
+used when it was created.</section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
<section><title>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>
-<section><p>For more information on exporting, see the <i><ph conref="../conrefs.dita#pub/citutilities"></ph></i>.</p></section>
</refbody>
</reference>
Added: db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita?view=auto&rev=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita Mon May 21 09:28:17 2007
@@ -0,0 +1,101 @@
+<?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
+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.
+-->
+<reference id="rrefexportproclobs" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE</codeph> system
+procedure to export all the data from a table, and place the LOB data into
+a separate export file. A reference to the location of the LOB data is placed
+in the LOB column in the main export file.</shortdesc>
+<refbody>
+<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE (
+ IN SCHEMANAME VARCHAR(128),
+ IN TABLENAME VARCHAR(128),
+ IN FILENAME VARCHAR(32672),
+ IN COLUMNDELIMITER CHAR(1),
+ IN CHARACTERDELIMITER CHAR(1),
+ IN CODESET VARCHAR(128)
+ IN LOBSFILENAME VARCHAR(32672)
+ ) </codeblock> <p>When you run this procedure, the column data is written
+to the main export file in a delimited data file format.</p><dl><dlentry>
+<dt>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>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>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>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>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>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>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.</p></section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>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>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefexportproctablelobs.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexportselectionproc.dita Mon May 21 09:28:17 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,9 +18,6 @@
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 id="rrefexportselectionproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_EXPORT_QUERY system procedure</title>
<refbody>
@@ -60,11 +60,11 @@
set to the specified code set before writing to the file. Passing a NULL value
will write the data in the same code set as the JVM in which it is being executed.</dd>
</dlentry></dl></section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
<section><title>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',
-'c:/output/awards.del', null, null, null);</codeblock></section>
-<section><p>For more information on exporting, see the <i><ph conref="../conrefs.dita#pub/citutilities"></ph></i>.</p></section>
+ 'c:/output/awards.del', null, null, null);</codeblock></section>
</refbody>
</reference>
-
Added: db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita?view=auto&rev=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita Mon May 21 09:28:17 2007
@@ -0,0 +1,98 @@
+<?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
+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.
+-->
+<reference id="rrefexportselectionproclobs" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE</codeph> system
+procedure to export the result of a SELECT statement to a main export file,
+and place the LOB data into a separate export file. A reference to the location
+of the LOB data is placed in the LOB column in the main export file. </shortdesc>
+<refbody>
+<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE (
+ IN SELECTSTATEMENT VARCHAR(32672),
+ IN TABLENAME VARCHAR(32672),
+ IN FILENAME VARCHAR(32672),
+ IN COLUMNDELIMITER CHAR(1),
+ IN CHARACTERDELIMITER CHAR(1),
+ IN CODESET VARCHAR(128)
+ IN LOBSFILENAME VARCHAR(32672)
+ )</codeblock> <p>When you run this procedure, the column data is written
+to the main export file in a delimited data file format.</p><dl><dlentry>
+<dt>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>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>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>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>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>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>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></section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<section><title>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
+file <codeph>staff.del</codeph> and the lob data to the file <codeph>pictures.dat</codeph>. <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>
Propchange: db/derby/docs/trunk/src/ref/rrefexportselectionproclobs.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefimportdataproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportdataproc.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportdataproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimportdataproc.dita Mon May 21 09:28:17 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -82,15 +83,16 @@
changed. You can only use the REPLACE mode if the table exists. INSERT mode
adds the imported data to the table without changing the existing table data.
Passing a NULL will result in an error.</dd>
-</dlentry></dl>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
+</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.</section>
+case that was used when it was created.</p></section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
<section><title>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
-(NULL, 'STAFF', null, '1,3,4', 'data.del', null, null, null,0)</codeblock></p></section>
-<section><p>For more information on importing, see the <i><ph conref="../conrefs.dita#pub/citutilities"></ph></i>.</p></section>
+the <codeph>STAFF</codeph> table: <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA
+ (NULL, 'STAFF', null, '1,3,4', 'data.del', null, null, null,0)</codeblock></p></section>
</refbody>
</reference>
Added: db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita?view=auto&rev=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita Mon May 21 09:28:17 2007
@@ -0,0 +1,124 @@
+<?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
+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.
+-->
+<reference id="rrefimportdataproclobs" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE</codeph> system
+procedure to import data to a subset of columns in a table, where the LOB
+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><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE (
+ IN TABLENAME VARCHAR(128),
+ IN INSERTCOLUMNS VARCHAR(32672),
+ IN COLUMNINDEXES VARCHAR(32672),
+ IN FILENAME VARCHAR(32672),
+ IN COLUMNDELIMITER CHAR(1),
+ IN CHARACTERDELIMITER CHAR(1),
+ IN CODESET VARCHAR(128),
+ IN REPLACE SMALLINT)
+ )
+</codeblock><p>The import utility looks in the main import file for a reference
+to the location of the LOB data.</p><dl><dlentry>
+<dt>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>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>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>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>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>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>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>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>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>
+<section><title>Usage</title><p>This procedure will read the LOB data using
+the reference that is stored in the main import file. The format of the reference
+to the LOB stored in the main import file must be <codeph>lobsFileName.Offset.length/</codeph>. </p><ul>
+<li><codeph>Offset</codeph> is position in the external file in bytes</li>
+<li><codeph>length</codeph> is the size of the LOB column data in bytes</li>
+</ul><p>For additional information on using this procedure see the section
+"Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<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>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefimportdataproclobs.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefimportproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimportproc.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimportproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefimportproc.dita Mon May 21 09:28:17 2007
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -71,15 +72,16 @@
changed. INSERT mode adds the imported data to the table without changing
the existing table data. Passing a NULL will result in an error.</dd>
</dlentry></dl>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
+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.</section>
+<section><title>Usage</title><p>For additional information on using this procedure
+see the section "Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
<section><title>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 <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 (;)
as the column delimiter: <codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE
-(null, 'STAFF', 'c:/output/myfile.del', ';', '%', null,0);</codeblock></p></section>
-<section><p>For more information on importing, see the <i><ph conref="../conrefs.dita#pub/citutilities"></ph></i>.</p></section>
+ (null, 'STAFF', 'c:/output/myfile.del', ';', '%', null,0);</codeblock></p></section>
</refbody>
</reference>
Added: db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita?view=auto&rev=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita Mon May 21 09:28:17 2007
@@ -0,0 +1,107 @@
+<?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
+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.
+-->
+<reference id="rrefimporttableproclobs" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE</codeph> system
+procedure to import data to a table, where the LOB 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><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE (
+ IN SCHEMANAME VARCHAR(128),
+ IN TABLENAME VARCHAR(128),
+ IN FILENAME VARCHAR(32672),
+ IN COLUMNDELIMITER CHAR(1),
+ IN CHARACTERDELIMITER CHAR(1),
+ IN CODESET VARCHAR(128),
+ IN REPLACE SMALLINT)
+ )</codeblock><p>The import utility looks in the main import file for a
+reference to the location of the LOB data.</p><dl><dlentry>
+<dt>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>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>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>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>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>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>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>
+<section><title>Usage</title><p>This procedure will read the LOB data using
+the reference that is stored in the main import file. If you are importing
+from a non-Derby source, the format of the reference to the LOB stored in
+the main import file must be <codeph>lobsFileName.Offset.length/</codeph>. </p><ul>
+<li><codeph>Offset</codeph> is position in the external file in bytes</li>
+<li><codeph>length</codeph> is the size of the LOB column data in bytes</li>
+</ul><p>For additional information on using this procedure see the section
+"Using the bulk import and export procedures" in the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p></section>
+<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
+a sample database from a delimited data file <codeph>staff.del</codeph>. This
+example defines 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>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefimporttableproclobs.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefsql9241891.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsql9241891.dita?view=diff&rev=540195&r1=540194&r2=540195
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsql9241891.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsql9241891.dita Mon May 21 09:28:17 2007
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--