migrations

Documentation

Index

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

Variables

var CRDBMigrations = migrate.NewManager[*CRDBDriver, *pgx.Conn, pgx.Tx]()

CRDBMigrations implements a migration manager for the CRDBDriver.

Types

type CRDBDriver

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

CRDBDriver implements a schema migration facility for use in SpiceDB's CRDB datastore.

func NewCRDBDriver

func NewCRDBDriver(url string) (*CRDBDriver, error)

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

func (*CRDBDriver) Close

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

Close disposes the driver.

func (*CRDBDriver) Conn

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

Conn returns the underlying pgx.Conn instance for this driver

func (*CRDBDriver) RunTx

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

func (*CRDBDriver) Version

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

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

func (*CRDBDriver) WriteVersion

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