DbSession (Jodd API Documentation)

java.lang.Object
- jodd.db.DbSession

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

DbThreadSession
```
public class DbSession
extends java.lang.Object
implements java.lang.AutoCloseable
```
Encapsulates db connection. Initially works in auto-commit mode. May start and work with transactions, after committing/rolling back DbSession goes back to auto-commit mode.
All invoked queries are stored within one session and closed implicitly on session closing.
For managed transaction see DbJtxTransactionManager from jodd-tx.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.sql.Connection`	`connection`
`protected ConnectionProvider`	`connectionProvider`
`protected DbManager`	`dbManager`
`protected java.util.Set<jodd.db.DbQueryBase>`	`queries` Bag of all queries attached to this session.
`protected boolean`	`txActive`
`protected DbTransactionMode`	`txMode`

Constructor Summary

Constructors
Constructor and Description
`DbSession()` Creates new database session using default connection provider.
`DbSession(ConnectionProvider connectionProvider)` Creates new database session with default transaction mode and in autocommit mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`attachQuery(jodd.db.DbQueryBase query)` Attaches a new `DbQuery`.
`void`	`beginTransaction()` Starts transaction with default transaction mode.
`void`	`beginTransaction(DbTransactionMode mode)` Starts a transaction.
`protected void`	`checkActiveTx()`
`protected void`	`checkClosedTx()`
`protected void`	`checkOpenSession()`
`void`	`close()`
`void`	`closeSession()` Closes current session and all allocated resources.
`protected void`	`closeTx()` Closes current transaction.
`void`	`commitTransaction()` Commit the current transaction, writing any unflushed changes to the database.
`protected void`	`detachQuery(jodd.db.DbQueryBase query)` Detach used `DbQuery`.
`java.sql.Connection`	`getConnection()` Returns current connection.
`int`	`getTotalQueries()` Returns total number of queries assigned to this session.
`boolean`	`isSessionClosed()` Indicates whether a session is closed.
`boolean`	`isSessionOpen()` Returns `true` if session is open.
`boolean`	`isTransactionActive()` Indicate whether a transaction is in progress.
`protected void`	`openConnectionForQuery()` Opens connection in auto-commit mode, if already not opened.
`protected void`	`openTx()` Opens a transaction.
`void`	`rollbackTransaction()` Roll back the current transaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dbManager
```
protected final DbManager dbManager
```
  - connectionProvider
```
protected final ConnectionProvider connectionProvider
```
  - connection
```
protected java.sql.Connection connection
```
  - queries
```
protected java.util.Set<jodd.db.DbQueryBase> queries
```
    Bag of all queries attached to this session. Explicitly closed queries remains in the set. If null, session is closed. If not null, but empty, session is still considered as open.
  - txActive
```
protected boolean txActive
```
  - txMode
```
protected DbTransactionMode txMode
```
- Constructor Detail
  - DbSession
```
public DbSession()
```
    Creates new database session using default connection provider.
  - DbSession
```
public DbSession(ConnectionProvider connectionProvider)
```
    Creates new database session with default transaction mode and in autocommit mode.
- Method Detail
  - closeSession
```
public void closeSession()
```
    Closes current session and all allocated resources. All attached queries are closed. If a transaction is still active, exception occurs. Database connection is returned to the ConnectionProvider. Closed session is no longer available for usage.
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - isSessionClosed
```
public boolean isSessionClosed()
```
    Indicates whether a session is closed.
  - isSessionOpen
```
public boolean isSessionOpen()
```
    Returns true if session is open.
  - getTotalQueries
```
public int getTotalQueries()
```
    Returns total number of queries assigned to this session.
  - getConnection
```
public java.sql.Connection getConnection()
```
    Returns current connection.
  - attachQuery
```
protected void attachQuery(jodd.db.DbQueryBase query)
```
    Attaches a new DbQuery. May be invoked both inside and outside of transaction.
  - detachQuery
```
protected void detachQuery(jodd.db.DbQueryBase query)
```
    Detach used DbQuery. Usually invoked by DbQueryBase.close().
  - openConnectionForQuery
```
protected void openConnectionForQuery()
```
    Opens connection in auto-commit mode, if already not opened.
  - isTransactionActive
```
public boolean isTransactionActive()
```
    Indicate whether a transaction is in progress.
  - openTx
```
protected void openTx()
```
    Opens a transaction.
  - closeTx
```
protected void closeTx()
```
    Closes current transaction.
  - beginTransaction
```
public void beginTransaction(DbTransactionMode mode)
```
    Starts a transaction.
  - beginTransaction
```
public void beginTransaction()
```
    Starts transaction with default transaction mode.
  - commitTransaction
```
public void commitTransaction()
```
    Commit the current transaction, writing any unflushed changes to the database. Transaction mode is closed.
  - rollbackTransaction
```
public void rollbackTransaction()
```
    Roll back the current transaction. Transaction mode is closed.
  - checkOpenSession
```
protected void checkOpenSession()
```
  - checkClosedTx
```
protected void checkClosedTx()
```
  - checkActiveTx
```
protected void checkActiveTx()
```

Class DbSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dbManager

connectionProvider

connection

queries

txActive

txMode

Constructor Detail

DbSession

DbSession

Method Detail

closeSession

close

isSessionClosed

isSessionOpen

getTotalQueries

getConnection

attachQuery

detachQuery

openConnectionForQuery

isTransactionActive

openTx

closeTx

beginTransaction

beginTransaction

commitTransaction

rollbackTransaction

checkOpenSession

checkClosedTx

checkActiveTx