Skip to content

@sqlrooms/ai / getQuerySummary

Function: getQuerySummary() ​

getQuerySummary(connector, sqlQuery, abortSignal?): Promise<Record<string, unknown>[] | null>

Generates summary statistics for a SQL query result

Parameters ​

ParameterTypeDescription
connectorDuckDbConnectorDuckDB connection instance
sqlQuerystringSQL SELECT query to analyze
abortSignal?AbortSignal-

Returns ​

Promise<Record<string, unknown>[] | null>

Summary statistics as JSON object, or null if the query is not a SELECT statement or if summary generation fails