migrations

Documentation

Index

• Variables
• type SpannerMigrationDriver
  • func NewSpannerDriver(ctx context.Context, database, credentialsFilePath, emulatorHost string) (*SpannerMigrationDriver, error)
  • func (smd *SpannerMigrationDriver) Close(_ context.Context) error
  • func (smd *SpannerMigrationDriver) Conn() Wrapper
  • func (smd *SpannerMigrationDriver) RunTx(ctx context.Context, f migrate.TxMigrationFunc[*spanner.ReadWriteTransaction]) error
  • func (smd *SpannerMigrationDriver) Version(ctx context.Context) (string, error)
  • func (smd *SpannerMigrationDriver) WriteVersion(_ context.Context, rwt *spanner.ReadWriteTransaction, version, replaced string) error
• type VersionProvider
  • func NewSpannerVersionChecker(c *spanner.Client) VersionProvider
• type Wrapper

Variables

var SpannerMigrations = migrate.NewManager[*SpannerMigrationDriver, Wrapper, *spanner.ReadWriteTransaction]()

SpannerMigrations implements a migration manager for the Spanner datastore.

Types

type SpannerMigrationDriver

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

SpannerMigrationDriver can migrate a Cloud Spanner instance The adminClient is required for DDL changes

func NewSpannerDriver

func NewSpannerDriver(ctx context.Context, database, credentialsFilePath, emulatorHost string) (*SpannerMigrationDriver, error)

NewSpannerDriver returns a migration driver for the given Cloud Spanner instance

func (*SpannerMigrationDriver) Close

func (smd *SpannerMigrationDriver) Close(_ context.Context) error

func (*SpannerMigrationDriver) Conn

func (smd *SpannerMigrationDriver) Conn() Wrapper

Conn returns the underlying spanner clients in a Wrapper instance for MigrationFunc to use

func (*SpannerMigrationDriver) RunTx

func (smd *SpannerMigrationDriver) RunTx(ctx context.Context, f migrate.TxMigrationFunc[*spanner.ReadWriteTransaction]) error

func (*SpannerMigrationDriver) Version

func (smd *SpannerMigrationDriver) Version(ctx context.Context) (string, error)

func (*SpannerMigrationDriver) WriteVersion

func (smd *SpannerMigrationDriver) WriteVersion(_ context.Context, rwt *spanner.ReadWriteTransaction, version, replaced string) error

type VersionProvider

type VersionProvider interface {
	Version(ctx context.Context) (string, error)
}

VersionProvider returns the migration version a specific spanner datastore is running at

func NewSpannerVersionChecker

func NewSpannerVersionChecker(c *spanner.Client) VersionProvider

NewSpannerVersionChecker returns a VersionProvider for the argument spanner.Client

type Wrapper

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

Wrapper makes it possible to forward the spanner clients to the MigrationFunc's to execute