Type Parameters:: R - The record type of the table being deleted from

All Superinterfaces:: Attachable, AttachableQueryPart, ConditionProvider, Delete<R>, DMLQuery<R>, Flow.Publisher<Integer>, Publisher<Integer>, org.reactivestreams.Publisher<Integer>, Query, QueryPart, RowCountQuery, Serializable, Statement

public interface DeleteQuery<R extends Record> extends ConditionProvider, Delete<R>

A DELETE statement (model API).

This type is the model API representation of a Delete statement, which can be mutated after creation. The advantage of this API compared to the DSL API is a more simple approach to writing dynamic SQL.

Instances can be created using DSLContext.deleteQuery(Table).

Author:: Lukas Eder

Method Summary

Modifier and Type

Method

Description

void

addConditions(Collection<? extends Condition> conditions)

Adds new conditions to the query, connecting them to existing conditions with Operator.AND.

void

addConditions(Condition condition)

Adds a new condition to the query, connecting them to existing conditions with Operator.AND.

void

addConditions(Condition... conditions)

Adds new conditions to the query, connecting them to existing conditions with Operator.AND.

void

addConditions(Operator operator, Collection<? extends Condition> conditions)

Adds new conditions to the query, connecting them to existing conditions with the provided operator.

void

addConditions(Operator operator, Condition condition)

Adds a new condition to the query, connecting them to existing conditions with the provided operator.

void

addConditions(Operator operator, Condition... conditions)

Adds new conditions to the query, connecting them to existing conditions with the provided operator.

void

addLimit(Number numberOfRows)

Limit the results of this select.

void

addLimit(Field<? extends Number> numberOfRows)

Limit the results of this select.

void

addOrderBy(Collection<? extends OrderField<?>> fields)

Adds ordering fields.

void

addOrderBy(OrderField<?>... fields)

Adds ordering fields.

void

addUsing(Collection<? extends TableLike<?>> tables)

Add tables to the USING clause.

void

addUsing(TableLike<?> table)

Add tables to the USING clause.

void

addUsing(TableLike<?>... tables)

Add tables to the USING clause.

R

getReturnedRecord()

The record holding returned values as specified by any of the setReturning() methods.

@NotNull Result<R>

getReturnedRecords()

The records holding returned values as specified by any of the setReturning() methods.

void

setReturning()

Configure the DELETE statement to return all fields in R.

void

setReturning(Collection<? extends SelectFieldOrAsterisk> fields)

Configure the DELETE statement to return a list of fields in R.

void

setReturning(SelectFieldOrAsterisk... fields)

Configure the DELETE statement to return a list of fields in R.

Methods inherited from interface org.jooq.Attachable
attach, configuration, detach

Methods inherited from interface org.jooq.AttachableQueryPart
getBindValues, getParam, getParams, getSQL, getSQL

Methods inherited from interface org.jooq.Publisher
subscribe

Methods inherited from interface org.reactivestreams.Publisher
subscribe

Methods inherited from interface org.jooq.Query
bind, bind, cancel, execute, executeAsync, executeAsync, isExecutable, keepStatement, poolable, queryTimeout

Methods inherited from interface org.jooq.QueryPart
$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details
- addUsing
  
  @Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,MARIADB,MYSQL,POSTGRES,REDSHIFT,SNOWFLAKE,SQLSERVER,SYBASE,TERADATA}) void addUsing(TableLike<?> table)
  
  Add tables to the USING clause.
- addUsing
  
  @Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,MARIADB,MYSQL,POSTGRES,REDSHIFT,SNOWFLAKE,SQLSERVER,SYBASE,TERADATA}) void addUsing(TableLike<?>... tables)
  
  Add tables to the USING clause.
- addUsing
  
  @Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,MARIADB,MYSQL,POSTGRES,REDSHIFT,SNOWFLAKE,SQLSERVER,SYBASE,TERADATA}) void addUsing(Collection<? extends TableLike<?>> tables)
  
  Add tables to the USING clause.
- addConditions
  
  @Support void addConditions(Condition condition)
  
  Description copied from interface: ConditionProvider
  
  Adds a new condition to the query, connecting them to existing conditions with Operator.AND.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  condition - The condition
- addConditions
  
  @Support void addConditions(Condition... conditions)
  
  Description copied from interface: ConditionProvider
  
  Adds new conditions to the query, connecting them to existing conditions with Operator.AND.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  conditions - The condition
- addConditions
  
  @Support void addConditions(Collection<? extends Condition> conditions)
  
  Description copied from interface: ConditionProvider
  
  Adds new conditions to the query, connecting them to existing conditions with Operator.AND.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  conditions - The condition
