sql

Documentation

Index

• Variables
• func CreateTransaction(db *sql.DB, fn func(tx *sql.Tx) error) error
• func Disconnect(db *sql.DB) error
• func RunQueriesConcurrently(db *sql.DB, queries ...func(db *sql.DB) error) *[]error
• func RunQueriesConcurrentlyWithCancel(db *sql.DB, queries ...func(db *sql.DB, ctx context.Context) error) *[]error
• type Config
• type ConnConfig
  • func NewConnConfig(driverName, dataSourceName string, maxOpenConnections, maxIdleConnections int, ...) (*ConnConfig, error)
  • func (c *ConnConfig) ConnectionMaxIdleTime() time.Duration
  • func (c *ConnConfig) ConnectionMaxLifetime() time.Duration
  • func (c *ConnConfig) DataSourceName() string
  • func (c *ConnConfig) DriverName() string
  • func (c *ConnConfig) MaxIdleConnections() int
  • func (c *ConnConfig) MaxOpenConnections() int
• type ConnHandler
• type DefaultConnHandler
  • func NewDefaultConnHandler(driverName, dataSourceName string, config Config) (*DefaultConnHandler, error)
  • func (d *DefaultConnHandler) Connect() (*sql.DB, error)
  • func (d *DefaultConnHandler) DB() (*sql.DB, error)
• type DefaultService
  • func NewDefaultService(db *sql.DB) (instance *DefaultService, err error)
  • func (d *DefaultService) CreateTransaction(fn func(tx *sql.Tx) error) error
  • func (d *DefaultService) DB() *sql.DB
  • func (d *DefaultService) Exec(query *string, params ...interface{}) (sql.Result, error)
  • func (d *DefaultService) Migrate(queries ...string) error
  • func (d *DefaultService) QueryRow(query *string, params ...interface{}) *sql.Row
  • func (d *DefaultService) ScanRow(row *sql.Row, destinations ...interface{}) error
• type Service

Variables

var (
	ErrNilService = errors.New("service cannot be nil")
)

Functions

func CreateTransaction

func CreateTransaction(db *sql.DB, fn func(tx *sql.Tx) error) error

CreateTransaction creates a transaction for the database

func Disconnect

func Disconnect(db *sql.DB) error

Disconnect closes the SQL connection

func RunQueriesConcurrently

func RunQueriesConcurrently(
	db *sql.DB,
	queries ...func(db *sql.DB) error,
) *[]error

RunQueriesConcurrently runs multiple queries concurrently

func RunQueriesConcurrentlyWithCancel

func RunQueriesConcurrentlyWithCancel(
	db *sql.DB,
	queries ...func(db *sql.DB, ctx context.Context) error,
) *[]error

RunQueriesConcurrentlyWithCancel runs multiple queries concurrently with a cancel context

Types

type Config

type Config interface {
	DriverName() string
	DataSourceName() string
	MaxOpenConnections() int
	MaxIdleConnections() int
	ConnectionMaxLifetime() time.Duration
	ConnectionMaxIdleTime() time.Duration
}

Config interface

type ConnConfig

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

ConnConfig struct

func NewConnConfig

func NewConnConfig(
	driverName,
	dataSourceName string,
	maxOpenConnections,
	maxIdleConnections int,
	connectionMaxIdleTime,
	connectionMaxLifetime time.Duration,
) (*ConnConfig, error)

NewConnConfig creates a new configuration for the connection

func (*ConnConfig) ConnectionMaxIdleTime

func (c *ConnConfig) ConnectionMaxIdleTime() time.Duration

ConnectionMaxIdleTime returns the connection max idle time

func (*ConnConfig) ConnectionMaxLifetime

func (c *ConnConfig) ConnectionMaxLifetime() time.Duration

ConnectionMaxLifetime returns the connection max lifetime

func (*ConnConfig) DataSourceName

func (c *ConnConfig) DataSourceName() string

DataSourceName returns the data source name

func (*ConnConfig) DriverName

func (c *ConnConfig) DriverName() string

DriverName returns the driver name

func (*ConnConfig) MaxIdleConnections

func (c *ConnConfig) MaxIdleConnections() int

MaxIdleConnections returns the maximum idle connections

func (*ConnConfig) MaxOpenConnections

func (c *ConnConfig) MaxOpenConnections() int

MaxOpenConnections returns the maximum open connections

type ConnHandler

type ConnHandler interface {
	Connect() (*sql.DB, error)
	DB() (*sql.DB, error)
	Disconnect()
}

ConnHandler interface

type DefaultConnHandler

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

DefaultConnHandler struct

func NewDefaultConnHandler

func NewDefaultConnHandler(
	driverName, dataSourceName string,
	config Config,
) (*DefaultConnHandler, error)

NewDefaultConnHandler creates a new connection

func (*DefaultConnHandler) Connect

func (d *DefaultConnHandler) Connect() (*sql.DB, error)

Connect returns a new SQL connection

func (*DefaultConnHandler) DB

func (d *DefaultConnHandler) DB() (*sql.DB, error)

DB returns the SQL connection

type DefaultService

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

DefaultService is the default service struct

func NewDefaultService

func NewDefaultService(db *sql.DB) (
	instance *DefaultService,
	err error,
)

NewDefaultService creates a new default service

func (*DefaultService) CreateTransaction

func (d *DefaultService) CreateTransaction(fn func(tx *sql.Tx) error) error

CreateTransaction creates a transaction for the database

func (*DefaultService) DB

func (d *DefaultService) DB() *sql.DB

DB returns the database

func (*DefaultService) Exec

func (d *DefaultService) Exec(query *string, params ...interface{}) (
	sql.Result,
	error,
)

Exec executes a query with parameters and returns the result

func (*DefaultService) Migrate

func (d *DefaultService) Migrate(queries ...string) error

Migrate migrates the database

func (*DefaultService) QueryRow

func (d *DefaultService) QueryRow(
	query *string,
	params ...interface{},
) *sql.Row

QueryRow runs a query row with parameters and returns the result row

func (*DefaultService) ScanRow

func (d *DefaultService) ScanRow(
	row *sql.Row,
	destinations ...interface{},
) error

ScanRow scans a row

type Service

type Service interface {
	DB() *sql.DB
	Migrate(queries ...string) error
	CreateTransaction(fn func(tx *sql.Tx) error) error
	Exec(query *string, params ...interface{}) (sql.Result, error)
	QueryRow(query *string, params ...interface{}) *sql.Row
	ScanRow(row *sql.Row, destinations ...interface{}) error
}

Service is the interface for the service