Chapter 3. UNIX Quick Start - version 1.8

How to quickly get Hsqldb up and running on UNIX, including Mac OS X

Blaine Simpson

HSQLDB Development Group

$Date: 2005/07/25 23:20:53 $

This Guide is for HSQLDB version 1.8.0. For the latest version see HSQLDB version 2.x Guide

Table of Contents

Purpose
Installation
Setting up Database Instance and Server
Accessing your Database
Create additional Accounts
Shutdown
Running Hsqldb as a System Daemon
Portability of hsqldb init script
Init script Setup Procedure
Troubleshooting the Init Script

Purpose

This chapter explains how to quickly install, run, and use HSQLDB on UNIX.

HSQLDB has lots of great optional features. I intend to cover very few of them. I do intend to cover what I think is the most common UNIX setup: To run a multi-user database with permament data persistence. (By the latter I mean that data is stored to disk so that the data will persist across database shutdowns and startups). I also cover how to run HSQLDB as a system daemon.

Installation

Go to http://sourceforge.net/projects/hsqldb and click on the "files" link. You want the current version. This will be the highest numbered version under the plain black "hsqldb" heading. See if there's a distribution for the current HSQLDB version in the format that you want.

If you want an rpm, you should still find out the current version of HSQLDB as described in the previous paragraph. Then click "hsqldb" in the "free section" of http://www.jpackage.org/ and see if they have the current HSQLDB version built yet. Hopefully, the JPackage folk will document what JVM versions their rpm will support (currently they document this neither on their site nor within the package itself). (I really can't document how to download from a site that is totally beyond my control).

Note

It could very well happen that some of the file formats which I discuss below are not in fact offered. If so, then we have not gotten around to building them.

Binary installation depends on the package format that you downloaded.

Installing from a .pkg.Z file

This package is only for use by a Solaris super-user. It's a System V package. Download then uncompress the package with uncompress or gunzip

    uncompress filename.pkg.Z
You can read about the package by running
    pkginfo -l -d filename.pkg
Run pkgadd as root to install.

    pkgadd -d filename.pkg
Installing from a .rpm file

This is a Linux rpm package. After you download the rpm, you can read about it by running

    rpm -qip /path/to/file.rpm

Rpms can be installed or upgraded by running

    rpm -Uvh /path/to/file.rpm
as root. Suse users may want to keep Yast aware of installed packages by running rpm through Yast: yast2 -i /path/to/file.rpm.

Installing from a .zip file

Extract the zip file to the parent directory of the new HSQLDB home. You don't need to create the HSQLDB_HOME directory because the extraction will create it for you with the right name)

    cd parent/of/new/hsqldb/home
unzip /path/to/file.zip

All the files in the zip archive will be extracted to underneath a new hsqldb directory.

Take a look at the files you installed. (Under hsqldb for zip file installations. Otherwise, use the utilities for your packaging system). The most important file of the hsqldb system is hsqldb.jar, which resides in the directory lib.

Important

For the purposes of this chapter, I define HSQLDB_HOME to be the parent directory of the lib directory that contains hsqldb.jar. E.g., if your path to hsqldb.jar is /a/b/hsqldb/lib/hsqldb.jar, then your HSQLDB_HOME is /a/b/hsqldb.

If the description of your distribution says that the hsqldb.jar file will work for your Java version, then you are finished with installation. Otherwise you need to build a new hsqldb.jar file.

If you followed the instructions above and you still don't know what Java version your hsqldb.jar supports, then read HSQLDB_HOME/readme.txt and HSQLDB_HOME/index.html. If that still doesn't help, then you can just try your hsqldb.jar and see if it works, or build your own.

To use the supplied hsqldb.jar, just skip to the next section of this document. Otherwise build a new hsqldb.jar.

