migrations

Documentation

Index

• Variables
• type AlembicPostgresDriver
  • func NewAlembicPostgresDriver(ctx context.Context, url string, ...) (*AlembicPostgresDriver, error)
  • func (apd *AlembicPostgresDriver) Close(ctx context.Context) error
  • func (apd *AlembicPostgresDriver) Conn() *pgx.Conn
  • func (apd *AlembicPostgresDriver) RunTx(ctx context.Context, f migrate.TxMigrationFunc[pgx.Tx]) error
  • func (apd *AlembicPostgresDriver) Version(ctx context.Context) (string, error)
  • func (apd *AlembicPostgresDriver) WriteVersion(ctx context.Context, tx pgx.Tx, version, replaced string) error

Variables

var DatabaseMigrations = migrate.NewManager[*AlembicPostgresDriver, *pgx.Conn, pgx.Tx]()

DatabaseMigrations implements a migration manager for the Postgres Driver.

Types

type AlembicPostgresDriver

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

AlembicPostgresDriver implements a schema migration facility for use in SpiceDB's Postgres datastore.

It is compatible with the popular Python library, Alembic

func NewAlembicPostgresDriver

func NewAlembicPostgresDriver(ctx context.Context, url string, credentialsProvider datastore.CredentialsProvider) (*AlembicPostgresDriver, error)

NewAlembicPostgresDriver creates a new driver with active connections to the database specified.

func (*AlembicPostgresDriver) Close

func (apd *AlembicPostgresDriver) Close(ctx context.Context) error

Close disposes the driver.

func (*AlembicPostgresDriver) Conn

func (apd *AlembicPostgresDriver) Conn() *pgx.Conn

Conn returns the underlying pgx.Conn instance for this driver

func (*AlembicPostgresDriver) RunTx

func (apd *AlembicPostgresDriver) RunTx(ctx context.Context, f migrate.TxMigrationFunc[pgx.Tx]) error

func (*AlembicPostgresDriver) Version

func (apd *AlembicPostgresDriver) Version(ctx context.Context) (string, error)

Version returns the version of the schema to which the connected database has been migrated.

func (*AlembicPostgresDriver) WriteVersion

func (apd *AlembicPostgresDriver) WriteVersion(ctx context.Context, tx pgx.Tx, version, replaced string) error