migrator

package

v0.14.7 Latest Latest Go to latest Published: Aug 7, 2022 License: MPL-2.0 Imports: 19 Imported by: 2

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

Repository

github.com/cloudquery/cq-provider-sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ReadMigrationFiles(log hclog.Logger, migrationFiles embed.FS) (map[string]map[string][]byte, error)
type Migrator
- func New(log hclog.Logger, dt schema.DialectType, ...) (*Migrator, error)
type Option

Constants ¶

View Source

const (
	Latest  = "latest"
	Initial = "initial"
	Down    = "down_testing" // used in testing

)

Variables ¶

This section is empty.

Functions ¶

func ReadMigrationFiles ¶

func ReadMigrationFiles(log hclog.Logger, migrationFiles embed.FS) (map[string]map[string][]byte, error)

ReadMigrationFiles reads the given embed.FS for the migration files and returns a map of dialect directories vs. filenames vs. data

Types ¶

type Migrator ¶

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

func New ¶

func New(log hclog.Logger, dt schema.DialectType, migrationFiles map[string]map[string][]byte, dsnURI, providerName string, opts ...Option) (*Migrator, error)

func (*Migrator) Close ¶

func (m *Migrator) Close() error

func (*Migrator) DowngradeProvider ¶

func (m *Migrator) DowngradeProvider(version string) (retErr error)

func (*Migrator) DropProvider ¶

func (m *Migrator) DropProvider(ctx context.Context, tableSchema map[string]*schema.Table) (retErr error)

func (*Migrator) FindLatestMigration ¶

func (m *Migrator) FindLatestMigration(requestedVersion string) (uint, error)

FindLatestMigration finds closet migration to the requested version

For example we have the following migrations:
1_001, 2_005, 3_009

if we ask for 007 we get 005 if we ask for 004 we get 001 if we ask for 005 we get 005

func (*Migrator) SetVersion ¶

func (m *Migrator) SetVersion(requestedVersion string) (retErr error)

func (*Migrator) UpgradeProvider ¶

func (m *Migrator) UpgradeProvider(version string) (retErr error)

func (*Migrator) Version ¶

func (m *Migrator) Version() (string, bool, error)

type Option ¶ added in v0.8.4

type Option func(*Migrator)

Source Files ¶

View all Source files

migrator.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL