Package org.mybatis.dynamic.sql.update

Class UpdateDSL<R>

java.lang.Object

org.mybatis.dynamic.sql.update.UpdateDSL<R>

All Implemented Interfaces:

Buildable<R>

public class UpdateDSL<R>
extends java.lang.Object
implements Buildable<R>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UpdateDSL.SetClauseFinisher<T>
class	UpdateDSL.UpdateWhereBuilder

Method Summary

Modifier and Type	Method	Description
UpdateDSL.UpdateWhereBuilder	applyWhere(WhereApplier whereApplier)
R	build()	WARNING! Calling this method could result in an update statement that updates all rows in a table.
<T> UpdateDSL.SetClauseFinisher<T>	set(SqlColumn<T> column)
static <R> UpdateDSL<R>	update(java.util.function.Function<UpdateModel,R> adapterFunction, SqlTable table)
static UpdateDSL<UpdateModel>	update(SqlTable table)
static <T> UpdateDSL<MyBatis3UpdateModelAdapter<T>>	updateWithMapper(java.util.function.Function<UpdateStatementProvider,T> mapperMethod, SqlTable table)	Deprecated. in favor of MyBatis3Utils.update(ToIntFunction, SqlTable, UpdateDSLCompleter).
UpdateDSL.UpdateWhereBuilder	where()
<T> UpdateDSL.UpdateWhereBuilder	where(BindableColumn<T> column, VisitableCondition<T> condition, SqlCriterion<?>... subCriteria)

Methods inherited from class java.lang.Object

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

Method Detail

set

public <T> UpdateDSL.SetClauseFinisher<T> set(SqlColumn<T> column)

where

public UpdateDSL.UpdateWhereBuilder where()

where

public <T> UpdateDSL.UpdateWhereBuilder where(BindableColumn<T> column,
                                              VisitableCondition<T> condition,
                                              SqlCriterion<?>... subCriteria)

applyWhere

public UpdateDSL.UpdateWhereBuilder applyWhere(WhereApplier whereApplier)

build

@NotNull
public R build()

WARNING! Calling this method could result in an update statement that updates all rows in a table.

Specified by:

build in interface Buildable<R>

Returns:

the update model

update

public static <R> UpdateDSL<R> update(java.util.function.Function<UpdateModel,R> adapterFunction,
                                      SqlTable table)

update

public static UpdateDSL<UpdateModel> update(SqlTable table)

updateWithMapper

@Deprecated
public static <T> UpdateDSL<MyBatis3UpdateModelAdapter<T>> updateWithMapper(java.util.function.Function<UpdateStatementProvider,T> mapperMethod,
                                                                            SqlTable table)

Deprecated.

in favor of MyBatis3Utils.update(ToIntFunction, SqlTable, UpdateDSLCompleter). This method will be removed without direct replacement in a future version.

Executes an update using a MyBatis3 mapper method.

Type Parameters:

T - return value from an update method - typically Integer

Parameters:

mapperMethod - MyBatis3 mapper method that performs the update

table - table to update

Returns:

number of records updated - typically as Integer