- addConditions
  
  @Support void addConditions(Operator operator, Condition condition)
  
  Description copied from interface: ConditionProvider
  
  Adds a new condition to the query, connecting them to existing conditions with the provided operator.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  condition - The condition
- addConditions
  
  @Support void addConditions(Operator operator, Condition... conditions)
  
  Description copied from interface: ConditionProvider
  
  Adds new conditions to the query, connecting them to existing conditions with the provided operator.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  conditions - The condition
- addConditions
  
  @Support void addConditions(Operator operator, Collection<? extends Condition> conditions)
  
  Description copied from interface: ConditionProvider
  
  Adds new conditions to the query, connecting them to existing conditions with the provided operator.
  
  Specified by:
  
  addConditions in interface ConditionProvider
  
  Parameters:
  
  conditions - The condition
- addOrderBy
  
  @Support void addOrderBy(OrderField<?>... fields)
  
  Adds ordering fields.
  
  Parameters:
  
  fields - The ordering fields
- addOrderBy
  
  @Support void addOrderBy(Collection<? extends OrderField<?>> fields)
  
  Adds ordering fields.
  
  Parameters:
  
  fields - The ordering fields
- addLimit
  
  @Support void addLimit(Number numberOfRows)
  
  Limit the results of this select.
  
  Parameters:
  
  numberOfRows - The number of rows to return
- addLimit
  
  @Support void addLimit(Field<? extends Number> numberOfRows)
  
  Limit the results of this select.
  
  Parameters:
  
  numberOfRows - The number of rows to return
- setReturning
  
  @Support({AURORA_POSTGRES,COCKROACHDB,DB2,FIREBIRD,H2_2_0_202,MARIADB_10_1,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB}) void setReturning()
  
  Configure the DELETE statement to return all fields in R.
  See Also:
  
  getReturnedRecords()
- setReturning
  
  @Support({AURORA_POSTGRES,COCKROACHDB,DB2,FIREBIRD,H2_2_0_202,MARIADB_10_1,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB}) void setReturning(SelectFieldOrAsterisk... fields)
  
  Configure the DELETE statement to return a list of fields in R.
  Parameters:
  
  fields - Fields to be returned
  
  See Also:
  
  getReturnedRecords()
- setReturning
  
  @Support({AURORA_POSTGRES,COCKROACHDB,DB2,FIREBIRD,H2_2_0_202,MARIADB_10_1,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB}) void setReturning(Collection<? extends SelectFieldOrAsterisk> fields)
  
  Configure the DELETE statement to return a list of fields in R.
  Parameters:
  
  fields - Fields to be returned
  
  See Also:
  
  getReturnedRecords()
- getReturnedRecord
  
  @Nullable @Support({AURORA_POSTGRES,COCKROACHDB,DB2,FIREBIRD,H2_2_0_202,MARIADB_10_1,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB}) R getReturnedRecord()
  The record holding returned values as specified by any of the setReturning() methods.
  If the DELETE statement returns several records, this is the same as calling getReturnedRecords().get(0)
  This implemented differently for every dialect:
  
  Firebird and Postgres have native support for DELETE … RETURNING clauses
  Returns:
  
  The returned value as specified by any of the setReturning() methods. This may return null in case jOOQ could not retrieve any generated keys from the JDBC driver.
  
  See Also:
  
  getReturnedRecords()
- getReturnedRecords
  
  @NotNull @Support({AURORA_POSTGRES,COCKROACHDB,DB2,FIREBIRD,H2_2_0_202,MARIADB_10_1,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB}) @NotNull Result<R> getReturnedRecords()
  The records holding returned values as specified by any of the setReturning() methods.
  If the DELETE statement returns several records, this is the same as calling getReturnedRecords().get(0)
  This implemented differently for every dialect:
  
  Firebird and Postgres have native support for DELETE … RETURNING clauses
  Returns:
  
  The returned values as specified by any of the setReturning() methods. Note:
  
  Not all databases / JDBC drivers support returning several values on multi-row inserts!
  This may return an empty Result in case jOOQ could not retrieve any generated keys from the JDBC driver.

Interface DeleteQuery<R extends Record>

Method Summary

Methods inherited from interface org.jooq.Attachable

Methods inherited from interface org.jooq.AttachableQueryPart

Methods inherited from interface org.jooq.Publisher

Methods inherited from interface org.reactivestreams.Publisher

Methods inherited from interface org.jooq.Query

Methods inherited from interface org.jooq.QueryPart

Method Details

addUsing

addUsing

addUsing

addConditions

addConditions

addConditions

addConditions

addConditions

addConditions

addOrderBy

addOrderBy

addLimit

addLimit

setReturning

setReturning

setReturning

getReturnedRecord

getReturnedRecords