A command-line JDBC SQL tool supporting both interactive and non-interactive usage.

See JavaDocs for the main method for syntax of how to run from the command-line.

Programmatic users will usually want to use the objectMain(String[]) method if they want arguments and behavior exactly like command-line SqlTool. But in many cases, you will have better control and efficiency by using the SqlFile class directly. The file src/org/hsqldb/sample/SqlFileEmbedder.java in the HSQLDB distribution provides an example for this latter strategy.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SqlTool.BadCmdline Utility nested class for internal use.
private static class	SqlTool.PrivateException For trapping of exceptions inside this class.
public static class	SqlTool.SqlToolException

Field Summary

Modifier and Type	Field and Description
private static final SqlTool.BadCmdline	bcl Utility object for internal use.
private static final String	CMDLINE_ID The configuration identifier to use when connection parameters are specified on the command line
public static final int	CONNECTERR_EXITVAL
public static final String	DEFAULT_RCFILE
public static final int	FILEERR_EXITVAL
public static final int	INPUTERR_EXITVAL
public static final int	IOERR_EXITVAL
private static final FrameworkLogger	logger
public static final String	LS Platform-specific line separator
public static final int	RCERR_EXITVAL
private static final String	revnum
private static final String	revString
private static final int	revStringLength
public static final int	SQLERR_EXITVAL
public static final int	SQLTOOLERR_EXITVAL
public static final int	SYNTAXERR_EXITVAL

Constructor Summary

Access	Constructor and Description
public	SqlTool()

Method Summary

Modifier and Type	Method and Description
public static void	main(final String[] arguments args) A static wrapper for objectMain, so that that method may be executed as a Java "program".
public static void	objectMain(final String[] Run "java... org.hsqldb.cmdline.SqlTool --help" for syntax. arg) Connect to a JDBC Database and execute the commands given on stdin or in SQL file(s).
private static String	Returns: The password the user entered promptForPassword(final String The user the password is for username) Prompt the user for a password.
private static void	varParser(final String The string to parse inVarString, final Map<String, String> The map to save the paired values into varMap, final boolean Set to `true` if the map keys should be converted to lower case lowerCaseKeys) Parses a comma delimited string of name value pairs into a `Map` object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bcl	back to summary
private static final SqlTool.BadCmdline bcl Utility object for internal use.

CMDLINE_ID	back to summary
private static final String CMDLINE_ID The configuration identifier to use when connection parameters are specified on the command line

CONNECTERR_EXITVAL	back to summary
public static final int CONNECTERR_EXITVAL

DEFAULT_RCFILE	back to summary
public static final String DEFAULT_RCFILE

FILEERR_EXITVAL	back to summary
public static final int FILEERR_EXITVAL

INPUTERR_EXITVAL	back to summary
public static final int INPUTERR_EXITVAL

IOERR_EXITVAL	back to summary
public static final int IOERR_EXITVAL

logger	back to summary
private static final FrameworkLogger logger

LS	back to summary
public static final String LS Platform-specific line separator

RCERR_EXITVAL	back to summary
public static final int RCERR_EXITVAL

revnum	back to summary
private static final String revnum Annotations @SuppressWarnings:ConstantConditions

revString	back to summary
private static final String revString

revStringLength	back to summary
private static final int revStringLength

SQLERR_EXITVAL	back to summary
public static final int SQLERR_EXITVAL

SQLTOOLERR_EXITVAL	back to summary
public static final int SQLTOOLERR_EXITVAL

SYNTAXERR_EXITVAL	back to summary
public static final int SYNTAXERR_EXITVAL

Constructor Detail

SqlTool	back to summary
public SqlTool()

Method Detail

main back to summary

main	back to summary
public static void main(final String[] args) A static wrapper for objectMain, so that that method may be executed as a Java "program". Throws only RuntimeExceptions or Errors, because this method is intended to System.exit() for all but disastrous system problems, for which the inconvenience of a stack trace would be the least of your worries. If you don't want SqlTool to System.exit(), then use the method objectMain() instead of this method. Parameters args:String[] arguments See Also `objectMain(String[])`

