migrator

package

v1.0.1 Latest Latest Go to latest Published: Apr 23, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hookdeck/outpost

Links

Documentation ¶

Index ¶

type MigrationInfo
type MigrationOpts
type MigrationOptsCH
type MigrationOptsPG
type Migrator
- func New(opts MigrationOpts) (*Migrator, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type MigrationInfo ¶ added in v0.17.0

type MigrationInfo struct {
	Version int
	Name    string
	Applied bool
}

MigrationInfo describes a single SQL migration and its applied state.

type MigrationOpts ¶

type MigrationOpts struct {
	PG MigrationOptsPG
	CH MigrationOptsCH
}

type MigrationOptsCH ¶

type MigrationOptsCH struct {
	Addr         string
	Username     string
	Password     string
	Database     string
	DeploymentID string
	TLSEnabled   bool
}

type MigrationOptsPG ¶

type MigrationOptsPG struct {
	URL string
}

type Migrator ¶

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

func New ¶

func New(opts MigrationOpts) (*Migrator, error)

func (*Migrator) Close ¶

func (m *Migrator) Close(ctx context.Context) (error, error)

func (*Migrator) Down ¶

func (m *Migrator) Down(ctx context.Context, n int) (int, int, error)

Down migrates the database down by n migrations. It returns the updated version, the number of migrations rolled back, and an error.

func (*Migrator) Force ¶

func (m *Migrator) Force(ctx context.Context, version int) error

func (*Migrator) LatestVersion ¶ added in v0.17.0

func (m *Migrator) LatestVersion() (int, error)

LatestVersion returns the highest migration version available in the embedded migration files. Returns 0 if there are no migrations.

func (*Migrator) ListMigrations ¶ added in v0.17.0

func (m *Migrator) ListMigrations(ctx context.Context) ([]MigrationInfo, error)

ListMigrations returns all available SQL migrations in version order, with Applied set based on the migrator's current schema version.

func (*Migrator) PendingCount ¶ added in v0.17.0

func (m *Migrator) PendingCount(ctx context.Context) (int, error)

PendingCount returns the number of migrations that would be applied by running Up(-1) from the current state.

func (*Migrator) Up ¶

func (m *Migrator) Up(ctx context.Context, n int) (int, int, error)

Up migrates the database up by n migrations. It returns the updated version, the number of migrations applied, and an error.

func (*Migrator) Version ¶

func (m *Migrator) Version(ctx context.Context) (int, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
coordinator Package coordinator provides a unified interface over the SQL and Redis migration subsystems so callers (CLI, startup checks) can work with "migrations" as a single concept instead of two separate systems.	Package coordinator provides a unified interface over the SQL and Redis migration subsystems so callers (CLI, startup checks) can work with "migrations" as a single concept instead of two separate systems.
migrations Package migrations provides a central registry for all Redis migrations.	Package migrations provides a central registry for all Redis migrations.
migratorredis
001_hash_tags
002_timestamps
003_entity

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