Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Delete

A Query class that represents a DELETE query.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Optional alias

alias: string

Alias of the table to delete from. Optional and defaults to the base table.

Protected escaper

escaper: Escaper

An Escaper matching the database type (e.g. MySQLEscaper or MSSQLEscaper). Used when escaping column names in compiled conditions.

Protected executer

executer: Executer

An Executer instance that matches the database type (e.g. MySQLExecuter).

Protected from

from: From

A From instance which holds the base table, all joined-in tables, and the where clause.

Methods

buildQuery

execute

  • Execute the query.

    Returns Promise<MutateResultType>

    A promise that shall be resolved with an object containing an "affectedRows" property. If an error occurs when executing the query, the returned promise shall be rejected with the error (unmodified).

toString

  • toString(): string

Generated using TypeDoc