Documentation
¶
Overview ¶
Package atlasplugin provides the Atlas migration driver plugin. Atlas has larger dependencies (HCL toolchain) so it ships as a separate binary to keep the main workflow-plugin-migrations binary lean.
Index ¶
- Variables
- func NewPlugin() sdk.PluginProvider
- type AtlasPlugin
- func (p *AtlasPlugin) CreateModule(typeName, name string, rawCfg map[string]any) (sdk.ModuleInstance, error)
- func (p *AtlasPlugin) CreateStep(typeName, name string, _ map[string]any) (sdk.StepInstance, error)
- func (p *AtlasPlugin) Manifest() sdk.PluginManifest
- func (p *AtlasPlugin) ModuleTypes() []string
- func (p *AtlasPlugin) StepTypes() []string
Constants ¶
This section is empty.
Variables ¶
var Version = "0.0.0"
Version is set at build time via -ldflags.
Functions ¶
Types ¶
type AtlasPlugin ¶
type AtlasPlugin struct{}
AtlasPlugin implements sdk.PluginProvider for the Atlas driver.
func (*AtlasPlugin) CreateModule ¶
func (p *AtlasPlugin) CreateModule(typeName, name string, rawCfg map[string]any) (sdk.ModuleInstance, error)
CreateModule creates a module instance for the requested type. This binary ships all three drivers (golang-migrate, goose, atlas) but the atlas driver is the primary addition over the main plugin binary.
func (*AtlasPlugin) CreateStep ¶
func (p *AtlasPlugin) CreateStep(typeName, name string, _ map[string]any) (sdk.StepInstance, error)
CreateStep returns an error — use the main plugin binary for pipeline steps.
func (*AtlasPlugin) Manifest ¶
func (p *AtlasPlugin) Manifest() sdk.PluginManifest
Manifest returns plugin metadata.
func (*AtlasPlugin) ModuleTypes ¶
func (p *AtlasPlugin) ModuleTypes() []string
ModuleTypes returns the module types this plugin provides.
func (*AtlasPlugin) StepTypes ¶
func (p *AtlasPlugin) StepTypes() []string
StepTypes returns nil — steps are handled by the main plugin binary.