org.jminor.dbms.h2database

Class H2Database

java.lang.Object

org.jminor.common.db.AbstractDatabase

org.jminor.dbms.h2database.H2Database

All Implemented Interfaces:

Database

public final class H2Database
extends AbstractDatabase

A Database implementation based on the H2 database.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.db.Database

Database.Statistics, Database.Type

Field Summary

Fields inherited from interface org.jminor.common.db.Database

DATABASE_EMBEDDED, DATABASE_EMBEDDED_IN_MEMORY, DATABASE_HOST, DATABASE_INIT_SCRIPT, DATABASE_PORT, DATABASE_SID, DATABASE_TYPE, DEFAULT_LOGIN_TIMEOUT, PASSWORD_PROPERTY, USER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
H2Database() Instantiates a new embedded H2Database, using Database.DATABASE_HOST for database name.
H2Database(java.lang.String databaseName) Instantiates a new embedded H2Database.
H2Database(java.lang.String databaseName, boolean embeddedInMemory) Instantiates a new embedded H2Database.
H2Database(java.lang.String host, java.lang.Integer port, java.lang.String databaseName) Instantiates a new networked H2Database.
H2Database(java.lang.String databaseName, java.lang.String initScript) Instantiates a new embedded H2Database instance, in memory, initialized with the given script, if any
H2Database(java.lang.String databaseName, java.lang.String initScript, boolean embeddedInMemory) Instantiates a new embedded H2Database instance, initialized with the given script, if any

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutoIncrementQuery(java.lang.String idSource) Returns a query string for retrieving the last automatically generated id from the given id source
java.lang.String	getSequenceQuery(java.lang.String sequenceName)
java.lang.String	getURL(java.util.Properties connectionProperties)
boolean	isAuthenticationException(java.sql.SQLException exception) This default implementation returns false
boolean	isReferentialIntegrityException(java.sql.SQLException exception) This default implementation returns false
boolean	isUniqueConstraintException(java.sql.SQLException exception)
void	runScript(java.lang.String scriptPath) Runs the given script using the RunScript tool, with the default sysadmin username (sa) and default charset
void	runScript(java.lang.String scriptPath, java.lang.String username, java.lang.String password, java.nio.charset.Charset scriptCharset) Runs the given script using the RunScript tool

Methods inherited from class org.jminor.common.db.AbstractDatabase

addConnectionProperties, createConnection, getAuthenticationInfo, getCheckConnectionQuery, getDriverClassName, getErrorMessage, getHost, getLoginTimeout, getPort, getSid, getType, getUrlAppend, isEmbedded, setUrlAppend, shutdownEmbedded, supportsIsValid, supportsNowait, supportsSelectForUpdate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.common.db.Database

getDatabaseType

Constructor Detail

H2Database

public H2Database()

Instantiates a new embedded H2Database, using Database.DATABASE_HOST for database name.

H2Database

public H2Database(java.lang.String databaseName)

Instantiates a new embedded H2Database.

Parameters:

databaseName - the path to the database files

H2Database

public H2Database(java.lang.String databaseName,
                  boolean embeddedInMemory)

Instantiates a new embedded H2Database.

Parameters:

databaseName - the path to the database files or the database name if in-memory

embeddedInMemory - if true then this instance is memory based

H2Database

public H2Database(java.lang.String host,
                  java.lang.Integer port,
                  java.lang.String databaseName)

Instantiates a new networked H2Database.

Parameters:

host - the host name

port - the port number

databaseName - the database name

H2Database

public H2Database(java.lang.String databaseName,
                  java.lang.String initScript)

Instantiates a new embedded H2Database instance, in memory, initialized with the given script, if any

Parameters:

databaseName - the database name

initScript - a script to use for initializing the database, null if not required

Throws:

java.lang.RuntimeException - in case of an error during initialization

H2Database

public H2Database(java.lang.String databaseName,
                  java.lang.String initScript,
                  boolean embeddedInMemory)

Instantiates a new embedded H2Database instance, initialized with the given script, if any

Parameters:

databaseName - the database name

initScript - a script to use for initializing the database, null if not required

embeddedInMemory - if true then the resulting database is in memory

Throws:

java.lang.RuntimeException - in case of an error during initialization

Method Detail

getAutoIncrementQuery

public java.lang.String getAutoIncrementQuery(java.lang.String idSource)

Returns a query string for retrieving the last automatically generated id from the given id source

Parameters:

idSource - the source for the id, for example a sequence name or in the case of Derby, the name of the table auto generating the value

Returns:

a query string for retrieving the last auto-increment value from idSource

getSequenceQuery

public java.lang.String getSequenceQuery(java.lang.String sequenceName)

Specified by:

getSequenceQuery in interface Database

Overrides:

getSequenceQuery in class AbstractDatabase

Parameters:

sequenceName - the name of the sequence

Returns:

a query for selecting the next value from the given sequence

getURL

public java.lang.String getURL(java.util.Properties connectionProperties)

Parameters:

connectionProperties - the connection properties, used primarily to provide embedded databases with user info for authentication purposes

Returns:

the database url of the active database, based on system properties

isAuthenticationException

public boolean isAuthenticationException(java.sql.SQLException exception)

This default implementation returns false

Specified by:

isAuthenticationException in interface Database

Overrides:

isAuthenticationException in class AbstractDatabase

Parameters:

exception - the exception

Returns:

false

isReferentialIntegrityException

public boolean isReferentialIntegrityException(java.sql.SQLException exception)

This default implementation returns false

Specified by:

isReferentialIntegrityException in interface Database

Overrides:

isReferentialIntegrityException in class AbstractDatabase

Parameters:

exception - the exception

Returns:

false

isUniqueConstraintException

public boolean isUniqueConstraintException(java.sql.SQLException exception)

Specified by:

isUniqueConstraintException in interface Database

Overrides:

isUniqueConstraintException in class AbstractDatabase

Parameters:

exception - the exception

Returns:

true if this exception is a unique key exception

runScript

public void runScript(java.lang.String scriptPath)
               throws java.sql.SQLException

Runs the given script using the RunScript tool, with the default sysadmin username (sa) and default charset

Parameters:

scriptPath - the path to the script

Throws:

java.sql.SQLException - in case of an exception

runScript

public void runScript(java.lang.String scriptPath,
                      java.lang.String username,
                      java.lang.String password,
                      java.nio.charset.Charset scriptCharset)
               throws java.sql.SQLException

Runs the given script using the RunScript tool

Parameters:

scriptPath - the path to the script

username - the username to run the script under

password - the password

scriptCharset - the script characterset

Throws:

java.sql.SQLException - in case of an exception