gomigration

package module

Go to main page

Versions in this module

v1

v1.3.1

Nov 21, 2025

v1.3.0

Nov 21, 2025

Changes in this version

type Cli

+ func (c *Cli) CleanCommand(ctx context.Context) *cobra.Command

+ func (c *Cli) CreateCommand(ctx context.Context) *cobra.Command

+ func (c *Cli) ListCommand(ctx context.Context) *cobra.Command

+ func (c *Cli) MigrateCommand(ctx context.Context) *cobra.Command

+ func (c *Cli) ResetCommand(ctx context.Context) *cobra.Command

+ func (c *Cli) RollbackCommand(ctx context.Context) *cobra.Command

v1.2.0

Nov 5, 2025

Changes in this version

+ type SqliteDriver struct

+ func NewSqliteDriver(database string) (*SqliteDriver, error)

+ func (d *SqliteDriver) ApplyMigrations(ctx context.Context, migrations []Migration, ...) error

+ func (d *SqliteDriver) CleanDatabase(ctx context.Context) error

+ func (d *SqliteDriver) Close() error

+ func (d *SqliteDriver) CreateMigrationsTable(ctx context.Context) error

+ func (d *SqliteDriver) GetExecutedMigrations(ctx context.Context, reverse bool) ([]ExecutedMigration, error)

+ func (d *SqliteDriver) SetMigrationTableName(name string)

+ func (d *SqliteDriver) UnapplyMigrations(ctx context.Context, migrations []Migration, ...) error

v1.1.0

Jul 6, 2025

Changes in this version

type GoMigration

+ func (q *GoMigration) SetMigrationFilesDir(dir string) *GoMigration

v1.0.0

May 8, 2025

Changes in this version

+ var ErrConfigNotProvided = errors.New("config not provided")

+ var ErrDriverNotProvided = errors.New("driver not provided")

+ var ErrEmbeddedFSNotProvided = errors.New("embedded fs not provided")

+ var ErrGoMigrationNotProvided = errors.New("gomigration instance not provided")

+ var ErrInvalidRollbackStep = errors.New("invalid rollback step")

+ var ErrMigrationDirNotExists = errors.New("migration directory does not exist")

+ var ErrMigrationDirNotProvided = errors.New("migration directory not provided")

+ var ErrMigrationFileAlreadyExists = errors.New("migration file already exists")

+ var ErrMigrationFileNotFound = errors.New("migration file not found")

+ var ErrMigrationNameNotProvided = errors.New("migration name not provided")

+ type Cli struct

+ func NewCli(config CliConfig) (*Cli, error)

+ func (c *Cli) Execute(ctx context.Context) error

+ type CliConfig struct

+ CliName string

+ GoMigration *GoMigration

+ type Config struct

+ DebugSql bool

+ Driver Driver

+ MigrationFilesDir string

+ MigrationTableName string

+ type Driver interface

+ ApplyMigrations func(ctx context.Context, migrations []Migration, ...) error

+ CleanDatabase func(ctx context.Context) error

+ Close func() error

+ CreateMigrationsTable func(ctx context.Context) error

+ GetExecutedMigrations func(ctx context.Context, reverse bool) ([]ExecutedMigration, error)

+ SetMigrationTableName func(name string)

+ UnapplyMigrations func(ctx context.Context, migrations []Migration, ...) error

+ type ExecutedMigration struct

+ ExecutedAt time.Time

+ Name string

+ type GoMigration struct

+ func New(config *Config) (*GoMigration, error)

+ func (q *GoMigration) Clean(ctx context.Context) error

+ func (q *GoMigration) Create(fileName string) error

+ func (q *GoMigration) Fresh(ctx context.Context) error

+ func (q *GoMigration) List(ctx context.Context) (RegisteredMigrationList, error)

+ func (q *GoMigration) Migrate(ctx context.Context) error

+ func (q *GoMigration) Register(migrations ...Migration) error

+ func (q *GoMigration) Reset(ctx context.Context) error

+ func (q *GoMigration) Rollback(ctx context.Context, step int) error

+ type Migration interface

+ DownScript func() string

+ Name func() string

+ UpScript func() string

+ type MySqlDriver struct

+ func NewMySqlDriver(host string, port string, user string, password string, database string, ...) (*MySqlDriver, error)

+ func (m *MySqlDriver) ApplyMigrations(ctx context.Context, migrations []Migration, ...) error

+ func (m *MySqlDriver) CleanDatabase(ctx context.Context) error

+ func (m *MySqlDriver) Close() error

+ func (m *MySqlDriver) CreateMigrationsTable(ctx context.Context) error

+ func (m *MySqlDriver) GetExecutedMigrations(ctx context.Context, reverse bool) ([]ExecutedMigration, error)

+ func (m *MySqlDriver) SetMigrationTableName(name string)

+ func (m *MySqlDriver) UnapplyMigrations(ctx context.Context, migrations []Migration, ...) error

+ type PostgresDriver struct

+ func NewPostgresDriver(host string, port string, user string, password string, database string, ...) (*PostgresDriver, error)

+ func (p *PostgresDriver) ApplyMigrations(ctx context.Context, migrations []Migration, ...) error

+ func (p *PostgresDriver) CleanDatabase(ctx context.Context) error

+ func (p *PostgresDriver) Close() error

+ func (p *PostgresDriver) CreateMigrationsTable(ctx context.Context) error

+ func (p *PostgresDriver) GetExecutedMigrations(ctx context.Context, reverse bool) ([]ExecutedMigration, error)

+ func (p *PostgresDriver) SetMigrationTableName(name string)

+ func (p *PostgresDriver) UnapplyMigrations(ctx context.Context, migrations []Migration, ...) error

+ type RegisteredMigration struct

+ DownScript string

+ ExecutedAt *time.Time

+ IsExecuted bool

+ Name string

+ UpScript string

+ type RegisteredMigrationList []RegisteredMigration

+ func (m RegisteredMigrationList) Print()

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL