db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <j...@apache.org>
Subject [jira] Updated: (DERBY-2527) Add documentation for import/export of LOBS and other binary data types.
Date Fri, 20 Apr 2007 16:54:15 GMT

     [ https://issues.apache.org/jira/browse/DERBY-2527?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Laura Stewart updated DERBY-2527:
---------------------------------

    Attachment: derbytools.pdf
                refderby.pdf

I have drafted the new topics and updated the existing topics that are associated with this
issue.
I have attached the PDF files for the Ref Manual and Tools Guide because there are quite a
few topics impacted by these updates.  I have not attached a patch at this time because there
are several questions that I would like to get answers to which will impact the final set
of updated topics.

To review the updates:
*** In the Reference Manual, go to the section "Built-in system procedures". The import and
export procedures are all groupded together.
*** In the Tools Guide, go the section "Using the bulk import and export procedures".

General Questions:

Most reference guides include examples for each procedure.  But it does not seem right to
have examples in both the Reference Manual and the Tools Guide.  Should the examples in the
Tools guide be moved to the specific procedures in the Ref Manual? 

Also, the other system procedures in the Ref Manual have separate examples for JDBC and SQL.
Should the import/export have separate examples?

The other procedures use all uppercase for the parameters in the syntax in the Reference Manual.
 The new import/export procedures show mixed case (for example fileName and tableName). Should
the syntax in both the Ref Manual and Tools Guide show all uppercase for the parameters?

Specific Topic Questions - Tools Guide

In the topic "Bulk import and export requirements and considerations" the section "Restrictions
on the REPLACE option".  This is really the replace parameter that users specify in the procedure
isn't it? I think we should use consist terminology and say "replace parameter". Okay?

Regarding the topic "Parameters for the import procedures", these parameters are already described
in the Ref Manual along with the syntax of the procedure. I think that we should delete this
topic (since it contains the same info as the Ref Manual) and have a cross-reference from
the topic "Importing data using the built-in procedures" in the the Tools Guide to the procedure
description in the Ref Manual.  

Does the topic "Import into tables that contain identity columns" need to be updated to mention
the new procedure "SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE" ???

Regarding the topic "Parameters for the export procedures", these parameters are already described
in the Ref Manual along with the syntax of the procedure. I think that we should delete this
topic (since it contains the same info as the Ref Manual) and have a cross-reference from
the topic "Exporting data using the built-in procedures" in the the Tools Guide to the procedure
description in the Ref Manual.  

In the topic "Examples of bulk import and export" please provide examples for SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE
and SYSCS_UTIL.SYSCS_IMPORT_DATA

In the topic "Bulk import and export requirements and considerations" in the section "Data
types" it says "You can import and export only data of the non-binary, built-in data types."
Is that statement still true with the new procedures?

In the topic "Bulk import and export of large objects" I created 2 paragraphs at the beginning
to try to explain the difference between CLOB/BLOB data and the FOR BIT DATA types. I don't
know if I expressed this correctly. Please confirm.




> Add documentation for  import/export  of LOBS and other binary data types. 
> ---------------------------------------------------------------------------
>
>                 Key: DERBY-2527
>                 URL: https://issues.apache.org/jira/browse/DERBY-2527
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: Suresh Thalamati
>         Assigned To: Laura Stewart
>         Attachments: derbytools.pdf, iexlobs_v1.txt, refderby.pdf
>
>


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message