com.icodici.db

Class Db

java.lang.Object

com.icodici.db.Db

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Cloneable

Direct Known Subclasses:

PooledDb

public class Db
extends java.lang.Object
implements java.lang.Cloneable, java.lang.AutoCloseable

Database "smart connection" tool. Implements automatic statement caching, migrations, key-value parameters in database, accurate close() logic with right support for finalize() and some more neat featires sadly missing in the Connection.

It is advised to have separate Db instances in in different threads using #instance().

This is simplfied and enhanced for better performance version of Db class used in other iCodici projects, it does not rely on Record/Table infrastructure anymore so could run faster with plain cached SQL prepared statements. We recommend it where performance is of essense.

Created by sergeych on 20.03.16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Db.Error
static class	Db.RollbackException

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	connectionString
protected java.util.Properties	properties

Constructor Summary

Constructors

Constructor and Description
Db(java.lang.String connectionString)
Db(java.lang.String connectionString, java.util.Properties properties)
Db(java.lang.String connectionString, java.util.Properties properties, java.lang.String migrationsResource)

Method Summary

Modifier and Type	Method and Description
void	clearDB()
Db	clone()
void	close()
void	createDB(java.lang.String migrationResource)
boolean	equals(java.lang.Object obj)
void	executeFile(java.lang.String name)
protected void	finalize()
java.lang.String	getConnectionString()
java.lang.Integer	getIntParam(java.lang.String name)
int	getIntParam(java.lang.String name, int defaultValue)
java.util.Properties	getProperties()
java.lang.String	getStringParam(java.lang.String name)
java.lang.String	getStringParam(java.lang.String name, java.lang.String defaultValue)
int	hashCode()
boolean	isClosed()
<T> T	queryOne(java.lang.String sqlText, java.lang.Object... args) Execute sqlText using cached prepared statement and args and return its first row first column if any, nd casts it to desired type.
java.sql.ResultSet	queryRow(java.lang.String sqlText, java.lang.Object... args)
void	setIntParam(java.lang.String name, int value)
void	setStringParam(java.lang.String name, java.lang.String value)
void	setupDatabase(java.lang.String migrationsResource)
java.sql.PreparedStatement	statement(java.lang.String sqlText, java.lang.Object... args)
java.sql.PreparedStatement	statementReturningKeys(java.lang.String sqlText, java.lang.Object... args)
<T> T	transaction(java.util.concurrent.Callable<T> worker)
void	update(java.lang.String sqlText, java.lang.Object... args) Perform sql update on created/cached prepared statement
void	updateWithStatement(java.sql.PreparedStatement statement)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

connectionString

protected java.lang.String connectionString

properties

protected java.util.Properties properties

Constructor Detail

Db

public Db(java.lang.String connectionString)
   throws java.sql.SQLException

Throws:

java.sql.SQLException

Db

public Db(java.lang.String connectionString,
          java.util.Properties properties)
   throws java.sql.SQLException

Throws:

java.sql.SQLException

Db

public Db(java.lang.String connectionString,
          java.util.Properties properties,
          java.lang.String migrationsResource)
   throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getProperties

public java.util.Properties getProperties()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getConnectionString

public java.lang.String getConnectionString()

getIntParam

public java.lang.Integer getIntParam(java.lang.String name)
                              throws java.sql.SQLException

Throws:

java.sql.SQLException

getStringParam

public java.lang.String getStringParam(java.lang.String name)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

getIntParam

public int getIntParam(java.lang.String name,
                       int defaultValue)
                throws java.sql.SQLException

Throws:

java.sql.SQLException

setIntParam

public void setIntParam(java.lang.String name,
                        int value)
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getStringParam

public java.lang.String getStringParam(java.lang.String name,
                                       java.lang.String defaultValue)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

setStringParam

public void setStringParam(java.lang.String name,
                           java.lang.String value)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

clone

public Db clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clearDB

public void clearDB()

transaction

public <T> T transaction(java.util.concurrent.Callable<T> worker)
                  throws java.lang.Exception

Throws:

java.lang.Exception

createDB

public void createDB(java.lang.String migrationResource)

setupDatabase

public void setupDatabase(java.lang.String migrationsResource)

statement

public java.sql.PreparedStatement statement(java.lang.String sqlText,
                                            java.lang.Object... args)
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

statementReturningKeys

public java.sql.PreparedStatement statementReturningKeys(java.lang.String sqlText,
                                                         java.lang.Object... args)
                                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

queryRow

public java.sql.ResultSet queryRow(java.lang.String sqlText,
                                   java.lang.Object... args)
                            throws java.sql.SQLException

Throws:

java.sql.SQLException

queryOne

public <T> T queryOne(java.lang.String sqlText,
                      java.lang.Object... args)
               throws java.sql.SQLException

Execute sqlText using cached prepared statement and args and return its first row first column if any, nd casts it to desired type.

Parameters:

sqlText - sql text string with '?' for parameters

args - query parameters

Returns:

retreived data or null

Throws:

java.sql.SQLException

update

public void update(java.lang.String sqlText,
                   java.lang.Object... args)
            throws java.sql.SQLException

Perform sql update on created/cached prepared statement

Parameters:

sqlText -

args -

Throws:

java.sql.SQLException

updateWithStatement

public void updateWithStatement(java.sql.PreparedStatement statement)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

executeFile

public void executeFile(java.lang.String name)