Hi Blaine ... I'm not a native speaker, so I might not be the best referee.
Anyway.
#1 Typo 'yoru'
<snip> You must add the hsqldb.jar file and your JDBC driver classes to yoru classpath, and you must tell SqlTool what the JDBC driver class name is </snip>
#2 Shouldn't that be 'whatever facilitites *there* are... ' ?
<snip> Important Use whatever facilities are at your disposal to protect your configuration file. </snip>
#3 '*as* specified ... *as* ...' Shouldn't that read '*as* specified ... *and*' ? The paragraph is a one long sentence which is a little bit hard to follow....
<snip> If it starts up and connects to the database (as specified in your SqlTool configuration file as explained in the Authentication Setup section), executes the SQL file auto.sql from your home directory (if there is one), then displays a banner showing the SqlTool and SqlFile version numbers and describing the different command types that you can give, as well as commands to list all of the specific commands available to you. </snip>
#4 Writing about 'Special Commands' instead of 'Buffer Commands'
The phrase 'if you already typed some ...' makes it a little
bit to long and hard to follow (also in 'PL Commands'). Hows about 'Buffer Commands can be inserted at any place
where a 'Special Command' might be valid .... <snip>
Buffer Command
Run the command ":?" to list the Special Commands. All of the Special
Commands begin with ":". The text above about entering Special Commands
if you have already typed some line(s) of a SQL Statement applies equally
to Buffer Commands. Buffer commands operate upon the command "buffer",
so that you can edit and/or (re-)execute previously entered commands.
</snip>
#5 Shouldn't that be 'use *the* "\-" command' ?
<snip> You can then use "\-" command (which is described next) to retrieve commands </snip>
#6 I don't know *n.b.*
#7 Typo *othe* <snip> of these othe commands </snip>
#8 I'm not quite shure what you mean ....
<snip> Things will be exacly like you typed in the command that is in the buffer </snip>
#9 One 'command' to much <snip> It only contains commands SQL commands, </snip>
#10 Missing apostrophe at the end of line (to make it a multi line bash input) ?
<snip>
java -jar $HSQLDB_HOME/lib/hsqldb.jar --noinput --sql 'SQL statement;' urlid
SQL statement number one;
SQL statement
number two;
SQL statement three;
' urlid
</snip>#11 To much 'SQL files'. Hows about 'and you want it to terminat upon error' <snip> If you have an SQL file without error handling, and you want it to abort that SQL file when an error occurs, but not exit SqlTool, the easiest way to accomplish this is usually to add \* false to the top of the script. </snip>
#12 I would drop the 'in addition to interactivly' <snip> You can also use \i in SQL files in addition to interactively. This results in nested SQL files. </snip>
#13 behavior-compatible sounds a little strange <snip> If you want your SQL scripts optimally compatible among other SQL tools, then don't use any Special or PL Commands. SqlTool has default behavior which I think is far superior to the other SQL tools, but you will have to disable these defaults in order to be behavior-compatible.
</snip>
#14 do you mean '*/' ? <snip> Command could begin, and they end with the very first "/*" </snip>
#15 'A couple *of*' ? 'but where *explicitly* designed..' ?
<snip>
A couple Special Commands won't work in sql files (stuff for SQL history
manipulation),
but the following not only work, but were designed for use in sql files.
</snip>#16 *encountered* <snip> It depends on what you want your SQL files to do, of course, but I usually want my SQL files to abort when an error is countered, without ... </snip>
#17 'but they *also* want SqlTool'....'
<snip> Some script developers may run into cases where they want to run with sql files but they want SqlTool's interactive behavior </snip>
#18 Kick out 'This output will be....' I.e. small i guess. I would place the
clsoing bracket agter the first 'genereted.
<snip>
Run the command \o path/to/reportfile.txt. From this point on, output from
your queries will be appended to the specified file.
This output will be in addition to the normal output to your
screen or standard output. (I.e. another copy of the output is generated.
This way you can continue to monitor or use output as usual as the report is
generated.)</snip>
#19 Hard to undestand
<snip>
All other PL commands imply the "*" command, so
you only need to turn on PL variable expansion if
your script uses PL variables with it is possible that
no variables may be set before-hand (and no PL commands
have been run previously).
</snip>#20 Missing *be* 'that will *be* used'
<snip>
but it is the entire value that will used in evaluations,
regardless of whether quotes match up, etc. I.e. quotes
and whitespace are not special to the token evaluator.
</snip> #21 'If you have a question' instead if 'if you don't have a question ? I guess so.
<snip>
If you don't have a question about how to use a particular PL feature,
check this example before asking for help. This file resides in the
src/org/hsqldb/sample directory with the name pl.sql.
</snip>#22 'overhead' instead of 'over heard'
<snip>
This section is only for those users who want to use SqlTool but without the over
heard of hsqldb.jar.
</snip>
You have a bunch of strange characters in the text e.g. the 'g' in <snip> java -jar $HSQLDB_HOME/lib/hsqldb.jar mem $HSQLDB_HOME/src/org/hsqldb/sample/pl.jar </snip>
ǥ (Unicode ?). Whic Mozilla displayes as 'g' but with a different type face, and which is not printed properly
see also:
<snip>
Here is ahyperbolically impractical example to show the extent to
</snip>and other places
Hope that helps
Cheers
Sebastian
Blaine Simpson wrote:
If anybody has spare time, I'd appreciate it if you could review the SqlTool chapter of
the HSQLDB User Guide at http://hsqldb.sourceforge.net/alphadocs/guide/ch07.html .
Please don't use the doc from any of the hsqldb zips, since only the one at this URL
is up to date.
Anybody who wants to execute SQL files, or who currently uses ScriptTool, will
find SqlTool useful. It's much more powerful and robust than ScriptTool. I'm not
aware of anything better for script-level automation.
Even a read-through for typos would be good. If you want to RUN SqlTool too, you'll
need to build it from hsqldb-dev HEAD, since many things discussed in the Guide
have been added after rc6b.
------------------------------------------------------- This SF.Net email is sponsored by the new InstallShield X.
From Windows to Linux, servers to mobile, InstallShield X is the
one installation-authoring solution that does it all. Learn more and evaluate today! http://www.installshield.com/Dev2Dev/0504 _______________________________________________ hsqldb-developers mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/hsqldb-developers
