db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-1780) Document all supplied system procedures in the Server and Administration Guide (e.g. class loading utils and import/export)
Date Mon, 23 May 2011 20:35:47 GMT

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

Kim Haase updated DERBY-1780:
-----------------------------

    Attachment: DERBY-1780-1.zip
                DERBY-1780-1.stat
                DERBY-1780-1.diff

Attaching an initial patch containing only the Admin Guide changes -- adding the topics from
the Tools Guide, fixing typos, and fixing the references elsewhere in the manual. These are
the changes:

A       src/adminguide/radminexportarguments.dita
A       src/adminguide/radminimport91458.dita
A       src/adminguide/cadminimport98264.dita
A       src/adminguide/cadminimport16245.dita
M       src/adminguide/cadminreplicstartrun.dita
A       src/adminguide/radminimportcodeset.dita
M       src/adminguide/cadminov83312.dita
A       src/adminguide/cadminimport27052.dita
A       src/adminguide/cadminimportnulls.dita
A       src/adminguide/cadminimportlobs.dita
M       src/adminguide/derbyadmin.ditamap
M       src/adminguide/cadminpreface23947.dita
A       src/adminguide/cadminimportidentitycol.dita
A       src/adminguide/cadminimportdefaultformat.dita
A       src/adminguide/radminimport64241.dita
A       src/adminguide/cadminimportjdbc.dita
A       src/adminguide/tadminimporting.dita
A       src/adminguide/tadminexporting.dita

I put the import/export topics between the backup/restore section and the replication section
of the Admin Guide. Is there a more logical place?

"How this guide is organized" (cadminpreface23947.dita) hasn't been modified in some time
-- a couple of sections (sample programs, replication) were missing. I added them in addition
to the new section. "Administrative tools" (cadminov83312.dita) also needed updating. "Starting
and running replication" (cadminreplicstartrun.dita) needed to point to the changed locations
for the SQLJ utilities.

Please let me know of any needed changes. In the meantime I'll work on removing the topics
from the Tools Guide and fixing cross-references in the Reference Manual (and elsewhere, if
any).

I noticed that three topics in the Tools Guide source files that deal with the import/export
utilities are not currently used in the manual:

ctoolsimport12925.dita, "Bulk import and export"
rtoolsimport57005.dita, "Bulk-Import"
rtoolsimport92876.dita, "Exporting bulk data"

They appear to contain information covered in other topics. I'm planning to remove them; please
let me know if you see a reason not to.


> Document all supplied system procedures in the Server and Administration Guide (e.g.
class loading utils and import/export)
> ---------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-1780
>                 URL: https://issues.apache.org/jira/browse/DERBY-1780
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.0.2.1, 10.1.2.1, 10.1.3.1
>            Reporter: Stan Bradbury
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-1780-1.diff, DERBY-1780-1.stat, DERBY-1780-1.zip
>
>
>  Most of the utilities cataloged in SYSCS_UTIL are used to setup/initialize a Derby system
and are invoked using an existing connection using the 'CALL' command,  Such topics are best
covered in the the Server and Administration Guide. Currently the procedures install_jarfiles,
replace_jarfiles, remove_jarfiles, SYSCS_IMPORT_TABLE / DATA and SYSCS_EXPORT_TABLE / QUERY
are documented in the Tools and Utilities Guide.  
> I recommend reserving the Tools and Utilities Guide for routines that have a standalone
interface (e.g. an existing connection is not required to invoke the routine), currently that
is IJ, sysinfo and dblook.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message