diff

Documentation

Overview

Package diff contains functions to generate SQL statements to migrate an old schema to the new schema

Index

• func Files(dst io.Writer, from, to string, options ...Option) error
• func Statements(dst io.Writer, from, to model.Stmts, options ...Option) error
• func Strings(dst io.Writer, from, to string, options ...Option) error
• type Option
  • func WithParser(p *schemalex.Parser) Option
  • func WithTransaction(b bool) Option

Functions

func Files

func Files(dst io.Writer, from, to string, options ...Option) error

Files compares contents of two files and generates a series of statements to migrate from the old one to the new one, writing the result to `dst`

func Statements

func Statements(dst io.Writer, from, to model.Stmts, options ...Option) error

Statements compares two model.Stmts and generates a series of statements to migrate from the old one to the new one, writing the result to `dst`

func Strings

func Strings(dst io.Writer, from, to string, options ...Option) error

Strings compares two strings and generates a series of statements to migrate from the old one to the new one, writing the result to `dst`

Types

type Option

type Option interface {
	Name() string
	Value() interface{}
}

Option is a generic interface for objects that passes optional parameters to the various diff functions in this package

func WithParser

func WithParser(p *schemalex.Parser) Option

WithParser specifies the parser instance to use when parsing the statements given to the diffing functions. If unspecified, a default parser will be used

func WithTransaction

func WithTransaction(b bool) Option

WithTransaction specifies if statements to control transactions should be included in the diff.