Function update

  • update<
        T extends ObjectAny,
        Data extends Record<string, unknown>,
        V extends Record<string, unknown>,
    >(
        conn: PoolClient,
        table: string,
        where: { [K in string | number | symbol]: T[K] },
        data: Data,
    ): Promise<V>

    Run an update query on the database.

    Type Parameters

    • T extends ObjectAny
    • Data extends Record<string, unknown>
    • V extends Record<string, unknown>

    Parameters

    • conn: PoolClient

      The connection to the database

    • table: string

      The table to update

    • where: { [K in string | number | symbol]: T[K] }

      The where clause

    • data: Data

      The data to update

    Returns Promise<V>

    The updated row

    Example

    using conn = await pool.connect();
    const res = await update(conn, "users", { id: 1 }, { name: "John Doe" });

    Throws

    • If for some reason the query fails and the row does not exist

Settings

Member Visibility