Class LocalTransport

Implements

Transport

Index

Constructors

Methods

chat execute explain explainSchema listConnections schema

Constructors

constructor

new LocalTransport(engine: AskSqlEngine): LocalTransport
Parameters
- engine: AskSqlEngine
Returns LocalTransport
- Defined in packages/react/src/client.ts:292

Methods

chat

chat(params: AskParams): AsyncIterable<ChatEvent>
Parameters
- params: AskParams
Returns AsyncIterable<ChatEvent>
Implementation of Transport.chat
- Defined in packages/react/src/client.ts:306

execute

execute(
    sql: string,
    opts?: ExecuteOptions & {
        collection?: string;
        connectionId?: string;
        question?: string;
    },
): Promise<ResultSet>
Parameters
- sql: string
- Optionalopts: ExecuteOptions & {
      collection?: string;
      connectionId?: string;
      question?: string;
  }
Returns Promise<ResultSet>
Implementation of Transport.execute
- Defined in packages/react/src/client.ts:361

explain

explain(sql: string, connectionId?: string): Promise<string>
Parameters
- sql: string
- OptionalconnectionId: string
Returns Promise<string>
Implementation of Transport.explain
- Defined in packages/react/src/client.ts:367

explainSchema

explainSchema(
    question: string,
    connectionId?: string,
    context?: readonly { question: string; sql: string }[],
    signal?: AbortSignal,
): Promise<SchemaAnswer>
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>
Implementation of Transport.explainSchema
- Defined in packages/react/src/client.ts:370

listConnections

listConnections(): Promise<ConnectionSummary[]>
Returns Promise<ConnectionSummary[]>
Implementation of Transport.listConnections
- Defined in packages/react/src/client.ts:294

schema

schema(connectionId?: string, refresh?: boolean): Promise<SchemaCatalog>
Parameters
- OptionalconnectionId: string
- Optionalrefresh: boolean
Returns Promise<SchemaCatalog>
Implementation of Transport.schema
- Defined in packages/react/src/client.ts:303