dbx

Documentation

Index

• Variables
• type Database
  • func New() *Database
  • func NewWithLogger(logger log.Logger) *Database
  • func (db *Database) Begin() (*Trx, error)
  • func (db *Database) Close() error
  • func (db *Database) Connection() *sql.DB
  • func (db *Database) Migrate(path string) error
  • func (db *Database) Ping() error
  • func (db *Database) Seed()
  • func (db *Database) SetLogger(logger log.Logger)
• type FieldInfo
• type NullInt
  • func (r NullInt) MarshalJSON() ([]byte, error)
• type NullString
  • func (r NullString) MarshalJSON() ([]byte, error)
• type NullTime
  • func (r NullTime) MarshalJSON() ([]byte, error)
• type RowMapper
  • func NewRowMapper() *RowMapper
  • func (m *RowMapper) Map(dest interface{}, columns []string, scanner func(dest ...interface{}) error) error
• type Trx
  • func (trx *Trx) Commit() error
  • func (trx *Trx) Count(command string, args ...interface{}) (int, error)
  • func (trx *Trx) Execute(command string, args ...interface{}) (int64, error)
  • func (trx *Trx) Exists(command string, args ...interface{}) (bool, error)
  • func (trx *Trx) Get(data interface{}, command string, args ...interface{}) error
  • func (trx *Trx) NoLogs()
  • func (trx *Trx) QueryIntArray(command string, args ...interface{}) ([]int, error)
  • func (trx *Trx) ResumeLogs()
  • func (trx *Trx) Rollback() error
  • func (trx *Trx) Scalar(data interface{}, command string, args ...interface{}) error
  • func (trx *Trx) Select(data interface{}, command string, args ...interface{}) error
  • func (trx *Trx) SetLogger(logger log.Logger)
• type TypeMapper
  • func NewTypeMapper(t reflect.Type) TypeMapper

Variables

var ErrNoChanges = stdErrors.New("nothing to migrate.")

ErrNoChanges means that the migration process didn't change execute any file

Types

type Database

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

Database represents a connection to a SQL database

func New

func New() *Database

New creates a new Database instance without logging

func NewWithLogger

func NewWithLogger(logger log.Logger) *Database

NewWithLogger creates a new Database instance with logging or panic

func (*Database) Begin

func (db *Database) Begin() (*Trx, error)

Begin returns a new SQL transaction

func (*Database) Close

func (db *Database) Close() error

Close connection to database

func (*Database) Connection

func (db *Database) Connection() *sql.DB

Connection returns current database connection

func (*Database) Migrate

func (db *Database) Migrate(path string) error

Migrate the database to latest version

func (*Database) Ping

func (db *Database) Ping() error

Ping checks if current database connection is healthy

func (*Database) Seed

func (db *Database) Seed()

Seed clean and insert new seed data for testing

func (*Database) SetLogger

func (db *Database) SetLogger(logger log.Logger)

SetLogger replaces current database Logger

type FieldInfo

type FieldInfo struct {
	FieldName  []string
	ColumnName string
}

FieldInfo is a simple struct to map Column -> Field

type NullInt

type NullInt struct {
	sql.NullInt64
}

NullInt representa a nullable integer

func (NullInt) MarshalJSON

func (r NullInt) MarshalJSON() ([]byte, error)

MarshalJSON interface redefinition

type NullString

type NullString struct {
	sql.NullString
}

NullString representa a nullable string

func (NullString) MarshalJSON

func (r NullString) MarshalJSON() ([]byte, error)

MarshalJSON interface redefinition

type NullTime

type NullTime struct {
	pq.NullTime
}

NullTime representa a nullable time.Time

func (NullTime) MarshalJSON

func (r NullTime) MarshalJSON() ([]byte, error)

MarshalJSON interface redefinition

type RowMapper

type RowMapper struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

RowMapper is responsible for mapping a sql.Rows into a Struct (model)

func NewRowMapper

func NewRowMapper() *RowMapper

NewRowMapper creates a new instance of RowMapper

func (*RowMapper) Map

func (m *RowMapper) Map(dest interface{}, columns []string, scanner func(dest ...interface{}) error) error

Map values from scanner (usually sql.Rows.Scan) into dest based on columns

type Trx

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

Trx represents a Database transaction

func (*Trx) Commit

func (trx *Trx) Commit() error

Commit current transaction

func (*Trx) Count

func (trx *Trx) Count(command string, args ...interface{}) (int, error)

Count returns number of rows

func (*Trx) Execute

func (trx *Trx) Execute(command string, args ...interface{}) (int64, error)

Execute given SQL command

func (*Trx) Exists

func (trx *Trx) Exists(command string, args ...interface{}) (bool, error)

Exists returns true if at least one record is found

func (*Trx) Get

func (trx *Trx) Get(data interface{}, command string, args ...interface{}) error

Get first row and bind to given data

func (*Trx) NoLogs

func (trx *Trx) NoLogs()

NoLogs disable logs for this transaction

func (*Trx) QueryIntArray

func (trx *Trx) QueryIntArray(command string, args ...interface{}) ([]int, error)

QueryIntArray executes given SQL command and return first column as int

func (*Trx) ResumeLogs

func (trx *Trx) ResumeLogs()

ResumeLogs resume logs for this transaction

func (*Trx) Rollback

func (trx *Trx) Rollback() error

Rollback current transaction

func (*Trx) Scalar

func (trx *Trx) Scalar(data interface{}, command string, args ...interface{}) error

Scalar returns first row and first column

func (*Trx) Select

func (trx *Trx) Select(data interface{}, command string, args ...interface{}) error

Select all matched rows bind to given data

func (*Trx) SetLogger

func (trx *Trx) SetLogger(logger log.Logger)

SetLogger replaces current transaction Logger

type TypeMapper

type TypeMapper struct {
	Type   reflect.Type
	Fields map[string]FieldInfo
}

TypeMapper holds information about how to map SQL ResultSet to a Struct

func NewTypeMapper

func NewTypeMapper(t reflect.Type) TypeMapper

NewTypeMapper creates a new instance of TypeMapper for given reflect.Type