Class: MosaicDBCoordinator
The MosaicDBCoordinator class serves as a coordinator between a internal or remote DuckDB instance and the Mosaic.
It abstracts the connection and query execution process, offering table indexing and results caching.
Note: This class wraps the Mosaic Coordinator to handle type incompatibility between apache-arrow v17 (required by DuckDB) and @uwdata/flechette (used by Mosaic 0.20+).
Param
The connector used to interface with the DuckDB instance.
Param
An optional internal DuckDB instance for WASM-based operations.
Constructors
Constructor
new MosaicDBCoordinator(
connector,internalInstance?):MosaicDBCoordinator
Parameters
| Parameter | Type |
|---|---|
connector | RestConnector | DuckDBWASMConnector |
internalInstance? | DuckDBInstance |
Returns
MosaicDBCoordinator
Accessors
internalDB
Get Signature
get internalDB():
undefined|DuckDBInstance
Returns
undefined | DuckDBInstance
Methods
create()
staticcreate(connection?):Promise<undefined|MosaicDBCoordinator>
Static method to create a new MosaicDBCoordinator.
Parameters
| Parameter | Type | Description |
|---|---|---|
connection? | string | WasmDuckDBConnection | The connection string for a remote HTTP rest DuckDB instance or an existing WasmDuckDBConnection. |
Returns
Promise<undefined | MosaicDBCoordinator>
A promise that resolves to a new MosaicDBCoordinator instance. If no connection is provided, a internal instance of duckdb-wasm will be created.
connect()
connect(
client):void
Parameters
| Parameter | Type |
|---|---|
client | MosaicClient |
Returns
void
disconnect()
disconnect(
client):void
Parameters
| Parameter | Type |
|---|---|
client | MosaicClient |
Returns
void
clearCache()
clearCache():
void
Returns
void
destroy()
destroy():
Promise<void>
Returns
Promise<void>
query()
query(
query,options):QueryResult<Table<any>>
Parameters
| Parameter | Type |
|---|---|
query | string | Query |
options | {[k: string]: unknown; cache?: boolean; } |
options.cache? | boolean |
Returns
QueryResult<Table<any>>