Procedure 3.1. Building hsqldb.jar

  1. If you don't already have Ant, download the latest stable binary version from http://ant.apache.org. cd to where you want Ant to live, and extract from the archive with

        unzip /path/to/file.zip
    or
        tar -xzf /path/to/file.tar.gz
    or
        bunzip2 -c /path/to/file.tar.bz2 | tar -xzf -
    Everything will be installed into a new subdirectory named apache-ant- + version. You can rename the directory after the extraction if you wish.

  2. Set the environmental variable JAVA_HOME to the base directory of your Java JRE or SDK, like

        export JAVA_HOME; JAVA_HOME=/usr/java/j2sdk1.4.0
    The location is entirely dependent upon your variety of UNIX. Sun's rpm distributions of Java normally install to /usr/java/something. Sun's System V package distributions of Java (including those that come with Solaris) normally install to /usr/something, with a sym-link from /usr/java to the default version (so for Solaris you will usually set JAVA_HOME to /usr/java).

  3. Remove the existing file HSQLDB_HOME/lib/hsqldb.jar.

  4. cd to HSQLDB_HOME/build. Make sure that the bin directory under your Ant home is in your search path. Run the following command.

        ant hsqldb
    This will build a new HSQLDB_HOME/lib/hsqldb.jar.

See the Building HSQLDB appendix if you want to build anything other than hsqldb.jar with all default settings.

Setting up a Hsqldb Persistent Database Instance and a Hsqldb Server

