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

    Interface UseAskSqlResult

    interface UseAskSqlResult {
        busy: boolean;
        turns: readonly Turn[];
        ask(question: string): Promise<void>;
        cancel(): void;
        editSql(turnId: string, sql: string): void;
        planFor(turnId: string): Promise<void>;
        reset(): void;
        run(turnId: string): Promise<void>;
    }
    Index
    busy: boolean
    turns: readonly Turn[]
    • Replace a turn's SQL (manual edit) - re-guarded on run.

      Parameters

      • turnId: string
      • sql: string

      Returns void

    • Fetch the query plan (EXPLAIN) for a turn's SQL.

      Parameters

      • turnId: string

      Returns Promise<void>