Package org.apache.ibatis.session
Interface SqlSession
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
DefaultSqlSession
,SqlSessionManager
The primary Java interface for working with MyBatis. Through this interface you can execute commands, get mappers and
manage transactions.
- Author:
- Clinton Begin
-
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.
-
Method Details
-
selectOne
Retrieve a single row mapped from the statement key.- Type Parameters:
T
- the returned object type- Parameters:
statement
- the statement- Returns:
- Mapped object
-
selectOne
Retrieve a single row mapped from the statement key and parameter.- 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
-
selectList
Retrieve a list of mapped objects from the statement key.- Type Parameters:
E
- the returned list element type- Parameters:
statement
- Unique identifier matching the statement to use.- Returns:
- List of mapped object
-
selectList
Retrieve a list of mapped objects from the statement key and parameter.- 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
Retrieve a list of mapped objects from the statement key and parameter, within the specified row bounds.- 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
-
selectMap
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")- 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
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.- 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
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.- 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
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- Type Parameters:
T
- the returned cursor element type.- Parameters:
statement
- Unique identifier matching the statement to use.- Returns:
- Cursor of mapped objects
-
selectCursor
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- 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
A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.- 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
-
select
Retrieve a single row mapped from the statement key and parameter using aResultHandler
.- 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
Retrieve a single row mapped from the statement using aResultHandler
.- Parameters:
statement
- Unique identifier matching the statement to use.handler
- ResultHandler that will handle each retrieved row
-
select
Retrieve a single row mapped from the statement key and parameter using aResultHandler
andRowBounds
.- 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
Execute an insert statement.- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the insert.
-
insert
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.- 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
Execute an update statement. The number of rows affected will be returned.- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the update.
-
update
Execute an update statement. The number of rows affected will be returned.- 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
Execute a delete statement. The number of rows affected will be returned.- Parameters:
statement
- Unique identifier matching the statement to execute.- Returns:
- int The number of rows affected by the delete.
-
delete
Execute a delete statement. The number of rows affected will be returned.- 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
void commit()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 callcommit(boolean)
-
commit
void commit(boolean force) Flushes batch statements and commits database connection.- Parameters:
force
- forces connection commit
-
rollback
void rollback()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 callrollback(boolean)
-
rollback
void rollback(boolean force) 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.- Parameters:
force
- forces connection rollback
-
flushStatements
List<BatchResult> flushStatements()Flushes batch statements.- Returns:
- BatchResult list of updated records
- Since:
- 3.0.6
-
close
void close()Closes the session.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
clearCache
void clearCache()Clears local session cache. -
getConfiguration
Configuration getConfiguration()Retrieves current configuration.- Returns:
- Configuration
-
getMapper
Retrieves a mapper.- Type Parameters:
T
- the mapper type- Parameters:
type
- Mapper interface class- Returns:
- a mapper bound to this SqlSession
-
getConnection
Connection getConnection()Retrieves inner database connection.- Returns:
- Connection
-