migratebroccoli

Documentation

Overview

Code generated by broccoli at 2020-05-03T09:22:48-07:00.

Index

• Variables
• func WithInstance(instance interface{}) (source.Driver, error)
• type Config
• type Driver
  • func (d *Driver) Close() error
  • func (d *Driver) First() (version uint, err error)
  • func (d *Driver) Next(version uint) (nextVersion uint, err error)
  • func (d *Driver) Open(url string) (source.Driver, error)
  • func (d *Driver) Prev(version uint) (prevVersion uint, err error)
  • func (d *Driver) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)
  • func (d *Driver) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)

Variables

var (
	ErrInvalidInstance = errors.New("Invalid parameter for WithInstance; must be a migratebroccoli.Config")
	ErrNilBroccoli     = errors.New("migratebroccoli.Config must have its Broccoli property set to the variable output by broccoli")
)

Functions

func WithInstance

func WithInstance(instance interface{}) (source.Driver, error)

Types

type Config

type Config struct {
	Broccoli *fs.Broccoli
	Dir      string
}

type Driver

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

func (*Driver) Close

func (d *Driver) Close() error

func (*Driver) First

func (d *Driver) First() (version uint, err error)

func (*Driver) Next

func (d *Driver) Next(version uint) (nextVersion uint, err error)

func (*Driver) Open

func (d *Driver) Open(url string) (source.Driver, error)

func (*Driver) Prev

func (d *Driver) Prev(version uint) (prevVersion uint, err error)

func (*Driver) ReadDown

func (d *Driver) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)

func (*Driver) ReadUp

func (d *Driver) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)