db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mamta A. Satoor (JIRA)" <derby-...@db.apache.org>
Subject [jira] Created: (DERBY-429) Doc Review : Derby Tools and Utilities Guide
Date Fri, 01 Jul 2005 08:26:57 GMT
Doc Review : Derby Tools and Utilities Guide
--------------------------------------------

         Key: DERBY-429
         URL: http://issues.apache.org/jira/browse/DERBY-429
     Project: Derby
        Type: Improvement
  Components: Documentation  
    Versions: 10.2.0.0    
    Reporter: Mamta A. Satoor
    Priority: Minor


I have been reviewing Tools and Utility Guide and have some minor comments(was stuck with
a bug and hence couldn't get to this sooner. Might be too late for 10.2 but here they are
anyways). 

The page numbers are from the page number at the bottom of the pages in the doc

1)p10 The ij command description is little hard to read. Following is how it looks 
java
[<
options
>] org.apache.derby.tools.ij [-p <
propertyFile
>] [<
inputFile
>]

Should be reformatted to
java [<options>] org.apache.derby.tools.ij [-p <propertyFile>] [<inputFile>]

2)On p13, the 2 bullets under Running ij scripts use the identical example. I think the 2nd
example has < missing. It should look like following
java -Djdbc.drivers=org.apache.derby.jdbc.EmbeddedDriver
org.apache.derby.tools.ij < <myscript.sql>

3)p14 The example for redirecting output to a file looks incorrect. I think it should look
like following
java -Djdbc.drivers=org.apache.derby.jdbc.EmbeddedDriver
org.apache.derby.tools.ij <myscript.sql> ><myoutput.txt>

4)On p15, following 
ij.connection.
connectionName
=
databaseConnectionURL
should be reformatted to
ij.connection.connectionName=databaseConnectionURL

Please check the formatting of syntax description in the entire pdf. I saw few other places,
where it is hard to read the syntax of a command.

5)p21 Following 
"This section describes the commands and errors eithin the ij tool." should read as
"This section describes the commands and errors within the ij tool."

6)p26 has int in the syntax description on Before First as follows
BEFORE FIRST
int
Identifier
But in case of Before first, there is no int parameter to it. The syntax should look as follows
BEFORE FIRST Identifier

7)p33, the output of the commands after setting the maximumdisplaywidth is incorrect. Following
ij> VALUES 'NOW IS THE TIME!';
1
---
NOW

should look like as follows
ij> VALUES 'NOW IS THE TIME!';
1
---
NO&

8)p45 I think the tableName in SYSCS_UTIL.SYSCS_EXPORT_QUERY is not a correct parameter. SYSCS_UTIL.SYSCS_EXPORT_QUERY
accepts a select statement instead of a table name

9)p47 The 2nd example where we show how to import into an identity column table by exluding
columns from the input file, need to make a minor change. Following 
Suppose you want import data into tab1 from a file empfile.del that also has identity column
information and the file contains three fields with the following data:

should read as 
Suppose you want import data into tab1 from a file empfile.del that also has identity column
information and the file contains four fields with the following data:

10)p55 Need to add Synonym to the list of objects for which dblook utility will generate ddl.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message