forked from xuperchain/burrow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.go
490 lines (428 loc) · 12.9 KB
/
utils.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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
package sqldb
import (
"errors"
"fmt"
"strconv"
"strings"
"github.com/hyperledger/burrow/vent/sqldb/adapters"
"github.com/hyperledger/burrow/txs"
"encoding/json"
"github.com/hyperledger/burrow/vent/types"
)
// findTable checks if a table exists in the default schema
func (db *SQLDB) findTable(tableName string) (bool, error) {
found := 0
safeTable := safe(tableName)
query := db.DBAdapter.FindTableQuery()
db.Log.Info("msg", "FIND TABLE", "query", query, "value", safeTable)
if err := db.DB.QueryRow(query, tableName).Scan(&found); err != nil {
db.Log.Info("msg", "Error finding table", "err", err)
return false, err
}
if found == 0 {
db.Log.Warn("msg", "Table not found", "value", safeTable)
return false, nil
}
return true, nil
}
// getSysTablesDefinition returns log, chain info & dictionary structures
func (db *SQLDB) getSysTablesDefinition() types.EventTables {
return types.EventTables{
types.SQLLogTableName: {
Name: types.SQLLogTableName,
Columns: []*types.SQLTableColumn{
{
Name: types.SQLColumnLabelId,
Type: types.SQLColumnTypeSerial,
Primary: true,
},
{
Name: types.SQLColumnLabelTimeStamp,
Type: types.SQLColumnTypeTimeStamp,
Primary: false,
},
{
Name: types.SQLColumnLabelTableName,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: false,
},
{
Name: types.SQLColumnLabelEventName,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: false,
},
{
Name: types.SQLColumnLabelEventFilter,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: false,
},
// We use varchar for height - there is no uint64 type though numeric could have been used. We obtain the
// maximum height by maxing over the serial ID type
{
Name: types.SQLColumnLabelHeight,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: false,
},
{
Name: types.SQLColumnLabelTxHash,
Type: types.SQLColumnTypeVarchar,
Length: txs.HashLengthHex,
Primary: false,
},
{
Name: types.SQLColumnLabelAction,
Type: types.SQLColumnTypeVarchar,
Length: 20,
Primary: false,
},
{
Name: types.SQLColumnLabelDataRow,
Type: types.SQLColumnTypeJSON,
Length: 0,
Primary: false,
},
{
Name: types.SQLColumnLabelSqlStmt,
Type: types.SQLColumnTypeText,
Length: 0,
Primary: false,
},
{
Name: types.SQLColumnLabelSqlValues,
Type: types.SQLColumnTypeText,
Length: 0,
Primary: false,
},
},
NotifyChannels: map[string][]string{types.BlockHeightLabel: {types.SQLColumnLabelHeight}},
},
types.SQLDictionaryTableName: {
Name: types.SQLDictionaryTableName,
Columns: []*types.SQLTableColumn{
{
Name: types.SQLColumnLabelTableName,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: true,
},
{
Name: types.SQLColumnLabelColumnName,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: true,
},
{
Name: types.SQLColumnLabelColumnType,
Type: types.SQLColumnTypeInt,
Length: 0,
Primary: false,
},
{
Name: types.SQLColumnLabelColumnLength,
Type: types.SQLColumnTypeInt,
Length: 0,
Primary: false,
},
{
Name: types.SQLColumnLabelPrimaryKey,
Type: types.SQLColumnTypeInt,
Length: 0,
Primary: false,
},
{
Name: types.SQLColumnLabelColumnOrder,
Type: types.SQLColumnTypeInt,
Length: 0,
Primary: false,
},
},
},
types.SQLChainInfoTableName: {
Name: types.SQLChainInfoTableName,
Columns: []*types.SQLTableColumn{
{
Name: types.SQLColumnLabelChainID,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: true,
},
{
Name: types.SQLColumnLabelBurrowVer,
Type: types.SQLColumnTypeVarchar,
Length: 100,
Primary: false,
},
},
},
}
}
// getTableDef returns the structure of a given SQL table
func (db *SQLDB) getTableDef(tableName string) (*types.SQLTable, error) {
table := &types.SQLTable{
Name: safe(tableName),
}
found, err := db.findTable(table.Name)
if err != nil {
return nil, err
}
if !found {
db.Log.Info("msg", "Error table not found", "value", table.Name)
return nil, errors.New("Error table not found " + table.Name)
}
query := db.DBAdapter.TableDefinitionQuery()
db.Log.Info("msg", "QUERY STRUCTURE", "query", query, "value", table.Name)
rows, err := db.DB.Query(query, safe(tableName))
if err != nil {
db.Log.Info("msg", "Error querying table structure", "err", err)
return nil, err
}
defer rows.Close()
var columns []*types.SQLTableColumn
for rows.Next() {
var columnName string
var columnSQLType types.SQLColumnType
var columnIsPK int
var columnLength int
if err = rows.Scan(&columnName, &columnSQLType, &columnLength, &columnIsPK); err != nil {
db.Log.Info("msg", "Error scanning table structure", "err", err)
return nil, err
}
if _, err = db.DBAdapter.TypeMapping(columnSQLType); err != nil {
return nil, err
}
columns = append(columns, &types.SQLTableColumn{
Name: columnName,
Type: columnSQLType,
Length: columnLength,
Primary: columnIsPK == 1,
})
}
if err = rows.Err(); err != nil {
db.Log.Info("msg", "Error during rows iteration", "err", err)
return nil, err
}
table.Columns = columns
return table, nil
}
// alterTable alters the structure of a SQL table & add info to the dictionary
func (db *SQLDB) alterTable(table *types.SQLTable, eventName string) error {
db.Log.Info("msg", "Altering table", "value", table.Name)
// prepare log query
logQuery := db.DBAdapter.InsertLogQuery()
// current table structure
safeTable := safe(table.Name)
currentTable, err := db.getTableDef(safeTable)
if err != nil {
return err
}
sqlValues, _ := db.getJSON(nil)
// for each column in the new table structure
for order, newColumn := range table.Columns {
found := false
// check if exists in the current table structure
for _, currentColumn := range currentTable.Columns {
// if column exists
if currentColumn.Name == newColumn.Name {
found = true
break
}
}
if !found {
safeCol := safe(newColumn.Name)
query, dictionary := db.DBAdapter.AlterColumnQuery(safeTable, safeCol, newColumn.Type, newColumn.Length, order)
//alter column
db.Log.Info("msg", "ALTER TABLE", "query", safe(query))
_, err = db.DB.Exec(safe(query))
if err != nil {
if db.DBAdapter.ErrorEquals(err, types.SQLErrorTypeDuplicatedColumn) {
db.Log.Warn("msg", "Duplicate column", "value", safeCol)
} else {
db.Log.Info("msg", "Error altering table", "err", err)
return err
}
} else {
//store dictionary
db.Log.Info("msg", "STORE DICTIONARY", "query", dictionary)
_, err = db.DB.Exec(dictionary)
if err != nil {
db.Log.Info("msg", "Error storing dictionary", "err", err)
return err
}
//insert log (if action is not database initialization)
if eventName != string(types.ActionInitialize) {
// Marshal the table into a JSON string.
var jsonData []byte
jsonData, err = db.getJSON(newColumn)
if err != nil {
db.Log.Info("msg", "error marshaling column", "err", err, "value", fmt.Sprintf("%v", newColumn))
return err
}
//insert log
_, err = db.DB.Exec(logQuery, table.Name, eventName, "", nil, nil, types.ActionAlterTable, jsonData, query, sqlValues)
if err != nil {
db.Log.Info("msg", "Error inserting log", "err", err)
return err
}
}
}
}
}
// Ensure triggers are defined
err = db.createTableTriggers(table)
if err != nil {
db.Log.Info("msg", "error creating notification triggers", "err", err, "value", fmt.Sprintf("%v", table))
return fmt.Errorf("could not create table notification triggers: %v", err)
}
return nil
}
// createTable creates a new table
func (db *SQLDB) createTable(table *types.SQLTable, eventName string) error {
db.Log.Info("msg", "Creating Table", "value", table.Name)
// prepare log query
logQuery := db.DBAdapter.InsertLogQuery()
//get create table query
safeTable := safe(table.Name)
query, dictionary := db.DBAdapter.CreateTableQuery(safeTable, table.Columns)
if query == "" {
db.Log.Info("msg", "empty CREATE TABLE query")
return errors.New("empty CREATE TABLE query")
}
// create table
db.Log.Info("msg", "CREATE TABLE", "query", query)
_, err := db.DB.Exec(query)
if err != nil {
return err
}
//store dictionary
db.Log.Info("msg", "STORE DICTIONARY", "query", dictionary)
_, err = db.DB.Exec(dictionary)
if err != nil {
db.Log.Info("msg", "Error storing dictionary", "err", err)
return err
}
err = db.createTableTriggers(table)
if err != nil {
db.Log.Info("msg", "error creating notification triggers", "err", err, "value", fmt.Sprintf("%v", table))
return fmt.Errorf("could not create table notification triggers: %v", err)
}
//insert log (if action is not database initialization)
if eventName != string(types.ActionInitialize) {
// Marshal the table into a JSON string.
var jsonData []byte
jsonData, err = db.getJSON(table)
if err != nil {
db.Log.Info("msg", "error marshaling table", "err", err, "value", fmt.Sprintf("%v", table))
return err
}
sqlValues, _ := db.getJSON(nil)
//insert log
_, err = db.DB.Exec(logQuery, table.Name, eventName, "", nil, nil, types.ActionCreateTable, jsonData, query, sqlValues)
if err != nil {
db.Log.Info("msg", "Error inserting log", "err", err)
return err
}
}
return nil
}
// Creates (or updates) table notification triggers and functions
func (db *SQLDB) createTableTriggers(table *types.SQLTable) error {
// If the adapter supports notification triggers
dbNotify, ok := db.DBAdapter.(adapters.DBNotifyTriggerAdapter)
if ok {
for channel, columns := range table.NotifyChannels {
function := fmt.Sprintf("%s_%s_notify_function", table.Name, channel)
query := dbNotify.CreateNotifyFunctionQuery(function, channel, columns...)
db.Log.Info("msg", "CREATE NOTIFICATION FUNCTION", "query", query)
_, err := db.DB.Exec(query)
if err != nil {
return fmt.Errorf("could not create notification function: %v", err)
}
trigger := fmt.Sprintf("%s_%s_notify_trigger", table.Name, channel)
query = dbNotify.CreateTriggerQuery(trigger, table.Name, function)
db.Log.Info("msg", "CREATE NOTIFICATION TRIGGER", "query", query)
_, err = db.DB.Exec(query)
if err != nil {
return fmt.Errorf("could not create notification trigger: %v", err)
}
}
}
return nil
}
// getSelectQuery builds a select query for a specific SQL table and a given block
func (db *SQLDB) getSelectQuery(table *types.SQLTable, height uint64) (string, error) {
fields := ""
for _, tableColumn := range table.Columns {
if fields != "" {
fields += ", "
}
fields += db.DBAdapter.SecureName(tableColumn.Name)
}
if fields == "" {
return "", errors.New("error table does not contain any fields")
}
query := db.DBAdapter.SelectRowQuery(table.Name, fields, strconv.FormatUint(height, 10))
return query, nil
}
// getBlockTables return all SQL tables that have been involved
// in a given batch transaction for a specific block
func (db *SQLDB) getBlockTables(height uint64) (types.EventTables, error) {
tables := make(types.EventTables)
query := db.DBAdapter.SelectLogQuery()
db.Log.Info("msg", "QUERY LOG", "query", query, "value", height)
rows, err := db.DB.Query(query, height)
if err != nil {
db.Log.Info("msg", "Error querying log", "err", err)
return tables, err
}
defer rows.Close()
for rows.Next() {
var eventName, tableName string
var table *types.SQLTable
err = rows.Scan(&tableName, &eventName)
if err != nil {
db.Log.Info("msg", "Error scanning table structure", "err", err)
return tables, err
}
err = rows.Err()
if err != nil {
db.Log.Info("msg", "Error scanning table structure", "err", err)
return tables, err
}
table, err = db.getTableDef(tableName)
if err != nil {
return tables, err
}
tables[eventName] = table
}
return tables, nil
}
// safe sanitizes a parameter
func safe(parameter string) string {
replacer := strings.NewReplacer(";", "", ",", "")
return replacer.Replace(parameter)
}
//getJSON returns marshaled json from JSON single column
func (db *SQLDB) getJSON(JSON interface{}) ([]byte, error) {
if JSON != nil {
return json.Marshal(JSON)
}
return json.Marshal("")
}
//getJSONFromValues returns marshaled json from query values
func (db *SQLDB) getJSONFromValues(values []interface{}) ([]byte, error) {
if values != nil {
return json.Marshal(values)
}
return json.Marshal("")
}
//getValuesFromJSON returns query values from unmarshaled JSON column
func (db *SQLDB) getValuesFromJSON(JSON string) ([]interface{}, error) {
pointers := make([]interface{}, 0)
bytes := []byte(JSON)
err := json.Unmarshal(bytes, &pointers)
return pointers, err
}