migrate

package

v1.0.0-beta.226 Latest Latest Go to latest Published: Jan 14, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation ¶

A very lightweigh migration tool to replace `ent.Schema.Create` calls.

View Source

const IgnoreMarker = "-- migration:ignore"

View Source

const (
	MigrationsTable = "schema_om"
)

View Source

var ErrNoChange = migrate.ErrNoChange

View Source

var OMMigrationsConfig = MigrationsConfig{
	FS:             omMigrations,
	FSPath:         "migrations",
	StateTableName: MigrationsTable,
}

func NewLogger(log *slog.Logger) migrate.Logger

type FS interface {
	fs.ReadDirFS
	fs.ReadFileFS
}

type Migrate struct {
	// contains filtered or unexported fields
}

func New(options MigrateOptions) (*Migrate, error)

New creates a new migrate instance.

func (m *Migrate) CloseOrLogError()

func (m *Migrate) Down() error

func (m *Migrate) LatestVersion() (uint, error)

func (m *Migrate) Migrate(version uint) error

func (m *Migrate) Up() error

func (m *Migrate) WaitForMigrationJob(waitOpts ...WaitForMigrationOption) error

type MigrateOptions struct {
	ConnectionString string
	Migrations       MigrationsConfig
	Logger           *slog.Logger
}

func (m *MigrateOptions) Validate() error

type MigrationsConfig struct {
	FS             fs.FS
	FSPath         string
	StateTableName string
}

func (m *MigrationsConfig) Validate() error

type SourceWrapper struct {
	// contains filtered or unexported fields
}

func NewSourceWrapper(fsys fs.FS) *SourceWrapper

func (s *SourceWrapper) Open(name string) (fs.File, error)

func (s *SourceWrapper) ReadDir(path string) ([]fs.DirEntry, error)

func (s *SourceWrapper) ReadFile(name string) ([]byte, error)

type WaitForMigrationOption func(*waitForMigrationOptions)