q
builder as views. A small local input can join one Snowflake statement only
when its disclosure rule admits upload. A cross-warehouse join, or local input
to Databricks, requires every input to disclose its bounded rows to isolated
compute. The host does not retain those rows as local tables. Unsupported
expressions refuse before fetching input rows.
Type parameters
Methods
reserve
▸ reserve():Promise<AnswerReservation<Record<string, Value>>>
Reserve one expiring answer identity. No source work or discovery runs.
Returns
Promise<AnswerReservation<Record<string, Value>>>
ask
▸ ask<Expr>(relation, options): Promise<AnswerState<AnswerRow<Schema, Expr>, AnswerKind>>
Freeze the selected plan and inputs in private custody, then execute
through the native scheduler. Retention requires explicit disclosure.
Type parameters
Parameters
Returns
Promise<AnswerState<AnswerRow<Schema, Expr>, AnswerKind>>
get
▸ get<Row>(answer_id, request?): Promise<AnswerState<Row, AnswerKind>>
Type parameters
Parameters
Returns
Promise<AnswerState<Row, AnswerKind>>
page
▸ page<Row>(answer_id, options?): Promise<AnswerPage<Row, AnswerKind>>
Type parameters
Parameters
Returns
Promise<AnswerPage<Row, AnswerKind>>
facets
▸ facets<Row>(answer_id, fields): Promise<AnswerFacets<Row>>
Distributions of a complete ready result, under its current read authority.
Type parameters
Parameters
Returns
Promise<AnswerFacets<Row>>
cancel
▸ cancel<Row>(answer_id): Promise<AnswerControl<Row>>
Requests cancellation. A provider acknowledgement is not confirmation.
Type parameters
Parameters
Returns
Promise<AnswerControl<Row>>
release
▸ release<Row>(answer_id): Promise<AnswerControl<Row>>
Drops retained result custody. Source cleanup keeps its independent owner.
Type parameters
Parameters
Returns
Promise<AnswerControl<Row>>
keep
▸ keep<Row>(answer_id, options): Promise<AnswerFile>
Keep a ready result: the engine writes its complete rows as one CSV
file of columns (exactly the answer’s columns, values of the declared
types), attests the execution that produced it, and grants holder (an
installed component such as components.datasets, or this component)
custody of the file under key until its work settles, with renewable
delivery leases of at most 24 hours, in one commit. from names every
source this program permits keeping. Requires
the caller’s current read of the result and its sources’ consent to the
holder’s custody. A key holds one kept answer: repeating the same keep
returns it. The execution itself is unchanged.
Type parameters
Parameters
Returns
Promise<AnswerFile>
explain
▸ explain<Expr>(relation, options?): Promise<AnswerExplanation>
Type parameters
Parameters
Returns
Promise<AnswerExplanation>
collect
▸ collect<Expr>(relation, options?): Promise<AnswerCollection<AnswerRow<Schema, Expr>>>
Ask once and return the complete answer; nothing is retained.
Type parameters
Parameters
Returns
Promise<AnswerCollection<AnswerRow<Schema, Expr>>>