com.j256.ormlite.support

Interface DatabaseConnection

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DatabaseConnectionProxy

public interface DatabaseConnection
extends AutoCloseable

A reduction of the SQL Connection so we can implement its functionality outside of JDBC.

Author:

graywatson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RESULT_FLAGS
static Object	MORE_THAN_ONE returned by queryForOne(java.lang.String, java.lang.Object[], com.j256.ormlite.field.FieldType[], com.j256.ormlite.stmt.GenericRowMapper<T>, com.j256.ormlite.dao.ObjectCache) if more than one result was found by the query

Method Summary

Modifier and Type	Method and Description
void	closeQuietly() Close the connection to the database but swallow any exceptions.
void	commit(Savepoint savePoint) Commit all changes since the savepoint was created.
CompiledStatement	compileStatement(String statement, StatementBuilder.StatementType type, FieldType[] argFieldTypes, int resultFlags, boolean cacheStore) Like compileStatement(String, StatementType, FieldType[]) except the caller can specify the result flags.
int	delete(String statement, Object[] args, FieldType[] argfieldTypes) Perform a SQL delete with the associated SQL statement, arguments, and types.
int	executeStatement(String statementStr, int resultFlags) Execute a statement directly on the connection.
Connection	getUnderlyingConnection() Return the underlying database connection so that per-connection calls can be made on it as necessary.
int	insert(String statement, Object[] args, FieldType[] argfieldTypes, GeneratedKeyHolder keyHolder) Perform a SQL update while with the associated SQL statement, arguments, and types.
boolean	isAutoCommit() Return if auto-commit is currently enabled.
boolean	isAutoCommitSupported() Return if auto-commit is supported.
boolean	isClosed() Return if the connection has been closed either through a call to AutoCloseable.close() or because of a fatal error.
boolean	isTableExists(String tableName) Return true if the table exists in the database.
long	queryForLong(String statement) Perform a query whose result should be a single long-integer value.
long	queryForLong(String statement, Object[] args, FieldType[] argFieldTypes) Perform a query whose result should be a single long-integer value.
<T> Object	queryForOne(String statement, Object[] args, FieldType[] argfieldTypes, GenericRowMapper<T> rowMapper, ObjectCache objectCache) Perform a SQL query with the associated SQL statement, arguments, and types and returns a single result.
void	releaseSavePoint(Savepoint savePoint) Release a savepoint when we reach the end of a transaction but not the most outer one.
void	rollback(Savepoint savePoint) Roll back all changes since the savepoint was created.
void	setAutoCommit(boolean autoCommit) Set the auto-commit to be on (true) or off (false).
Savepoint	setSavePoint(String savePointName) Start a save point with a certain name.
int	update(String statement, Object[] args, FieldType[] argfieldTypes) Perform a SQL update with the associated SQL statement, arguments, and types.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

MORE_THAN_ONE

static final Object MORE_THAN_ONE

returned by queryForOne(java.lang.String, java.lang.Object[], com.j256.ormlite.field.FieldType[], com.j256.ormlite.stmt.GenericRowMapper<T>, com.j256.ormlite.dao.ObjectCache) if more than one result was found by the query

DEFAULT_RESULT_FLAGS

static final int DEFAULT_RESULT_FLAGS

See Also:

Constant Field Values

Method Detail

isAutoCommitSupported

boolean isAutoCommitSupported()
                       throws SQLException

Return if auto-commit is supported.

Throws:

SQLException

isAutoCommit

boolean isAutoCommit()
              throws SQLException

Return if auto-commit is currently enabled.

Throws:

SQLException

setAutoCommit

void setAutoCommit(boolean autoCommit)
            throws SQLException

Set the auto-commit to be on (true) or off (false). Setting auto-commit to true may or may-not cause a commit depending on the underlying database code.

Throws:

SQLException

setSavePoint

Savepoint setSavePoint(String savePointName)
                throws SQLException

Start a save point with a certain name. It can be a noop if savepoints are not supported.

Parameters:

savePointName - to use for the Savepoint although it can be ignored.

Returns:

A SavePoint object with which we can release or commit in the future or null if none.

Throws:

SQLException

commit

void commit(Savepoint savePoint)
     throws SQLException

Commit all changes since the savepoint was created. If savePoint is null then commit all outstanding changes.

Parameters:

savePoint - That was returned by setSavePoint or null if none.

Throws:

SQLException

rollback

void rollback(Savepoint savePoint)
       throws SQLException

