gorose

package module
v3.0.0-...-e2af5f4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2024 License: MIT Imports: 15 Imported by: 0

README

GoRose ORM V3

PHP Laravel ORM 的 go 实现, 与 laravel 官方文档保持一致 https://laravel.com/docs/10.x/queries .
分为 go 风格 (struct 结构绑定用法) 和 php 风格 (map 结构用法).
php 风格用法, 完全可以使用 laravel query builder 的文档做参考, 尽量做到 1:1 还原.

安装

目前还处于beta阶段, 请谨慎使用. 由于没有打 tag, 只能使用 go mod 的方式引入

# go.mod

require github.com/gohouse/gorose/v3 master

概览

go风格用法

package main

import (
    gorose "github.com/gohouse/gorose/v3"
    // 引入mysql驱动
    _ "github.com/go-sql-driver/mysql"
)

type User struct {
	Id    int64  `db:"id,pk"`   // 这里的 pk 是指主键
	Name  string `db:"name"`
	Email string `db:"email"`
    
    // 定义表名字,等同于 func (User) TableName() string {return "users"}, 二选一即可
	// TableName string `db:"users" json:"-"` 
}
func (User) TableName() string {
    return "users"
}

var rose = gorose.Open("mysql", "root:123456@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=true")

func db() *gorose.Database {
	return rose.NewDatabase()
}
func main() {
    // select id,name,email from users limit 1;
    var user User
    db().To(&user)

    // insert into users (name,email) values ("test","test@test.com");
    var user = User{Name: "test", Email: "test@test.com"}}
    db().Insert(&user)

    // update users set name="test2" where id=1;
    var user = User{Id: 1, Name: "test2"}
    db().Update(&user)

    // delete from users where id=1;
    var user = User{Id: 1}
    db().Delete(&user) 
}

php风格用法 和 go风格用法对比

// select id,name,email from users where id=1 and name="test"
db().Table("users").
    Select("id","name","email").
    Where("id", "=", 1).Where("name", "test").
    First()
// 等同于
var user = User{Id: 1, Name: "test"}
db().To(&user)

由此可以看出, 除了对 表 模型的绑定区别, 其他方法通用

配置

单数据库连接, 可以直接同官方接口一样用法

var rose = gorose.Open("mysql", "root:123456@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=true")

也可以用

var conf1 = gorose.Config{
    Driver:          "mysql",
    DSN:             "root:123456@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=true",
    Prefix:          "tb_",
    Weight:          0,
    MaxIdleConns:    0,
    MaxOpenConns:    0,
    ConnMaxLifetime: 0,
    ConnMaxIdleTime: 0,
}
var rose = gorose.Open(conf)

或者使用读写分离集群,事务内,自动强制从写库读数据

var rose = gorose.Open(
    gorose.ConfigCluster{
        WriteConf: []gorose.Config{
            conf1,
            conf2,
        },
        ReadConf: []gorose.Config{
            conf3,
            conf4,
        }
    },
)

事务

