database

README

Database Module Architecture

Documentation

Index

• func IsNotFound(err error) bool
• func WithTransaction(ctx context.Context, db *sql.DB, fn TxFunc) error
• func WrapError(op string, err error) error
• type Connection
  • func NewConnection(driver Driver, cs *ConnectionString, pool *ConnectionPoolConfig) (*Connection, error)
  • func (c *Connection) Close() error
  • func (c *Connection) Connect() error
  • func (c *Connection) GetConnectionString() *ConnectionString
  • func (c *Connection) GetPgxPool() *pgxpool.Pool
  • func (c *Connection) GetSQLDB() *sql.DB
• type ConnectionPoolConfig
  • func DefaultPoolConfig() *ConnectionPoolConfig
  • func NewConnectionPoolConfig(maxOpenConns int, maxIdleConns int, connMaxIdleTime time.Duration, ...) *ConnectionPoolConfig
• type ConnectionString
  • func NewConnectionString(host, port, user, password, database string, options map[string]string) *ConnectionString
  • func (cs *ConnectionString) DSN(driver Driver) string
• type Database
  • func NewDatabase(config *DatabaseConfig) (*Database, error)
• type DatabaseConfig
• type Driver
  • func ParseDriver(input string) (Driver, error)
• type Pagination
  • func NewPagination(page, pageSize int32) Pagination
• type TxFunc

Functions

func IsNotFound

func IsNotFound(err error) bool

func WithTransaction

func WithTransaction(ctx context.Context, db *sql.DB, fn TxFunc) error

func WrapError

func WrapError(op string, err error) error

Types

type Connection

type Connection struct {
	Driver           Driver
	ConnectionString *ConnectionString
	PoolConfig       *ConnectionPoolConfig
	DB               *sql.DB
	PgxPool          *pgxpool.Pool
}

func NewConnection

func NewConnection(driver Driver, cs *ConnectionString, pool *ConnectionPoolConfig) (*Connection, error)

func (*Connection) Close

func (c *Connection) Close() error

func (*Connection) Connect

func (c *Connection) Connect() error

func (*Connection) GetConnectionString

func (c *Connection) GetConnectionString() *ConnectionString

func (*Connection) GetPgxPool

func (c *Connection) GetPgxPool() *pgxpool.Pool

func (*Connection) GetSQLDB

func (c *Connection) GetSQLDB() *sql.DB

type ConnectionPoolConfig

type ConnectionPoolConfig struct {
	MaxOpenConns    int
	MaxIdleConns    int
	ConnMaxIdleTime time.Duration
	ConnMaxLifetime time.Duration
}

func DefaultPoolConfig

func DefaultPoolConfig() *ConnectionPoolConfig

func NewConnectionPoolConfig

func NewConnectionPoolConfig(
	maxOpenConns int,
	maxIdleConns int,
	connMaxIdleTime time.Duration,
	connMaxLifetime time.Duration,
) *ConnectionPoolConfig

type ConnectionString

type ConnectionString struct {
	Host     string
	Port     string
	User     string
	Password string
	Database string
	Options  map[string]string
}

func NewConnectionString

func NewConnectionString(
	host, port, user, password, database string,
	options map[string]string,
) *ConnectionString

func (*ConnectionString) DSN

func (cs *ConnectionString) DSN(driver Driver) string

type Database

type Database struct {
	Config     *DatabaseConfig
	Connection *Connection
}

func NewDatabase

func NewDatabase(config *DatabaseConfig) (*Database, error)

type DatabaseConfig

type DatabaseConfig struct {
	Name                 string
	Driver               Driver
	ConnectionString     *ConnectionString
	ConnectionPoolConfig *ConnectionPoolConfig
}

type Driver

type Driver string

Driver represents a supported SQL driver.

const (
	PostgresDriver Driver = "postgres"
	MySQLDriver    Driver = "mysql"
	SQLiteDriver   Driver = "sqlite3"
)

func ParseDriver

func ParseDriver(input string) (Driver, error)

type Pagination

type Pagination struct {
	Limit  int32
	Offset int32
}

func NewPagination

func NewPagination(page, pageSize int32) Pagination

type TxFunc

type TxFunc func(*sql.Tx) error