Module io.ebean.core

Package io.ebeaninternal.server.core

Class DefaultSqlUpdate

java.lang.Object

io.ebeaninternal.server.core.DefaultSqlUpdate

All Implemented Interfaces:

SqlUpdate, SpiSqlUpdate, Serializable

public final class DefaultSqlUpdate
extends Object
implements Serializable, SpiSqlUpdate

A SQL Update Delete or Insert statement that can be executed. For the times when you want to use Sql DML rather than a ORM bean approach. Refer to the Ebean execute() method.

There is also Update which is similar except should use logical bean and property names rather than physical table and column names.

SqlUpdate is designed for general DML sql and CallableSql is designed for use with stored procedures.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultSqlUpdate(SpiEbeanServer server, String sql)	Create with a specific server.
DefaultSqlUpdate(SpiEbeanServer server, String sql, BindParams bindParams)	Create with server sql and bindParams object.
DefaultSqlUpdate(String sql)	Create with some sql.

Method Summary

Modifier and Type	Method	Description
void	addBatch()
String	baseSql()	Return the sql taking into account bind parameter expansion.
BindParams	bindParams()	Return the bind parameters.
SpiSqlUpdate	copy()	Return a copy of the SqlUpdate with empty bind parameters.
int	execute()
int[]	executeBatch()
Object	executeGetKey()
int	executeNow()
Object	getGeneratedKey()
String	getGeneratedSql()
String	getLabel()
String	getSql()
int	getTimeout()
boolean	isAutoTableMod()
boolean	isGetGeneratedKeys()	Return true if we are using getGeneratedKeys.
void	reset()	Reset bind position to be ready for another bind execute.
SqlUpdate	setArrayParameter(String name, Collection<?> values)
SqlUpdate	setAutoTableMod(boolean isAutoTableMod)
void	setGeneratedKey(Object idValue)	Set the generated key value.
void	setGeneratedSql(String generatedSql)	Set the final sql being executed with named parameters replaced etc.
SqlUpdate	setGetGeneratedKeys(boolean getGeneratedKeys)
SqlUpdate	setLabel(String label)
SqlUpdate	setNull(int position, int jdbcType)
SqlUpdate	setNull(String name, int jdbcType)
SqlUpdate	setNullParameter(int position, int jdbcType)
SqlUpdate	setNullParameter(String name, int jdbcType)
SqlUpdate	setParameter(int position, Object value)
SqlUpdate	setParameter(Object value)
SqlUpdate	setParameter(String name, Object param)
SqlUpdate	setParameters(Object... values)
SqlUpdate	setTimeout(int secs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultSqlUpdate

public DefaultSqlUpdate(SpiEbeanServer server,
 String sql,
 BindParams bindParams)

Create with server sql and bindParams object.

Useful if you are building the sql and binding parameters at the same time.

DefaultSqlUpdate

public DefaultSqlUpdate(SpiEbeanServer server,
 String sql)

Create with a specific server. This means you can use the SqlUpdate.execute() method.

DefaultSqlUpdate

public DefaultSqlUpdate(String sql)

Create with some sql.

Method Details

copy

public SpiSqlUpdate copy()

Description copied from interface: SpiSqlUpdate

Return a copy of the SqlUpdate with empty bind parameters.

Specified by:

copy in interface SpiSqlUpdate

reset

public void reset()

Description copied from interface: SpiSqlUpdate

Reset bind position to be ready for another bind execute.

Specified by:

reset in interface SpiSqlUpdate

executeGetKey

public Object executeGetKey()

Specified by:

executeGetKey in interface SqlUpdate

execute

public int execute()

Specified by:

execute in interface SqlUpdate

executeNow

public int executeNow()

Specified by:

executeNow in interface SqlUpdate

executeBatch

public int[] executeBatch()

Specified by:

executeBatch in interface SqlUpdate

addBatch

public void addBatch()

Specified by:

addBatch in interface SqlUpdate

getGeneratedKey

public Object getGeneratedKey()

Specified by:

getGeneratedKey in interface SqlUpdate

setGeneratedKey

public void setGeneratedKey(Object idValue)

Description copied from interface: SpiSqlUpdate

Set the generated key value.

Specified by:

setGeneratedKey in interface SpiSqlUpdate

isAutoTableMod

public boolean isAutoTableMod()

Specified by:

isAutoTableMod in interface SqlUpdate

setAutoTableMod

public SqlUpdate setAutoTableMod(boolean isAutoTableMod)

Specified by:

setAutoTableMod in interface SqlUpdate

getLabel

public String getLabel()

Specified by:

getLabel in interface SqlUpdate

setLabel

public SqlUpdate setLabel(String label)

Specified by:

setLabel in interface SqlUpdate

isGetGeneratedKeys

public boolean isGetGeneratedKeys()

Description copied from interface: SpiSqlUpdate

Return true if we are using getGeneratedKeys.

Specified by:

isGetGeneratedKeys in interface SpiSqlUpdate

setGetGeneratedKeys

public SqlUpdate setGetGeneratedKeys(boolean getGeneratedKeys)

Specified by:

setGetGeneratedKeys in interface SqlUpdate

getGeneratedSql

public String getGeneratedSql()

Specified by:

getGeneratedSql in interface SqlUpdate

setGeneratedSql

public void setGeneratedSql(String generatedSql)

Description copied from interface: SpiSqlUpdate

Set the final sql being executed with named parameters replaced etc.

Specified by:

setGeneratedSql in interface SpiSqlUpdate

getSql

public String getSql()

Specified by:

getSql in interface SqlUpdate

baseSql

public String baseSql()

Description copied from interface: SpiSqlUpdate

Return the sql taking into account bind parameter expansion.

Specified by:

baseSql in interface SpiSqlUpdate

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface SqlUpdate

setTimeout

public SqlUpdate setTimeout(int secs)

Specified by:

setTimeout in interface SqlUpdate

setParameters

public SqlUpdate setParameters(Object... values)

Specified by:

setParameters in interface SqlUpdate

setParameter

public SqlUpdate setParameter(Object value)

Specified by:

setParameter in interface SqlUpdate

setParameter

public SqlUpdate setParameter(int position,
 Object value)

Specified by:

setParameter in interface SqlUpdate

setNull

public SqlUpdate setNull(int position,
 int jdbcType)

Specified by:

setNull in interface SqlUpdate

setNullParameter

public SqlUpdate setNullParameter(int position,
 int jdbcType)

Specified by:

setNullParameter in interface SqlUpdate

setParameter

public SqlUpdate setParameter(String name,
 Object param)

Specified by:

setParameter in interface SqlUpdate

setArrayParameter

public SqlUpdate setArrayParameter(String name,
 Collection<?> values)

Specified by:

setArrayParameter in interface SqlUpdate

setNull

public SqlUpdate setNull(String name,
 int jdbcType)

Specified by:

setNull in interface SqlUpdate

setNullParameter

public SqlUpdate setNullParameter(String name,
 int jdbcType)

Specified by:

setNullParameter in interface SqlUpdate

bindParams

public BindParams bindParams()

Return the bind parameters.

Specified by:

bindParams in interface SpiSqlUpdate