@terascope/data-mate / adapters/teal-frame-adapter / TealFrameAdapterOptions
Interface: TealFrameAdapterOptions<T>
Defined in: data-mate/src/adapters/teal-frame-adapter/index.ts:17
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
args? | T | Function arguments, bound once at registration. As with dataFrameAdapter's static arguments, they are constant for the whole query, so create() is called once and its closure becomes the UDF body. Per-row arguments (args: (rowIndex) => ... in dataFrameAdapter) are not supported; a row-dependent argument would have to be passed as an extra column. | data-mate/src/adapters/teal-frame-adapter/index.ts:30 |
database? | string | Database to register on. Defaults to the process-wide one. | data-mate/src/adapters/teal-frame-adapter/index.ts:32 |
field | string | The column the function applies to. | data-mate/src/adapters/teal-frame-adapter/index.ts:19 |
inputConfig | DataTypeFieldAndChildren | The column's field config at this step. | data-mate/src/adapters/teal-frame-adapter/index.ts:21 |
preferSql? | boolean | Use the function's sql definition when it has one. Defaults to true. Setting it to false forces the UDF path, so tests can compare the two paths, benchmarks can time both, and a faulty SQL definition can be bypassed without a new release. | data-mate/src/adapters/teal-frame-adapter/index.ts:39 |