delete

open fun Join.delete(targetTable: Table, vararg targetTables: Table, ignore: Boolean = false, limit: Int? = null, where: () -> Op<Boolean>? = null): DeleteStatement

Represents the SQL statement that deletes rows from a table in a join relation.

Return

A DeleteStatement that can be executed.

Parameters

targetTable

The specific table from this join relation to delete rows from.

targetTables

(Optional) Other tables from this join relation to delete rows from. Note Targeting multiple tables for deletion is not supported by all vendors. Please check the documentation.

ignore

Whether to ignore any possible errors that occur when deleting rows. Note ignore is not supported by all vendors. Please check the documentation.

limit

Maximum number of rows to delete. Note limit is not supported by all vendors. Please check the documentation.

where

Condition that determines which rows to delete. If left as null, all rows will be deleted.