Roll back all changes since the savepoint was created. If savePoint is null then roll back all outstanding changes.

Parameters:

savePoint - That was returned by setSavePoint previously or null if none.

Throws:

SQLException

releaseSavePoint

void releaseSavePoint(Savepoint savePoint)
               throws SQLException

Release a savepoint when we reach the end of a transaction but not the most outer one.

Parameters:

savePoint - That was returned by setSavePoint previously or null if none.

Throws:

SQLException

executeStatement

int executeStatement(String statementStr,
                     int resultFlags)
              throws SQLException

Execute a statement directly on the connection.

Parameters:

resultFlags - Allows specification of some result flags. This is dependent on the backend and database type. Set to DEFAULT_RESULT_FLAGS for the internal default.

Throws:

SQLException

compileStatement

CompiledStatement compileStatement(String statement,
                                   StatementBuilder.StatementType type,
                                   FieldType[] argFieldTypes,
                                   int resultFlags,
                                   boolean cacheStore)
                            throws SQLException

Like compileStatement(String, StatementType, FieldType[]) except the caller can specify the result flags.

Parameters:

resultFlags - Allows specification of some result flags. This is dependent on the backend and database type. Set to DEFAULT_RESULT_FLAGS for the internal default.

cacheStore - Cache can store results from this statement.

Throws:

SQLException

insert

int insert(String statement,
           Object[] args,
           FieldType[] argfieldTypes,
           GeneratedKeyHolder keyHolder)
    throws SQLException

Perform a SQL update while with the associated SQL statement, arguments, and types. This will possibly return generated keys if kyeHolder is not null.

Parameters:

statement - SQL statement to use for inserting.

args - Object arguments for the SQL '?'s.

argfieldTypes - Field types of the arguments.

keyHolder - The holder that gets set with the generated key value which may be null.

Returns:

The number of rows affected by the update. With some database types, this value may be invalid.

Throws:

SQLException

update

int update(String statement,
           Object[] args,
           FieldType[] argfieldTypes)
    throws SQLException

Perform a SQL update with the associated SQL statement, arguments, and types.

Parameters:

statement - SQL statement to use for updating.

args - Object arguments for the SQL '?'s.

argfieldTypes - Field types of the arguments.

Returns:

The number of rows affected by the update. With some database types, this value may be invalid.

Throws:

SQLException

delete

int delete(String statement,
           Object[] args,
           FieldType[] argfieldTypes)
    throws SQLException

Perform a SQL delete with the associated SQL statement, arguments, and types.

Parameters:

statement - SQL statement to use for deleting.

args - Object arguments for the SQL '?'s.

argfieldTypes - Field types of the arguments.

Returns:

The number of rows affected by the update. With some database types, this value may be invalid.

Throws:

SQLException

queryForOne

<T> Object queryForOne(String statement,
                       Object[] args,
                       FieldType[] argfieldTypes,
                       GenericRowMapper<T> rowMapper,
                       ObjectCache objectCache)
                throws SQLException

Perform a SQL query with the associated SQL statement, arguments, and types and returns a single result.

Parameters:

statement - SQL statement to use for deleting.

args - Object arguments for the SQL '?'s.

argfieldTypes - Field types of the arguments.

rowMapper - The mapper to use to convert the row into the returned object.

objectCache - Any object cache associated with the query or null if none.

Returns:

The first data item returned by the query which can be cast to T, null if none, the object MORE_THAN_ONE if more than one result was found.

Throws:

SQLException

queryForLong

long queryForLong(String statement)
           throws SQLException

Perform a query whose result should be a single long-integer value.

Parameters:

statement - SQL statement to use for the query.

Throws:

SQLException

queryForLong

long queryForLong(String statement,
                  Object[] args,
                  FieldType[] argFieldTypes)
           throws SQLException

Perform a query whose result should be a single long-integer value.

Parameters:

statement - SQL statement to use for the query.

args - Arguments to pass into the query.

argFieldTypes - Field types that correspond to the args.

Throws:

SQLException

closeQuietly

void closeQuietly()

Close the connection to the database but swallow any exceptions.

isClosed

boolean isClosed()
          throws SQLException

Return if the connection has been closed either through a call to AutoCloseable.close() or because of a fatal error.

Throws:

SQLException

isTableExists

boolean isTableExists(String tableName)
               throws SQLException

Return true if the table exists in the database.

Throws:

SQLException

getUnderlyingConnection

Connection getUnderlyingConnection()

Return the underlying database connection so that per-connection calls can be made on it as necessary. This is not supported under Android.