org.hsqldb.util
Class SqlFile

java.lang.Object
  org.hsqldb.util.SqlFile

public class SqlFile

extends Object

Encapsulation of a sql text file like 'myscript.sql'. The ultimate goal is to run the execute() method to feed the SQL commands within the file to a jdbc connection. Some implementation comments and variable names use keywords based on the following definitions.

• COMMAND = Statement || SpecialCommand || BufferCommand Statement = SQL statement like "SQL Statement;" SpecialCommand = Special Command like "\x arg..." BufferCommand = Editing/buffer command like ":s/this/that/" When entering SQL statements, you are always "appending" to the "current" command (not the "buffer", which is a different thing). All you can do to the current command is append new lines to it, execute it, or save it to buffer. In general, the special commands mirror those of Postgresql's psql, but SqlFile handles command editing much different from Postgresql because of Java's lack of support for raw tty I/O. The \p special command, in particular, is very different from psql's. Also, to keep the code simpler, we're sticking to only single-char special commands until we really need more. Buffer commands are uniqueue to SQLFile. The ":" commands allow you to edit the buffer and to execute the buffer. The command history consists only of SQL Statements (i.e., special commands and editing commands are not stored for later viewing or editing). Most of the Special Commands and all of the Editing Commands are for interactive use only.

  Version:

  $Revision: 1.45 $

  Author:

  Blaine Simpson

  Method Summary

  void	execute(Connection conn) Process all the commands on stdin.
  void	execute(Connection conn, PrintStream stdIn, PrintStream errIn) Process all the commands in the file (or stdin) associated with "this" object.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Method Detail

  execute

  public void execute(Connection conn)
               throws IOException,
                      SqlToolError,
                      SQLException

  Process all the commands on stdin.

  Parameters:

  conn - The JDBC connection to use for SQL Commands.

  Throws:

  IOException

  SqlToolError

  SQLException

  See Also:

  execute(Connection,PrintStream,PrintStream)

  execute

  public void execute(Connection conn,
                      PrintStream stdIn,
                      PrintStream errIn)
               throws IOException,
                      SqlToolError,
                      SQLException

  Process all the commands in the file (or stdin) associated with "this" object. Run SQL in the file through the given database connection. This is synchronized so that I can use object variables to keep track of current line number, command, connection, i/o streams, etc. Sets encoding character set to that specified with System Property 'sqlfile.charset'. Defaults to "US-ASCII".

  Parameters:

  conn - The JDBC connection to use for SQL Commands.

  Throws:

  IOException

  SqlToolError

  SQLException