Variable ViewRegistryConst

Type Declaration

• getSQL: function

  • getSQL(
        target: Function,
        dialectOverride?: "mysql" | "mariadb" | "postgres" | "sqlite" | Dialect,
    ): string

    Generate the CREATE VIEW SQL for a

    Parameters

    • target: Function
    • OptionaldialectOverride: "mysql" | "mariadb" | "postgres" | "sqlite" | Dialect

      Either a dialect name, or a live Dialect. A definition-based view needs the instance, since only a real dialect can compile the SELECT; a name alone is enough for query/queryFn.

    Returns string

    View-annotated

    class.

• createView: function

  • createView(
        prorm: Prorm,
        target: Function,
        dialectOverride?: "mysql" | "mariadb" | "postgres" | "sqlite" | Dialect,
    ): Promise<void>

    Execute the CREATE VIEW statement for a

    Parameters

    • prorm: Prorm
    • target: Function
    • OptionaldialectOverride: "mysql" | "mariadb" | "postgres" | "sqlite" | Dialect

    Returns Promise<void>

    View-annotated

    model class.

    The dialect is taken from prorm, so a view declared with definition compiles for whichever database the instance is connected to.

• dropView: function

  • dropView(prorm: Prorm, target: Function, ifExists?: boolean): Promise<void>

    Drop the view for a

    Parameters

    • prorm: Prorm
    • target: Function
    • ifExists: boolean = true

      Emit IF EXISTS (default: true)

    Returns Promise<void>

    View-annotated

    class.