mysql-all-in-one/QueryBuilder/update/types.d.ts

A package that allows you to have a complete interaction with a MYSQL database, allowing to connect to the database, retrieve data and create queries.

import { SelectOrder } from '../select/order/type';
import { SqlValues } from '../types';
export declare const isUpdateValues: (val: any) => val is UpdateValues;
export interface UpdateValues {
    [key: string]: SqlValues | undefined | Record<string, any>;
}
export declare const defaultUpdateOptions: UpdateOptions;
export interface UpdateOptions {
    /**
     * @description Adds IGNORE modifier if true
     * @default false
     */
    ignore?: boolean;
    /**
     * @description Adds ORDER BY modifier if true
     */
    order?: SelectOrder;
    /**
     * @description Adds LIMIT modifier if true
     */
    limit?: number;
    /**
     * @description Returns a PreparedStament object if true
     * @default false
     * @example ({
     * statement: UPDATE `table` SET name = ? WHERE id = ? OR name LIKE ?",
     * values: ["Anne", 3, "John"]
     * })
     */
    returnPreparedStatement?: boolean;
}