Documentation
¶
Overview ¶
Package atlas provides a MigrationDriver backed by ariga.io/atlas v1. Atlas uses versioned SQL migration files with an atlas.sum integrity file. If atlas.sum is absent the driver auto-generates it so users don't need the Atlas CLI installed for basic up/down/status operations.
Index ¶
- type Driver
- func (d *Driver) Down(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
- func (d *Driver) Goto(ctx context.Context, req interfaces.MigrationRequest, target string) (interfaces.MigrationResult, error)
- func (d *Driver) Name() string
- func (d *Driver) Status(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationStatus, error)
- func (d *Driver) Up(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Driver ¶
type Driver struct{}
Driver implements interfaces.MigrationDriver using ariga.io/atlas.
func (*Driver) Down ¶
func (d *Driver) Down(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
Down rolls back N migrations (Options.Steps, default 1). Atlas versioned migrations do not include rollback SQL natively; this driver looks for paired <version>_<desc>.down.sql files alongside the up migration files.
func (*Driver) Goto ¶
func (d *Driver) Goto(ctx context.Context, req interfaces.MigrationRequest, target string) (interfaces.MigrationResult, error)
Goto migrates to the specified version (up or down as needed).
func (*Driver) Status ¶
func (d *Driver) Status(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationStatus, error)
Status returns the current migration state.
func (*Driver) Up ¶
func (d *Driver) Up(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
Up applies all pending migrations.
Source Files