Class DefaultSqlSession
java.lang.Object
org.apache.ibatis.session.defaults.DefaultSqlSession
- All Implemented Interfaces:
Closeable
,AutoCloseable
,SqlSession
The default implementation for
SqlSession
. Note that this class is not Thread-Safe.- Author:
- Clinton Begin
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Deprecated.Since 3.5.5 -
Constructor Summary
ConstructorDescriptionDefaultSqlSession
(Configuration configuration, Executor executor) DefaultSqlSession
(Configuration configuration, Executor executor, boolean autoCommit) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears local session cache.void
close()
Closes the session.void
commit()
Flushes batch statements and commits database connection.void
commit
(boolean force) Flushes batch statements and commits database connection.int
Execute a delete statement.int
Execute a delete statement.Flushes batch statements.Retrieves current configuration.Retrieves inner database connection.<T> T
Retrieves a mapper.int
Execute an insert statement.int
Execute an insert statement with the given parameter object.void
rollback()
Discards pending batch statements and rolls database connection back.void
rollback
(boolean force) Discards pending batch statements and rolls database connection back.void
select
(String statement, Object parameter, ResultHandler handler) Retrieve a single row mapped from the statement key and parameter using aResultHandler
.void
select
(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler) Retrieve a single row mapped from the statement key and parameter using aResultHandler
andRowBounds
.void
select
(String statement, ResultHandler handler) Retrieve a single row mapped from the statement using aResultHandler
.<T> Cursor<T>
selectCursor
(String statement) A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.<T> Cursor<T>
selectCursor
(String statement, Object parameter) A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.<T> Cursor<T>
selectCursor
(String statement, Object parameter, RowBounds rowBounds) A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.<E> List<E>
selectList
(String statement) Retrieve a list of mapped objects from the statement key.<E> List<E>
selectList
(String statement, Object parameter) Retrieve a list of mapped objects from the statement key and parameter.<E> List<E>
selectList
(String statement, Object parameter, RowBounds rowBounds) Retrieve a list of mapped objects from the statement key and parameter, within the specified row bounds.<K,
V> Map<K, V> The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.<K,
V> Map<K, V> The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.<K,
V> Map<K, V> The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.<T> T
Retrieve a single row mapped from the statement key.<T> T
Retrieve a single row mapped from the statement key and parameter.int
Execute an update statement.int
Execute an update statement.
-
Constructor Details
-
DefaultSqlSession
-
DefaultSqlSession
-
-
Method Details
-
selectOne
Description copied from interface:SqlSession
Retrieve a single row mapped from the statement key.- Specified by:
selectOne
in interfaceSqlSession
- Type Parameters:
T
- the returned object type- Parameters:
statement
- the statement- Returns:
- Mapped object
-
selectOne
Description copied from interface:SqlSession
Retrieve a single row mapped from the statement key and parameter.- Specified by:
selectOne
in interfaceSqlSession
- Type Parameters:
T
- the returned object type- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.- Returns:
- Mapped object
-
selectMap
Description copied from interface:SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects. Eg. Return a of Map[Integer,Author] for selectMap("selectAuthors","id")- Specified by:
selectMap
in interfaceSqlSession
- Type Parameters:
K
- the returned Map keys typeV
- the returned Map values type- Parameters:
statement
- Unique identifier matching the statement to use.mapKey
- The property to use as key for each value in the list.- Returns:
- Map containing key pair data.
-
selectMap
Description copied from interface:SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.- Specified by:
selectMap
in interfaceSqlSession
- Type Parameters:
K
- the returned Map keys typeV
- the returned Map values type- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.mapKey
- The property to use as key for each value in the list.- Returns:
- Map containing key pair data.
-
selectMap
public <K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds) Description copied from interface:SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.- Specified by:
selectMap
in interfaceSqlSession
- Type Parameters:
K
- the returned Map keys typeV
- the returned Map values type- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.mapKey
- The property to use as key for each value in the list.rowBounds
- Bounds to limit object retrieval- Returns:
- Map containing key pair data.
-
selectCursor
Description copied from interface:SqlSession
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- Specified by:
selectCursor
in interfaceSqlSession
- Type Parameters:
T
- the returned cursor element type.- Parameters:
statement
- Unique identifier matching the statement to use.- Returns:
- Cursor of mapped objects
-
selectCursor
Description copied from interface:SqlSession
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- Specified by:
selectCursor
in interfaceSqlSession
- Type Parameters:
T
- the returned cursor element type.- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.- Returns:
- Cursor of mapped objects
-
selectCursor
Description copied from interface:SqlSession
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- Specified by:
selectCursor
in interfaceSqlSession
- Type Parameters:
T
- the returned cursor element type.- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.rowBounds
- Bounds to limit object retrieval- Returns:
- Cursor of mapped objects
-
selectList
Description copied from interface:SqlSession
Retrieve a list of mapped objects from the statement key.- Specified by:
selectList
in interfaceSqlSession
- Type Parameters:
E
- the returned list element type- Parameters:
statement
- Unique identifier matching the statement to use.- Returns:
- List of mapped object
-
selectList
Description copied from interface:SqlSession
Retrieve a list of mapped objects from the statement key and parameter.- Specified by:
selectList
in interfaceSqlSession
- Type Parameters:
E
- the returned list element type- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.- Returns:
- List of mapped object
-
selectList
Description copied from interface:SqlSession
Retrieve a list of mapped objects from the statement key and parameter, within the specified row bounds.- Specified by:
selectList
in interfaceSqlSession
- Type Parameters:
E
- the returned list element type- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.rowBounds
- Bounds to limit object retrieval- Returns:
- List of mapped object
-
select
Description copied from interface:SqlSession
Retrieve a single row mapped from the statement key and parameter using aResultHandler
.- Specified by:
select
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- A parameter object to pass to the statement.handler
- ResultHandler that will handle each retrieved row
-
select
Description copied from interface:SqlSession
Retrieve a single row mapped from the statement using aResultHandler
.- Specified by:
select
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to use.handler
- ResultHandler that will handle each retrieved row
-
select
Description copied from interface:SqlSession
Retrieve a single row mapped from the statement key and parameter using aResultHandler
andRowBounds
.- Specified by:
select
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to use.parameter
- the parameterrowBounds
- RowBound instance to limit the query resultshandler
- ResultHandler that will handle each retrieved row
-
insert
Description copied from interface:SqlSession
Execute an insert statement.- Specified by:
insert
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the insert.
-
insert
Description copied from interface:SqlSession
Execute an insert statement with the given parameter object. Any generated autoincrement values or selectKey entries will modify the given parameter object properties. Only the number of rows affected will be returned.- Specified by:
insert
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.parameter
- A parameter object to pass to the statement.- Returns:
- int The number of rows affected by the insert.
-
update
Description copied from interface:SqlSession
Execute an update statement. The number of rows affected will be returned.- Specified by:
update
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the update.
-
update
Description copied from interface:SqlSession
Execute an update statement. The number of rows affected will be returned.- Specified by:
update
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.parameter
- A parameter object to pass to the statement.- Returns:
- int The number of rows affected by the update.
-
delete
Description copied from interface:SqlSession
Execute a delete statement. The number of rows affected will be returned.- Specified by:
delete
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the delete.
-
delete
Description copied from interface:SqlSession
Execute a delete statement. The number of rows affected will be returned.- Specified by:
delete
in interfaceSqlSession
- Parameters:
statement
- Unique identifier matching the statement to execute.parameter
- A parameter object to pass to the statement.- Returns:
- int The number of rows affected by the delete.
-
commit
public void commit()Description copied from interface:SqlSession
Flushes batch statements and commits database connection. Note that database connection will not be committed if no updates/deletes/inserts were called. To force the commit callSqlSession.commit(boolean)
- Specified by:
commit
in interfaceSqlSession
-
commit
public void commit(boolean force) Description copied from interface:SqlSession
Flushes batch statements and commits database connection.- Specified by:
commit
in interfaceSqlSession
- Parameters:
force
- forces connection commit
-
rollback
public void rollback()Description copied from interface:SqlSession
Discards pending batch statements and rolls database connection back. Note that database connection will not be rolled back if no updates/deletes/inserts were called. To force the rollback callSqlSession.rollback(boolean)
- Specified by:
rollback
in interfaceSqlSession
-
rollback
public void rollback(boolean force) Description copied from interface:SqlSession
Discards pending batch statements and rolls database connection back. Note that database connection will not be rolled back if no updates/deletes/inserts were called.- Specified by:
rollback
in interfaceSqlSession
- Parameters:
force
- forces connection rollback
-
flushStatements
Description copied from interface:SqlSession
Flushes batch statements.- Specified by:
flushStatements
in interfaceSqlSession
- Returns:
- BatchResult list of updated records
-
close
public void close()Description copied from interface:SqlSession
Closes the session.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceSqlSession
-
getConfiguration
Description copied from interface:SqlSession
Retrieves current configuration.- Specified by:
getConfiguration
in interfaceSqlSession
- Returns:
- Configuration
-
getMapper
Description copied from interface:SqlSession
Retrieves a mapper.- Specified by:
getMapper
in interfaceSqlSession
- Type Parameters:
T
- the mapper type- Parameters:
type
- Mapper interface class- Returns:
- a mapper bound to this SqlSession
-
getConnection
Description copied from interface:SqlSession
Retrieves inner database connection.- Specified by:
getConnection
in interfaceSqlSession
- Returns:
- Connection
-
clearCache
public void clearCache()Description copied from interface:SqlSession
Clears local session cache.- Specified by:
clearCache
in interfaceSqlSession
-