net.digger.db

Class H2Helper

java.lang.Object

net.digger.db.H2Helper

public class H2Helper
extends Object

Utility class for H2 Database. Provides table versioning and reduces boilerplate code.

Author:

walton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	H2Helper.GeneratedKeysCallback<T> Callback used for processing update generated keys ResultSet.
static interface	H2Helper.PrepareCallback Callback used for working with PreparedStatement before executing query.
static interface	H2Helper.ResultCallback<T> Callback used for processing query ResultSet.
static interface	H2Helper.TransactionCallback<T> Callback used for performing transactions.
static interface	H2Helper.UpgradeCallback Callback used for creating and upgrading database tables.

Constructor Summary

Constructors

Constructor and Description
H2Helper(Path datafile) Create instance of H2DB using given database, and initialize table version table.
H2Helper(Path datafile, Map<String,String> options) Create instance of H2DB using given database and options, and initialize table version table.
H2Helper(Path datafile, Map<String,String> options, String user, String password) Create instance of H2DB using given database, options and login credentials, and initialize table version table.
H2Helper(String connUrl) Create instance of H2DB using given connection URL, and initialize table version table.

Method Summary

Modifier and Type	Method and Description
Connection	connect() Opens and returns a connection to the database.
Connection	connect(String user, String password) Opens and returns a connection to the database as given user.
int[]	doBatchUpdate(Connection conn, String sql, H2Helper.PrepareCallback pc) Perform database batch update transaction, doing PreparedStatement setup and cleanup.
int[]	doBatchUpdate(String sql, H2Helper.PrepareCallback pc) Perform database batch update transaction, doing Connection and PreparedStatement setup and cleanup.
<T> T	doQuery(Connection conn, String sql, H2Helper.PrepareCallback pc, H2Helper.ResultCallback<T> rc) Perform database query, doing PreparedStatement and ResultSet setup and cleanup.
<T> T	doQuery(String sql, H2Helper.PrepareCallback pc, H2Helper.ResultCallback<T> rc) Perform database query, doing Connection, PreparedStatement and ResultSet setup and cleanup.
<T> T	doTransaction(Connection conn, H2Helper.TransactionCallback<T> tc) Perform a transaction, doing rollback if SQLException thrown.
<T> T	doTransaction(H2Helper.TransactionCallback<T> tc) Perform a transaction, doing Connection setup and cleanup, and rollback if SQLException thrown.
int	doUpdate(Connection conn, String sql, H2Helper.PrepareCallback pc) Perform database update, doing PreparedStatement setup and cleanup.
<T> T	doUpdate(Connection conn, String sql, H2Helper.PrepareCallback pc, H2Helper.GeneratedKeysCallback<T> gkc) Perform database update transaction, returning generated keys, doing PreparedStatement and ResultSet setup and cleanup.
int	doUpdate(String sql, H2Helper.PrepareCallback pc) Perform database update, doing Connection and PreparedStatement setup and cleanup.
<T> T	doUpdate(String sql, H2Helper.PrepareCallback pc, H2Helper.GeneratedKeysCallback<T> gkc) Perform database update transaction, returning generated keys, doing Connection, PreparedStatement and ResultSet setup and cleanup.
String	getConnUrl() Returns the connection url used to connect to the database.
void	initTable(String name, int version, H2Helper.UpgradeCallback upgrade) Checks the version of the given table against the given version, and calls the upgrade callback if necessary.
void	setCredentials(String user, String password) Sets login credentials to be used by connect() and other methods which do not have a Connection argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

H2Helper

public H2Helper(String connUrl)
         throws ClassNotFoundException,
                SQLException

Create instance of H2DB using given connection URL, and initialize table version table.

Parameters:

connUrl - H2 JDBC connection URL.

Throws:

ClassNotFoundException - If error loading database driver.

SQLException - If database error occurs.

H2Helper

public H2Helper(Path datafile)
         throws IOException,
                ClassNotFoundException,
                SQLException

Create instance of H2DB using given database, and initialize table version table.

Parameters:

datafile - Path to database.

Throws:

IOException - If error creating database directory.

ClassNotFoundException - If error loading database driver.

SQLException - If database error occurs.

H2Helper

public H2Helper(Path datafile,
                Map<String,String> options)
         throws IOException,
                ClassNotFoundException,
                SQLException

Create instance of H2DB using given database and options, and initialize table version table.

Parameters:

datafile - Path to database.

options - Map of options to be added to connection URL as ";KEY=VALUE";

Throws:

IOException - If error creating database directory.

ClassNotFoundException - If error loading database driver.

SQLException - If database error occurs.

H2Helper

public H2Helper(Path datafile,
                Map<String,String> options,
                String user,
                String password)
         throws IOException,
                ClassNotFoundException,
                SQLException

Create instance of H2DB using given database, options and login credentials, and initialize table version table.

Parameters:

datafile - Path to database.

options - Map of options to be added to connection URL as ";KEY=VALUE";

user - Username to use for connections.

password - Password to use for connections.

Throws:

IOException - If error creating database directory.

ClassNotFoundException - If error loading database driver.

SQLException - If database error occurs.

Method Detail

setCredentials

public void setCredentials(String user,
                           String password)

Sets login credentials to be used by connect() and other methods which do not have a Connection argument.

If these have not been set, or user is set to null here, the H2 default ("sa"/"") is used. For any usage where security matters that should have been changed, and you will need to provide credentials here.

Parameters:

user - Username to use for connections.

password - Password to use for connections.

getConnUrl

public String getConnUrl()

Returns the connection url used to connect to the database.

Returns:

Connection URL

connect

public Connection connect()
                   throws SQLException

Opens and returns a connection to the database.

