driver

Documentation

Overview

Package driver holds the driver interface.

Index

• type Driver
  • func New(instance interface{}, url string) (Driver, error)

Types

type Driver

type Driver interface {

	// Initialize is the first function to be called.
	// If instance is not nil, try to use instance as connection/session.
	// If instance is nil, check the url string and open and verify any
	// connection that has to be made.
	Initialize(instance interface{}, url string) error

	// Close is the last function to be called.
	// Close any open connection here.
	Close() error

	// FilenameExtension returns the extension of the migration files.
	// The returned string must not begin with a dot.
	FilenameExtension() string

	// Migrate is the heart of the driver.
	// It will receive a file which the driver should apply
	// to its backend or whatever. The migration function should use
	// the pipe channel to return any errors or other useful information.
	Migrate(id string, file file.File, pipe chan interface{})

	// Version returns the current migration version.
	Version(id string) (uint64, error)
}

Driver is the interface type that needs to implemented by all drivers.

func New

func New(instance interface{}, url string) (Driver, error)

New returns Driver and calls Initialize on it