driver

Documentation

Overview

Package driver holds the driver interface.

Index

• Variables
• func CanIgnoreError(err error) bool
• func Drivers() []string
• func GenerateAdvisoryLockId(databaseName string, additionalNames ...string) (string, error)
• func RegisterDriver(name string, driver *DriverGenerator)
• type Driver
  • func New(url string, initOptions ...func(Driver)) (Driver, error)
• type DriverGenerator
  • func GetDriverGenerator(name string) (*DriverGenerator, bool)
  • func NewDriverGenerator(fn func() Driver) *DriverGenerator
  • func (dg *DriverGenerator) Generate() Driver
  • func (dg *DriverGenerator) RegisterInitFunction(fnInit func(Driver))

Variables

var (
	ErrLocked                  = fmt.Errorf("can't acquire lock")
	ErrFailedToSendCloseNotify = fmt.Errorf("failed to send closeNotify alert, please see https://github.com/jackc/pgx/issues/984 for more details")
)

Functions

func CanIgnoreError

func CanIgnoreError(err error) bool

func Drivers

func Drivers() []string

Drivers returns a sorted list of the names of the registered drivers.

func GenerateAdvisoryLockId

func GenerateAdvisoryLockId(databaseName string, additionalNames ...string) (string, error)

GenerateAdvisoryLockId inspired by rails migrations, see https://goo.gl/8o9bCT

func RegisterDriver

func RegisterDriver(name string, driver *DriverGenerator)

Registers a driver so it can be created from its name. Drivers should call this from an init() function so that they registers themselvse on import

Types

type Driver

type Driver interface {

	// Initialize is the first function to be called.
	// Check the url string and open and verify any connection
	// that has to be made.
	Initialize(url string, initOptions ...func(Driver)) 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(file file.File, pipe chan interface{})

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

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

func New

func New(url string, initOptions ...func(Driver)) (Driver, error)

New returns Driver and calls Initialize on it

type DriverGenerator

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

func GetDriverGenerator

func GetDriverGenerator(name string) (*DriverGenerator, bool)

Retrieves a registered driver by name

func NewDriverGenerator

func NewDriverGenerator(fn func() Driver) *DriverGenerator

func (*DriverGenerator) Generate

func (dg *DriverGenerator) Generate() Driver

func (*DriverGenerator) RegisterInitFunction

func (dg *DriverGenerator) RegisterInitFunction(fnInit func(Driver))