AskSQL API Reference (core v0.10.0)
    Preparing search index...

    Interface GuardVerdict

    interface GuardVerdict {
        allowed: boolean;
        autoLimited: boolean;
        loweredLimit: boolean;
        reason?: string;
        ruleId?: string;
        sql: string;
        tables?: readonly string[];
        warnings: readonly string[];
    }
    Index
    allowed autoLimited loweredLimit reason? ruleId? sql tables? warnings
    allowed: boolean
    autoLimited: boolean
    loweredLimit: boolean
    reason?: string

    Plain-language reason for the user.

    ruleId?: string

    Stable machine reason, e.g. 'statement_not_allowed:delete'.

    sql: string

    Possibly rewritten SQL (auto-LIMIT). Only meaningful when allowed.

    tables?: readonly string[]

    Base relations referenced by the allowed statement, in node-sql-parser type::schema::table form.

    warnings: readonly string[]

    Settings
    Member Visibility

    On This Page
    Properties