deploy

Documentation

Index

• type DB
  • func Open(driverName string, dataSourceName string) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) Deploy(ctx context.Context, plan *Plan) error
  • func (db *DB) Import(ctx context.Context, sqlText string) error
  • func (db *DB) LoadSchema(ctx context.Context) (string, error)
  • func (db *DB) Plan(ctx context.Context, schema string) (*Plan, error)
• type Plan
  • func (plan *Plan) Preview(w io.Writer) error

Types

type DB

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

DB is the target of deploying a DDL schema.

func Open

func Open(driverName string, dataSourceName string) (*DB, error)

Open opens a database specified by its database driver name.

func (*DB) Close

func (db *DB) Close() error

Close closes the database.

func (*DB) Deploy

func (db *DB) Deploy(ctx context.Context, plan *Plan) error

Deploy deploys the new schema according to the plan.

func (*DB) Import

func (db *DB) Import(ctx context.Context, sqlText string) error

Import imports and updates the schemalex revision using sqlText.

func (*DB) LoadSchema

func (db *DB) LoadSchema(ctx context.Context) (string, error)

LoadSchema loads existing table schemas from running database.

func (*DB) Plan

func (db *DB) Plan(ctx context.Context, schema string) (*Plan, error)

Plan generates a series statements to migrate from the current one to the new schema.

type Plan

type Plan struct {
	From  string
	To    string
	Stmts diff.Stmts
}

func (*Plan) Preview

func (plan *Plan) Preview(w io.Writer) error