The highest tagged major version is
README
¶
orm
目前内置了对以下数据库的支持：
| 数据库 | 驱动 | 状态 |
|---|---|---|
| mysql | mysql github.com/go-sql-driver/mysql |  |
| mariadb | mysql github.com/go-sql-driver/mysql |  |
| sqlite3 | sqlite3 github.com/mattn/go-sqlite3 |  |
| postgres | postgres github.com/lib/pq |  |
理论上 github.com/jackc/pgx/v4/stdlib 也是可用于 postgres，不过其驱动的注册名称为 pgx。
其它数据库，用户可以通过实现 Dialect 接口，来实现相应的支持。 如果用到了 check 约束，则需要 mysql > 8.0.16、mariadb > 10.2.1。
初始化
默认情况下，orm 包并不会加载任何数据库的实例。所以想要用哪个数据库，需要手动初始化：
import (
github.com/issue9/orm/v3/dialect // sqlite3 的 dialect 声明在此处
_ github.com/mattn/go-sqlite3 // 加载数据库驱动
)
// 初始化一个 DB，表前缀为 prefix_
db1 := orm.NewDB("./db1", "prefix_", dialect.Sqlite3("sqlite3"))
// 另一个 DB 实例
db2 := orm.NewDB("./db2", "db2_", dialect.Sqlite3("sqlite3"))
占位符
SQL 语句可以使用 # 字符在语句中暂替真实的表名前缀，也可以使用 {} 包含一个关键字，使其它成为普通列名，如：
SELECT * FROM #user WHERE {group}=1
在实际执行时，相关的占位符就会被替换成与当前环境想容的实例，如在表名前缀为 p_， 数据库为 mysql 时，会被替换成以下语句，然后再执行：
SELECT * FROM p_user WHERE `group`=1
DB.Query(),DB.Exec(),DB.Prepare().DB.Where() 及 Tx 与之对应的函数都可以使用占位符。
Model 不能指定占位符，它们默认总会使用占位符，且无法取消。
Model:
orm 包通过 struct tag 来描述 model 在数据库中的结构。大概格式如下：
type User struct {
Id int64 `orm:"name(id);ai;"`
FirstName string `orm:"name(first_name);index(index_name)"`
LastName string `orm:"name(first_name);index(index_name)"`
// 此处group会自动加上引号，无须担心是否为关键字
Group string `orm:"name(group)"`
}
// 通过 orm.Metaer 接口，指定表的额外数据。若不需要，可不用实现该接口
// 表名 user 会被自动加上表名前缀。
func(u *User) Meta() string {
return "name(user);engine(innodb);charset(utf8)"
}
目前支持以下的 struct tag：
指定当前字段在数据表中的名称，如果未指定，则和字段名相同。 只有可导出的字段才有效果。
指定字段的长度。比如 mysql 中的int(5),varchar(255),double(1,2), 不支持该特性的数据，将会忽略该标签的内容，比如 sqlite3。 NOTE:字符串类型必须指定长度，若长度过大或是将长度设置了-1， 想使用类似于 TEXT 等不定长的形式表达。
如果是日期类型，则第一个可选参数表示日期精度。
相当于定义表结构时的 NULL。
主键，支持联合主键，给多个字段加上 pk 的 struct tag 即可。
自增，若指定了自增列，则将自动取消其它的 pk 设置。无法指定起始值和步长。 可手动设置一个非零值来更改某条数据的 AI 行为。
唯一索引，支持联合索引，index_name 为约束名， 会将 index_name 为一样的字段定义为一个联合索引。
普通的关键字索引，同 unique 一样会将名称相同的索引定义为一个联合索引。
当前列作为乐观锁字段。
作为乐观锁的字段，其值表示的是线上数据的值，在更新时，会自动给线上的值加 1。
指定默认值。相当于定义表结构时的 DEFAULT。 当一个字段如果是个零值(reflect.Zero())时，将会使用它的默认值， 但是系统无法判断该零值是人为指定，还是未指定被默认初始化零值的， 所以在需要用到零值的字段，最好不要用 default 的 struct tag。
定义物理外键，最少需要指定 fk_name、refTable 和 refColName 三个值。分别对应约束名， 引用的表和引用的字段，updateRule,deleteRule，在不指定的情况下，使用数据库的默认值。 refTable 如果需要表名前缀，需要添加 # 符号。
check 约束。chk_name 为约束名，expr 为该约束的表达式。 check 约束只能在 model.Metaer 接口中指定，而不是像其它约束一样，通过字段的 struct tag 指定。 因为 check 约束的表达式可以通过 and 或是 or 等符号连接多条基本表达式， 在字段 struct tag 中指定会显得有点怪异。
接口:
在 Go 不能将 struct tag 作用于结构体，所以为了指定一些表级别的属性， 只能通过接口的形式，在接口方法中返回一段类似于 struct tag 的字符串， 以达到相同的目的。
在 model.Metaer 每种数据库可以指定一些自定义的属性，这些属性都将会被保存到 Model.Meta 中，各个数据库的自定义属性以其名称开头，比如 mysql 的 charset 属性， 可以使用 mysql_charset。
同时还包含了以下几种通用的属性信息：
- name(val): 指定模型的名称，比如表名，或是视图名称；
- check(expr): 指定 check 约束内容。
在拉到数据之后，对该对象执行的一些额外操作。如果需要根据字段做额外工作的，可以使用该接口。
在执行插入之前，需要执行的操作。
在执行更新之前，需要执行的操作。
约束名：
index、unique、check 和 fk 都是可以指定约束名的，在当前数据库中， 约束名必须是唯一的，即便是不同类型的约束，比如已经有一个 unique 的约束名叫作 name， 那么其它类型的约束，就不能再取这个名称了。
如何使用：
可以通过 DB.Create() 或是 Tx.Create() 创建一张表。
// 创建表
db.Create(&User{})
// 创建多个表，同时创建多张表，主使用 Tx.Create
tx.MultCreate(&User{},&Email{})
// 将 id 为 1 的记录的 FirstName 更改为 abc；对象中的零值不会被提交。
db.Update(&User{Id:1,FirstName:"abc"})
sqlbuilder.Update(db).Table("#table").Where("id=?",1).Set("FirstName", "abc").Exec()
// 删除 id 为 1 的记录
e.Delete(&User{Id:1})
sqlbuilder.Delete(e).Table("#table").Where("id=?",1).Exec()
// 插入一条数据
db.Insert(&User{Id:1,FirstName:"abc"})
// 一次性插入多条数据
tx.InsertMany(&User{Id:1,FirstName:"abc"},&User{Id:1,FirstName:"abc"})
// 导出 id=1 的数据
_,err := sqlbuilder.Select(e, e.Dialect()).Select("*").From("{#table}").Where("id=1").QueryObj(obj)
// 导出 id 为 1 的数据，并回填到 user 实例中
user := &User{Id:1}
err := e.Select(u)
// Query 返回参数与 sql.Query 是相同的
sql := "select * from #tbl_name where id=?"
rows, err := e.Query(sql, []interface{}{5})
// Exec 返回参数与 sql.Exec 是相同的
sql = "update #tbl_name set name=? where id=?"
r, err := e.Exec(sql, []interface{}{"name1", 5})
type order struct {
ID int `orm:"name(id);ai"`
UID int `orm:"name(uid)"`
User *User `orm:"name(u)"` // sql 语句的 u. 开头的列导入到此对象中
}
sql := "SELECT o.*, u.id AS 'u.id',u.name AS 'u.name' FROM orders AS o LEFT JOIN users AS u ON o.uid= u.id where id=?"
// 以下查询会将 u.name 和 u.id 导入到 User 指向的对象中
data := []*order{}
rows,err := e.Query(sql, []interface{}{5})
r, err := fetch.Object(rows, &data)
像 postgres 之类的数据库，插入语句返回的 sql.Result 并不支持 LastInsertId() 所以得通过其它方式得到该 ID，可以直接尝试使用 InsertLastID 来代码 Insert 操作。
lastID,err := db.InsertLastID(&User{FirstName:"abc"})
事务：
默认的 DB 是不支持事务的，若需要事务支持，则需要调用 DB.Begin() 返回事务对象 Tx，当然并不是所有的数据库都支持事务操作的。 Tx 拥有一组与 DB 相同的接口。
版权
Documentation
¶
Overview ¶
Package orm 一个简单小巧的 orm 实现方案
目前内置了对以下数据库的支持：
- sqlite3: github.com/mattn/go-sqlite3
- mysql: github.com/go-sql-driver/mysql
- postgres: github.com/lib/pq
其它数据库，用户可以通过实现 Dialect 接口，来实现相应的支持。
初始化：
默认情况下，orm 包并不会加载任何数据库的实例。所以想要用哪个数据库，需要手动初始化：
import (
_ github.com/mattn/go-sqlite3 // 加载数据库驱动
_ github.com/issue9/orm/v3/dialect // sqlite3 的 dialect 声明在此处
)
// 初始化一个 DB，表前缀为 prefix_
db1 := orm.NewDB("./db1", "prefix_", dialect.Sqlite3("sqlite3"))
// 另一个 DB 实例
db2 := orm.NewDB("./db2", "db2_", dialect.Sqlite3("sqlite3"))
占位符
SQL 语句可以使用 # 字符在语句中暂替真实的表名前缀，也可以使用 {} 包含一个关键字，使其它成为普通列名，如：
select * from #user where {group}=1
在实际执行时，相关的占位符就会被替换成与当前环境想容的实例，如在表名前缀为 p_， 数据库为 mysql 时，会被替换成以下语句，然后再执行：
select * from p_user where `group`=1
DB.Query(),DB.Exec(),DB.Prepare().DB.Where() 及 Tx 与之对应的函数都可以使用占位符。
Model 不能指定占位符，它们默认总会使用占位符，且无法取消。
Model:
orm 包通过 struct tag 来描述 model 在数据库中的结构。大概格式如下：
type User struct {
Id int64 `orm:"name(id);ai;"`
FirstName string `orm:"name(first_name);index(index_name)"`
LastName string `orm:"name(first_name);index(index_name)"`
// 此处group会自动加上引号，无须担心是否为关键字
Group string `orm:"name(group)"`
}
// 通过 orm.Metaer 接口，指定表的额外数据。若不需要，可不用实现该接口
// 表名 user 会被自动加上表名前缀。
func(u *User) Meta() string {
return "name(user);engine(innodb);charset(utf8)"
}
目前支持以下的 struct tag：
name(fieldName): 指定当前字段在数据表中的名称，如果未指定， 则和字段名相同。只有可导出的字段才有效果。 len(l1, l2): 指定字段的长度。比如 mysql 中的int(5),varchar(255),double(1,2), 不支持该特性的数据，将会忽略该标签的内容，比如 sqlite3。 NOTE:字符串类型必须指定长度，若长度过大或是将长度设置了 -1， 想使用类似于 TEXT 等不定长的形式表达。 如果是日期类型，则第一个可选参数表示日期精度。 nullable(true|false): 相当于定义表结构时的 NULL。 pk: 主键，支持联合主键，给多个字段加上 pk 的 struct tag 即可。 ai: 自增，若指定了自增列，则将自动取消其它的 pk 设置。无法指定起始值和步长。 可手动设置一个非零值来更改某条数据的 AI 行为。 unique(index_name): 唯一索引，支持联合索引，index_name 为约束名， 会将 index_name 为一样的字段定义为一个联合索引。 index(index_name): 普通的关键字索引，同 unique 一样会将名称相同的索引定义为一个联合索引。 occ(true|false) 当前列作为乐观锁字段。 作为乐观锁的字段，其值表示的是线上数据的值，在更新时，会自动给线上的值加 1。 default(value): 指定默认值。相当于定义表结构时的 DEFAULT。 当一个字段如果是个零值(reflect.Zero())时，将会使用它的默认值， 但是系统无法判断该零值是人为指定，还是未指定被默认初始化零值的， 所以在需要用到零值的字段，最好不要用 default 的 struct tag。 fk(fk_name,refTable,refColName,updateRule,deleteRule): 定义物理外键，最少需要指定 fk_name,refTable,refColName 三个值。 分别对应约束名，引用的表和引用的字段，updateRule,deleteRule， 在不指定的情况下，使用数据库的默认值。 refTable 如果需要表名前缀，需要添加 # 符号。 check(chk_name, expr): check 约束。chk_name 为约束名，expr 为该约束的表达式。 check 约束只能在 model.Metaer 接口中指定，而不是像其它约束一样， 通过字段的 struct tag 指定。因为 check 约束的表达式可以通过 and 或是 or 等符号连接多条基本表达式，在字段 struct tag 中指定会显得有点怪异。
model.Metaer:
在 Go 不能将 struct tag 作用于结构体，所以为了指定一些表级别的属性， 只能通过接口的形式，在接口方法中返回一段类似于 struct tag 的字符串， 以达到相同的目的。
在 model.Metaer 每种数据库可以指定一些自定义的属性，这些属性都将会被保存到 Model.Meta 中，各个数据库的自定义属性以其名称开头，比如 mysql 的 charset 属性， 可以使用 mysql_charset。
同时还包含了以下几种通用的属性信息：
name(val): 指定模型的名称，比如表名，或是视图名称； check(expr): 指定 check 约束内容。
约束名：
index、unique、check 和 fk 都是可以指定约束名的，在表中，约束名必须是唯一的， 即便是不同类型的约束，比如已经有一个 unique 的约束名叫作 name，那么其它类 型的约束，就不能再取这个名称了。 部分数据库（比如 postgres）可能要求约束名是整个数据库唯一的， 为了统一，在 ORM 中所有数据都强制约束名全局（数据库）唯一。
如何使用：
Create: 可以通过 DB.Create() 或是 Tx.Create() 创建一张表。
// 创建表
db.Create(&User{})
// 创建多个表，同时创建多张表，主使用 Tx.Create
tx.MultCreate(&User{},&Email{})
Update:
// 将 id 为 1 的记录的 FirstName 更改为 abc；对象中的零值不会被提交。
db.Update(&User{Id:1,FirstName:"abc"})
sqlbuilder.Update(db).Table("#table").Where("id=?",1).Set("FirstName", "abc").Exec()
Delete:
// 删除 id 为 1 的记录
e.Delete(&User{Id:1})
sqlbuilder.Delete(e).Table("#table").Where("id=?",1).Exec()
Insert:
// 插入一条数据
db.Insert(&User{Id:1,FirstName:"abc"})
// 一次性插入多条数据
tx.InsertMany(&User{Id:1,FirstName:"abc"},&User{Id:1,FirstName:"abc"})
Select:
// 导出 id=1 的数据
_,err := sqlbuilder.Select(e, e.Dialect()).Select("*").From("{#table}").Where("id=1").QueryObj(obj)
// 导出 id 为 1 的数据，并回填到 user 实例中
user := &User{Id:1}
err := e.Select(u)
Query/Exec:
// Query 返回参数与 sql.Query 是相同的
sql := "select * from #tbl_name where id=?"
rows, err := e.Query(sql, []interface{}{5})
// Exec 返回参数与 sql.Exec 是相同的
sql = "update #tbl_name set name=? where id=?"
r, err := e.Exec(sql, []interface{}{"name1", 5})
事务：
默认的 DB 是不支持事务的，若需要事务支持，则需要调用 DB.Begin() 返回事务对象 Tx，当然并不是所有的数据库都支持事务操作的。 Tx 拥有一组与 DB 相同的接口。
Index ¶
- Variables
- type AfterFetcher
- type BeforeInserter
- type BeforeUpdater
- type Column
- type DB
- func (db *DB) Begin() (*Tx, error)
- func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error)
- func (db *DB) Close() error
- func (db *DB) Create(v interface{}) error
- func (db *DB) Debug(l *log.Logger)
- func (db *DB) Delete(v interface{}) (sql.Result, error)
- func (db *DB) Dialect() Dialect
- func (db *DB) Drop(v interface{}) error
- func (db *DB) Exec(query string, args ...interface{}) (sql.Result, error)
- func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
- func (db *DB) Insert(v interface{}) (sql.Result, error)
- func (db *DB) InsertMany(v interface{}, max int) error
- func (db *DB) LastInsertID(v interface{}) (int64, error)
- func (db *DB) MultCreate(objs ...interface{}) error
- func (db *DB) MultDelete(objs ...interface{}) error
- func (db *DB) MultDrop(objs ...interface{}) error
- func (db *DB) MultInsert(objs ...interface{}) error
- func (db *DB) MultSelect(objs ...interface{}) error
- func (db *DB) MultTruncate(objs ...interface{}) error
- func (db *DB) MultUpdate(objs ...interface{}) error
- func (db *DB) NewModel(obj interface{}) (*Model, error)
- func (db *DB) Prepare(query string) (*core.Stmt, error)
- func (db *DB) PrepareContext(ctx context.Context, query string) (*core.Stmt, error)
- func (db *DB) Query(query string, args ...interface{}) (*sql.Rows, error)
- func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
- func (db *DB) QueryRow(query string, args ...interface{}) *sql.Row
- func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
- func (db *DB) SQLBuilder() *sqlbuilder.SQLBuilder
- func (db *DB) Select(v interface{}) error
- func (db *DB) TablePrefix() string
- func (db *DB) Truncate(v interface{}) error
- func (db *DB) Update(v interface{}, cols ...string) (sql.Result, error)
- func (db *DB) Upgrade(v interface{}) (*Upgrader, error)
- func (db *DB) Version() (string, error)
- func (db *DB) Where(cond string, args ...interface{}) *WhereStmt
- type Dialect
- type Engine
- type ForeignKey
- type Metaer
- type Model
- type Tx
- func (tx *Tx) Create(v interface{}) error
- func (tx *Tx) Delete(v interface{}) (sql.Result, error)
- func (tx *Tx) Dialect() Dialect
- func (tx *Tx) Drop(v interface{}) error
- func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error)
- func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
- func (tx *Tx) ForUpdate(v interface{}) error
- func (tx *Tx) Insert(v interface{}) (sql.Result, error)
- func (tx *Tx) InsertMany(v interface{}, max int) error
- func (tx *Tx) LastInsertID(v interface{}) (int64, error)
- func (tx *Tx) MultCreate(objs ...interface{}) error
- func (tx *Tx) MultDelete(objs ...interface{}) error
- func (tx *Tx) MultDrop(objs ...interface{}) error
- func (tx *Tx) MultInsert(objs ...interface{}) error
- func (tx *Tx) MultSelect(objs ...interface{}) error
- func (tx *Tx) MultTruncate(objs ...interface{}) error
- func (tx *Tx) MultUpdate(objs ...interface{}) error
- func (tx *Tx) NewModel(obj interface{}) (*Model, error)
- func (tx *Tx) Prepare(query string) (*core.Stmt, error)
- func (tx *Tx) PrepareContext(ctx context.Context, query string) (*core.Stmt, error)
- func (tx *Tx) Query(query string, args ...interface{}) (*sql.Rows, error)
- func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
- func (tx *Tx) QueryRow(query string, args ...interface{}) *sql.Row
- func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
- func (tx *Tx) SQLBuilder() *sqlbuilder.SQLBuilder
- func (tx *Tx) Select(v interface{}) error
- func (tx *Tx) TablePrefix() string
- func (tx *Tx) Truncate(v interface{}) error
- func (tx *Tx) Update(v interface{}, cols ...string) (sql.Result, error)
- func (tx *Tx) Where(cond string, args ...interface{}) *WhereStmt
- type Unix
- type Upgrader
- func (u *Upgrader) AddColumn(name ...string) *Upgrader
- func (u *Upgrader) AddConstraint(name ...string) *Upgrader
- func (u *Upgrader) AddIndex(name ...string) *Upgrader
- func (u *Upgrader) DB() *DB
- func (u *Upgrader) Do() error
- func (u *Upgrader) DropColumn(name ...string) *Upgrader
- func (u *Upgrader) DropConstraint(conts ...string) *Upgrader
- func (u *Upgrader) DropIndex(name ...string) *Upgrader
- func (u *Upgrader) Err() error
- type WhereStmt
- func (stmt *WhereStmt) And(cond string, args ...interface{}) *WhereStmt
- func (stmt *WhereStmt) AndBetween(col string, v1, v2 interface{}) *WhereStmt
- func (stmt *WhereStmt) AndGroup() *sqlbuilder.WhereStmt
- func (stmt *WhereStmt) AndIn(col string, v ...interface{}) *WhereStmt
- func (stmt *WhereStmt) AndIsNotNull(col string) *WhereStmt
- func (stmt *WhereStmt) AndIsNull(col string) *WhereStmt
- func (stmt *WhereStmt) AndLike(col string, content interface{}) *WhereStmt
- func (stmt *WhereStmt) AndNotBetween(col string, v1, v2 interface{}) *WhereStmt
- func (stmt *WhereStmt) AndNotIn(col string, v ...interface{}) *WhereStmt
- func (stmt *WhereStmt) AndNotLike(col string, content interface{}) *WhereStmt
- func (stmt *WhereStmt) Count(v interface{}) (int64, error)
- func (stmt *WhereStmt) Delete(v interface{}) (sql.Result, error)
- func (stmt *WhereStmt) Or(cond string, args ...interface{}) *WhereStmt
- func (stmt *WhereStmt) OrBetween(col string, v1, v2 interface{}) *WhereStmt
- func (stmt *WhereStmt) OrGroup() *sqlbuilder.WhereStmt
- func (stmt *WhereStmt) OrIn(col string, v ...interface{}) *WhereStmt
- func (stmt *WhereStmt) OrIsNotNull(col string) *WhereStmt
- func (stmt *WhereStmt) OrIsNull(col string) *WhereStmt
- func (stmt *WhereStmt) OrLike(col string, content interface{}) *WhereStmt
- func (stmt *WhereStmt) OrNotBetween(col string, v1, v2 interface{}) *WhereStmt
- func (stmt *WhereStmt) OrNotIn(col string, v ...interface{}) *WhereStmt
- func (stmt *WhereStmt) OrNotLike(col string, content interface{}) *WhereStmt
- func (stmt *WhereStmt) Select(strict bool, v interface{}) (int, error)
- func (stmt *WhereStmt) Update(v interface{}, cols ...string) (sql.Result, error)
Constants ¶
This section is empty.
Variables ¶
var ErrNeedAutoIncrementColumn = errors.New("必须存在自增列")
ErrNeedAutoIncrementColumn 当以 LastInsertID 的方式插入一条没有 AI 列的对象时，会返回此错误。
Functions ¶
This section is empty.
Types ¶
type BeforeInserter ¶
type BeforeInserter interface {
BeforeInsert() error
}
BeforeInserter 在插入之前调用的函数
type DB ¶
DB 数据库操作实例
func NewDB ¶
NewDB 声明一个新的 DB 实例
不同驱动对时间的处理不尽相同，如果有在不同数据库之间移植的需求， 那么建议将保存时的时区都统一设置为 UTC： postgres 已经固定为 UTC，sqlite3 可以在 dsn 中通过 _loc=UTC 指定， mysql 默认是 UTC，也可以在 DSN 中通过 loc=UTC 指定。
func NewDBWithStdDB ¶
NewDBWithStdDB 从 sql.DB 构建 DB 实例
NOTE: 请确保用于打开 db 的 driverName 参数与 dialect.DriverName() 是相同的， 否则后续操作的结果是未知的。
func (*DB) Debug ¶
Debug 指定调输出调试内容通道
如果 l 不为 nil，则每次 SQL 调用都会输出 SQL 语句， 预编译的语句，仅在预编译时输出； 如果为 nil，则表示关闭调试。
func (*DB) ExecContext ¶
func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
ExecContext 执行 SQL 语句
func (*DB) LastInsertID ¶
LastInsertID 插入数据并获取其自增的 ID
func (*DB) PrepareContext ¶
PrepareContext 预编译查询语句
func (*DB) QueryContext ¶
func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
QueryContext 执行一条查询语句
func (*DB) Select ¶
Select 查询一个符合条件的数据
查找条件以结构体定义的主键或是唯一约束(在没有主键的情况下 ) 来查找， 若两者都不存在，则将返回 error 若没有符合条件的数据，将不会对参数 v 做任何变动。
查找条件的查找顺序是为 自增 > 主键 > 唯一约束， 如果同时存在多个唯一约束满足条件，则返回错误信息。
func (*DB) Update ¶
Update 更新数据
零值不会被提交，cols 指定的列，即使是零值也会被更新。
查找条件以结构体定义的主键或是唯一约束(在没有主键的情况下)来查找， 若两者都不存在，则将返回 error
type Engine ¶
type Engine interface {
core.Engine
// 理论上功能等同于以下两步操作：
// rslt, err := engine.Insert(obj)
// id, err := rslt.LastInsertId()
// 但是实际上部分数据库不支持直接在 sql.Result 中获取 LastInsertId，
// 比如 postgresql，所以使用 LastInsertID() 会是比 sql.Result
// 更简单和安全的方法。
//
// NOTE: 要求 v 有定义自增列。
LastInsertID(v interface{}) (int64, error)
Insert(v interface{}) (sql.Result, error)
Delete(v interface{}) (sql.Result, error)
Update(v interface{}, cols ...string) (sql.Result, error)
Select(v interface{}) error
Create(v interface{}) error
Drop(v interface{}) error
Truncate(v interface{}) error
InsertMany(v interface{}, max int) error
MultInsert(objs ...interface{}) error
MultSelect(objs ...interface{}) error
MultUpdate(objs ...interface{}) error
MultDelete(objs ...interface{}) error
MultCreate(objs ...interface{}) error
MultDrop(objs ...interface{}) error
MultTruncate(objs ...interface{}) error
SQLBuilder() *sqlbuilder.SQLBuilder
NewModel(v interface{}) (*Model, error)
}
Engine 是 DB 与 Tx 的共有接口
type Tx ¶
Tx 事务对象
func (*Tx) ExecContext ¶
func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
ExecContext 执行一条 SQL 语句
func (*Tx) InsertMany ¶
InsertMany 插入多条相同的数据
若需要向某张表中插入多条记录，InsertMany() 会比 Insert() 性能上好很多。
max 表示一次最多插入的数量，如果超过此值，会分批执行， 但是依然在一个事务中完成。
与 MultInsert() 方法最大的不同在于:
// MultInsert() 可以每个参数的类型都不一样：
vs := []interface{}{&user{...}, &userInfo{...}}
db.Insert(vs...)
// db.InsertMany(vs) // 这里将出错，数组的元素的类型必须相同。
us := []*users{&user{}, &user{}}
db.InsertMany(us)
db.Insert(us...) // 这样也行，但是性能会差好多
func (*Tx) LastInsertID ¶
LastInsertID 插入数据，并获取其自增的 ID
func (*Tx) MultSelect ¶
MultSelect 选择符合要求的一条或是多条记录
func (*Tx) PrepareContext ¶
PrepareContext 将一条 SQL 语句进行预编译
func (*Tx) QueryContext ¶
func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
QueryContext 执行一条查询语句
type Upgrader ¶
type Upgrader struct {
// contains filtered or unexported fields
}
Upgrader 更新数据库对象
主要针对线上数据与本地模型不相同时，可执行的一些操作。
func (*Upgrader) DropConstraint ¶
DropConstraint 删除约束
type WhereStmt ¶
type WhereStmt struct {
// contains filtered or unexported fields
}
WhereStmt 用于生成 where 语句
func (*WhereStmt) AndBetween ¶
AndBetween 指定 WHERE ... AND col BETWEEN v1 AND v2
func (*WhereStmt) AndGroup ¶
func (stmt *WhereStmt) AndGroup() *sqlbuilder.WhereStmt
AndGroup 开始一个子条件语句
func (*WhereStmt) AndIsNotNull ¶
AndIsNotNull 指定 WHERE ... AND col IS NOT NULL
func (*WhereStmt) AndNotBetween ¶
AndNotBetween 指定 WHERE ... AND col NOT BETWEEN v1 AND v2
func (*WhereStmt) AndNotLike ¶
AndNotLike 指定 WHERE ... AND col NOT LIKE content
func (*WhereStmt) OrGroup ¶
func (stmt *WhereStmt) OrGroup() *sqlbuilder.WhereStmt
OrGroup 开始一个子条件语句
func (*WhereStmt) OrIsNotNull ¶
OrIsNotNull 指定 WHERE ... OR col IS NOT NULL
func (*WhereStmt) OrNotBetween ¶
OrNotBetween 指定 WHERE ... OR col BETWEEN v1 AND v2
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package core 核心功能
|
Package core 核心功能 |
|
Package dialect 提供了部分数据库对 orm.Dialect 接口的实现
|
Package dialect 提供了部分数据库对 orm.Dialect 接口的实现 |
|
Package fetch 包提供了将 sql.Rows 导出为几种常用数据格式的方法
|
Package fetch 包提供了将 sql.Rows 导出为几种常用数据格式的方法 |
|
internal
|
|
|
createtable
Package createtable 分析 create table 语句的内容
|
Package createtable 分析 create table 语句的内容 |
|
flagtest
Package flagtest 用于生成测试用的命令行参数
|
Package flagtest 用于生成测试用的命令行参数 |
|
model
Package model 管理数据模型
|
Package model 管理数据模型 |
|
sqltest
Package sqltest 提供对 SQL 内容测试的工具
|
Package sqltest 提供对 SQL 内容测试的工具 |
|
tags
Package tags 包实现对特定格式的 struct tag 字符串的分析 1.
|
Package tags 包实现对特定格式的 struct tag 字符串的分析 1. |
|
test
Package test 提供了整个包的基本测试数据
|
Package test 提供了整个包的基本测试数据 |
|
Package sqlbuilder 提供一套通过字符串拼接来构成 SQL 语句的工具 sqlbuilder 提供了部分 *Hooker 的接口，用于自定义某一条语句的实现。
|
Package sqlbuilder 提供一套通过字符串拼接来构成 SQL 语句的工具 sqlbuilder 提供了部分 *Hooker 的接口，用于自定义某一条语句的实现。 |