Interface DbStatementDml

All Superinterfaces:

DbStatement<DbStatementDml>

All Known Implementing Classes:

MongoDbStatementDml

public interface DbStatementDml
extends DbStatement<DbStatementDml>

Data Manipulation Language (DML) database statement. A DML statement modifies records in the database and returns the number of modified records.

Method Summary

Modifier and Type	Method	Description
long	execute()	Execute this statement using the parameters configured with params and addParams methods.
DbResultDml	insert()	Execute INSERT statement using the parameters configured with params and addParams methods and return compound result with generated keys.
DbStatementDml	returnColumns(List<String> columnNames)	Set column names to be returned from the inserted row or rows from the statement execution using insert().
DbStatementDml	returnGeneratedKeys()	Set auto-generated keys to be returned from the statement execution using insert().

Methods inherited from interface DbStatement

addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, indexedParam, namedParam, params, params, params

Modifier and Type	Method	Description
DbStatementDml	addParam(boolean parameter)	Add next boolean parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(byte parameter)	Add next byte parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(byte[] parameter)	Add next byte[] parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(double parameter)	Add next double parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(float parameter)	Add next float parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(int parameter)	Add next integer parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(long parameter)	Add next long parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(short parameter)	Add next short parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(Object parameter)	Add next parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(String parameter)	Add next String parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(String name, boolean parameter)	Add next boolean parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, byte parameter)	Add next byte parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, byte[] parameter)	Add next byte[] parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, double parameter)	Add next double parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, float parameter)	Add next float parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, int parameter)	Add next int parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, long parameter)	Add next long parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, short parameter)	Add next short parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, Object parameter)	Add next parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, String parameter)	Add next String parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, BigDecimal parameter)	Add next BigDecimal parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, BigInteger parameter)	Add next BigInteger parameter to the map of named parameters (e.g.
DbStatementDml	addParam(BigDecimal parameter)	Add next BigDecimal parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(BigInteger parameter)	Add next BigInteger parameter to the list of ordered parameters (e.g.
DbStatementDml	indexedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
DbStatementDml	namedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
default DbStatementDml	params(Object... parameters)	Configure parameters from an array by order.
DbStatementDml	params(List<?> parameters)	Configure parameters from a List by order.
DbStatementDml	params(Map<String,?> parameters)	Configure named parameters.

Method Details

execute

long execute()

Execute this statement using the parameters configured with params and addParams methods.

Returns:

the result of this statement

insert

DbResultDml insert()

Execute INSERT statement using the parameters configured with params and addParams methods and return compound result with generated keys.

Returns:

the result of this statement with generated keys

returnGeneratedKeys

DbStatementDml returnGeneratedKeys()

Set auto-generated keys to be returned from the statement execution using insert(). Only one method from returnGeneratedKeys() and returnColumns(List) may be used. This feature is database provider specific and some databases require specific columns to be set.

Returns:

updated db statement

returnColumns

DbStatementDml returnColumns(List<String> columnNames)

Set column names to be returned from the inserted row or rows from the statement execution using insert(). Only one method from returnGeneratedKeys() and returnColumns(List) may be used. This feature is database provider specific.

Parameters:

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

updated db statement