store

Documentation

Index

• type DBClient
  • func (client *DBClient) FetchResults(query string) (map[string]interface{}, error)
• type DBClientOpts
• type Manager
  • func NewDBClient(db string, dsn string, opts *DBClientOpts) (Manager, error)
  • func NewManager(store Store) (Manager, error)
• type Store

Types

type DBClient

type DBClient struct {
	Conn    *sqlx.DB
	Queries goyesql.Queries
}

DBClient represents the structure to hold DB Client object required to create DB session and query and fetch results.

func (*DBClient) FetchResults

func (client *DBClient) FetchResults(query string) (map[string]interface{}, error)

FetchResults executes the query and parses the result

type DBClientOpts

type DBClientOpts struct {
	QueryFile    string
	MaxIdleConns int
	MaxOpenConns int
}

DBClientOpts represents additional options to use for DB Client

type Manager

type Manager interface {
	FetchResults(string) (map[string]interface{}, error)
}

Manager represents the set of methods used to interact with the db.

func NewDBClient

func NewDBClient(db string, dsn string, opts *DBClientOpts) (Manager, error)

NewDBClient initializes a connection object with the databse.

func NewManager

func NewManager(store Store) (Manager, error)

NewManager instantiates an object of Manager based on the params

type Store

type Store struct {
	MaxOpenConnections int    `koanf:"max_open_connections"`
	MaxIdleConnections int    `koanf:"max_idle_connections"`
	DB                 string `koanf:"db"`
	DSN                string `koanf:"dsn"`
	QueryFile          string `koanf:"query"`
}

Store represents additional options for the external store