gopostgres

README

go-postgres

A simple mockable postgres db interface

    mm := &PgDB{
	    Host:     "localhost",
        Port:     "5432",
	    User:     "test",
	    Password: "test",
	    Database: "test",				
    }
    m := mm.New()
    m.Connect()
    //Insert requires  RETURNING id on end of prepared statement query
        //Example: "insert into carrier (carrier, type, store_id) values($1, $2, $3) RETURNING id"
    m.Insert(query, args...)
    m.Update(query, args...)
    m.Get(query, args...)
    m.GetList(query, args...)
    m.Delete(query, args...)

Also Supports Transactions

 mm := &PgDB{
	    Host:     "localhost",
        Port:     "5432",
	    User:     "test",
	    Password: "test",
	    Database: "test",				
    }
    m := mm.New()
    m.Connect()
    tr := m.BeginTransaction()
    //Insert requires  RETURNING id on end of prepared statement query
        //Example: "insert into carrier (carrier, type, store_id) values($1, $2, $3) RETURNING id"
    tr.Insert(query, args...)
    tr.Update(query, args...)
    tr.Get(query, args...)
    tr.GetList(query, args...)
    tr.Delete(query, args...)
    tr.Commit()
    //Or
    tr.Rollback()

Documentation

Index

• type Database
• type DbRow
• type DbRows
• type PgDB
  • func (p *PgDB) BeginTransaction() Transaction
  • func (p *PgDB) Close() bool
  • func (p *PgDB) Connect() bool
  • func (p *PgDB) Delete(query string, args ...any) bool
  • func (p *PgDB) Get(query string, args ...any) *DbRow
  • func (p *PgDB) GetList(query string, args ...any) *DbRows
  • func (p *PgDB) Insert(query string, args ...any) (bool, int64)
  • func (p *PgDB) New() Database
  • func (p *PgDB) Test(query string, args ...any) *DbRow
  • func (p *PgDB) Update(query string, args ...any) bool
• type PgDBMock
  • func (p *PgDBMock) BeginTransaction() Transaction
  • func (p *PgDBMock) Close() bool
  • func (p *PgDBMock) Connect() bool
  • func (p *PgDBMock) Delete(query string, args ...any) bool
  • func (p *PgDBMock) Get(query string, args ...any) *DbRow
  • func (p *PgDBMock) GetList(query string, args ...any) *DbRows
  • func (p *PgDBMock) GetNewDatabase() Database
  • func (p *PgDBMock) Insert(query string, args ...any) (bool, int64)
  • func (p *PgDBMock) New() Database
  • func (p *PgDBMock) Test(query string, args ...any) *DbRow
  • func (p *PgDBMock) Update(query string, args ...any) bool
• type PgDbTx
  • func (t *PgDbTx) Commit() bool
  • func (t *PgDbTx) Delete(query string, args ...any) bool
  • func (t *PgDbTx) Insert(query string, args ...any) (bool, int64)
  • func (t *PgDbTx) Rollback() bool
  • func (t *PgDbTx) Update(query string, args ...any) bool
• type PgDbTxMock
  • func (t *PgDbTxMock) Commit() bool
  • func (t *PgDbTxMock) Delete(query string, args ...any) bool
  • func (t *PgDbTxMock) Insert(query string, args ...any) (bool, int64)
  • func (t *PgDbTxMock) Rollback() bool
  • func (t *PgDbTxMock) Update(query string, args ...any) bool
• type Transaction

Types

type Database

type Database interface {
	Connect() bool
	BeginTransaction() Transaction
	Test(query string, args ...any) *DbRow
	Insert(query string, args ...any) (bool, int64)
	Update(query string, args ...any) bool
	Get(query string, args ...any) *DbRow
	GetList(query string, args ...any) *DbRows
	Delete(query string, args ...any) bool
	Close() bool
}

Database Database

type DbRow

type DbRow struct {
	Columns []string
	Row     []string
}

DbRow database row

type DbRows

type DbRows struct {
	Columns []string
	Rows    [][]string
}

DbRows array of database rows

type PgDB

type PgDB struct {
	Host     string
	Port     string
	User     string
	Password string
	Database string
	// contains filtered or unexported fields
}

PgDB PgDB

func (*PgDB) BeginTransaction

func (p *PgDB) BeginTransaction() Transaction

BeginTransaction BeginTransaction

func (*PgDB) Close

func (p *PgDB) Close() bool

Close Close

func (*PgDB) Connect

func (p *PgDB) Connect() bool

Connect Connect

func (*PgDB) Delete

func (p *PgDB) Delete(query string, args ...any) bool

Delete Delete

func (*PgDB) Get

func (p *PgDB) Get(query string, args ...any) *DbRow

Get Get

func (*PgDB) GetList

func (p *PgDB) GetList(query string, args ...any) *DbRows

GetList GetList

func (*PgDB) Insert

func (p *PgDB) Insert(query string, args ...any) (bool, int64)

Insert Insert requires use of RETURNING id on end of insert query

func (*PgDB) New

func (p *PgDB) New() Database

New NewDatabase

