Module org.mybatis.dynamic.sql

Package org.mybatis.dynamic.sql.delete

Class DeleteDSL<R>

java.lang.Object

org.mybatis.dynamic.sql.delete.DeleteDSL<R>

All Implemented Interfaces:

Buildable<R>

public class DeleteDSL<R>
extends Object
implements Buildable<R>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DeleteDSL.DeleteWhereBuilder

Method Summary

Modifier and Type	Method	Description
DeleteDSL.DeleteWhereBuilder	applyWhere(WhereApplier whereApplier)
R	build()	WARNING! Calling this method could result in an delete statement that deletes all rows in a table.
static <R> DeleteDSL<R>	deleteFrom(Function<DeleteModel,R> adapterFunction, SqlTable table)
static DeleteDSL<DeleteModel>	deleteFrom(SqlTable table)
static <T> DeleteDSL<MyBatis3DeleteModelAdapter<T>>	deleteFromWithMapper(Function<DeleteStatementProvider,T> mapperMethod, SqlTable table)	Deprecated. in favor of MyBatis3Utils.deleteFrom(ToIntFunction, SqlTable, DeleteDSLCompleter).
DeleteDSL.DeleteWhereBuilder	where()
<T> DeleteDSL.DeleteWhereBuilder	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

where

public DeleteDSL.DeleteWhereBuilder where()

where

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

applyWhere

public DeleteDSL.DeleteWhereBuilder applyWhere(WhereApplier whereApplier)

build

@NotNull
public R build()

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

Specified by:

build in interface Buildable<R>

Returns:

the model class

deleteFrom

public static <R> DeleteDSL<R> deleteFrom(Function<DeleteModel,R> adapterFunction,
                                          SqlTable table)

deleteFrom

public static DeleteDSL<DeleteModel> deleteFrom(SqlTable table)

deleteFromWithMapper

@Deprecated
public static <T> DeleteDSL<MyBatis3DeleteModelAdapter<T>> deleteFromWithMapper(Function<DeleteStatementProvider,T> mapperMethod,
                                                                                SqlTable table)

Deprecated.

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

Delete record(s) by executing a MyBatis3 mapper method.

Type Parameters:

T - return value from a delete method - typically Integer

Parameters:

mapperMethod - MyBatis3 mapper method that performs the delete

table - table to delete from

Returns:

number of records deleted - typically as Integer