Class DuckDBHandler

An implementation of Perspective's Virtual Server for @duckdb/duckdb-wasm.

Implements

VirtualServerHandler

Index

Constructors

Methods

getFeatures getHostedTables tableMakeView tableSchema tableSize tableValidateExpression viewColumnSize viewDelete viewGetData viewGetMinMax

Constructors

constructor

new DuckDBHandler(db: AsyncDuckDBConnection, mod?: inline): DuckDBHandler
Parameters
- db: AsyncDuckDBConnection
- Optionalmod: inline
Returns DuckDBHandler
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:270

Methods

getFeatures

getFeatures(): Features
Defaults to no optional features.

Returns Features
Implementation of VirtualServerHandler.getFeatures
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:292

getHostedTables

getHostedTables(): Promise<string[]>
Returns Promise<string[]>
Implementation of VirtualServerHandler.getHostedTables
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:328

tableMakeView

tableMakeView(
    tableId: string,
    viewId: string,
    config: ViewConfigUpdate,
): Promise<void>
Parameters
- tableId: string
- viewId: string
- config: ViewConfigUpdate
Returns Promise<void>
Implementation of VirtualServerHandler.tableMakeView
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:369

tableSchema

tableSchema(
tableId: string,
config?: ViewConfig,
): Promise<Record<string, ColumnType>>
Parameters
- tableId: string
- Optionalconfig: ViewConfig
Returns Promise<Record<string, ColumnType>>
Implementation of VirtualServerHandler.tableSchema
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:337

tableSize

tableSize(tableId: string): Promise<number>
Parameters
- tableId: string
Returns Promise<number>
Implementation of VirtualServerHandler.tableSize
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:363

tableValidateExpression

tableValidateExpression(
tableId: string,
expression: string,
): Promise<ColumnType>
Required when getFeatures() reports expressions: true.
Parameters
- tableId: string
- expression: string
Returns Promise<ColumnType>
Implementation of VirtualServerHandler.tableValidateExpression
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:378

viewColumnSize

viewColumnSize(viewId: string, config: ViewConfig): Promise<number>
Defaults to the length of viewSchema(viewId, config).
Parameters
- viewId: string
- config: ViewConfig
Returns Promise<number>
Implementation of VirtualServerHandler.viewColumnSize
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:354

viewDelete

viewDelete(viewId: string): Promise<void>
Parameters
- viewId: string
Returns Promise<void>
Implementation of VirtualServerHandler.viewDelete
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:389

viewGetData

viewGetData(
    viewId: string,
    config: ViewConfig,
    schema: Record<string, ColumnType>,
    viewport: ViewWindow,
    dataSlice: VirtualDataSlice,
): Promise<void>
Parameters
- viewId: string
- config: ViewConfig
- schema: Record<string, ColumnType>
- viewport: ViewWindow
- dataSlice: VirtualDataSlice
Returns Promise<void>
Implementation of VirtualServerHandler.viewGetData
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:408

viewGetMinMax

viewGetMinMax(
    viewId: string,
    columnName: string,
    config: ViewConfig,
): Promise<{ max: Scalar; min: Scalar }>
Parameters
- viewId: string
- columnName: string
- config: ViewConfig
Returns Promise<{ max: Scalar; min: Scalar }>
Implementation of VirtualServerHandler.viewGetMinMax
- Defined in rust/perspective-js/src/ts/virtual_servers/duckdb.ts:394