func (*PgDB) Test

func (p *PgDB) Test(query string, args ...any) *DbRow

Test Test

func (*PgDB) Update

func (p *PgDB) Update(query string, args ...any) bool

Update Update

type PgDBMock

type PgDBMock struct {
	Host     string
	User     string
	Password string
	Database string

	MockConnectSuccess  bool
	MockCloseSuccess    bool
	MockCommitSuccess   bool
	MockRollbackSuccess bool

	MockInsertSuccess1 bool
	MockInsertSuccess2 bool
	MockInsertSuccess3 bool
	MockInsertSuccess4 bool
	MockInsertSuccess5 bool
	MockInsertSuccess6 bool
	MockInsertSuccess7 bool
	MockInsertSuccess8 bool

	MockInsertID1 int64
	MockInsertID2 int64
	MockInsertID3 int64
	MockInsertID4 int64
	MockInsertID5 int64
	MockInsertID6 int64
	MockInsertID7 int64
	MockInsertID8 int64

	MockUpdateSuccess1 bool
	MockUpdateSuccess2 bool
	MockUpdateSuccess3 bool
	MockUpdateSuccess4 bool

	MockDeleteSuccess1 bool
	MockDeleteSuccess2 bool
	MockDeleteSuccess3 bool
	MockDeleteSuccess4 bool
	MockDeleteSuccess5 bool
	MockDeleteSuccess6 bool
	MockDeleteSuccess7 bool
	MockDeleteSuccess8 bool

	MockTestRow *DbRow

	MockRow1 *DbRow
	MockRow2 *DbRow
	MockRow3 *DbRow
	MockRow4 *DbRow
	MockRow5 *DbRow
	MockRow6 *DbRow
	MockRow7 *DbRow
	MockRow8 *DbRow

	MockRows1 *DbRows
	MockRows2 *DbRows
	MockRows3 *DbRows
	MockRows4 *DbRows
	MockRows5 *DbRows
	MockRows6 *DbRows
	MockRows7 *DbRows
	MockRows8 *DbRows
	// contains filtered or unexported fields
}

PgDBMock PgDBMock

func (*PgDBMock) BeginTransaction

func (p *PgDBMock) BeginTransaction() Transaction

BeginTransaction BeginTransaction

func (*PgDBMock) Close

func (p *PgDBMock) Close() bool

Close Close

func (*PgDBMock) Connect

func (p *PgDBMock) Connect() bool

Connect Connect

func (*PgDBMock) Delete

func (p *PgDBMock) Delete(query string, args ...any) bool

Delete Delete

func (*PgDBMock) Get

func (p *PgDBMock) Get(query string, args ...any) *DbRow

Get Get

func (*PgDBMock) GetList

func (p *PgDBMock) GetList(query string, args ...any) *DbRows

GetList GetList

func (*PgDBMock) GetNewDatabase

func (p *PgDBMock) GetNewDatabase() Database

GetNewDatabase GetNewDatabase

func (*PgDBMock) Insert

func (p *PgDBMock) Insert(query string, args ...any) (bool, int64)

Insert Insert

func (*PgDBMock) New

func (p *PgDBMock) New() Database

New New

func (*PgDBMock) Test

func (p *PgDBMock) Test(query string, args ...any) *DbRow

Test Test

func (*PgDBMock) Update

func (p *PgDBMock) Update(query string, args ...any) bool

Update Update

type PgDbTx

type PgDbTx struct {
	Tx *sql.Tx
}

PgDbTx PgDbTx

func (*PgDbTx) Commit

func (t *PgDbTx) Commit() bool

Commit Commit

func (*PgDbTx) Delete

func (t *PgDbTx) Delete(query string, args ...any) bool

Delete Delete

func (*PgDbTx) Insert

func (t *PgDbTx) Insert(query string, args ...any) (bool, int64)

Insert Insert

func (*PgDbTx) Rollback

func (t *PgDbTx) Rollback() bool

Rollback Rollback

func (*PgDbTx) Update

func (t *PgDbTx) Update(query string, args ...any) bool

Update Update

type PgDbTxMock

type PgDbTxMock struct {
	Tx       *sql.Tx
	PgDBMock *PgDBMock
}

PgDbTxMock PgDbTxMock

func (*PgDbTxMock) Commit

func (t *PgDbTxMock) Commit() bool

Commit Commit

func (*PgDbTxMock) Delete

func (t *PgDbTxMock) Delete(query string, args ...any) bool

Delete Delete

func (*PgDbTxMock) Insert

func (t *PgDbTxMock) Insert(query string, args ...any) (bool, int64)

Insert Insert

func (*PgDbTxMock) Rollback

func (t *PgDbTxMock) Rollback() bool

Rollback Rollback

func (*PgDbTxMock) Update

func (t *PgDbTxMock) Update(query string, args ...any) bool

Update Update

type Transaction

type Transaction interface {
	Insert(query string, args ...any) (bool, int64)
	Update(query string, args ...any) bool
	Delete(query string, args ...any) bool
	Commit() bool
	Rollback() bool
}

Transaction transaction