DCRcoder / fei

mysql experimental ORM. it base on squirrel

Fei(胐胐)

注: 又北四十里，曰霍山，其木多榖。有兽焉，其状如狸，而白尾，有鬣，名曰腓腓，养之可以已忧。——《山海经·卷五·中山经》

mysql experimental ORM. it base on squirrel

Init

import (
    	_ "github.com/go-sql-driver/mysql"
)

func main() {
    // init db
    engine, err := NewEngine("mysql", dbAddr)
    // init db 读写分离
    engine, err := NewEngineWithMS("mysql", masterAddr, []slaveAddr)
    // init db with config
    // type Config struct {
	//    Driver       string
	//    MasterAddr   string
	//    SlavesAddr   []string
	//    MaxIdleConns int
	//    MaxOpenConns int
	//    Logger       Logger
	//    LogLevel     LogLevel
    // }
    engine, err := New(cfg)
}

Session

    session := engine.NewSession()
    // with context
    session := engine.NewSessionCtx(ctx)

Select

    import 	"github.com/DCRcoder/fei"
    // count
    engine.NewSession().Select().From("tableName").Where(fei.Eq{"field": "someting"}).Count()
    // findOne
    user := &User{} 
    engine.NewSession().Select().From("tableName").Where(fei.Eq{"field": "someting"}).FindOne(user) // need pointer
    // fineAll
    users := make([]*User, 0)
    engine.NewSession().Select().From("tableName").Where(fei.Eq{"field": "someting"}).FindAll(&user) // need pointer

    如果 user 定义了 TableName 可以不使用 From 方法
    // e.g
    type User struct {
        Name string
    }

    func (u *User) TableName() string {
        return "user"
    }
    // findOne
    user := &User{}
    engine.NewSession().Select().Where(fei.Eq{"field": "someting"}).FindOne(user) // need pointer
    // fineAll
    users := make([]*User, 0)
    engine.NewSession().Select().Where(fei.Eq{"field": "someting"}).FindAll(&user) // need pointer
    // where 中条件可以多种定义 详情参见 cond.go

Insert

    // insert a record
    user := &User{}
    engine.NewSession().Insert(user)
    // insert multiple
    users := []*User{}
    engine.NewSession().Insert(users)

Update

    // update a record
    user := &User{}
    engine.NewSession().Update(user)
    // update multiple
    users := []*User{}
    engine.NewSession().Update(users)

UpdateRow

    // update a record by updateRow
    user := &User{}
    engine.NewSession().From("table_name").Where(Eq{"id": 12313}).UpdateRow(map[string]interface{}{"name": "xxxx"})

Delete

    // delete a record
    user := &User{}
    engine.NewSession().Delete(user)
    // delete multiple
    users := []*User{}
    engine.NewSession().Delete(users)

Use like normal sql

    // you can also use sql Query, Exec
    engine.NewSession().Query("select * from user")
    engine.NewSession().QueryContext(ctx, "select * from user")
    engine.NewSession().Exec("insert ....")
    engine.NewSession().ExecContext("insert ....")

TODO

• plugin