If you installed from an OS-specific package, you may already have a database instance and server pre-configured. See if your package includes a file named server.properties (make use of your packaging utilities). If you do, then I suggest that you still read this section while you poke around, in order to understand your setup.

  1. Select a UNIX user to run the database as. If this database is for the use of multiple users, or is a production system (or to emulate a production system), you should dedicate a UNIX user for this purpose. In my examples, I use the user name hsqldb. In this chapter, I refer to this user as the HSQLDB_OWNER, since that user will own the database instance files and processes.

    If the account doesn't exist, then create it. On all system-5 UNIXes and most hybrids (including Linux), you can run (as root) something like

        useradd -c 'HSQLDB Database Owner' -s /bin/bash -m hsqldb
    (BSD-variant users can use a similar pw useradd hsqldb... command).

  2. Become the HSQLDB_OWNER. Copy the sample file HSQLDB_HOME/src/org/hsqldb/sample/sample-server.properties to the HSQLDB_OWNER's home directory and rename it to server.properties.

    # Hsqldb Server cfg file.
    # See the Advanced Topics chapter of the Hsqldb User Guide.

    server.database.0 file:db0/db0
    # I suggest that, for every file: database you define, you add the
    # connection property "ifexists=true" after the database instance
    # is created (which happens simply by starting the Server one time).
    # Just append ";ifexists=true" to the file: URL, like so:
    # server.database.0 file:db0/db0;ifexists=true

    Since the value of the first database (server.database.0) begins with file:, the database instance will be persisted to a set of files in the specified directory with names beginning with the specified name. Set the path to whatever you want (relative paths will be relative to the directory containing the properties file). You can read about how to specify other database instances of various types, and how to make settings for the listen port and many other things, in the Advanced Topics chapter.

  3. Set and export the environmental variable CLASSPATH to the value of HSQLDB_HOME (as described above) plus "/lib/hsqldb.jar", like

        export CLASSPATH; CLASSPATH=/path/to/hsqldb/lib/hsqldb.jar
    In HSQLDB_OWNER's home directory, run

        nohup java org.hsqldb.Server &

    This will start the Server process in the background, and will create your new database instance "db0". Continue on when you see the message containing HSQLDB server... is online. nohup just makes sure that the command will not quit when you exit the current shell (omit it if that's what you want to do).

Accessing your Database

Copy the file HSQLDB_HOME/src/org/hsqldb/sample/sqltool.rc to the HSQLDB_OWNER's home directory. Use chmod to make the file readable and writable only to HSQLDB_OWNER.

# $Id: sqltool.rc,v 1.22 2007/08/09 03:22:21 unsaved Exp $

# This is a sample RC configuration file used by SqlTool, DatabaseManager,
# and any other program that uses the org.hsqldb.util.RCData class.

# You can run SqlTool right now by copying this file to your home directory
# and running
# java -jar /path/to/hsqldb.jar mem
# This will access the first urlid definition below in order to use a
# personal Memory-Only database.
# "url" values may, of course, contain JDBC connection properties, delimited
# with semicolons.

# If you have the least concerns about security, then secure access to
# your RC file.
# See the documentation for SqlTool for various ways to use this file.

# A personal Memory-Only (non-persistent) database.
urlid mem
url jdbc:hsqldb:mem:memdbid
username sa
password

# A personal, local, persistent database.
urlid personal
url jdbc:hsqldb:file:${user.home}/db/personal;shutdown=true
username sa
password
# When connecting directly to a file database like this, you should
# use the shutdown connection property like this to shut down the DB
# properly when you exit the JVM.

# This is for a hsqldb Server running with default settings on your local
# computer (and for which you have not changed the password for "sa").
urlid localhost-sa
url jdbc:hsqldb:hsql://localhost
username sa
password



# Template for a urlid for an Oracle database.
# You will need to put the oracle.jdbc.OracleDriver class into your
# classpath.
# In the great majority of cases, you want to use the file classes12.zip
# (which you can get from the directory $ORACLE_HOME/jdbc/lib of any
# Oracle installation compatible with your server).
# Since you need to add to the classpath, you can't invoke SqlTool with
# the jar switch, like "java -jar .../hsqldb.jar..." or
# "java -jar .../hsqlsqltool.jar...".
# Put both the HSQLDB jar and classes12.zip in your classpath (and export!)
# and run something like "java org.hsqldb.util.SqlTool...".

#urlid cardiff2
#url jdbc:oracle:thin:@aegir.admc.com:1522:TRAFFIC_SID
#username blaine
#password secretpassword
#driver oracle.jdbc.OracleDriver



# Template for a TLS-encrypted HSQLDB Server.
# Remember that the hostname in hsqls (and https) JDBC URLs must match the
# CN of the server certificate (the port and instance alias that follows
# are not part of the certificate at all).
# You only need to set "truststore" if the server cert is not approved by
# your system default truststore (which a commercial certificate probably
# would be).

#urlid tls
#url jdbc:hsqldb:hsqls://db.admc.com:9001/lm2
#username blaine
#password asecret
#truststore /home/blaine/ca/db/db-trust.store


# Template for a Postgresql database
#urlid blainedb
#url jdbc:postgresql://idun.africawork.org/blainedb
#username blaine
#password losung1
#driver org.postgresql.Driver

# Template for a MySQL database. MySQL has poor JDBC support.
#urlid mysql-testdb
#url jdbc:mysql://hostname:3306/dbname
#username root
#username blaine
#password hiddenpwd
#driver com.mysql.jdbc.Driver

# Note that "databases" in SQL Server and Sybase are traditionally used for
# the same purpose as "schemas" with more SQL-compliant databases.

# Template for a Microsoft SQL Server database
#urlid msprojsvr
#url jdbc:microsoft:sqlserver://hostname;DatabaseName=DbName;SelectMethod=Cursor
# The SelectMethod setting is required to do more than one thing on a JDBC
# session (I guess Microsoft thought nobody would really use Java for
# anything other than a "hello world" program).
# This is for Microsoft's SQL Server 2000 driver (requires mssqlserver.jar
# and msutil.jar).
#driver com.microsoft.jdbc.sqlserver.SQLServerDriver
#username myuser
#password hiddenpwd

# Template for a Sybase database
#urlid sybase
#url jdbc:sybase:Tds:hostname:4100/dbname
#username blaine
#password hiddenpwd
# This is for the jConnect driver (requires jconn3.jar).
#driver com.sybase.jdbc3.jdbc.SybDriver

# Template for Embedded Derby / Java DB.
#urlid derby1
#url jdbc:derby:path/to/derby/directory;create=true
#username ${user.name}
#password any_noauthbydefault
#driver org.apache.derby.jdbc.EmbeddedDriver
# The embedded Derby driver requires derby.jar.
# There'a also the org.apache.derby.jdbc.ClientDriver driver with URL
# like jdbc:derby://<server>[:<port>]/databaseName, which requires
# derbyclient.jar.
# You can use \= to commit, since the Derby team decided (why???)
# not to implement the SQL standard statement "commit"!!
# Note that SqlTool can not shut down an embedded Derby database properly,
# since that requires an additional SQL connection just for that purpose.
# However, I've never lost data by not shutting it down properly.
# Other than not supporting this quirk of Derby, SqlTool is miles ahead of ij.

We will be using the "localhost-sa" sample urlid definition from the config file. The JDBC URL for this urlid is jdbc:hsqldb:hsql://localhost. That is the URL for the default database instance of a HSQLDB Server running on the default port of the local host. You can read about URLs to connect to other instances and other servers in the Advanced Topics chapter.

Run SqlTool.

    java -jar path/to/hsqldb.jar localhost-sa
If you get a prompt, then all is well. If security is of any concern to you at all, then you should change the privileged password in the database. Use the command SET PASSWORD command to change SA's password.
    set password "newpassword";

When you're finished playing, exit with the command \q.

If you changed the SA password, then you need to fix the password in the sqltool.rc file accordingly.

You can, of course, also access the database with any JDBC client program. See the First JDBC Client Example appendix. You will need to modify your classpath to include hsqldb.jar as well as your client class(es). You can also use the other HSQLDB client programs, such as org.hsqldb.util.DatabasManagerSwing, a graphical client with a similar purpose to SqlTool.

You can use any normal UNIX account to run the JDBC clients, including SqlTool, as long as the account has read access to the hsqldb.jar file and to an sqltool.rc file. See the SqlTool chapter about where to put sqltool.rc, how to execute sql files, and other SqlTool features.

Create additional Accounts

Connect to the database as SA (or any other Administrative user) and run CREATE USER to create new accounts for your database instance. HSQLDB accounts are database-instance-specific, not Server-specific.

For the current version of HSQLDB, only users with Role of DBA may create or own database objects. DBA members have privileges to do anything. Non-DBAs may be granted some privileges, but may never create or own database objects. (Before long, non-DBAs will be able to create objects if they have permission to do so in the target schema). When you first create a hsqldb database, it has only one database user-- SA, a DBA account, with an empty string password. You should set a password (as described above). You can create as many additional users as you wish. To make a user a DBA, you can use the "ADMIN" option to the CREATE USER command, or GRANT the DBA Role to the account after creating it.

If you create a user without the ADMIN tag (and without granting the DBA role to them) this user will be able to read the data dictionary tables, but will be able unable to create or own his own objects. He will have only the rights which the pseudo-user PUBLIC has. To give him more permissions, even rights to read objects, you can GRANT permissions for specific objects, grant Roles (which encompass a set of permissions), or grant the DBA Role itself.

Since only people with a database account may do anything at all with the database, it is often useful to permit other database users to view the data in your tables. To optimize performance, reduce contention, and minimize administration, it is often best to grant SELECT to PUBLIC on any object that needs to be accessed by multiple database users (with the significant exception of any data which you want to keep secret).

Shutdown

Do a clean database shutdown when you are finished with the database instance. You need to connect up as SA or some other Admin user, of course. With SqlTool, you can run

    java -jar path/to/hsqldb.jar --sql shutdown localhost-sa
You don't have to worry about stopping the Server because it shuts down automatically when all served database instances are shut down.

Running Hsqldb as a System Daemon

You can, of course, run HSQLDB through inittab on System V UNIXes, but usually an init script is more convenient and manageable. This section explains how to set up and use our UNIX init script. Our init script is only for use by root. (That is not to say that the Server will run as root-- it usually should not).

The main purpose of the init script is to start up a Server with the database instances specified in your server.properties file; and to shut down all of those instances plus additional urlids which you may (optionally) list in your init script config file. These urlids must all have entries in a sqltool.rc file. If, due to firewall issues, you want to run a WebServer instead of a Server, then make sure you have a healthy WebServer with a webserver.properties set up, adjust your URLs in sqltool.rc, and set TARGET_CLASS in the config file. (By following the commented examples in the config file, you can start up any number of Server and/or WebServer listeners with or without TLS ecryption).

After you have the init script set up, root can use it anytime to start or stop HSQLDB. (I.e., not just at system bootup or shutdown).

Portability of hsqldb init script

The primary design criterion of the init script is portability. It does not print pretty color startup/shutdown messages as is common in late-model Linuxes and HPUX; and it does not keep subsystem state files or use the startup/shutdown functions supplied by many UNIXes, because these features are all non-portable.

Offsetting these limitations, this one script does it's intended job great on the UNIX varieties I have tested, and can easily be modified to accommodate other UNIXes. While you don't have tight integration with OS-specific daemon administration guis, etc., you do have a well tested and well behaved script that gives good, utilitarian feedback.

Init script Setup Procedure

The strategy taken here is to get the init script to run your single Server or WebServer first (as specified by TARGET_CLASS). After that's working, you can customize the JVM that is run by running additional Servers in it, running your own application in it (embedding), or even overriding HSQLDB behavior with your own overriding classes.

  1. Copy the init script hsqldb from HSQLDB_HOME/bin into the directory where init scripts live on your variety of UNIX. The most common locations are /etc/init.d or /etc/rc.d/init.d on System V style UNIXes, /usr/local/etc/rc.d on BSD style UNIXes, and /Library/StartupItems/hsqldb on OS X (you'll need to create the directory for the last).

  2. Look at the comment towards the top of the init script which lists recommended locations for the configuration file for various UNIX platforms. Copy the sample config file HSQLDB_HOME/src/org/hsqldb/sample/sample-hsqldb.cfg to one of the listed locations (your choice). Edit the config file according to the instructions in it.

    # $Id: sample-hsqldb.cfg,v 1.16 2005/07/24 18:33:13 unsaved Exp $

    # Sample configuration file for HSQLDB database server.
    # See the "UNIX Quick Start" chapter of the Hsqldb User Guide.

    # N.b.!!!! You must place this in the right location for your type of UNIX.
    # See the init script "hsqldb" to see where this must be placed and
    # what it should be renamed to.

    # This file is "sourced" by a Bourne shell, so use Bourne shell syntax.

    # This file WILL NOT WORK until you set (at least) the non-commented
    # variables to the appropriate values for your system.
    # Life will be easier if you avoid all filepaths with spaces or any other
    # funny characters. Don't ask for support if you ignore this advice.

    # Thanks to Meikel Bisping for his contributions. -- Blaine

    JAVA_EXECUTABLE=/usr/bin/java

    # Unless you copied a hsqldb.jar file from another system, this typically
    # resides at $HSQLDB_HOME/lib/hsqldb.jar, where $HSQLDB_HOME is your HSQLDB
    # software base directory.
    HSQLDB_JAR_PATH=/opt/hsqldb/lib/hsqldb.jar

    # Where the file "server.properties" resides.
    SERVER_HOME=/opt/hsqldb/data

    # What UNIX user the server will run as.
    # (The shutdown client is always run as root or the invoker of the init script).
    # Runs as root by default, but you should take the time to set database file
    # ownerships to another user and set that user name here.
    HSQLDB_OWNER=hsqldb

    # The HSQLDB jar file specified in HSQLDB_JAR_PATH above will automatically
    # be in the class path. This arg specifies additional classpath elements.
    # To embed your own application, add your jar file(s) or class base
    # directories here, and add your main class to the INVOC_ADDL_ARGS setting
    # below.
    #SERVER_ADDL_CLASSPATH=/usr/local/dist/currencybank.jar

    # We require all Server/WebServer instances to be accessible within
    # $MAX_START_SECS from when the Server/WebServer is started.
    # Defaults to 60.
    # Raise this is you are running lots of DB instances or have a slow server.
    #MAX_START_SECS=200

    # Time to allow for JVM to die after all HSQLDB instances stopped.
    # Defaults to 1.
    #MAX_TERMINATE_SECS=0

    # These are "urlid" values from a SqlTool authentication file
    # ** IN ADDITION TO THOSE IN YOUR server.properties OR webserver.properties **
    # file. All server.urlid.X values from your properties file will automatically
    # be started/stopped/tested. $SHUTDOWN_URLIDS is for additional urlids which
    # will stopped. (Therefore, most users will not set this at all).
    # Separate multiple values with white space. NO OTHER SPECIAL CHARACTERS!
    # Make sure to quote the entire value if it contains white space separator(s).
    # Defaults to none (i.e., only urlids set in properties file will be stopped).
    #SHUTDOWN_URLIDS='sa mygms'

    # SqlTool authentication file used only for shutdown.
    # The default value will be sqltool.rc in root's home directory, since it is
    # root who runs the init script.
    # (See the SqlTool chapter of the HSQLDB User Guide if you don't understand
    # this).
    #AUTH_FILE=/home/blaine/sqltool.rc

    # Set this to either 'WebServer' or 'Server'. Defaults to Server.
    # The JVM that is started can invoke many classes (see the following item
    # about that), but this is the Server that is used (1) to check status,
    # (2) to shut down the JVM, (3) to get urlids for #1 from the
    # server's server/webserver.properties file.
    #TARGET_CLASS=WebServer
    # Note that you don't specify the org.hsqldb package, since you have no
    # choice in the matter (you can only run org.hsqldb.Server or
    # org.hsqldb.WebServer). If you specify additional classes with
    # INVOC_ADDL_ARGS (described next), you do need to specify the
    # full class name with package name.

    # This is where you specify exactly what your HSQLDB JVM will run.
    # The class org.hsqldb.util.MainInvoker will run the TARGET_CLASS
    # specified above with any arguments supplied here + any other classes
    # and arguments. Every additional class (in addition to the TARGET_CLASS)
    # must be preceded with an empty string, so that MainInvoker will know
    # you are giving a class name. MainInvoker will invoke the normal
    # static main(String[]) method of each such class.
    # By default, MainInvoker will just run TARGET_CLASS with no args.
    # Example that runs just the TARGET_CLASS with the specified arguments:
    #INVOC_ADDL_ARGS='-silent false'
    # Example that runs the TARGET_CLASS plus a WebServer:
    #INVOC_ADDL_ARGS='"" org.hsqldb.WebServer'
    # Note the empty string preceding the class name.
    # Example that starts TARGET_CLASS with an argument + a WebServer +
    # your own application with its args (i.e., the HSQLDB Servers are
    # "embedded" in your application). (Set SERVER_ADDL_CLASSPATH too).:
    #INVOC_ADDL_ARGS='-silent false "" org.hsqldb.WebServer "" com.acme.Stone --env prod localhost'
    # Example to run a non-TLS server in same JVM with a TLS server. In this
    # case, TARGET_CLASS is Server which will run in TLS mode by virtue of
    # setting TLS_KEYSTORE and TLS_PASSWORD above. The "additional" Server
    # here overrides the 'tls' and 'port' settings:
    #INVOC_ADDL_ARGS="'' org.hsqldb.Server -port 9002 -tls false"
    # Note that you use nested quotes to group arguments and to specify the
    # empty-string delimiter.

    # For TLS encryption for your Server, set these two variables.
    # N.b.: If you set these, then make this file unreadable to non-root users!!!!
    # See the TLS chapter of the HSQLDB User Guide, paying attention to the
    # security warning(s).
    # If you are running with a private server cert, then you will also need to
    # set "truststore" in the your SqlTool config file (location is set by the
    # AUTH_FILE variable in this file, or it must be at the default location for
    # HSQLDB_OWNER).
    #TLS_KEYSTORE=/path/to/jks/server.store
    #TLS_PASSWORD=password

    # Any JVM args for the invocation of the JDBC client used to verify DB
    # instances and to shut them down (SqlToolSprayer).
    # This example specifies the location of a private trust store for TLS
    # encryption.
    # For multiple args, put quotes around entire value.
    #CLIENT_JVMARGS=-Djavax.net.debug=ssl

    # Any JVM args for the server.
    # For multiple args, put quotes around entire value.
    #SERVER_JVMARGS=-Xmx512m
  3. Either copy HSQLDB_OWNER's sqltool.rc file into root's home directory, or set the value of AUTH_FILE to the absolute path of HSQLDB_OWNER's sqltool.rc file. This file is read (for stops) directly by root, even if you run hsqldb as non-root (by setting HSQLDB_OWNER in the config file). If you copy the file, make sure to use chmod to restrict permissions on the new copy. (The init script now enforces permissions on this file).

  4. Edit your server.properties file. For every server.database.X that you have defined, set a property of name server.urlid.X to the urlid for an Administrative user for that database instance.

    Example 3.1. server.properties fragment

        server.database.0=file://home/hsqldb/data/db1
    server.urlid.0=localhostdb1

    Warning

    Make sure to add a urlid for each and every database instance. If you don't then the init script will never know about databases that become inaccessible and will give false diagnostics.

    For this example, you would need to define the urlid localhostdb1 in your sqltool.rc file.

    Example 3.2. example sqltool.rc stanza

        urlid localhostdb1
    url jdbc:hsqldb:hsql://localhost
    username sa
    password secret
  5. Verify that the init script works.

    Just run

        /path/to/hsqldb
    as root to see the arguments you may use. Notice that you can run

        /path/to/hsqldb status

    at any time to see whether your HSQLDB Server is running.

    Re-run the script with each of the possible arguments to really test it good. If anything doesn't work right, then see the Troubleshooting the Init Script section.

  6. Tell your OS to run the init script upon system startup and shutdown. If you are using a UNIX variant that has /etc/rc.conf or /etc/rc.conf.local (like BSD variants and Gentoo), you must set "hsqldb_enable" to "YES" in either of those files. (Just run cd /etc; ls rc.conf rc.conf.local to see if you have one of these files). For good UNIXes that use System V style init, you must set up hard links or soft links either manually or with management tools (such as chkconfig or insserv) or Gui's (like run level editors).

    This paragraph is for Mac OS X users only. If you followed the instructions above, your init script should reside at /Library/StartupItems/hsqldb/hsqldb. Now copy the file StartupParameters.plist from the directory src/org.hsqldb/sample of your HSQLDB distribution to the same directory as the init script. As long as these two files reside in /Library/StartupItems/hsqldb, your init script is active (for portability reasons, it doesn't check for a setting in /etc/hostconfig). You can run it as a Startup Item by running

        SystemStarter {start|stop|restart} Hsqldb
    Hsqldb is the service name. See the man page for SystemStarter. To disable the init script, wipe out the /Library/StartupItems/hsqldb directory. Hard to believe, but the Mac people tell me that during system shutdown the Startup Items don't run at all. Therefore, if you don't want your data corrupted, make sure to run "SystemStarter stop Hsqldb" before shutting down your Mac.

Follow the examples in the config file to add additional classes to the server JVM's classpath and to execute additional classes in your JVM. (See the SERVER_ADDL_CLASSPATH and INVOC_ADDL_ARGS items).

Troubleshooting the Init Script

Do a ps to look for processes containing the string hsqldb, and try to connect to the database from any client. If the init script starts up your database successfully, but incorrectly reports that it has not, then your problem is with specification of urlid(s) or SqlTool setup. If your database really did not start, then skip to the next paragraph. Verify that the urlid(s) listed in the server.properties or webserver.properties are correct. and verify that you can run SqlTool as root to connect to the instances. (For the latter test, use the --rcfile switch if you are setting AUTH_FILE in the init script config file).

If your database really is not starting, then verify that you can su to the database owner account and start the database. The command su USERNAME -c ... won't work on most UNIXes unless the target user has a real login shell. Therefore, if you try to tighten up security by disabling this user's login shell, you will break the init script. If these possibilities don't pan out, then debug the init script or seek help, as described below.

To debug the init script, run it in verbose mode to see exactly what is happening (and perhaps manually run the steps that are suspect). To run an init script (in fact, any sh shell script) in verbose mode, use sh with the -x or -v switch, like

    sh -x path/to/hsqldb start
See the man page for sh if you don't know the difference between -v and -x.

If you want troubleshooting help, use the HSQLDB lists/forums or email me at blaine.simpson@admc.com. If you email me, make sure to include the revision number from your hsqldb init script (it's towards the top in the line that starts like "# $Id:"), and the output of a run of

    sh -x path/to/hsqldb start > /tmp/hstart.log 2>&1