@terascope/data-mate / teal-frame/extension-tools

teal-frame/extension-tools

Interfaces

Interface	Description
ExtensionReport	Installs and verifies the DuckDB extensions while a Docker image is built, much as node-pre-gyp install fetches the kafka client's native binary during pnpm install.
InstallOptions	-

Functions

installExtensions()

installExtensions(options?): Promise<ExtensionReport>

Defined in: data-mate/src/teal-frame/extension-tools.ts:46

Downloads the required extensions into directory. Throws on the first failure, so the image build stops there.

It first checks that STATIC_EXTENSIONS are still compiled in, so a DuckDB upgrade that drops one fails the build rather than a machine without network access.

Parameters

Parameter	Type
options	InstallOptions

Returns

Promise<ExtensionReport>

---

verifyExtensions()

verifyExtensions(options?): Promise<ExtensionReport>

Defined in: data-mate/src/teal-frame/extension-tools.ts:73

Checks that the extensions work without network access. Opens a database as production does, with autoinstall off, and runs each extension's check. Run it in the image's runtime stage so it tests the shipped files with their real ownership and permissions.

Parameters

Parameter	Type
options	Pick<InstallOptions, "directory">

Returns

Promise<ExtensionReport>