Docs

Plugins

Connector plugin management and transformer plugin definitions.


Plugin Manager  

type: PluginManager

PluginManager manages the configured plugins, grouped by category.

PropertyTypeRequiredDescription
sourcePlugin []NoList of configured source plugins.
List of configured source plugins.
targetPlugin []NoList of configured target plugins.
List of configured target plugins.
transformerPlugin []NoList of configured transformer plugins.
List of configured transformer plugins.

Plugin  

type: Plugin

Plugin defines an Amfelt plugin configuration.

Example

plugin: postgres
version: 1.2.3
registry: local
PropertyTypeRequiredDescription
addressstringNoAddress is the network address (host:port) of the plugin’s gRPC server. Only used when Registry is “grpc”.
Address is the network address (host:port) of the plugin’s gRPC server. Only used when Registry is “grpc”.
insecurebooleanNoInsecure disables TLS for the gRPC connection to this plugin. Only used when Registry is “grpc”. Default: false (TLS required).
Insecure disables TLS for the gRPC connection to this plugin. Only used when Registry is “grpc”. Default: false (TLS required).
pathstringNoPath of the plugin relative to the project’s Amfelt directory.
Path of the plugin relative to the project’s Amfelt directory.
pluginstringYesName of the plugin.
Name of the plugin.
registrystringNoPlugin registry to use.
Plugin registry to use.
versionstringNoSemantic version of the plugin.
Semantic version of the plugin.

Transformer  

type: Transformer

A transformer plugin and the jobs it runs after data has landed in a target.

PropertyTypeRequiredDescription
jobsTransformerJob []YesJobs lists the transformation jobs this transformer runs.
Jobs lists the transformation jobs this transformer runs.
pluginstringYesPlugin is the name of the transformer plugin used to run these jobs (e.g. “dbt”). Must match a plugin configured in Plugins.Transformer.
Plugin is the name of the transformer plugin used to run these jobs (e.g. “dbt”). Must match a plugin configured in Plugins.Transformer.

Transformer Job  

type: TransformerJob

One transformation job: which source and target objects it transforms between, and how objects are selected.

PropertyTypeRequiredDescription
namestringYesName identifies this transformer job within its transformer’s Jobs list.
Name identifies this transformer job within its transformer’s Jobs list.
selectSelectNoSelect is the glob-based object selection this transformer job operates over.
Select is the glob-based object selection this transformer job operates over.
sourcestringYesSource is the name of the source this transformer job reads from. Must match the name of an entry in the project’s sources list.
Source is the name of the source this transformer job reads from. Must match the name of an entry in the project’s sources list.
targetstringYesTarget is the name of the target this transformer job writes to. Must match the name of an entry in the project’s targets list.
Target is the name of the target this transformer job writes to. Must match the name of an entry in the project’s targets list.

Last updated on November 1, 2026