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

    Interface MongoGuardVerdict

    The MongoDB engine path. A non-SQL parallel to the SQL pipeline: a question becomes a read-only aggregation pipeline, validated by an allowlist guard, and run against a MongoConnector. Exported from @asksql/core under this namespace.

    interface MongoGuardVerdict {
        allowed: boolean;
        autoLimited: boolean;
        collections: readonly string[];
        loweredLimit: boolean;
        pipelineJson: string;
        reason?: string;
        ruleId?: string;
    }
    Index
    allowed autoLimited collections loweredLimit pipelineJson reason? ruleId?
    allowed: boolean
    autoLimited: boolean
    collections: readonly string[]

    Collections referenced by $lookup / $graphLookup / $unionWith, for the hallucination floor.

    loweredLimit: boolean
    pipelineJson: string

    The re-serialized, capped pipeline as a bare JSON array string. Meaningful only when allowed.

    reason?: string
    ruleId?: string

    Settings
    Member Visibility

    On This Page
    Properties