public static void main(final String[] args)

A static wrapper for objectMain, so that that method may be executed as a Java "program".

Throws only RuntimeExceptions or Errors, because this method is intended to System.exit() for all but disastrous system problems, for which the inconvenience of a stack trace would be the least of your worries.

If you don't want SqlTool to System.exit(), then use the method objectMain() instead of this method.

Parameters

args:String[]: arguments

See Also

objectMain(String[])

objectMain	back to summary
public static void objectMain(final String[] arg) throws SqlToolException Connect to a JDBC Database and execute the commands given on stdin or in SQL file(s). This method is changed for HSQLDB 1.8.0.8 and later to never System.exit(). Developers may catch Throwables to handle all fatal situations. Parameters arg:String[] Run "java... org.hsqldb.cmdline.SqlTool --help" for syntax. Exceptions SqlToolException: Upon any fatal error, with useful reason as the exception's message.

objectMain

back to summary

public static void objectMain(final String[] arg) throws SqlToolException

Connect to a JDBC Database and execute the commands given on stdin or in SQL file(s).

This method is changed for HSQLDB 1.8.0.8 and later to never System.exit(). Developers may catch Throwables to handle all fatal situations.

Parameters

arg:String[]: Run "java... org.hsqldb.cmdline.SqlTool --help" for syntax.

Exceptions

SqlToolException:: Upon any fatal error, with useful reason as the exception's message.

promptForPassword	back to summary
private static String promptForPassword(final String username) throws PrivateException Prompt the user for a password. Parameters username:String The user the password is for Returns:String The password the user entered

promptForPassword

back to summary

private static String promptForPassword(final String username) throws PrivateException

Prompt the user for a password.

Parameters

username:String: The user the password is for

Returns:String

The password the user entered

varParser back to summary

varParser	back to summary
private static void varParser(final String inVarString, final Map<String, String> varMap, final boolean lowerCaseKeys) throws PrivateException Parses a comma delimited string of name value pairs into a `Map` object. Parameters inVarString:String The string to parse varMap:Map<String, String> The map to save the paired values into lowerCaseKeys:boolean Set to `true` if the map keys should be converted to lower case

private static void varParser(final String inVarString, final Map<String, String> varMap, final boolean lowerCaseKeys) throws PrivateException

Parses a comma delimited string of name value pairs into a Map object.

Parameters

inVarString:String: The string to parse
varMap:Map<String, String>: The map to save the paired values into
lowerCaseKeys:boolean: Set to true if the map keys should be converted to lower case

org.hsqldb.cmdline back to summary

private Class SqlTool.BadCmdline

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.hsqldb.cmdline.SqlTool.BadCmdline

Utility nested class for internal use.

Field Summary

Modifier and Type	Field and Description
pack-priv static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	BadCmdline()

Field Detail

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

BadCmdline	back to summary
pack-priv BadCmdline()

org.hsqldb.cmdline back to summary

private Class SqlTool.PrivateException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.hsqldb.cmdline.SqlTool.PrivateException

For trapping of exceptions inside this class. These are always handled inside this class.

Field Summary

Modifier and Type	Field and Description
pack-priv static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	PrivateException(String s)

Field Detail

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

PrivateException	back to summary
pack-priv PrivateException(String s)

org.hsqldb.cmdline back to summary

public Class SqlTool.SqlToolException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.hsqldb.cmdline.SqlTool.SqlToolException

Field Summary

Modifier and Type	Field and Description
pack-priv int	exitValue
pack-priv static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	SqlToolException(String message, int exitValue)
pack-priv	SqlToolException(int exitValue, String message)
pack-priv	SqlToolException(int exitValue)

Field Detail

exitValue	back to summary
pack-priv int exitValue

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

SqlToolException	back to summary
pack-priv SqlToolException(String message, int exitValue)

SqlToolException	back to summary
pack-priv SqlToolException(int exitValue, String message)

SqlToolException	back to summary
pack-priv SqlToolException(int exitValue)