Skip to main content

@terascope/data-mate / teal-frame/extensions / DuckExtension

Interface: DuckExtension

Defined in: data-mate/src/teal-frame/extensions.ts:18

The DuckDB extensions a frame needs, and how the database loads them.

DuckDB downloads extensions from extensions.duckdb.org the first time a query needs one; no npm install step fetches them. Without network access that download fails at the first query that needs the extension rather than at startup. So every database loads them up front (loadExtensions), and images install them at build time (extension-tools.ts, run from bin/duckdb-extensions.js).

parquet, json and icu are compiled into the binding (STATIC_EXTENSIONS). The four below are not. spatial does not autoload at all: without it, ST_Point is a catalog error.

Properties​

PropertyModifierTypeDescriptionDefined in
checkreadonlyreadonly string[]Statements run by verify to check that the extension actually works.data-mate/src/teal-frame/extensions.ts:23
namereadonlystring-data-mate/src/teal-frame/extensions.ts:19
reasonreadonlystringWhat breaks without it, for the error a missing one produces.data-mate/src/teal-frame/extensions.ts:21