migrations

package

v1.31.0 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

SpannerMigrations implements a migration manager for the Spanner datastore.

This section is empty.

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

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

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

NewSpannerDriver returns a migration driver for the given Cloud Spanner instance

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

func (smd *SpannerMigrationDriver) Conn() Wrapper

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

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 interface {
	Version(ctx context.Context) (string, error)
}

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

func NewSpannerVersionChecker(c *spanner.Client) VersionProvider

NewSpannerVersionChecker returns a VersionProvider for the argument spanner.Client

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

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