prorm API Reference
    Preparing search index...

    Interface VacuumOptions

    Options shared by the operations that can target one table or all of them.

    interface VacuumOptions {
        verbose?: boolean;
        full?: boolean;
        analyze?: boolean;
        into?: string;
    }

    Hierarchy (View Summary)

    Index
    verbose? full? analyze? into?
    verbose?: boolean

    Print per-table progress where the engine supports it.

    full?: boolean

    Rewrite the table completely, returning space to the operating system.

    PostgreSQL takes an ACCESS EXCLUSIVE lock for the duration — the table is unreadable while it runs. Plain VACUUM reclaims space for reuse within the table and does not block reads.

    analyze?: boolean

    Refresh statistics in the same pass.

    into?: string

    Write a compacted copy to this path instead. SQLite only (VACUUM INTO).

    Settings
    Member Visibility

    On This Page
    Properties