db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Suresh Thalamati (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2527) Add documentation for import/export of LOBS and other binary data types.
Date Wed, 11 Apr 2007 00:00:32 GMT

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

Suresh Thalamati commented on DERBY-2527:
-----------------------------------------

Thanks for volunteering to write the documentation , Laura.  My comments are
below for the questions you posted. 


1) Regarding null arguments.
 
yes. if user passes null value for any of the argument for import/export procedures , 
default value is used.  If user passes null as argument for schema
name, current schema is used.  Default value for  for column delimiter 
is comma (,)   and the default value for character delimiter is double
quote("). Default for the codeset depends on the environment user has started the jvm. 


It might be better to have an example that does not have null, to be more
clear. Please use the following example instead of the ones in the spec. 
 

CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE('APP','STAFF',
            'c:\data\staff.del',',','"','UTF-8', 'c:\data\pictures.dat');


CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(
           'APP','STAFF','c:\data\staff.del',',','"','UTF-8',0);


2)Reading how to document  definition of the procedures.

This is not my creativity, I have just been following the same format as
other ones already in the documentation. 

>> Laur wrote:
>>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),
>>IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1),
>> IN CODESET VARCHAR(128), IN REPLACE SMALLINT)

>>The syntax should appear in the docs as:

>> SYSCS_UTIL.SYSCS_IMPORT_DATA(
>>    SCHEMANAME, TABLENAME, INSERTCOLUMNS, COLUMNINDEXES, FILENAME, COLUMNDELIMITER,
>>    CHARACTERDELIMITER, CODESET, REPLACE
>>     )

No. It can not be that simple.  Type of the arguments needs to be documented. 
"IN"  is to  indicate that it is an input parameter.  Procedure can have 
OUT or INOUT type parameters. I find the above definition useful , just 
by looking at the syntax , I can set the correct parameters instead of reading 
through the whole doc. 


May be the current way of documenting is not the best approach. If you have
some ideas to improve it, please file a separate jira. May be others will 
have some opinions. 
 

> 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: iexlobs_v1.txt
>
>


-- 
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