Uses credentials set by setCredentials(), or the H2 defaults.

Returns:

Database connection.

Throws:

SQLException - If database error occurs.

connect

public Connection connect(String user,
                          String password)
                   throws SQLException

Opens and returns a connection to the database as given user.

Parameters:

user - Username for connection.

password - Password for connection.

Returns:

Database connection.

Throws:

SQLException - If database error occurs.

initTable

public void initTable(String name,
                      int version,
                      H2Helper.UpgradeCallback upgrade)
               throws SQLException

Checks the version of the given table against the given version, and calls the upgrade callback if necessary. After successful completion of the upgrade callback, updates table to the given version.

Parameters:

name - Name of table to check.

version - Desired table version.

upgrade - Callback to use if the current version is less than desired version.

Throws:

SQLException - If database error occurs.

doQuery

public <T> T doQuery(String sql,
                     H2Helper.PrepareCallback pc,
                     H2Helper.ResultCallback<T> rc)
              throws SQLException

Perform database query, doing Connection, PreparedStatement and ResultSet setup and cleanup.

Type Parameters:

T - Type of data object to return.

Parameters:

sql - Query SQL.

pc - Callback for preparing query. Can be null.

rc - Callback for processing result set.

Returns:

Return value from rc.

Throws:

SQLException - If database error occurs.

doQuery

public <T> T doQuery(Connection conn,
                     String sql,
                     H2Helper.PrepareCallback pc,
                     H2Helper.ResultCallback<T> rc)
              throws SQLException

Perform database query, doing PreparedStatement and ResultSet setup and cleanup.

Synchronizes on conn, to avoid concurrency problems if the caller is using multiple threads.

Type Parameters:

T - Type of data object to return.

Parameters:

conn - Database connection to use.

sql - Query SQL.

pc - Callback for preparing query. Can be null.

rc - Callback for processing result set.

Returns:

Return value from rc.

Throws:

SQLException - If database error occurs.

doUpdate

public int doUpdate(String sql,
                    H2Helper.PrepareCallback pc)
             throws SQLException

Perform database update, doing Connection and PreparedStatement setup and cleanup.

Parameters:

sql - Update SQL.

pc - Callback for preparing update. Can be null.

Returns:

Row count.

Throws:

SQLException - If database error occurs.

doUpdate

public int doUpdate(Connection conn,
                    String sql,
                    H2Helper.PrepareCallback pc)
             throws SQLException

Perform database update, doing PreparedStatement setup and cleanup.

Synchronizes on conn, to avoid concurrency problems if the caller is using multiple threads.

Parameters:

conn - Database connection to use.

sql - Update SQL.

pc - Callback for preparing update. Can be null.

Returns:

Row count.

Throws:

SQLException - If database error occurs.

doUpdate

public <T> T doUpdate(String sql,
                      H2Helper.PrepareCallback pc,
                      H2Helper.GeneratedKeysCallback<T> gkc)
               throws SQLException

Perform database update transaction, returning generated keys, doing Connection, PreparedStatement and ResultSet setup and cleanup.

Type Parameters:

T - Type of data object to return.

Parameters:

sql - Update SQL.

pc - Callback for preparing update. Can be null.

gkc - Callback for processing generated keys result set.

Returns:

Return value from gkc.

Throws:

SQLException - If database error occurs.

doUpdate

public <T> T doUpdate(Connection conn,
                      String sql,
                      H2Helper.PrepareCallback pc,
                      H2Helper.GeneratedKeysCallback<T> gkc)
               throws SQLException

Perform database update transaction, returning generated keys, doing PreparedStatement and ResultSet setup and cleanup.

Synchronizes on conn, to avoid concurrency problems if the caller is using multiple threads.

Type Parameters:

T - Type of data object to return.

Parameters:

conn - Database connection to use.

sql - Update SQL.

pc - Callback for preparing update. Can be null.

gkc - Callback for processing generated keys result set.

Returns:

Return value from gkc.

Throws:

SQLException - If database error occurs.

doBatchUpdate

public int[] doBatchUpdate(String sql,
                           H2Helper.PrepareCallback pc)
                    throws SQLException

Perform database batch update transaction, doing Connection and PreparedStatement setup and cleanup.

Parameters:

sql - Batch update SQL.

pc - Callback for preparing batch update. Can be null.

Returns:

Array of row counts.

Throws:

SQLException - If database error occurs.

doBatchUpdate

public int[] doBatchUpdate(Connection conn,
                           String sql,
                           H2Helper.PrepareCallback pc)
                    throws SQLException

Perform database batch update transaction, doing PreparedStatement setup and cleanup.

Synchronizes on conn, to avoid concurrency problems if the caller is using multiple threads.

Parameters:

conn - Database connection to use.

sql - Batch update SQL.

pc - Callback for preparing batch update. Can be null.

Returns:

Array of row counts.

Throws:

SQLException - If database error occurs.

doTransaction

public <T> T doTransaction(H2Helper.TransactionCallback<T> tc)
                    throws SQLException

Perform a transaction, doing Connection setup and cleanup, and rollback if SQLException thrown.

Type Parameters:

T - Type of data object to return.

Parameters:

tc - Callback for processing transaction.

Throws:

SQLException - If database error occurs.

doTransaction

public <T> T doTransaction(Connection conn,
                           H2Helper.TransactionCallback<T> tc)
                    throws SQLException

Perform a transaction, doing rollback if SQLException thrown.

Synchronizes on conn, to avoid concurrency problems if the caller is using multiple threads.

Type Parameters:

T - Type of data object to return.

Parameters:

conn - Database connection to use.

tc - Callback for processing transaction.

Throws:

SQLException - If database error occurs.