Class SQLFragment<TFields>

constructor

• new SQLFragment<TFields extends Record<string, any>>(
      sql: string,
      bindings: readonly SQLBinding<TFields>[],
  ): SQLFragment<TFields>

  Type Parameters

  • TFields extends Record<string, any>

  Parameters

  • sql: string
  • bindings: readonly SQLBinding<TFields>[]

  Returns SQLFragment<TFields>

Readonlybindings

Readonlysql

append

• append(other: SQLFragment<TFields>): SQLFragment<TFields>

  Combine SQL fragments

  Parameters

  • other: SQLFragment<TFields>

  Returns SQLFragment<TFields>

getDebugString

• getDebugString(): string

  Get a debug representation of the query with values inline WARNING: This is for debugging only. Never execute the returned string directly.

  Returns string

getKnexBindings

• getKnexBindings(
      getColumnForField: (fieldName: keyof TFields) => string,
  ): readonly RawBinding[]

  Get bindings in the format expected by Knex. Knex expects a flat array where both identifiers and values are mixed in order.

  Parameters

  • getColumnForField: (fieldName: keyof TFields) => string

    function that resolves an entity field name to its database column name

  Returns readonly RawBinding[]

Staticconcat

• concat<TFields extends Record<string, any>>(
      ...fragments: readonly SQLFragment<TFields>[],
  ): SQLFragment<TFields>

  Concatenate multiple SQL fragments with space separator. Useful for combining SQL clauses like WHERE, ORDER BY, etc.

  Type Parameters

  • TFields extends Record<string, any>

  Parameters

  • ...fragments: readonly SQLFragment<TFields>[]

  Returns SQLFragment<TFields>

  Example

  const where = sql`WHERE age > ${18}`;
  const orderBy = sql`ORDER BY name`;
  const query = SQLFragment.concat(sql`SELECT * FROM users`, where, orderBy);
  // Generates: "SELECT * FROM users WHERE age > ? ORDER BY name"
  Copy

StaticjoinWithCommaSeparator

• joinWithCommaSeparator<TFields extends Record<string, any>>(
      ...fragments: readonly SQLFragment<TFields>[],
  ): SQLFragment<TFields>

  Join multiple SQL fragments with a comma separator. Useful for combining column lists, value lists, etc.

  Type Parameters

  • TFields extends Record<string, any>

  Parameters

  • ...fragments: readonly SQLFragment<TFields>[]

    Array of SQL fragments to join

  Returns SQLFragment<TFields>

  • A new SQLFragment with the fragments joined by a comma and space