sirius.db.jdbc

Class Database

java.lang.Object

sirius.db.jdbc.Database

public class Database
extends Object

Represents a database connection obtained via Databases.get(String).

Use createQuery(String) to create an SQL query with built in connection management. Use getConnection() to obtain a regular JDBC connection (which has to be handled with some caution).

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Database(String name)

Method Summary

Modifier and Type	Method and Description
SQLCall	createFunctionCall(String fun, Integer returnType) Creates a new call wrapper which permits safe and convenient function calls.
SQLCall	createProcedureCall(String fun) Creates a new call wrapper which permits safe and convenient procedure calls.
SQLQuery	createQuery(String sql) Creates a new query wrapper which permits safe and convenient queries.
protected void	fillValues(List<Object> valueList, String sql, PreparedStatement stmt)
Connection	getConnection() Creates a new connection to the database.
DataSource	getDatasource() Provides access to the underlying DataSource representing the connection pool.
Connection	getHostConnection() Tries to obtain a host connection which is not bound to a specific database or schema.
int	getNumActive() Return the number of active connections
int	getNumIdle() Return the number of idle connections
String	getPassword() Returns the JDBC password supplied to the database.
int	getSize() Returns the maximal number of concurrent connections
String	getUrl() Returns the JDBC connection URL
String	getUsername() Returns the JDBC username supplied to the database.
boolean	hasCapability(Capability cap) Determines if the current driver has the requested capability.
Row	insertRow(String table, sirius.kernel.commons.Context ctx) Generates an INSERT statement for the given table inserting all supplied parameters in ctx.
Row	insertRow(String table, Map<String,Object> row) Boilerplate method to use insertRow(String, sirius.kernel.commons.Context) with plan maps.
protected void	prepareValues(sirius.kernel.commons.Context ctx, StringBuilder fields, StringBuilder values, List<Object> valueList)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

Constructor Detail

Database

protected Database(String name)

Method Detail

getDatasource

public DataSource getDatasource()

Provides access to the underlying DataSource representing the connection pool.

You must ensure to close each opened connection property as otherwise the pool will lock up, once all connections are busy. Consider using createQuery(String) or createFunctionCall(String, Integer) or createProcedureCall(String) to access the database in a safe manner.

Returns:

the connection pool as DataSource

getConnection

public Connection getConnection()
                         throws SQLException

Creates a new connection to the database.

You must ensure to close each opened connection property as otherwise the pool will lock up, once all connections are busy. Consider using createQuery(String) or createFunctionCall(String, Integer) or createProcedureCall(String) to access the database in a safe manner.

Returns:

a new Connection to the database

Throws:

SQLException - in case of a database error

getHostConnection

public Connection getHostConnection()
                             throws SQLException

Tries to obtain a host connection which is not bound to a specific database or schema.

This is used to setup test databases by executing an initial statement like CREATE DATABASE test.

Returns:

the host connection

Throws:

SQLException - in case of a database or configuration error

createQuery

public SQLQuery createQuery(String sql)

Creates a new query wrapper which permits safe and convenient queries.

Using this wrapper ensures proper connection handling and simplifies query creation.

Parameters:

sql - the SQL to send to the database. For syntax help concerning parameter names and optional query parts, see SQLQuery

Returns:

a new query which can be supplied with parameters and executed against the database

See Also:

SQLQuery

createFunctionCall

public SQLCall createFunctionCall(String fun,
                                  Integer returnType)

Creates a new call wrapper which permits safe and convenient function calls.

Parameters:

fun - name of the function to call

returnType - the SQL type (Types) of the return value of this function

Returns:

a new call which can be supplied with parameters and executed against the database

createProcedureCall

public SQLCall createProcedureCall(String fun)

Creates a new call wrapper which permits safe and convenient procedure calls.

Parameters:

fun - name of the procedure to call

Returns:

a new call which can be supplied with parameters and executed against the database

insertRow

public Row insertRow(String table,
                     sirius.kernel.commons.Context ctx)
              throws SQLException

Generates an INSERT statement for the given table inserting all supplied parameters in ctx.

Parameters:

table - the target table to insert a row

ctx - contains names and values to insert into the database

Returns:

a Row containing all generated keys

Throws:

SQLException - in case of a database error

fillValues

protected void fillValues(List<Object> valueList,
                          String sql,
                          PreparedStatement stmt)

prepareValues

protected void prepareValues(sirius.kernel.commons.Context ctx,
                             StringBuilder fields,
                             StringBuilder values,
                             List<Object> valueList)

insertRow

public Row insertRow(String table,
                     Map<String,Object> row)
              throws SQLException

Boilerplate method to use insertRow(String, sirius.kernel.commons.Context) with plan maps.

Parameters:

table - the target table to insert a row

row - contains names and values to insert into the database

Returns:

a Row containing all generated keys

Throws:

SQLException - in case of a database error

getUrl

public String getUrl()

Returns the JDBC connection URL

Returns:

the JDBC connection URL used to connect to the database

getUsername

public String getUsername()

Returns the JDBC username supplied to the database.

Returns:

the username supplied to the database

getPassword

public String getPassword()

Returns the JDBC password supplied to the database.

Returns:

the password supplied to the database

getSize

public int getSize()

Returns the maximal number of concurrent connections

Returns:

the maximal number of concurrent connections

getNumIdle

public int getNumIdle()

Return the number of idle connections

Returns:

the number of open but unused connection

getNumActive

public int getNumActive()

Return the number of active connections

Returns:

the number of open and active connection

hasCapability

public boolean hasCapability(Capability cap)

Determines if the current driver has the requested capability.

Parameters:

cap - the capability to determine

Returns:

true if the capability is supported / present, false otherwise

toString

public String toString()

Overrides:

toString in class Object