dbx

Documentation

Index

• Variables
• func Connection() *sql.DB
• func Migrate(ctx context.Context, path string) error
• func Ping() error
• func Seed()
• 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 BeginTx(ctx context.Context) (*Trx, error)
  • 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) MustCommit()
  • func (trx *Trx) MustRollback()
  • func (trx *Trx) Query(command string, args ...interface{}) (*sql.Rows, error)
  • 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
• 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

Functions

func Connection

func Connection() *sql.DB

func Migrate

func Migrate(ctx context.Context, path string) error

Migrate the database to latest version

func Ping

func Ping() error

Ping checks if current database connection is healthy

func Seed

func Seed()

Seed clean and insert new seed data for testing

Types

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 BeginTx

func BeginTx(ctx context.Context) (*Trx, error)

BeginTx returns a new SQL 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) MustCommit

func (trx *Trx) MustCommit()

MustCommit current transaction

func (*Trx) MustRollback

func (trx *Trx) MustRollback()

MustRollback current transaction

func (*Trx) Query

func (trx *Trx) Query(command string, args ...interface{}) (*sql.Rows, error)

Query all matched rows and return raw sql.Rows

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

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