-
Notifications
You must be signed in to change notification settings - Fork 682
/
gauss.go
403 lines (355 loc) · 12.3 KB
/
gauss.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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
package gauss
import (
"context"
"database/sql"
"fmt"
"log/slog"
"net"
"regexp"
"strings"
"time"
"strconv"
//opengauss driver
_ "gitee.com/opengauss/openGauss-connector-go-pq"
//"github.com/jackc/pgx/v5"
//"github.com/jackc/pgx/v5/stdlib"
"github.com/pkg/errors"
//"go.uber.org/multierr"
"golang.org/x/crypto/ssh"
"google.golang.org/protobuf/types/known/durationpb"
"github.com/bytebase/bytebase/backend/common"
"github.com/bytebase/bytebase/backend/common/log"
"github.com/bytebase/bytebase/backend/plugin/db"
"github.com/bytebase/bytebase/backend/plugin/db/util"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
pgparser "github.com/bytebase/bytebase/backend/plugin/parser/pg"
storepb "github.com/bytebase/bytebase/proto/generated-go/store"
v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
)
var (
excludedDatabaseList = map[string]bool{
// Skip internal databases from cloud service providers
"omm": true,
// system templates.
"template0": true,
"template1": true,
}
// driverName is the driver name that our driver dependence register, now is "pgx".
driverName = "opengauss"
_ db.Driver = (*Driver)(nil)
)
func init() {
db.Register(storepb.Engine_GAUSSDB, newDriver)
}
// Driver is the GaussDB driver.
type Driver struct {
config db.ConnectionConfig
db *sql.DB
sshClient *ssh.Client
// connectionString is the connection string registered by pgx.
// Unregister connectionString if we don't need it.
connectionString string
databaseName string
}
func newDriver(db.DriverConfig) db.Driver {
return &Driver{}
}
// Open opens a GaussDB driver.
func (driver *Driver) Open(_ context.Context, _ storepb.Engine, config db.ConnectionConfig) (db.Driver, error) {
// Require username for GaussDB, as the guessDSN 1st guess is to use the username as the connecting database
// if database name is not explicitly specified.
if config.Username == "" {
return nil, errors.Errorf("user must be set")
}
port, err := strconv.Atoi(config.Port)
if err != nil {
return nil, errors.Errorf("invalid port %q", config.Port)
}
dsn := fmt.Sprintf("postgres:https://%s:%s@%s:%d", config.Username, config.Password, config.Host, port)
if config.Database != "" {
dsn = fmt.Sprintf("%s/%s", dsn, config.Database)
}
db, err := sql.Open(driverName, dsn)
if err != nil {
return nil, err
}
driver.db = db
driver.databaseName = config.Database
return driver, nil
}
type noDeadlineConn struct{ net.Conn }
func (*noDeadlineConn) SetDeadline(time.Time) error { return nil }
func (*noDeadlineConn) SetReadDeadline(time.Time) error { return nil }
func (*noDeadlineConn) SetWriteDeadline(time.Time) error { return nil }
// Close closes the database and prevents new queries from starting.
// Close then waits for all queries that have started processing on the server to finish.
func (driver *Driver) Close(context.Context) error {
return driver.db.Close()
}
// Ping verifies a connection to the database is still alive, establishing a connection if necessary.
func (driver *Driver) Ping(ctx context.Context) error {
return driver.db.PingContext(ctx)
}
// GetType returns the database type.
func (*Driver) GetType() storepb.Engine {
return storepb.Engine_GAUSSDB
}
// GetDB gets the database.
func (driver *Driver) GetDB() *sql.DB {
return driver.db
}
// Execute will execute the statement. For CREATE DATABASE statement, some types of databases such as GaussDB
// will not use transactions to execute the statement but will still use transactions to execute the rest of statements.
func (driver *Driver) Execute(ctx context.Context, statement string, opts db.ExecuteOptions) (int64, error) {
if opts.CreateDatabase {
if err := driver.createDatabaseExecute(ctx, statement); err != nil {
return 0, err
}
return 0, nil
}
owner, err := driver.GetCurrentDatabaseOwner()
if err != nil {
return 0, err
}
singleSQLs, err := pgparser.SplitSQL(statement)
if err != nil {
return 0, err
}
singleSQLs = base.FilterEmptySQL(singleSQLs)
if len(singleSQLs) == 0 {
return 0, nil
}
var remainingSQLs []base.SingleSQL
var nonTransactionStmts []string
for _, singleSQL := range singleSQLs {
if isNonTransactionStatement(singleSQL.Text) {
nonTransactionStmts = append(nonTransactionStmts, singleSQL.Text)
continue
}
if isSuperuserStatement(singleSQL.Text) {
if strings.Contains(strings.ToUpper(singleSQL.Text), "CREATE EVENT TRIGGER") {
singleSQL.Text = strings.ReplaceAll(singleSQL.Text, "EXECUTE FUNCTION", "EXECUTE PROCEDURE")
}
// Use superuser privilege to run privileged statements.
singleSQL.Text = fmt.Sprintf("SET SESSION AUTHORIZATION NONE;%sSET SESSION AUTHORIZATION '%s';", singleSQL.Text, owner)
}
remainingSQLs = append(remainingSQLs, singleSQL)
}
totalRowsAffected := int64(0)
if len(remainingSQLs) != 0 {
var totalCommands int
var chunks [][]base.SingleSQL
if opts.ChunkedSubmission && len(statement) <= common.MaxSheetCheckSize {
totalCommands = len(remainingSQLs)
ret, err := util.ChunkedSQLScript(remainingSQLs, common.MaxSheetChunksCount)
if err != nil {
return 0, errors.Wrapf(err, "failed to chunk sql")
}
chunks = ret
} else {
chunks = [][]base.SingleSQL{
remainingSQLs,
}
}
currentIndex := 0
tx, err := driver.db.BeginTx(ctx, nil)
if err != nil {
return 0, err
}
defer tx.Rollback()
// Set the current transaction role to the database owner so that the owner of created objects will be the same as the database owner.
//if _, err := tx.ExecContext(ctx, fmt.Sprintf("SET SESSION AUTHORIZATION '%s';", owner)); err != nil {
if _, err := tx.ExecContext(ctx, "SET SESSION AUTHORIZATION DEFAULT;"); err != nil {
return 0, err
}
for _, chunk := range chunks {
if len(chunk) == 0 {
continue
}
// Start the current chunk.
// Set the progress information for the current chunk.
if opts.UpdateExecutionStatus != nil {
opts.UpdateExecutionStatus(&v1pb.TaskRun_ExecutionDetail{
CommandsTotal: int32(totalCommands),
CommandsCompleted: int32(currentIndex),
CommandStartPosition: &v1pb.TaskRun_ExecutionDetail_Position{
Line: int32(chunk[0].FirstStatementLine),
Column: int32(chunk[0].FirstStatementColumn),
},
CommandEndPosition: &v1pb.TaskRun_ExecutionDetail_Position{
Line: int32(chunk[len(chunk)-1].LastLine),
Column: int32(chunk[len(chunk)-1].LastColumn),
},
})
}
chunkText, err := util.ConcatChunk(chunk)
if err != nil {
return 0, err
}
sqlResult, err := tx.ExecContext(ctx, chunkText)
if err != nil {
return 0, &db.ErrorWithPosition{
Err: errors.Wrapf(err, "failed to execute context in a transaction"),
Start: &storepb.TaskRunResult_Position{
Line: int32(chunk[0].FirstStatementLine),
Column: int32(chunk[0].FirstStatementColumn),
},
End: &storepb.TaskRunResult_Position{
Line: int32(chunk[len(chunk)-1].LastLine),
Column: int32(chunk[len(chunk)-1].LastColumn),
},
}
}
rowsAffected, err := sqlResult.RowsAffected()
if err != nil {
// Since we cannot differentiate DDL and DML yet, we have to ignore the error.
slog.Debug("rowsAffected returns error", log.BBError(err))
}
totalRowsAffected += rowsAffected
currentIndex += len(chunk)
}
// Restore the current transaction role to the current user.
if _, err := tx.ExecContext(ctx, "SET SESSION AUTHORIZATION DEFAULT;"); err != nil {
slog.Warn("Failed to restore the current transaction role to the current user", log.BBError(err))
}
if err := tx.Commit(); err != nil {
return 0, err
}
}
// Run non-transaction statements at the end.
for _, stmt := range nonTransactionStmts {
if _, err := driver.db.ExecContext(ctx, stmt); err != nil {
return 0, err
}
}
return totalRowsAffected, nil
}
func (driver *Driver) createDatabaseExecute(ctx context.Context, statement string) error {
databaseName, err := getDatabaseInCreateDatabaseStatement(statement)
if err != nil {
return err
}
databases, err := driver.getDatabases(ctx)
if err != nil {
return err
}
for _, database := range databases {
if database.Name == databaseName {
// Database already exists.
return nil
}
}
for _, s := range strings.Split(statement, "\n") {
if _, err := driver.db.ExecContext(ctx, s); err != nil {
return err
}
}
return nil
}
func isSuperuserStatement(stmt string) bool {
upperCaseStmt := strings.ToUpper(strings.TrimLeft(stmt, " \n\t"))
if strings.HasPrefix(upperCaseStmt, "GRANT") || strings.HasPrefix(upperCaseStmt, "CREATE EXTENSION") || strings.HasPrefix(upperCaseStmt, "CREATE EVENT TRIGGER") || strings.HasPrefix(upperCaseStmt, "COMMENT ON EVENT TRIGGER") {
return true
}
return false
}
func isNonTransactionStatement(stmt string) bool {
// CREATE INDEX CONCURRENTLY cannot run inside a transaction block.
// CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] name ] ON [ ONLY ] table_name [ USING method ] ...
createIndexReg := regexp.MustCompile(`(?i)CREATE(\s+(UNIQUE\s+)?)INDEX(\s+)CONCURRENTLY`)
if len(createIndexReg.FindString(stmt)) > 0 {
return true
}
// DROP INDEX CONCURRENTLY cannot run inside a transaction block.
// DROP INDEX [ CONCURRENTLY ] [ IF EXISTS ] name [, ...] [ CASCADE | RESTRICT ]
dropIndexReg := regexp.MustCompile(`(?i)DROP(\s+)INDEX(\s+)CONCURRENTLY`)
return len(dropIndexReg.FindString(stmt)) > 0
}
func getDatabaseInCreateDatabaseStatement(createDatabaseStatement string) (string, error) {
raw := strings.TrimRight(createDatabaseStatement, ";")
raw = strings.TrimPrefix(raw, "CREATE DATABASE")
tokens := strings.Fields(raw)
if len(tokens) == 0 {
return "", errors.Errorf("database name not found")
}
databaseName := strings.TrimLeft(tokens[0], `"`)
databaseName = strings.TrimRight(databaseName, `"`)
return databaseName, nil
}
// GetCurrentDatabaseOwner returns the current database owner name.
func (driver *Driver) GetCurrentDatabaseOwner() (string, error) {
const query = `
SELECT
u.usename
FROM
pg_database as d JOIN pg_user as u ON (d.datdba = u.usesysid)
WHERE d.datname = current_database();
`
var owner string
rows, err := driver.db.Query(query)
if err != nil {
return "", err
}
defer rows.Close()
for rows.Next() {
if err := rows.Scan(&owner); err != nil {
return "", err
}
}
if err := rows.Err(); err != nil {
return "", err
}
if owner == "" {
return "", errors.Errorf("cannot find the current database owner because the query result is empty")
}
return owner, nil
}
// QueryConn queries a SQL statement in a given connection.
func (driver *Driver) QueryConn(ctx context.Context, conn *sql.Conn, statement string, queryContext *db.QueryContext) ([]*v1pb.QueryResult, error) {
singleSQLs, err := pgparser.SplitSQL(statement)
if err != nil {
return nil, err
}
singleSQLs = base.FilterEmptySQL(singleSQLs)
if len(singleSQLs) == 0 {
return nil, nil
}
singleSQLs = base.FilterEmptySQL(singleSQLs)
if len(singleSQLs) == 0 {
return nil, nil
}
var results []*v1pb.QueryResult
for _, singleSQL := range singleSQLs {
result, err := driver.querySingleSQL(ctx, conn, singleSQL, queryContext)
if err != nil {
results = append(results, &v1pb.QueryResult{
Error: err.Error(),
})
} else {
results = append(results, result)
}
}
return results, nil
}
func getStatementWithResultLimit(stmt string, limit int) string {
return fmt.Sprintf("WITH result AS (%s) SELECT * FROM result LIMIT %d;", stmt, limit)
}
func (*Driver) querySingleSQL(ctx context.Context, conn *sql.Conn, singleSQL base.SingleSQL, queryContext *db.QueryContext) (*v1pb.QueryResult, error) {
statement := strings.Trim(singleSQL.Text, " \n\t;")
stmt := statement
if !strings.HasPrefix(stmt, "EXPLAIN") && queryContext.Limit > 0 {
stmt = getStatementWithResultLimit(stmt, queryContext.Limit)
}
startTime := time.Now()
result, err := util.Query(ctx, storepb.Engine_GAUSSDB, conn, stmt, queryContext)
if err != nil {
return nil, err
}
result.Latency = durationpb.New(time.Since(startTime))
result.Statement = statement
return result, nil
}
// RunStatement runs a SQL statement in a given connection.
func (*Driver) RunStatement(ctx context.Context, conn *sql.Conn, statement string) ([]*v1pb.QueryResult, error) {
return util.RunStatement(ctx, storepb.Engine_GAUSSDB, conn, statement)
}