Skip to content

Documentation v1.0.0


Documentation / @openassistant/duckdb / QueryDuckDBFunctionContext

Type Alias: QueryDuckDBFunctionContext

QueryDuckDBFunctionContext = object

Defined in: query.ts:84

The context of the queryDuckDB function.

Properties

config

config: object

Defined in: query.ts:88

isDraggable?

optional isDraggable: boolean


duckDB?

optional duckDB: duckdb.AsyncDuckDB

Defined in: query.ts:86

The duckdb instance. It's optional. If not provided, the function will initialize a new duckdb instance, and create a new table using getValues.


getValues()

getValues: (datasetName, variableName) => Promise<unknown[]>

Defined in: query.ts:85

Get the values of a variable from the dataset.

Parameters

datasetName

string

variableName

string

Returns

Promise<unknown[]>


onSelected?

optional onSelected: OnSelectedCallback

Defined in: query.ts:87

The callback function can be used to sync the selections of the query result table with the original dataset. See OnSelectedCallback for more details.

Released under the MIT License.