Interface AskSqlEngine

connectors

Readonlyhistory

Readonlypolicy

ask

• ask(question: string, opts?: AskOptions): Promise<AskResult>

  Parameters

  • question: string
  • Optionalopts: AskOptions

  Returns Promise<AskResult>

catalog

• catalog(connectionId?: string, opts?: CatalogOptions): Promise<SchemaCatalog>

  Parameters

  • OptionalconnectionId: string
  • Optionalopts: CatalogOptions

  Returns Promise<SchemaCatalog>

close

• close(): Promise<void>

  Returns Promise<void>

execute

• execute(sql: string, opts?: ExecuteEngineOptions): Promise<ResultSet>

  Parameters

  • sql: string
  • Optionalopts: ExecuteEngineOptions

  Returns Promise<ResultSet>

explain

• explain(sql: string, opts?: ExplainOptions): Promise<string>

  Parameters

  • sql: string
  • Optionalopts: ExplainOptions

  Returns Promise<string>

explainSchema

• explainSchema(
      question: string,
      opts?: ExplainSchemaOptions,
  ): Promise<SchemaAnswer>

  Answer a natural-language question about the schema in prose, grounded in the catalog. Explains structure only, never data values. grounded is false if the answer named identifiers absent from the schema.

  Parameters

  • question: string
  • Optionalopts: ExplainSchemaOptions

  Returns Promise<SchemaAnswer>

recordFeedback

• recordFeedback(
      question: string,
      sql: string,
      opts?: { connectionId?: string; userId?: string },
  ): Promise<void>

  Record an approved question->SQL pair for the few-shot loop; a no-op without a fewShots store.

  Parameters

  • question: string
  • sql: string
  • Optionalopts: { connectionId?: string; userId?: string }

  Returns Promise<void>

suggestFix

• suggestFix(failedSql: string, opts?: SuggestFixOptions): Promise<string | null>

  Given a SQL statement the database rejected, ask the model for a corrected one. Returns the guarded corrected SQL, or null. Never runs the query.

  Parameters

  • failedSql: string
  • Optionalopts: SuggestFixOptions

  Returns Promise<string | null>