-
Notifications
You must be signed in to change notification settings - Fork 269
/
baseconn.go
245 lines (222 loc) · 8.68 KB
/
baseconn.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
// Copyright 2019 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package conn
import (
"database/sql"
"database/sql/driver"
"fmt"
"strings"
"time"
gmysql "github.com/go-mysql-org/go-mysql/mysql"
"github.com/go-sql-driver/mysql"
"github.com/pingcap/failpoint"
"github.com/prometheus/client_golang/prometheus"
"go.uber.org/zap"
tcontext "github.com/pingcap/tiflow/dm/pkg/context"
"github.com/pingcap/tiflow/dm/pkg/log"
"github.com/pingcap/tiflow/dm/pkg/retry"
"github.com/pingcap/tiflow/dm/pkg/terror"
"github.com/pingcap/tiflow/dm/pkg/utils"
)
// BaseConn is the basic connection we use in dm
// BaseDB -> BaseConn correspond to sql.DB -> sql.Conn
// In our scenario, there are two main reasons why we need BaseConn
// 1. we often need one fixed DB connection to execute sql
// 2. we need own retry policy during execute failed
//
// So we split a fixed sql.Conn out of sql.DB, and wraps it to BaseConn
// And Similar with sql.Conn, all BaseConn generated from one BaseDB shares this BaseDB to reset
//
// Basic usage:
// For Syncer and Loader Unit, they both have different amount of connections due to config
// Currently we have some types of connections exist
//
// Syncer:
// Worker Connection:
// DML connection:
// execute some DML on Downstream DB, one unit has `syncer.WorkerCount` worker connections
// DDL Connection:
// execute some DDL on Downstream DB, one unit has one connection
// CheckPoint Connection:
// interact with CheckPoint DB, one unit has one connection
// OnlineDDL connection:
// interact with Online DDL DB, one unit has one connection
// ShardGroupKeeper connection:
// interact with ShardGroupKeeper DB, one unit has one connection
//
// Loader:
// Worker Connection:
// execute some DML to Downstream DB, one unit has `loader.PoolSize` worker connections
// CheckPoint Connection:
// interact with CheckPoint DB, one unit has one connection
// Restore Connection:
// only use to create schema and table in restoreData,
// it ignore already exists error and it should be removed after use, one unit has one connection
//
// each connection should have ability to retry on some common errors (e.g. tmysql.ErrTiKVServerTimeout) or maybe some specify errors in the future
// and each connection also should have ability to reset itself during some specify connection error (e.g. driver.ErrBadConn).
type BaseConn struct {
DBConn *sql.Conn
RetryStrategy retry.Strategy
}
// NewBaseConn builds BaseConn to connect real DB.
func NewBaseConn(conn *sql.Conn, strategy retry.Strategy) *BaseConn {
if strategy == nil {
strategy = &retry.FiniteRetryStrategy{}
}
return &BaseConn{conn, strategy}
}
// SetRetryStrategy set retry strategy for baseConn.
func (conn *BaseConn) SetRetryStrategy(strategy retry.Strategy) error {
if conn == nil {
return terror.ErrDBUnExpect.Generate("database connection not valid")
}
conn.RetryStrategy = strategy
return nil
}
// QuerySQL defines query statement, and connect to real DB.
func (conn *BaseConn) QuerySQL(tctx *tcontext.Context, query string, args ...interface{}) (*sql.Rows, error) {
if conn == nil || conn.DBConn == nil {
return nil, terror.ErrDBUnExpect.Generate("database connection not valid")
}
tctx.L().Debug("query statement",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(args, -1)))
rows, err := conn.DBConn.QueryContext(tctx.Context(), query, args...)
if err != nil {
tctx.L().ErrorFilterContextCanceled("query statement failed",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(args, -1)),
log.ShortError(err))
return nil, terror.ErrDBQueryFailed.Delegate(err, utils.TruncateString(query, -1))
}
return rows, nil
}
// ExecuteSQLWithIgnoreError executes sql on real DB, and will ignore some error and continue execute the next query.
// return
// 1. failed: (the index of sqls executed error, error)
// 2. succeed: (len(sqls), nil).
func (conn *BaseConn) ExecuteSQLWithIgnoreError(tctx *tcontext.Context, hVec *prometheus.HistogramVec, task string, ignoreErr func(error) bool, queries []string, args ...[]interface{}) (int, error) {
// inject an error to trigger retry, this should be placed before the real execution of the SQL statement.
failpoint.Inject("retryableError", func(val failpoint.Value) {
if mark, ok := val.(string); ok {
enabled := false
for _, query := range queries {
if strings.Contains(query, mark) {
enabled = true // only enable if the `mark` matched.
}
}
if enabled {
tctx.L().Info("", zap.String("failpoint", "retryableError"), zap.String("mark", mark))
failpoint.Return(0, &mysql.MySQLError{
Number: gmysql.ER_LOCK_DEADLOCK,
Message: fmt.Sprintf("failpoint inject retryable error for %s", mark),
})
}
}
})
if len(queries) == 0 {
return 0, nil
}
if conn == nil || conn.DBConn == nil {
return 0, terror.ErrDBUnExpect.Generate("database connection not valid")
}
startTime := time.Now()
txn, err := conn.DBConn.BeginTx(tctx.Context(), nil)
if err != nil {
return 0, terror.ErrDBExecuteFailed.Delegate(err, "begin")
}
if hVec != nil {
hVec.WithLabelValues("begin", task).Observe(time.Since(startTime).Seconds())
}
l := len(queries)
for i, query := range queries {
var arg []interface{}
if len(args) > i {
arg = args[i]
}
// avoid use TruncateInterface for all log level which will slow the speed of DML
if tctx.L().Core().Enabled(zap.DebugLevel) {
tctx.L().Debug("execute statement",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(arg, -1)))
}
startTime = time.Now()
_, err = txn.ExecContext(tctx.Context(), query, arg...)
if err == nil {
if hVec != nil {
hVec.WithLabelValues("stmt", task).Observe(time.Since(startTime).Seconds())
}
} else {
if ignoreErr != nil && ignoreErr(err) {
tctx.L().Warn("execute statement failed and will ignore this error",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(arg, -1)),
log.ShortError(err))
continue
}
tctx.L().ErrorFilterContextCanceled("execute statement failed",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(arg, -1)), log.ShortError(err))
startTime = time.Now()
rerr := txn.Rollback()
if rerr != nil {
tctx.L().Error("rollback failed",
zap.String("query", utils.TruncateString(query, -1)),
zap.String("argument", utils.TruncateInterface(arg, -1)),
log.ShortError(rerr))
} else if hVec != nil {
hVec.WithLabelValues("rollback", task).Observe(time.Since(startTime).Seconds())
}
// we should return the exec err, instead of the rollback rerr.
return i, terror.ErrDBExecuteFailed.Delegate(err, utils.TruncateString(query, -1))
}
}
startTime = time.Now()
err = txn.Commit()
if err != nil {
return l - 1, terror.ErrDBExecuteFailed.Delegate(err, "commit") // mark failed on the last one
}
if hVec != nil {
hVec.WithLabelValues("commit", task).Observe(time.Since(startTime).Seconds())
}
return l, nil
}
// ExecuteSQL executes sql on real DB,
// return
// 1. failed: (the index of sqls executed error, error)
// 2. succeed: (len(sqls), nil).
func (conn *BaseConn) ExecuteSQL(tctx *tcontext.Context, hVec *prometheus.HistogramVec, task string, queries []string, args ...[]interface{}) (int, error) {
return conn.ExecuteSQLWithIgnoreError(tctx, hVec, task, nil, queries, args...)
}
// ApplyRetryStrategy apply specify strategy for BaseConn.
func (conn *BaseConn) ApplyRetryStrategy(tctx *tcontext.Context, params retry.Params,
operateFn func(*tcontext.Context) (interface{}, error),
) (interface{}, int, error) {
return conn.RetryStrategy.Apply(tctx, params, operateFn)
}
// close should not be used by functions other than BaseDB.CloseBaseConn.
func (conn *BaseConn) close() error {
if conn == nil || conn.DBConn == nil {
return nil
}
err := conn.DBConn.Raw(func(dc interface{}) error {
// return an `ErrBadConn` to ensure close the connection, but do not put it back to the pool.
// if we choose to use `Close`, it will always put the connection back to the pool.
return driver.ErrBadConn
})
if err != driver.ErrBadConn {
return terror.ErrDBUnExpect.Delegate(err, "close")
}
return nil
}