Skip to main content

del

Delete records from a database table using the query builder.

Import​

import { del } from '@evershop/evershop/lib/postgres/query';
Typed wrapper

@evershop/evershop/lib/postgres/query is EverShop's first-party typed query builder. It wraps @evershop/postgres-query-builder and adds table/column types for every known EverShop table, so del('order') narrows .where() to that table's columns and gives you autocomplete. (A delete has no .given() — that belongs to insert and update.)

The narrowing is autocomplete, not enforcement: ColumnOf<T> falls back to (string & {}), so an unknown column name still compiles and fails only at runtime.

The raw @evershop/postgres-query-builder package is still available as an untyped lower-level fallback, but new code should import from the wrapper.

Syntax​

del<T extends AnyTableName>(table: T): TypedDeleteQuery<T>

Parameters​

table

Type: AnyTableName

The name of the table to delete from. Known EverShop tables are suggested by name; any other string is still accepted for custom tables.

Return Value​

Returns a TypedDeleteQuery<T> that can be chained with additional methods. When T is a known table, .where() only accepts that table's columns.

Examples​

Basic Delete​

import { del } from '@evershop/evershop/lib/postgres/query';
import { pool } from '@evershop/evershop/lib/postgres';

await del('customer')
  .where('customer_id', '=', 123)
  .execute(pool);

Delete with Multiple Conditions​

import { del } from '@evershop/evershop/lib/postgres/query';
import { pool } from '@evershop/evershop/lib/postgres';

// `qty` is not a `product` column — it moved to `product_inventory` in catalog 1.0.3.
// `status` and `visibility` on `product` are booleans.
await del('product')
  .where('status', '=', false)
  .and('created_at', '<', new Date('2024-01-01'))
  .execute(pool);

Delete in Transaction​

import { del, startTransaction, commit, rollback } from '@evershop/evershop/lib/postgres/query';
import { getConnection } from '@evershop/evershop/lib/postgres';

const connection = await getConnection();

try {
  await startTransaction(connection);
  
  // Delete order items first. The FK column on `order_item` is
  // `order_item_order_id`, not `order_id`.
  await del('order_item')
    .where('order_item_order_id', '=', 789)
    .execute(connection, false);
  
  // Then delete the order
  await del('order')
    .where('order_id', '=', 789)
    .execute(connection, false);
  
  await commit(connection);
} catch (error) {
  await rollback(connection);
  throw error;
}

Methods​

where(field, operator, value)​

Add a WHERE condition. Required for delete queries.

Parameters:

  • field - Column name
  • operator - Comparison operator (e.g., =, >, <, !=, IN, IS NULL)
  • value - Value to compare

Returns: Where

del('customer')
  .where('customer_id', '=', 123)

and(field, operator, value)​

Add an AND condition to the WHERE clause.

Parameters:

  • field - Column name
  • operator - Comparison operator
  • value - Value to compare

Returns: Node

del('product')
  .where('status', '=', 0)
  .and('qty', '=', 0)

orWhere(field, operator, value)​

Add an OR condition to the WHERE clause.

Parameters:

  • field - Column name
  • operator - Comparison operator
  • value - Value to compare

Returns: Node

del('log')
  .where('level', '=', 'debug')
  .orWhere('created_at', '<', new Date('2024-01-01'))

execute(connection, releaseConnection?)​

Execute the delete query.

Parameters:

  • connection - Pool or PoolClient instance
  • releaseConnection - Whether to release the connection after execution (default: true)

Returns: Promise<any[]> - Array of deleted rows

const deletedRows = await del('customer')
  .where('customer_id', '=', 123)
  .execute(pool);

Return Value Details​

The execute() method returns an array of deleted rows (empty if no rows were deleted):

const result = await del('customer')
  .where('customer_id', '=', 123)
  .execute(pool);

// result is an array (empty if nothing was deleted)
console.log(result); // []

See Also​