nrdatasource

Documentation

Index

• Variables
• type DBAccess
• type DBConfig
• type Generic
  • func (g *Generic) CanLock() (lock bool)
  • func (g *Generic) Close() (err error)
  • func (g *Generic) Get() (db *sqlx.DB, err error)
  • func (g *Generic) New(config DBConfig) (db *sqlx.DB, err error)
  • func (g *Generic) RandomFuncName() (fName string)

Variables

var (
	ErrNoDatabase         = errors.New("no database found with the specified name")
	ErrDriverNotSupported = errors.New("database driver not supported")
)

Global errors

Types

type DBAccess

type DBAccess interface {
	New(config DBConfig) (*sqlx.DB, error)
	Get() (*sqlx.DB, error)
	Close() error
	CanLock() bool
	RandomFuncName() string
}

DBAccess is the common interface for data access definitions

type DBConfig

type DBConfig struct {
	DBName             string
	Driver             string
	Address            string
	Username           string
	Password           string
	MaxOpenConnections int
	MaxIdleConnections int
	ConnectionLifetime time.Duration
}

DBConfig holds the configuration required to initialize a data source

type Generic

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

Generic is the generic data access implementation for `DBAccess` interface. Drivers currently supported: - mysql

func (*Generic) CanLock

func (g *Generic) CanLock() (lock bool)

CanLock returns true if the current driver supportes locking

func (*Generic) Close

func (g *Generic) Close() (err error)

Close should be called when the server ends the execution, so connection are gracefully released

func (*Generic) Get

func (g *Generic) Get() (db *sqlx.DB, err error)

Get returns the DB instance

func (*Generic) New

func (g *Generic) New(config DBConfig) (db *sqlx.DB, err error)

New configures the datasources

func (*Generic) RandomFuncName

func (g *Generic) RandomFuncName() (fName string)

RandomFuncName returns the driver's RANDOM name