// 全自动事务, 有错误会自动回滚, 无错误会自动提交
// Transaction 方法可以接收多个操作, 同用一个 tx, 方便在不同方法内处理同一个事务
db().Transaction(func(tx gorose.TxHandler) error {
    tx().Insert(&user)
    tx().Update(&user)
    tx().To(&user)
}

// 手动事务
tx = db().Begin()
tx().Insert(&user)
tx().Update(&user)
tx().To(&user)
tx().Rollback()
tx().Commit()

// 全自动嵌套事务
db().Transaction(func(tx gorose.TxHandler) error {
    tx().Insert(&user)
    ...
    // 自动子事务
    tx().Transaction(func(tx2 gorose.TxHandler) error {
        tx2().Update(&user)
        ...
    }
}

// 手动嵌套事务
var tx = db().Begin()
// 自动子事务
tx().Begin() // 自动 savepoint 子事务
...
tx().Rollback()   // 自动回滚到上一个 savepoint
...
// 手动子事务
tx().SavePoint("savepoint1")    // 手动 savepoint 到 savepoint1(自定义名字)
...
tx().RollbackTo("savepoint1") // 手动回滚到自定义的 savepoint
tx().Commit()

update

在插入和更新数据时,如果使用 struct 模型作为数据对象的时候, 默认忽略类型零值,如果想强制写入,则可以从第二个参数开始传入需要强制写入的字段即可,如:

var user = User{Id: 1, Name: "test"}
// 这里不会对 sex 做任何操作, 
//update user set name="test" where id=1
db().Update(&user)
// 这里会强制将sex更改为0
//update user set name="test", sex=0 where id=1
db().Update(&user, "sex")
// 等同于
db().Table(&user).Where("id", 1).Update(map[string]any{"name": "test", "sex": 0}))

如果没有where条件,则会自动添加tag中指定了pk的字段作为条件,如: db:"id,pk", 因为指定了 pk,如果 id 的值不为0值, 则 id 会作为主键条件更新

insert

参考 update

delete

var user = User{Id: 1}
db().Delete(&user)
// 等同于
db().Table(&user).Where("id", 1).Delete()
// 要加上字段0值条件,只需要传入第二个字段,如:
// delete from users where id=1 and sex=0 and name=""
db().Delete(&user, "sex", "name")

table

  • 参数
    table 参数, 可以是字符串, 也可以是 User 结构体
db().Table(User{})
db().Table("users")
  • 取别名
db().Table(User{}, "u")
db().Table("users", "u")
  • 结果集查询
sub := db().Table("users").Select("id", "name")
db().Table(sub).Where("id", ">", 1).Get()

join

type UserInfo struct {
    UserId      int64   `db:"user_id"`
    TableName   string  `db:"user_info"`
}
  • 简单用法
db().Table("users").Join(UserInfo{}, "user.id", "=", "user_info.user_id").Get()
  • 取别名
// select * from users a inner join user_info b on a.id=b.user_id
db().Table("users", "u").Join(gorose.As(UserInfo{}, "b"), "u.id", "=", "b.user_id").Get()
// 等同于
db().Table(User{}, "u").Join(gorose.As("user_info", "b"), "u.id", "=", "b.user_id").Get()

gorose.As(UserInfo{}, "b") 中, user_info 取别名 b

  • 复杂用法
db().Table("users").Join(UserInfo{}, func(wh builder.IJoinOn) {
    wh.On("a.id", "b.user_id").OrOn("a.sex", "b.sex")
}).Get()
// 等同于
db().Table("users").JoinOn(UserInfo{}, func(wh builder.IJoinOn) {
    wh.On("a.id", "b.user_id").OrOn("a.sex", "b.sex")
}).Get()

当Join的第二个参数为builder.IJoinOn时,等同于JoinOn用法(第二个参数有强类型提醒,方便ide快捷提示)

where sub

// where id in (select user_id from user_info)
sub := db().Table("user_info").Select("user_id")
db().Table(User{}).Where("id", "in", sub).Get()
  • where sub query
// where id in (select user_id from user_info)
db().Table(User{}).WhereSub("id", "in", func(tx *builder.Context) {
    tx.Table("user_info").Select("user_id")
}).Get()
  • where sub builder
// where id in (select user_id from user_info)
sub := db().Table("user_info").Select("user_id")
db().Table(User{}).WhereBuilder("id", "in", sub).Get()

以上3种用法等同

where nested

// where id>1 and (sex=1 or sex=2)
db().Table(User{}).Where("id",">", 1).Where(func(wh builder.IWhere) {
    wh.Where("sex", 1).OrWhere("sex", 2)
})

// where id>1 and (sex=1 or sex=2)
db().Table(User{}).Where("id",">", 1).WhereNested(func(wh builder.IWhere) {
    wh.Where("sex", 1).OrWhere("sex", 2)
})

以上两种用法等同

子查询

Table,Where,Join内都可以用子查询

sub := db().Table("user").Where().OrWhere()
sub2 := db().Table("address").Select("user_id").Where().OrWhere()
sub3 := db().Table("user_info").Select("user_id").Where().OrWhere()

用在 Table,Where,Join 内

db().
    Table(sub, "a").
    Join(gorose.As(sub2, "b"), "a.id", "=", "b.user_id")).
    WhereIn("a.id", sub3).
    Get()

用在 Union,UnionAll 内

db().
    Table("users").
    Union(sub).
    Get()

var sub2222 = db().Table("user").Where().OrWhere()
var to []User
db().
    Table("users").
    UnionAll(sub, sub2222).
    To(&to)

Pluck

返回两列数据到一个map中,第一列为value,第二列为key

// select id,name from users
db().Table("users").Pluck("name", "id")
// 返回 map[<id>]<name>, 实际得到 map[int64]string{1: "张三", 2: "李四"}

List

返回一列数据到一个数组中

// select id,name from users
db().Table("users").List("id")
// 返回 []<id>, 实际得到 []int64{1,2,3}

To 查询结果绑定到对象

使用结构体字段作为 select 字段
使用结构体字段值作为 where 条件
查询结果绑定到结构体,支持一条或多条

// 查询一条数据
var user User
db().To(&user)

// 查询条件,一条数据
// select id,name,email from users where id=1
var user = User{Id: 1}
db().To(&user)

// 查询多条数据
var users []User
db().To(&users)

// 查询条件,多条数据
var users []User
db().Where("id", ">", 1).To(&users)

Bind 查询结果绑定到对象

仅仅用作查询结果的绑定
结构体字段,不作为查询字段和条件
常用作join或者手动指定字段查询绑定

type Result struct {
    Id    int64  `db:"id"`
    Aname string `db:"aname"`
    Bname string `db:"bname"`
}
var res Result
// select a.id, a.name aname, b.name bname from a inner join b on a.id=b.id where a.id>1
db().Table("a").Join("b", "a.id","b.aid").Select("a.id", "a.name aname","b.name bname").Where("a.id", ">", 1).Bind(&res)

查询字段的显示名字一定要跟 结构体的字段 tag(db) 名字相同, 否则不会被赋值
字段数量可以不一样

ListTo,PluckTo,ValueTo

var list []int
db().Table("users").ListTo("age", &list)
var pluck map[int64]string
db().Table("users").PluckTo("name","id", &pluck)
var value int
db().Table("users").ValueTo("age", &value)

SumTo,MaxTo,MinTo

var sum int
db().Table("users").SumTo("age", &sum)
var max int
db().Table("users").MaxTo("age", &max)
var min int
db().Table("users").MinTo("age", &min)

日志

默认采用 官方库的 slog debug level, 如果不想显示sql日志, 只需要设置slog的level到debug以上即可, 如: Info, Warn, Error

驱动

只要实现了 gorose/driver.IDriver 接口即可,理论上可以支持任意数据库, 目前实现了mysql的支持, 可以开发更多接口的支持

数据库字段为null的处理

type User struct {
    Id  int64  `db:"id,pk"`
    Sex *int8  `db:"sex"` // 使用指针可以绑定 null 值
    Age sql.NullInt64 `db:"age"` // 使用sql.NullInt64 可以绑定 null 值
}

指针赋值

var sex = int8(1)
var user = User{Id: 1, Sex: &sex}
// 或者,快捷用法
var user = User{Id: 1, Sex: gorose.Ptr(int8(1))}

sql.Null* 赋值

var age = sql.NullInt64{Int64: 18, Valid: true}

sql.Null* 使用

if age.Valid {
    fmt.Println(age.Int64)
}

由此可见,null处理起来还是有点麻烦,所以,建议在设计表的时候,不要允许null即可,给定默认值,而大部分默认值刚好可以与go的类型零值对应

已经支持的 laravel query builder 方法

  • Table

  • Select

  • SelectRaw

  • AddSelect

  • Join

  • GroupBy

  • Having

  • HavingRaw

  • OrHaving

  • OrHavingRaw

  • OrderBy

  • Limit

  • Offset

  • Where

  • WhereRaw

  • OrWhere

  • OrWhereRaw

  • WhereBetween

  • OrWhereBetween

  • WhereNotBetween

  • OrWhereNotBetween

  • WhereIn

  • OrWhereIn

  • WhereNotIn

  • OrWhereNotIn

  • WhereNull

  • OrWhereNull

  • WhereNotNull

  • OrWhereNotNull

  • WhereLike

  • OrWhereLike

  • WhereNotLike

  • OrWhereNotLike

  • WhereExists

  • WhereNotExists

  • WhereNot

  • Get

  • First

  • Find

  • Insert

  • Update

  • Delete

  • Max

  • Min

  • Sum

  • Avg

  • Count

  • InsertGetId

  • Upsert

  • InsertOrIgnore

  • Exists

  • DoesntExist

  • Pluck

  • List

  • Value

  • Increment

  • Decrement

  • IncrementEach

  • DecrementEach

  • Truncate

  • Union

  • UnionAll

  • SharedLock

  • LockForUpdate

额外增加的 api

  • Replace

  • Page

  • LastSql

  • WhereBuilder

  • OrWhereBuilder

  • WhereSub

  • OrWhereSub

  • WhereNested

  • OrWhereNested

  • To

  • Bind

  • ListTo

  • PluckTo

  • ValueTo

  • SumTo

  • MaxTo

  • UnionTo

  • UnionAllTo

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func As 

func As(table any, alias string) builder.TableClause

func GetRandomInt 

func GetRandomInt(num int) int

func GetRandomWeightedIndex 

func GetRandomWeightedIndex(weights []int) int

func NamedSprintf 

func NamedSprintf(format string, a ...any) string

func Null 

func Null[T any](arg T) sql.Null[T]

func Ptr 

func Ptr[T any](arg T) *T

Types

type Config 

type Config struct {
	Driver          string
	DSN             string
	Prefix          string
	Weight          int8 // 权重越高,选中的概率越大
	MaxIdleConns    int
	MaxOpenConns    int
	ConnMaxLifetime time.Duration
	ConnMaxIdleTime time.Duration
}

type ConfigCluster 

type ConfigCluster struct {
	WriteConf []Config
	ReadConf  []Config
}

type Database 

type Database struct {
	*Engin
	Driver  driver.IDriver
	Context *builder.Context
}

func NewDatabase 

func NewDatabase(g *GoRose) *Database

func (*Database) AddSelect 

func (db *Database) AddSelect(columns ...string) *Database

AddSelect 添加选择列

func (*Database) Avg 

func (db *Database) Avg(column string) (res float64, err error)

func (*Database) Begin 

func (db *Database) Begin() (tx TxHandler, err error)

func (*Database) Bind 

func (db *Database) Bind(obj any) (err error)

Bind 查询结果,绑定到结构体 与 To 的区别是,绑定字段不作为查询依据 经常用在join语句中,手动指定查询字段,然后直接绑定到一个结构体

func (*Database) Count 

func (db *Database) Count() (res int64, err error)

func (*Database) CrossJoin 

func (db *Database) CrossJoin(table any, argOrFn ...any) *Database

CrossJoin clause

func (*Database) Decrement 

func (db *Database) Decrement(column string, steps ...any) (affectedRows int64, err error)

func (*Database) DecrementEach 

func (db *Database) DecrementEach(data map[string]any) (affectedRows int64, err error)

func (*Database) Delete 

func (db *Database) Delete(obj any, mustColumn ...string) (affectedRows int64, err error)

func (*Database) DoesntExist 

func (db *Database) DoesntExist(bind ...any) (b bool, err error)

func (*Database) Exists 

func (db *Database) Exists(bind ...any) (b bool, err error)

func (*Database) Find 

func (db *Database) Find(id int) (res map[string]any, err error)

func (*Database) First 

func (db *Database) First(columns ...string) (res map[string]any, err error)

func (*Database) Get 

func (db *Database) Get(columns ...string) (res []map[string]any, err error)

Get 获取查询结果集。

columns: 要获取的列名数组，如果不提供，则获取所有列。

func (*Database) GroupBy 

func (db *Database) GroupBy(columns ...string) *Database

GroupBy 添加 GROUP BY 子句

func (*Database) GroupByRaw 

func (db *Database) GroupByRaw(columns ...string) *Database

func (*Database) Having 

func (db *Database) Having(column any, argsOrClosure ...any) *Database

Having 添加 HAVING 子句, 同where

func (*Database) HavingRaw 

func (db *Database) HavingRaw(raw string, argsOrClosure ...any) *Database

HavingRaw 添加 HAVING 子句, 同where

func (*Database) Increment 

func (db *Database) Increment(column string, steps ...any) (affectedRows int64, err error)

func (*Database) IncrementEach 

func (db *Database) IncrementEach(data map[string]any) (affectedRows int64, err error)

func (*Database) Insert 

func (db *Database) Insert(obj any, mustColumn ...string) (affectedRows int64, err error)

func (*Database) InsertGetId 

func (db *Database) InsertGetId(obj any, mustColumn ...string) (lastInsertId int64, err error)

InsertGetId 插入数据,获取并自增id

参考 https://laravel.com/docs/10.x/queries#auto-incrementing-ids

func (*Database) InsertOrIgnore 

func (db *Database) InsertOrIgnore(obj any, mustColumn ...string) (affectedRows int64, err error)

InsertOrIgnore 插入数据，忽略错误。

参考 https://laravel.com/docs/10.x/queries#insert-statements

func (*Database) Join 

func (db *Database) Join(table any, argOrFn ...any) *Database

Join clause

func (*Database) JoinOn 

func (db *Database) JoinOn(table any, fn func(on builder.IJoinOn)) *Database

func (*Database) LeftJoin 

func (db *Database) LeftJoin(table any, argOrFn ...any) *Database

LeftJoin clause

func (*Database) Limit 

func (db *Database) Limit(limit int) *Database

Limit 设置查询结果的限制数量。

func (*Database) List 

func (db *Database) List(column string) (res []any, err error)

List 获取指定列的值列表。

func (*Database) ListTo 

func (db *Database) ListTo(column string, obj any) (err error)

ListTo 获取指定列的值列表。

func (*Database) LockForUpdate 

func (db *Database) LockForUpdate() *Database

LockForUpdate 4 select ... for update

func (*Database) Max 

func (db *Database) Max(column string) (res float64, err error)

func (*Database) MaxTo 

func (db *Database) MaxTo(column string, obj any) (err error)

MaxTo 同 Max 

obj为具体类型的变量,如: var a int, obj 为 &a, 可以得到具体类型

func (*Database) Min 

func (db *Database) Min(column string) (res float64, err error)

func (*Database) MinTo 

func (db *Database) MinTo(column string, obj any) (err error)

MinTo 同 Min, 参考 MaxTo

func (*Database) Offset 

func (db *Database) Offset(offset int) *Database

Offset 设置查询结果的偏移量。

func (*Database) OrHaving 

func (db *Database) OrHaving(column any, argsOrClosure ...any) *Database

func (*Database) OrHavingRaw 

func (db *Database) OrHavingRaw(raw string, argsOrClosure ...any) *Database

func (*Database) OrWhere 

func (db *Database) OrWhere(column any, argsOrclosure ...any) *Database

func (*Database) OrWhereBetween 

func (db *Database) OrWhereBetween(column string, value any) *Database

func (*Database) OrWhereBuilder 

func (db *Database) OrWhereBuilder(column string, operation string, sub builder.IBuilder) *Database

func (*Database) OrWhereIn 

func (db *Database) OrWhereIn(column string, value any) *Database

func (*Database) OrWhereLike 

func (db *Database) OrWhereLike(column, value string) *Database

func (*Database) OrWhereNested 

func (db *Database) OrWhereNested(handler builder.WhereNestedHandler) *Database

func (*Database) OrWhereNull 

func (db *Database) OrWhereNull(column string) *Database

func (*Database) OrWhereRaw 

func (db *Database) OrWhereRaw(raw string, bindings ...any) *Database

func (*Database) OrWhereSub 

func (db *Database) OrWhereSub(column string, operation string, sub builder.WhereSubHandler) *Database

func (*Database) OrderBy 

func (db *Database) OrderBy(column string, directions ...string) *Database

OrderBy adds an ORDER BY clause to the query.

func (*Database) OrderByAsc 

func (db *Database) OrderByAsc(column string) *Database

func (*Database) OrderByDesc 

func (db *Database) OrderByDesc(column string) *Database

func (*Database) OrderByRaw 

func (db *Database) OrderByRaw(column string) *Database

func (*Database) Page 

func (db *Database) Page(num int) *Database

Page 页数,根据limit确定

func (*Database) Paginate 

func (db *Database) Paginate(obj ...any) (result Pagination, err error)

func (*Database) Pluck 

func (db *Database) Pluck(column string, keyColumn string) (res map[any]any, err error)

Pluck 从查询结果集中获取键值对列表。

func (*Database) PluckTo 

func (db *Database) PluckTo(column string, keyColumn string, obj any) (err error)

PluckTo 从查询结果集中获取键值对列表。

func (*Database) Replace 

func (db *Database) Replace(obj any, mustColumn ...string) (affectedRows int64, err error)

Replace 插入数据，如果存在则替换。

参考 mysql replace into 用法

func (*Database) RightJoin 

func (db *Database) RightJoin(table any, argOrFn ...any) *Database

RightJoin clause

func (*Database) Select 

func (db *Database) Select(columns ...string) *Database

Select specifies the columns to retrieve. Select("a","b") Select("a.id as aid","b.id bid") Select("id,nickname name")

func (*Database) SelectRaw 

func (db *Database) SelectRaw(raw string, binds ...any) *Database

SelectRaw 允许直接在查询中插入原始SQL片段作为选择列。

func (*Database) SharedLock 

func (db *Database) SharedLock() *Database

SharedLock 4 select ... locking in share mode

func (*Database) Sum 

func (db *Database) Sum(column string) (res float64, err error)

func (*Database) SumTo 

func (db *Database) SumTo(column string, obj any) (err error)

SumTo 同 Sum, 参考 MaxTo

func (*Database) Table 

func (db *Database) Table(table any, alias ...string) *Database

func (*Database) To 

func (db *Database) To(obj any, mustColumn ...string) (err error)

To 通用查询,go 绑定 struct/map

func (*Database) ToSql 

func (db *Database) ToSql() (sql4prepare string, values []any, err error)

func (*Database) ToSqlAggregate 

func (db *Database) ToSqlAggregate(function, column string) (sql4prepare string, values []any, err error)

func (*Database) ToSqlDelete 

func (db *Database) ToSqlDelete(obj any, mustColumn ...string) (sqlSegment string, binds []any, err error)

func (*Database) ToSqlExists 

func (db *Database) ToSqlExists(bind ...any) (sql4prepare string, values []any, err error)

func (*Database) ToSqlIncDec 

func (db *Database) ToSqlIncDec(symbol string, data map[string]any) (sql4prepare string, values []any, err error)

func (*Database) ToSqlInsert 

func (db *Database) ToSqlInsert(obj any, args ...builder.TypeToSqlInsertCase) (sqlSegment string, binds []any, err error)

func (*Database) ToSqlJoin 

func (db *Database) ToSqlJoin() (sql4prepare string, binds []any, err error)

func (*Database) ToSqlLimitOffset 

func (db *Database) ToSqlLimitOffset() (sqlSegment string, binds []any)

func (*Database) ToSqlOrderBy 

func (db *Database) ToSqlOrderBy() (sql4prepare string)

func (*Database) ToSqlSelect 

func (db *Database) ToSqlSelect() (sql4prepare string, binds []any)

func (*Database) ToSqlTable 

func (db *Database) ToSqlTable() (sql4prepare string, values []any, err error)

func (*Database) ToSqlTo 

func (db *Database) ToSqlTo(obj any, mustColumn ...string) (sql4prepare string, binds []any, err error)

func (*Database) ToSqlUpdate 

func (db *Database) ToSqlUpdate(obj any, mustColumn ...string) (sqlSegment string, binds []any, err error)

func (*Database) ToSqlWhere 

func (db *Database) ToSqlWhere() (sql4prepare string, values []any, err error)

func (*Database) Transaction 

func (db *Database) Transaction(closure ...func(TxHandler) error) error

func (*Database) Truncate 

func (db *Database) Truncate(obj ...any) (affectedRows int64, err error)

func (*Database) Union 

func (db *Database) Union(b ...builder.IBuilder) *Database

func (*Database) UnionAll 

func (db *Database) UnionAll(b ...builder.IBuilder) *Database

func (*Database) Update 

func (db *Database) Update(obj any, mustColumn ...string) (affectedRows int64, err error)

func (*Database) UpdateOrInsert 

func (db *Database) UpdateOrInsert(conditions, data map[string]any) (affectedRows int64, err error)

UpdateOrInsert 更新数据，如果存在则更新，否则插入。

参考 https://laravel.com/docs/10.x/queries#update-or-insert

func (*Database) Upsert 

func (db *Database) Upsert(obj any, onDuplicateKeys, updateFields []string, mustColumn ...string) (affectedRows int64, err error)

Upsert 插入数据，如果存在则更新。

参考 https://laravel.com/docs/10.x/queries#upserts 如果是mysql,则不需要填写第二个参数,MySQL会自动处理唯一索引和主键冲突问题 

eg: Upsert(obj, []string{"id"}, []string{"age"}, "id", "name")

func (*Database) Value 

func (db *Database) Value(column string) (res any, err error)

func (*Database) ValueTo 

func (db *Database) ValueTo(column string, obj any) (err error)

ValueTo 获取指定字段的值,并绑定到给定的变量中

func (*Database) Where 

func (db *Database) Where(column any, argsOrclosure ...any) *Database

func (*Database) WhereBetween 

func (db *Database) WhereBetween(column string, value any) *Database

func (*Database) WhereBuilder 

func (db *Database) WhereBuilder(column string, operation string, sub builder.IBuilder) *Database

func (*Database) WhereExists 

func (db *Database) WhereExists(clause builder.IBuilder)

func (*Database) WhereIn 

func (db *Database) WhereIn(column string, value any) *Database

func (*Database) WhereLike 

func (db *Database) WhereLike(column, value string) *Database

func (*Database) WhereNested 

func (db *Database) WhereNested(handler builder.WhereNestedHandler) *Database

func (*Database) WhereNot 

func (db *Database) WhereNot(column any, args ...any) *Database
func (db *Database) WhereNotIn(column string, value any) *Database {
	db.Context.WhereClause.WhereNotIn(column, value)
	return db
}

func (db *Database) OrWhereNotIn(column string, value any) *Database {
	db.Context.WhereClause.WhereNotIn(column, value)
	return db
}

func (db *Database) WhereNotNull(column string) *Database {
	db.Context.WhereClause.whereNull("AND", column, true)
	return db
}

func (db *Database) OrWhereNotNull(column string) *Database {
	db.Context.WhereClause.whereNull("OR", column, true)
	return db
}

func (db *Database) WhereNotBetween(column string, value any) *Database {
	db.Context.WhereClause.whereBetween("AND", column, value, true)
	return db
}

func (db *Database) OrWhereNotBetween(column string, value any) *Database {
	db.Context.WhereClause.whereBetween("OR", column, value, true)
	return db
}

func (db *Database) WhereNotExists(clause IBuilder) {
	db.Context.WhereClause.WhereNotExists(clause)
}

func (db *Database) WhereNotLike(column, value string) *Database {
	db.Context.WhereClause.whereLike("AND", column, value, true)
	return db
}

func (db *Database) OrWhereNotLike(column, value string) *Database {
	db.Context.WhereClause.whereLike("OR", column, value, true)
	return db
}

func (*Database) WhereNull 

func (db *Database) WhereNull(column string) *Database

func (*Database) WhereRaw 

func (db *Database) WhereRaw(raw string, bindings ...any) *Database

WhereRaw 在查询中添加一个原生SQL“where”条件。

sql: 原生SQL条件字符串。 bindings: SQL绑定参数数组。

func (*Database) WhereSub 

func (db *Database) WhereSub(column string, operation string, sub builder.WhereSubHandler) *Database

type Engin 

type Engin struct {
	*GoRose
	// contains filtered or unexported fields
}

func NewEngin 

func NewEngin(g *GoRose) *Engin

func (*Engin) Begin 

func (s *Engin) Begin() (err error)

func (*Engin) Commit 

func (s *Engin) Commit() (err error)

func (*Engin) Exec 

func (s *Engin) Exec(query string, args ...any) (sql.Result, error)

func (*Engin) LastSql 

func (s *Engin) LastSql() SqlItem

func (*Engin) Log 

func (s *Engin) Log(sqls string, bindings ...any)

func (*Engin) Query 

func (s *Engin) Query(query string, args ...any) (rows *sql.Rows, err error)

func (*Engin) QueryRow 

func (s *Engin) QueryRow(query string, args ...any) *sql.Row

func (*Engin) QueryTo 

func (s *Engin) QueryTo(bind any, query string, args ...any) (err error)

func (*Engin) Rollback 

func (s *Engin) Rollback() (err error)

func (*Engin) RollbackTo 

func (s *Engin) RollbackTo(name any) (err error)

func (*Engin) SavePoint 

func (s *Engin) SavePoint(name any) (err error)

func (*Engin) Transaction 

func (s *Engin) Transaction(closure ...func(*Engin) error) (err error)

type GoRose 

type GoRose struct {
	Cluster *ConfigCluster
	// contains filtered or unexported fields
}

func Open 

func Open(conf ...any) *GoRose

Open db examples 

Open("mysql", "root:root@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=true")
Open(&Config{...})
Open(&ConfigCluster{...})

func (*GoRose) Close 

func (g *GoRose) Close() (err error)

func (*GoRose) MasterDB 

func (g *GoRose) MasterDB() *sql.DB

func (*GoRose) NewDatabase 

func (g *GoRose) NewDatabase() *Database

func (*GoRose) NewEngin 

func (g *GoRose) NewEngin() *Engin

func (*GoRose) SlaveDB 

func (g *GoRose) SlaveDB() *sql.DB

func (*GoRose) Use 

func (g *GoRose) Use(h ...HandlerFunc) *GoRose

type HandlerFunc 

type HandlerFunc func(*builder.Context)

type HandlersChain 

type HandlersChain []HandlerFunc

type Pagination 

type Pagination struct {
	Limit       int              `json:"limit"`
	Pages       int              `json:"pages"`
	CurrentPage int              `json:"currentPage"`
	PrevPage    int              `json:"prevPage"`
	NextPage    int              `json:"nextPage"`
	Total       int64            `json:"total"`
	Data        []map[string]any `json:"data"`
}

Pagination 是用于分页查询结果的结构体，包含当前页数据及分页信息。

type SqlItem 

type SqlItem struct {
	Sql      string
	Bindings []any
	Err      error
}

type TxHandler 

type TxHandler func() *Database

Source Files

View all Source files

Directories

Path Synopsis
mysql

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.