-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapi.go
112 lines (99 loc) · 4.68 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
package sq
import (
"context"
"database/sql"
)
type API interface {
// Ping 检查连通性
Ping(ctx context.Context) error
// Close 关闭数据库连接
Close() error
// Insert 插入数据
Insert(ctx context.Context, qb QB) (result Result, err error)
// InsertAffected 插入数据(返回影响行数)
InsertAffected(ctx context.Context, qb QB) (affected int64, err error)
// InsertModel 基于 Model 创建数据, 根据 Model 字段自动填充 qb.Insert
InsertModel(ctx context.Context, ptr Model, qb QB) (err error)
// InsertModelAffected 基于 Model 创建数据 (返回影响行数)
InsertModelAffected(ctx context.Context, ptr Model, qb QB) (affected int64, err error)
// QueryRow 查询单行多列 类似 sql.Row{}.Scan()
QueryRow(ctx context.Context, qb QB, desc []interface{}) (has bool, err error)
// Query 查询单行多列并转换为结构体
Query(ctx context.Context, ptr Tabler, qb QB) (has bool, err error)
// QuerySlice 查询多行并转换为结构体
QuerySlice(ctx context.Context, slicePtr interface{}, qb QB) (err error)
// QuerySliceScaner 查询多行多列(自定义扫描)
QuerySliceScaner(ctx context.Context, qb QB, scaner Scaner) (err error)
QueryRelation(ctx context.Context, ptr Relation, qb QB) (has bool, err error)
// QueryRelationSlice 查询多条数据并转换为 Relation slice
QueryRelationSlice(ctx context.Context, relationSlicePtr interface{}, qb QB) (err error)
// Count SELECT count(*)
Count(ctx context.Context, from Tabler, qb QB) (count uint64, err error)
// Has 查询数据是否存在(单条数据是否存在不建议使用 count 而是使用 Exist)
Has(ctx context.Context, from Tabler, qb QB) (has bool, err error)
SumInt64(ctx context.Context, from Tabler, column Column, qb QB) (value sql.NullInt64, err error)
SumFloat64(ctx context.Context, from Tabler, column Column, qb QB) (value sql.NullFloat64, err error)
// Update 更新
Update(ctx context.Context, from Tabler, qb QB) (err error)
// UpdateAffected 更新(返回影响行数)
UpdateAffected(ctx context.Context, from Tabler, qb QB) (affected int64, err error)
// ClearTestData 删除测试数据库的数据，只能运行在 test_ 为前缀的数据库中
ClearTestData(ctx context.Context, form Tabler, qb QB) (err error)
// // 基于 Model 删除测试数据库的数据，只能运行在 test_ 为前缀的数据库中
// ClearTestModel(ctx context.Context, model Model, qb QB) (result Result, err error)
// HardDelete 硬删除（不可恢复）
HardDelete(ctx context.Context, form Tabler, qb QB) (err error)
// HardDeleteAffected 硬删除（不可恢复）(返回影响行数)
HardDeleteAffected(ctx context.Context, form Tabler, qb QB) (affected int64, err error)
// SoftDelete 软删除（可恢复）
SoftDelete(ctx context.Context, form Tabler, qb QB) (err error)
// SoftDeleteAffected 软删除（可恢复）(返回影响行数)
SoftDeleteAffected(ctx context.Context, form Tabler, qb QB) (affected int64, err error)
// ExecQB 执行QB
ExecQB(ctx context.Context, qb QB, statement Statement) (result Result, err error)
// ExecQBAffected 执行QB(返回影响行数)
ExecQBAffected(ctx context.Context, qb QB, statement Statement) (affected int64, err error)
// Exec 执行
Exec(ctx context.Context, query string, values []interface{}) (result Result, err error)
// Begin 开启事务
Begin(ctx context.Context, level sql.IsolationLevel, handle func(tx *T) TxResult) (rollbackNoError bool, err error)
BeginOpt(ctx context.Context, opt sql.TxOptions, handle func(tx *T) TxResult) (rollbackNoError bool, err error)
// LastQueryCost show status like "last_query_cost"
LastQueryCost(ctx context.Context) (lastQueryCost float64, err error)
// PrintLastQueryCost 打印 show status like "last_query_cost" 的结果
PrintLastQueryCost(ctx context.Context)
// PublishMessage 发布消息
PublishMessage(ctx context.Context, queueName string, publish Publish) (message Message, err error)
// ConsumeMessage 消费消息
ConsumeMessage(ctx context.Context, consume Consume) error
}
func verifyDoc() {
db := &Database{}
func(API) {
}(db)
tx := struct {
T
onlyDB
}{}
func(API) {
}(&tx)
}
type onlyDB struct{}
func (onlyDB) Ping(ctx context.Context) error {
return nil
}
func (onlyDB) Close() error {
return nil
}
func (onlyDB) ClearTestData(ctx context.Context, form Tabler, qb QB) (err error) {
return
}
func (onlyDB) Begin(ctx context.Context, level sql.IsolationLevel, handle func(tx *T) TxResult) (rollbackNoError bool, err error) {
return
}
func (onlyDB) BeginOpt(ctx context.Context, opt sql.TxOptions, handle func(tx *T) TxResult) (rollbackNoError bool, err error) {
return
}
func (onlyDB) ConsumeMessage(ctx context.Context, consume Consume) (err error) {
return
}