db

Documentation

Index

• func New(driverName string, conStr string) (*sql.DB, error)
• type Completer
• type Query
  • func (q Query) Create(name string, definition ...string) error
  • func (q Query) CreateCtx(ctx context.Context, name string, definition ...string) error
  • func (q Query) Delete(i interface{}) Completer
  • func (q Query) Find(i interface{}) Completer
  • func (q Query) FindAll(i interface{}) ([]map[string]interface{}, error)
  • func (q Query) FindAllCtx(ctx context.Context, i interface{}) ([]map[string]interface{}, error)
  • func (q Query) Insert(i interface{}) (int64, error)
  • func (q Query) InsertCtx(ctx context.Context, i interface{}) (int64, error)
  • func (q Query) TxCreateCtx(ctx context.Context, tx *sql.Tx, name string, definition ...string) error
  • func (q Query) TxFindAllCtx(ctx context.Context, tx *sql.Tx, i interface{}) ([]map[string]interface{}, error)
  • func (q Query) TxInsertCtx(ctx context.Context, tx *sql.Tx, i interface{}) (int64, error)
  • func (q Query) Update(i interface{}) Completer

Functions

func New

func New(driverName string, conStr string) (*sql.DB, error)

* e.g conn, err := db.New("postgres", "postgres://postgres:password@localhost:port_no/db_name")

Types

type Completer

type Completer interface {
	/*
	 *	set update data
	 * 	m equals struct matching db relation
	 */
	Set(m map[string]interface{}) Completer
	/*
	 * 	execute non returning query like update and delete
	 */
	Apply() error
	/*
	 * 	execute non returning query like update and delete with context
	 */
	ApplyCtx(ctx context.Context) error
	/*
	 * 	execute non returning query like update and delete with context in a transaction
	 */
	TxApplyCtx(ctx context.Context, tx *sql.Tx) error
	/*
	 * 	execute select or queries returning many rows
	 */
	Many(i interface{}) error
	/*
	 * 	execute select or queries returning many rows with context
	 */
	ManyCtx(ctx context.Context, i interface{}) error
	/*
	 * 	execute select or queries returning many rows with context in a transaction
	 */
	TxManyCtx(ctx context.Context, tx *sql.Tx, i interface{}) error
	/*
	 * 	execute select scan into provided interface
	 */
	One(i interface{}) error
	/*
	 * 	execute select scan into provided interface with context
	 */
	OneCtx(ctx context.Context, i interface{}) error
	/*
	 * 	execute select scan into provided interface with context in a transaction
	 */
	TxOneCtx(ctx context.Context, tx *sql.Tx, i interface{}) error
	/*
	 *	where condition
	 *	could be map[string]interface{} or []map[string]interface{}
	 *  e.g. map[string]interface{ "id": 1 }
	 */
	Where(any) Completer
	/*
	 * 	perform query for values in list
	 */
	In(field string, values []interface{}) Completer
}

type Query

type Query struct {
	Conn *sql.DB
}

func (Query) Create

func (q Query) Create(name string, definition ...string) error

create table

func (Query) CreateCtx

func (q Query) CreateCtx(ctx context.Context, name string, definition ...string) error

create table with context

func (Query) Delete

func (q Query) Delete(i interface{}) Completer

delete data

func (Query) Find

func (q Query) Find(i interface{}) Completer

find data from relation

func (Query) FindAll

func (q Query) FindAll(i interface{}) ([]map[string]interface{}, error)

find all from relation

func (Query) FindAllCtx

func (q Query) FindAllCtx(ctx context.Context, i interface{}) ([]map[string]interface{}, error)

find all with context from relation

func (Query) Insert

func (q Query) Insert(i interface{}) (int64, error)

insert into table

func (Query) InsertCtx

func (q Query) InsertCtx(ctx context.Context, i interface{}) (int64, error)

insert into table with context

func (Query) TxCreateCtx

func (q Query) TxCreateCtx(ctx context.Context, tx *sql.Tx, name string, definition ...string) error

tx create table with context

func (Query) TxFindAllCtx

func (q Query) TxFindAllCtx(ctx context.Context, tx *sql.Tx, i interface{}) ([]map[string]interface{}, error)

TX find all with context from relation

func (Query) TxInsertCtx

func (q Query) TxInsertCtx(ctx context.Context, tx *sql.Tx, i interface{}) (int64, error)

TX insert into table with context

func (Query) Update

func (q Query) Update(i interface{}) Completer

update table