migrations

Documentation

Index

• Variables
• type AlembicPostgresDriver
  • func NewAlembicPostgresDriver(url string) (*AlembicPostgresDriver, error)
  • func (apd *AlembicPostgresDriver) Dispose()
  • func (apd *AlembicPostgresDriver) Version() (string, error)
  • func (apd *AlembicPostgresDriver) WriteVersion(version, replaced string) error

Variables

var DatabaseMigrations = migrate.NewManager()

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(url string) (*AlembicPostgresDriver, error)

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

func (*AlembicPostgresDriver) Dispose

func (apd *AlembicPostgresDriver) Dispose()

Dispose disposes the driver.

func (*AlembicPostgresDriver) Version

func (apd *AlembicPostgresDriver) Version() (string, error)

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

func (*AlembicPostgresDriver) WriteVersion

func (apd *AlembicPostgresDriver) WriteVersion(version, replaced string) error

WriteVersion overwrites the value stored to track the version of the database schema.