db

Documentation

Overview

Package db defines interface for using RDBMS

Index

• func Adapters() []string
• func Drivers() []string
• func RegisterAdapterFactory(name string, factory AdapterFactory)
• type Adapter
  • func GetAdapter(name string) (Adapter, error)
• type AdapterDefaults
• type AdapterFactory
• type Manager
  • func NewManager(config config.DatabaseManagerConfig) *Manager
  • func (mgr *Manager) Close() error
  • func (mgr *Manager) Config(name string) (config.DatabaseConfig, error)
  • func (mgr *Manager) Default() (*Wrapper, error)
  • func (mgr *Manager) DefaultConfig() (config.DatabaseConfig, error)
  • func (mgr *Manager) DefaultName() (string, error)
  • func (mgr *Manager) GetLogger() *dlog.Logger
  • func (mgr *Manager) LoggerIdentity(justCallMe func() dlog.Identity) dlog.Identity
  • func (mgr *Manager) PrintConfig()
  • func (mgr *Manager) RegisteredAdapters() []string
  • func (mgr *Manager) RegisteredDrivers() []string
  • func (mgr *Manager) SetLogger(logger *dlog.Logger)
  • func (mgr *Manager) Wrapper(name string, useDatabase bool) (*Wrapper, error)
• type Wrapper
  • func NewWrapper(a Adapter) *Wrapper
  • func (w *Wrapper) Adapter() Adapter
  • func (w *Wrapper) Close() error
  • func (w *Wrapper) CreateDatabase(name string) error
  • func (w *Wrapper) GetDB() *sql.DB
  • func (w *Wrapper) GetLogger() *dlog.Logger
  • func (w *Wrapper) LoggerIdentity(justCallMe func() dlog.Identity) dlog.Identity
  • func (w *Wrapper) Ping(timeout time.Duration) (time.Duration, error)
  • func (w *Wrapper) SetDB(db *sql.DB)
  • func (w *Wrapper) SetLogger(logger *dlog.Logger)
  • func (w *Wrapper) Transaction() (*sql.Tx, error)

Functions

func Adapters

func Adapters() []string

func Drivers

func Drivers() []string

func RegisterAdapterFactory

func RegisterAdapterFactory(name string, factory AdapterFactory)

Types

type Adapter

type Adapter interface {
	DriverName() string
	Defaults() AdapterDefaults
	FormatDSN(c config.DatabaseConfig) (string, error)
	CanCreateDatabase() bool
	Placeholders(count int) string
}

Adapter is high level wrapper around underlying drivers

func GetAdapter

func GetAdapter(name string) (Adapter, error)

TODO: future, adapter factory functions should allow passing config

type AdapterDefaults

type AdapterDefaults interface {
	DockerImage() string
	Port() int
	NativeShell() string
}

type AdapterFactory

type AdapterFactory func() Adapter

type Manager

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

func NewManager

func NewManager(config config.DatabaseManagerConfig) *Manager

func (*Manager) Close

func (mgr *Manager) Close() error

func (*Manager) Config

func (mgr *Manager) Config(name string) (config.DatabaseConfig, error)

func (*Manager) Default

func (mgr *Manager) Default() (*Wrapper, error)

func (*Manager) DefaultConfig

func (mgr *Manager) DefaultConfig() (config.DatabaseConfig, error)

func (*Manager) DefaultName

func (mgr *Manager) DefaultName() (string, error)

func (*Manager) GetLogger

func (mgr *Manager) GetLogger() *dlog.Logger

func (*Manager) LoggerIdentity

func (mgr *Manager) LoggerIdentity(justCallMe func() dlog.Identity) dlog.Identity

func (*Manager) PrintConfig

func (mgr *Manager) PrintConfig()

func (*Manager) RegisteredAdapters

func (mgr *Manager) RegisteredAdapters() []string

func (*Manager) RegisteredDrivers

func (mgr *Manager) RegisteredDrivers() []string

func (*Manager) SetLogger

func (mgr *Manager) SetLogger(logger *dlog.Logger)

func (*Manager) Wrapper

func (mgr *Manager) Wrapper(name string, useDatabase bool) (*Wrapper, error)

type Wrapper

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

func NewWrapper

func NewWrapper(a Adapter) *Wrapper

func (*Wrapper) Adapter

func (w *Wrapper) Adapter() Adapter

func (*Wrapper) Close

func (w *Wrapper) Close() error

func (*Wrapper) CreateDatabase

func (w *Wrapper) CreateDatabase(name string) error

func (*Wrapper) GetDB

func (w *Wrapper) GetDB() *sql.DB

TODO: add error in return value? now we just warn if its nil ...

func (*Wrapper) GetLogger

func (w *Wrapper) GetLogger() *dlog.Logger

func (*Wrapper) LoggerIdentity

func (w *Wrapper) LoggerIdentity(justCallMe func() dlog.Identity) dlog.Identity

func (*Wrapper) Ping

func (w *Wrapper) Ping(timeout time.Duration) (time.Duration, error)

func (*Wrapper) SetDB

func (w *Wrapper) SetDB(db *sql.DB)

func (*Wrapper) SetLogger

func (w *Wrapper) SetLogger(logger *dlog.Logger)

func (*Wrapper) Transaction

func (w *Wrapper) Transaction() (*sql.Tx, error)