Documentation
¶
Overview ¶
Package internal implements the workflow-plugin-migrations plugin. It provides database.migrations and database.migration_driver module types, plus step.migrate_up, step.migrate_down, step.migrate_status, step.migrate_to step types. Drivers: golang-migrate, goose.
Index ¶
- Variables
- func NewPlugin() sdk.PluginProvider
- type MigrationsPlugin
- func (p *MigrationsPlugin) CreateModule(typeName, name string, cfg map[string]any) (sdk.ModuleInstance, error)
- func (p *MigrationsPlugin) CreateStep(typeName, name string, cfg map[string]any) (sdk.StepInstance, error)
- func (p *MigrationsPlugin) Manifest() sdk.PluginManifest
- func (p *MigrationsPlugin) ModuleTypes() []string
- func (p *MigrationsPlugin) StepTypes() []string
Constants ¶
This section is empty.
Variables ¶
View Source
var Version = "0.0.0"
Version is set at build time via -ldflags.
Functions ¶
Types ¶
type MigrationsPlugin ¶
type MigrationsPlugin struct{}
MigrationsPlugin implements sdk.PluginProvider, sdk.ModuleProvider, and sdk.StepProvider.
func (*MigrationsPlugin) CreateModule ¶
func (p *MigrationsPlugin) CreateModule(typeName, name string, cfg map[string]any) (sdk.ModuleInstance, error)
CreateModule creates a module instance of the given type.
func (*MigrationsPlugin) CreateStep ¶
func (p *MigrationsPlugin) CreateStep(typeName, name string, cfg map[string]any) (sdk.StepInstance, error)
CreateStep creates a step instance of the given type.
func (*MigrationsPlugin) Manifest ¶
func (p *MigrationsPlugin) Manifest() sdk.PluginManifest
Manifest returns plugin metadata.
func (*MigrationsPlugin) ModuleTypes ¶
func (p *MigrationsPlugin) ModuleTypes() []string
ModuleTypes returns module type names this plugin provides.
func (*MigrationsPlugin) StepTypes ¶
func (p *MigrationsPlugin) StepTypes() []string
StepTypes returns step type names this plugin provides.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package atlas provides a MigrationDriver backed by ariga.io/atlas v1.
|
Package atlas provides a MigrationDriver backed by ariga.io/atlas v1. |
|
Package atlasplugin provides the Atlas migration driver plugin.
|
Package atlasplugin provides the Atlas migration driver plugin. |
|
Package golangmigrate provides a MigrationDriver backed by golang-migrate/migrate/v4.
|
Package golangmigrate provides a MigrationDriver backed by golang-migrate/migrate/v4. |
|
Package goose provides a MigrationDriver backed by pressly/goose/v3.
|
Package goose provides a MigrationDriver backed by pressly/goose/v3. |
|
Package steps provides pipeline step implementations for database migrations.
|
Package steps provides pipeline step implementations for database migrations. |
Click to show internal directories.
Click to hide internal directories.