Skip to main content

@terascope/data-mate / adapters/teal-frame-adapter

adapters/teal-frame-adapter

Interfaces​

InterfaceDescription
TealFrameAdapterOptions-
TealFrameAdapterResult-

Functions​

tealFrameAdapter()​

tealFrameAdapter<T>(fnDef, options): Promise<TealFrameAdapterResult>

Defined in: data-mate/src/adapters/teal-frame-adapter/index.ts:78

Applies a FunctionDefinitionConfig to a DuckDB column; the DuckDB counterpart of dataFrameAdapter.

The function configs define each function's name, aliases, arguments, accepted types, output_type and implementation. This adapter reuses them instead of restating any of it, so both frames behave the same.

The behavior mirrors dataFrameAdapter. Keep the two in sync.

Type Parameters​

Type ParameterDefault type
T extends Record<string, any>Record<string, unknown>

Parameters​

ParameterType
fnDefFunctionDefinitionConfig<T>
optionsTealFrameAdapterOptions<T>

Returns​

Promise<TealFrameAdapterResult>