prorm API Reference
    Preparing search index...

    Interface ProcedureOptions

    interface ProcedureOptions {
        name?: string;
        params?: ProcedureParam[];
        body?: string;
        dialect?: "mysql" | "mariadb" | "postgres" | "sqlite";
        schema?: string;
        replace?: boolean;
    }
    Index
    name? params? body? dialect? schema? replace?
    name?: string

    The name of the stored procedure in the database. Defaults to the method name if not provided.

    params?: ProcedureParam[]

    Input/output parameters

    Optionalbody

    body?: string

    The SQL body of the procedure (everything inside BEGIN...END or $$...$$). If omitted, the generated DDL will have an empty body placeholder.

    dialect?: "mysql" | "mariadb" | "postgres" | "sqlite"

    Target dialect. Controls the DDL syntax that is generated. One of: 'mysql' | 'mariadb' | 'postgres' | 'sqlite' Defaults to 'mysql'.

    schema?: string

    Optional schema prefix, e.g. 'public'

    replace?: boolean

    If true, generates CREATE OR REPLACE PROCEDURE (Postgres) or DROP PROCEDURE IF EXISTS + CREATE PROCEDURE (MySQL). Default: false.

    Settings
    Member Visibility

    On This Page
    Properties