pipet

README

Pipet

GORM wrapper to connect to read and write databases

Install

go get github.com/ekyfauzi/pipet

Usages

Connection

import "github.com/ekyfauzi/pipet"

func main() {
  host := "YOUR_DB_WRITE_HOST"
  hostRead := "YOUR_DB_READ_HOST"
  port := "YOUR_DB_PORT"
  user := "YOUR_DB_USER"
  passwd := "YOUR_DB_PASSWORD"
  dbName := "YOUR_DB_NAME"
  
  // Set default connection
  conn := pipet.Init("mysql")
  conn.SetWrite(host, port, user, passwd, dbName)
  
  // Add read db connection
  // You can skip this if your read and write database in the same host
  // You also can set multiple read connection
  conn.SetRead(hostRead, port, user, passwd, dbName)
  
}

Functions

Because this library is a wrapper of GORM so basically usages of functions are same.

conn.Where()
conn.Save()
conn.Create()
conn.Exec()

If you want to get instance of connection to database, you can use:

// Get write connection
// Return *gorm.DB
conn.Instance("write")

// Get read connection
// Return *gorm.DB
conn.Instance("read")

then you can use as usual GORM

Documentation

Index

• type Pipet
  • func Init(driver string) *Pipet
  • func (s *Pipet) Conn() *gorm.DB
  • func (s *Pipet) Create(value interface{}) *gorm.DB
  • func (s *Pipet) Exec(sql string, values ...interface{}) *gorm.DB
  • func (s *Pipet) Instance(conn string) *gorm.DB
  • func (s *Pipet) Save(value interface{}) *gorm.DB
  • func (s *Pipet) SetRead(host string, port string, user string, password string, database string)
  • func (s *Pipet) SetWrite(host string, port string, user string, password string, database string)
  • func (s *Pipet) Where(query interface{}, args ...interface{}) *gorm.DB

Types

type Pipet

type Pipet struct {
	Driver        string
	ReadDatabases []*gorm.DB
	WriteDatabase *gorm.DB
}

func Init

func Init(driver string) *Pipet

func (*Pipet) Conn

func (s *Pipet) Conn() *gorm.DB

func (*Pipet) Create

func (s *Pipet) Create(value interface{}) *gorm.DB

func (*Pipet) Exec

func (s *Pipet) Exec(sql string, values ...interface{}) *gorm.DB

func (*Pipet) Instance

func (s *Pipet) Instance(conn string) *gorm.DB

func (*Pipet) Save

func (s *Pipet) Save(value interface{}) *gorm.DB

func (*Pipet) SetRead

func (s *Pipet) SetRead(host string, port string, user string, password string, database string)

func (*Pipet) SetWrite

func (s *Pipet) SetWrite(host string, port string, user string, password string, database string)

func (*Pipet) Where

func (s *Pipet) Where(query interface{}, args ...interface{}) *gorm.DB