AskSQL API Reference (core v0.10.0)
GitHub
Preparing search index...
@asksql/react
Transport
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
HttpTransport
LocalTransport
Index
Methods
chat
execute
explain
explain
Schema
list
Connections
schema
Methods
chat
chat
(
params
:
AskParams
)
:
AsyncIterable
<
ChatEvent
>
Parameters
params
:
AskParams
Returns
AsyncIterable
<
ChatEvent
>
execute
execute
(
sql
:
string
,
opts
?:
ExecuteOptions
&
{
collection
?:
string
;
connectionId
?:
string
;
question
?:
string
;
}
,
)
:
Promise
<
ResultSet
>
Parameters
sql
:
string
Optional
opts
:
ExecuteOptions
&
{
collection
?:
string
;
connectionId
?:
string
;
question
?:
string
;
}
Returns
Promise
<
ResultSet
>
explain
explain
(
sql
:
string
,
connectionId
?:
string
)
:
Promise
<
string
>
Parameters
sql
:
string
Optional
connectionId
:
string
Returns
Promise
<
string
>
explain
Schema
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
Optional
connectionId
:
string
Optional
context
:
readonly
{
question
:
string
;
sql
:
string
}
[]
Optional
signal
:
AbortSignal
Returns
Promise
<
SchemaAnswer
>
list
Connections
listConnections
()
:
Promise
<
ConnectionSummary
[]
>
Returns
Promise
<
ConnectionSummary
[]
>
schema
schema
(
connectionId
?:
string
,
refresh
?:
boolean
)
:
Promise
<
SchemaCatalog
>
Parameters
Optional
connectionId
:
string
Optional
refresh
:
boolean
Returns
Promise
<
SchemaCatalog
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
chat
execute
explain
explain
Schema
list
Connections
schema
GitHub
AskSQL API Reference (core v0.10.0)
Loading...
Grounded plain-language answer about the schema (never runs a query).