database

Documentation

Index

• type ConnectOptions
• type DB
• type DBReaderWriter
  • func NewDbConnection(ctx context.Context, ready *bool, ro ConnectOptions, wo ConnectOptions) *DBReaderWriter
  • func (dbs *DBReaderWriter) GetReaderConn() *sql.DB
  • func (dbs *DBReaderWriter) GetWriterConn() *sql.DB
• type DbStore
  • func NewDbConnectionFromSettings(ctx context.Context, settings *config.Settings) DbStore
  • func (store *DbStore) DBS() *DBReaderWriter
  • func (store *DbStore) IsReady() bool
• type Tx

Types

type ConnectOptions

type ConnectOptions struct {
	DSN                string
	DriverName         string
	Retries            int
	RetryDelay         time.Duration
	ConnectTimeout     time.Duration
	ConnMaxLifetime    time.Duration
	MaxIdleConnections int
	MaxOpenConnections int
}

ConnectOptions config options for database

type DB

type DB struct {
	*sql.DB
}

DB type to wrap sql.DB

type DBReaderWriter

type DBReaderWriter struct {
	Reader *DB
	Writer *DB
}

DBReaderWriter wraps db reader and writer

func NewDbConnection

func NewDbConnection(ctx context.Context, ready *bool, ro ConnectOptions, wo ConnectOptions) *DBReaderWriter

NewDbConnection connects to the reader and writer per passed in options, with retries, returning a DBReaderWriter object that contains sql.DB connection

func (*DBReaderWriter) GetReaderConn

func (dbs *DBReaderWriter) GetReaderConn() *sql.DB

GetReaderConn returns connection to reader

func (*DBReaderWriter) GetWriterConn

func (dbs *DBReaderWriter) GetWriterConn() *sql.DB

GetWriterConn returns connection to writer

type DbStore

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

DbStore holds the database connection and other stuff.

func NewDbConnectionFromSettings

func NewDbConnectionFromSettings(ctx context.Context, settings *config.Settings) DbStore

NewDbConnectionFromSettings sets up a db connection from the settings, only once

func (*DbStore) DBS

func (store *DbStore) DBS() *DBReaderWriter

DBS returns the reader and writer databases to connect to

func (*DbStore) IsReady

func (store *DbStore) IsReady() bool

IsReady returns if db is ready to connect to

type Tx

type Tx struct {
	*sql.Tx
}

Tx type to wrap sql.Tx