tspace-mysql/dist/lib/core/StoredProcedure.d.ts

Tspace MySQL is a promise-based ORM for Node.js, designed with modern TypeScript and providing type safety for schema databases.

import type { TStoreProcedure } from "../types";
/**
 *
 * 'StoredProcedure' is a predefined set of SQL statements stored in the database that you can call (execute) by name.
 * @generic {Type} TS
 * @generic {Type} TR
 * @example
    import { StoredProcedure } from 'tspace-mysql'

    type T = {
        AddUser: {
            params: {
                name : string;
                email: string;
            } | [string,string];
            result: {
                fieldCount: number;
                affectedRows: number;
                insertId: number;
                info: string;
                serverStatus: number;
                warningStatus: number;
                changedRows: number;
            }
        };
        GetUser: {
            params: [number];
            result: any[]
        },
        GetUsers: {
            params: [];
            result: any[]
        }
    };

    class MyStore extends StoredProcedure<T> {
        protected boot(): void {

            this.createProcedure({
                name: 'AddUser',
                expression: `
                    CREATE PROCEDURE AddUser(IN name VARCHAR(255), IN email VARCHAR(255))
                    BEGIN
                    INSERT INTO users (name, email) VALUES (name, email);
                    END;
                `,
                synchronize: true
            });

            this.createProcedure({
                name: 'GetUsers',
                expression: `
                    CREATE PROCEDURE GetUsers()
                    BEGIN
                    SELECT * FROM users LIMIT 5;
                    END;
                `,
                synchronize: true
            });

            this.createProcedure({
                name: 'GetUser',
                expression: `
                    CREATE PROCEDURE GetUser(IN userId INT)
                    BEGIN
                    SELECT * FROM users WHERE id = userId LIMIT 1;
                    END;
                `,
                synchronize: true
            })
        }
    }

    const storeProcedure = new MyStoredProcedure()

    storeProcedure.call('AddUser', { name : 'tspace-mysql' , email : 'tspace-mysql@example.com'})
    .then(r => console.log(r))
    .catch(e => console.log(e))

    storeProcedure.call('GetUser',[1])
    .then(r => console.log(r))
    .catch(e => console.log(e))

    storeProcedure.call('GetUsers',[])
    .then(r => console.log(r))
    .catch(e => console.log(e))
 */
declare class StoredProcedure<T extends Record<string, TStoreProcedure>> {
    private APPLY_STORED;
    constructor();
    /**
     * The 'boot' method is a special method that you can define within a store procedure.
     * @returns {void} void
     */
    protected boot(): void;
    /**
     * The 'createProcedure' method is used create store procedure.
     *
     * @param    {object}   object { name, expression, synchronize }
     * @property {string?}  object.name
     * @property {string}   object.expression
     * @property {boolean}  object.synchronize
     * @returns  {void}
     */
    protected createProcedure({ name, expression, synchronize }: {
        name: keyof T & string;
        expression: string;
        synchronize?: boolean;
    }): void;
    /**
     * The 'call' method is used create store procedure.
     *
     * @param    {string}       name
     * @param    {object|array} params
     * @returns  {Promise<any>}
     */
    call<K extends keyof T>(name: K, params: T[K]['params']): Promise<T[K]['result']>;
}
export { StoredProcedure };
export default StoredProcedure;