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

    Interface Transport

    interface Transport {
        chat(params: AskParams): AsyncIterable<ChatEvent>;
        execute(
            sql: string,
            opts?: ExecuteOptions & {
                collection?: string;
                connectionId?: string;
                question?: string;
            },
        ): Promise<ResultSet>;
        explain(sql: string, connectionId?: string): Promise<string>;
        explainSchema(
            question: string,
            connectionId?: string,
            context?: readonly { question: string; sql: string }[],
            signal?: AbortSignal,
        ): Promise<SchemaAnswer>;
        listConnections(): Promise<ConnectionSummary[]>;
        schema(connectionId?: string, refresh?: boolean): Promise<SchemaCatalog>;
    }

    Implemented by

    Index
    • Parameters

      • sql: string
      • Optionalopts: ExecuteOptions & {
            collection?: string;
            connectionId?: string;
            question?: string;
        }

      Returns Promise<ResultSet>

    • Parameters

      • sql: string
      • OptionalconnectionId: string

      Returns Promise<string>

    • Grounded plain-language answer about the schema (never runs a query).

      Parameters

      • question: string
      • OptionalconnectionId: string
      • Optionalcontext: readonly { question: string; sql: string }[]
      • Optionalsignal: AbortSignal

      Returns Promise<SchemaAnswer>