node-mysql-query-utils/dist/src/table-model/index.d.ts

A simple MySQL query utils for Node.js

import { SQLBuilder } from "../../dto/sql-builder-class";
import { InsertOptions, LimitOffset, OrderByField, Prettify, QueryAction, UpdateOptions, WhereCondition, SoftDeleteOptions, FieldAlias, PatchOptions, TableModelConstructor, SelectFields, InsertValue, UpdateValue } from "../../dto/types";
import type { ResultSetHeader, RowDataPacket } from "mysql2";
export declare class TableModel<ColumnKeys extends string, PrimaryKey extends ColumnKeys> {
    tableName: string;
    tableAlias?: string;
    primaryKey: PrimaryKey;
    columns: ColumnKeys[];
    private centralFields;
    private queryFn?;
    constructor(config: TableModelConstructor<ColumnKeys[], PrimaryKey>);
    private checkConfig;
    private checkEmptyObject;
    private throwEmptyObjectError;
    private throwEmptyArrayError;
    private printPrefixMessage;
    private removeExtraFieldsAndLog;
    initSQLBuilder<T extends ColumnKeys, QueryReturnType = any>(): SQLBuilder<T, QueryReturnType>;
    createWhereCondition(): WhereCondition<ColumnKeys>;
    createOrderbyObject(defaultValues: OrderByField<ColumnKeys>): OrderByField<ColumnKeys>;
    createOrderByArray(): OrderByField<ColumnKeys>[];
    createSelect(): (values?: {
        fields?: SelectFields<ColumnKeys>;
    }) => import("../../dto/types").FromQueryBuilder<ColumnKeys, RowDataPacket[]>;
    createUpdate(options?: UpdateOptions): (values: {
        data: Omit<UpdateValue<ColumnKeys>, PrimaryKey>;
        where: WhereCondition<ColumnKeys>;
    }) => import("../../dto/types").WhereQueryBuilder<ColumnKeys, ResultSetHeader>;
    createInsert(options?: InsertOptions): (data: InsertValue<ColumnKeys>) => import("../../dto/types").InsertQueryBuilder<ResultSetHeader>;
    createDelete(): (values: {
        where: WhereCondition<ColumnKeys>;
    }) => import("../../dto/types").WhereQueryBuilder<ColumnKeys, ResultSetHeader>;
    createCount(): (field?: ColumnKeys | (string & {}) | "*", alias?: string) => import("../../dto/types").FromQueryBuilder<ColumnKeys, RowDataPacket[]>;
    findOne(values: {
        fields?: ColumnKeys | string & {} | (ColumnKeys | FieldAlias<ColumnKeys>)[];
        where: WhereCondition<ColumnKeys>;
        orderBy?: OrderByField<ColumnKeys>[];
    }): import("../../dto/types").LimitQueryBuilder<{ [key in (string & {}) | ColumnKeys]?: any; }[]>;
    findAll(values?: Prettify<{
        fields?: ColumnKeys | string & {} | (ColumnKeys | FieldAlias<ColumnKeys>)[];
        where?: WhereCondition<ColumnKeys>;
        orderBy?: OrderByField<ColumnKeys>[];
    } & LimitOffset>): import("../../dto/types").OffsetQueryBuilder<RowDataPacket[]>;
    updateOne(values: Prettify<{
        data: Omit<UpdateValue<ColumnKeys>, PrimaryKey>;
        where: WhereCondition<ColumnKeys>;
        options?: UpdateOptions;
    }>): QueryAction<ResultSetHeader>;
    updateAll(values: Prettify<{
        data: Omit<UpdateValue<ColumnKeys>, PrimaryKey>;
        where?: WhereCondition<ColumnKeys>;
        options?: UpdateOptions;
    }>): QueryAction<ResultSetHeader>;
    insertRecord(data: InsertValue<ColumnKeys>, options?: InsertOptions): import("../../dto/types").InsertQueryBuilder<ResultSetHeader>;
    removeOne(values: {
        where: WhereCondition<ColumnKeys>;
        orderBy?: OrderByField<ColumnKeys>[];
    }): QueryAction<ResultSetHeader>;
    remove(values: {
        where: WhereCondition<ColumnKeys>;
    }): QueryAction<ResultSetHeader>;
    patchSingleField<T>(values: {
        patchField: ColumnKeys;
        where: WhereCondition<ColumnKeys>;
        value: T;
        options?: PatchOptions;
    }): QueryAction<ResultSetHeader>;
    softDeleteOne<T>(values: {
        where: WhereCondition<ColumnKeys>;
        value: T;
        options?: SoftDeleteOptions;
    }): QueryAction<ResultSetHeader>;
    softDelete(values: {
        where: WhereCondition<ColumnKeys>;
        value: any;
        options?: SoftDeleteOptions;
    }): QueryAction<ResultSetHeader>;
}
//# sourceMappingURL=index.d.ts.map