DatabaseConnectionProxy (ORMLite Core 6.1 API)

java.lang.Object
- com.j256.ormlite.support.DatabaseConnectionProxy

All Implemented Interfaces:

DatabaseConnection, AutoCloseable
```
public class DatabaseConnectionProxy
extends Object
implements DatabaseConnection
```
Database connection proxy so you can intercept database operations either for debugging, replication, logging, or other purposes. This is designed to be extended by a subclass with particular methods overridden by the subclass to do monitoring, logging, or to do some special hackery.
See the DatabaseConnectionProxyFactory javadocs for more details.

Author:

graywatson

Field Summary
- Fields inherited from interface com.j256.ormlite.support.DatabaseConnection
  DEFAULT_RESULT_FLAGS, MORE_THAN_ONE

Constructor Summary

Constructors
Constructor and Description

DatabaseConnectionProxy(DatabaseConnection proxy)

Constructors
Constructor and Description
`DatabaseConnectionProxy(DatabaseConnection proxy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`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 name)` 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DatabaseConnectionProxy
```
public DatabaseConnectionProxy(DatabaseConnection proxy)
```
- Method Detail
  - isAutoCommitSupported
```
public boolean isAutoCommitSupported()
                              throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Return if auto-commit is supported.
    
    Specified by:
    
    isAutoCommitSupported in interface DatabaseConnection
    
    Throws:
    
    SQLException
  - isAutoCommit
```
public boolean isAutoCommit()
                     throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Return if auto-commit is currently enabled.
    
    Specified by:
    
    isAutoCommit in interface DatabaseConnection
    
    Throws:
    
    SQLException
  - setAutoCommit
```
public void setAutoCommit(boolean autoCommit)
                   throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    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.
    
    Specified by:
    
    setAutoCommit in interface DatabaseConnection
    
    Throws:
    
    SQLException
  - setSavePoint
```
public Savepoint setSavePoint(String name)
                       throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Start a save point with a certain name. It can be a noop if savepoints are not supported.
    
    Specified by:
    
    setSavePoint in interface DatabaseConnection
    
    Parameters:
    
    name - 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
```
public void commit(Savepoint savePoint)
            throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Commit all changes since the savepoint was created. If savePoint is null then commit all outstanding changes.
    
    Specified by:
    
    commit in interface DatabaseConnection
    
    Parameters:
    
    savePoint - That was returned by setSavePoint or null if none.
    
    Throws:
    
    SQLException
  - rollback
```
public void rollback(Savepoint savePoint)
              throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Roll back all changes since the savepoint was created. If savePoint is null then roll back all outstanding changes.
    
    Specified by:
    
    rollback in interface DatabaseConnection
    
    Parameters:
    
    savePoint - That was returned by setSavePoint previously or null if none.
    
    Throws:
    
    SQLException
  - releaseSavePoint
```
public void releaseSavePoint(Savepoint savePoint)
                      throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Release a savepoint when we reach the end of a transaction but not the most outer one.
    
    Specified by:
    
    releaseSavePoint in interface DatabaseConnection
    
    Parameters:
    
    savePoint - That was returned by setSavePoint previously or null if none.
    
    Throws:
    
    SQLException
  - executeStatement
```
public int executeStatement(String statementStr,
                            int resultFlags)
                     throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Execute a statement directly on the connection.
    
    Specified by:
    
    executeStatement in interface DatabaseConnection
    
    resultFlags - Allows specification of some result flags. This is dependent on the backend and database type. Set to DatabaseConnection.DEFAULT_RESULT_FLAGS for the internal default.
    
    Throws:
    
    SQLException
  - compileStatement
```
public CompiledStatement compileStatement(String statement,
                                          StatementBuilder.StatementType type,
                                          FieldType[] argFieldTypes,
                                          int resultFlags,
                                          boolean cacheStore)
                                   throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Like compileStatement(String, StatementType, FieldType[]) except the caller can specify the result flags.
    
    Specified by:
    
    compileStatement in interface DatabaseConnection
    
    resultFlags - Allows specification of some result flags. This is dependent on the backend and database type. Set to DatabaseConnection.DEFAULT_RESULT_FLAGS for the internal default.
    
    cacheStore - Cache can store results from this statement.
    
    Throws:
    
    SQLException
  - insert
```
public int insert(String statement,
                  Object[] args,
                  FieldType[] argfieldTypes,
                  GeneratedKeyHolder keyHolder)
           throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a SQL update while with the associated SQL statement, arguments, and types. This will possibly return generated keys if kyeHolder is not null.
    
    Specified by:
    
    insert in interface DatabaseConnection
    
    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
```
public int update(String statement,
                  Object[] args,
                  FieldType[] argfieldTypes)
           throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a SQL update with the associated SQL statement, arguments, and types.
    
    Specified by:
    
    update in interface DatabaseConnection
    
    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
```
public int delete(String statement,
                  Object[] args,
                  FieldType[] argfieldTypes)
           throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a SQL delete with the associated SQL statement, arguments, and types.
    
    Specified by:
    
    delete in interface DatabaseConnection
    
    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
```
public <T> Object queryForOne(String statement,
                              Object[] args,
                              FieldType[] argfieldTypes,
                              GenericRowMapper<T> rowMapper,
                              ObjectCache objectCache)
                       throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a SQL query with the associated SQL statement, arguments, and types and returns a single result.
    
    Specified by:
    
    queryForOne in interface DatabaseConnection
    
    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 DatabaseConnection.MORE_THAN_ONE if more than one result was found.
    
    Throws:
    
    SQLException
  - queryForLong
```
public long queryForLong(String statement)
                  throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a query whose result should be a single long-integer value.
    
    Specified by:
    
    queryForLong in interface DatabaseConnection
    
    Parameters:
    
    statement - SQL statement to use for the query.
    
    Throws:
    
    SQLException
  - queryForLong
```
public long queryForLong(String statement,
                         Object[] args,
                         FieldType[] argFieldTypes)
                  throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Perform a query whose result should be a single long-integer value.
    
    Specified by:
    
    queryForLong in interface DatabaseConnection
    
    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
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - closeQuietly
```
public void closeQuietly()
```
    Description copied from interface: DatabaseConnection
    
    Close the connection to the database but swallow any exceptions.
    
    Specified by:
    
    closeQuietly in interface DatabaseConnection
  - isClosed
```
public boolean isClosed()
                 throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Return if the connection has been closed either through a call to AutoCloseable.close() or because of a fatal error.
    
    Specified by:
    
    isClosed in interface DatabaseConnection
    
    Throws:
    
    SQLException
  - isTableExists
```
public boolean isTableExists(String tableName)
                      throws SQLException
```
    Description copied from interface: DatabaseConnection
    
    Return true if the table exists in the database.
    
    Specified by:
    
    isTableExists in interface DatabaseConnection
    
    Throws:
    
    SQLException
  - getUnderlyingConnection
```
public Connection getUnderlyingConnection()
```
    Description copied from interface: DatabaseConnection
    
    Return the underlying database connection so that per-connection calls can be made on it as necessary. This is not supported under Android.
    
    Specified by:
    
    getUnderlyingConnection in interface DatabaseConnection

Class DatabaseConnectionProxy

Field Summary

Fields inherited from interface com.j256.ormlite.support.DatabaseConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatabaseConnectionProxy

Method Detail

isAutoCommitSupported

isAutoCommit

setAutoCommit

setSavePoint

commit

rollback

releaseSavePoint

executeStatement

compileStatement

insert

update

delete

queryForOne

queryForLong

queryForLong

close

closeQuietly

isClosed

isTableExists

getUnderlyingConnection