forked from SkygearIO/skygear-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
recorddb.go
576 lines (503 loc) · 14.3 KB
/
recorddb.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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
// Copyright 2015-present Oursky Ltd.
//
// 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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package pq
import (
"database/sql"
"encoding/json"
"errors"
"fmt"
"io"
"strings"
"time"
log "github.com/Sirupsen/logrus"
"github.com/jmoiron/sqlx"
sq "github.com/lann/squirrel"
"github.com/lib/pq"
"github.com/skygeario/skygear-server/skydb"
)
func (db *database) Get(id skydb.RecordID, record *skydb.Record) error {
typemap, err := db.remoteColumnTypes(id.Type)
if err != nil {
return err
}
if len(typemap) == 0 { // record type has not been created
return skydb.ErrRecordNotFound
}
builder := db.selectQuery(psql.Select(), id.Type, typemap).Where("_id = ?", id.Key)
row := db.c.QueryRowWith(builder)
if err := newRecordScanner(id.Type, typemap, row).Scan(record); err == sql.ErrNoRows {
return skydb.ErrRecordNotFound
} else if err != nil {
return err
}
return nil
}
// GetByIDs using SQL IN cause
// GetByIDs only support one type of records at a time. If you want to query
// array of ids belongs to different type, you need to call this method multiple
// time.
func (db *database) GetByIDs(ids []skydb.RecordID) (*skydb.Rows, error) {
if len(ids) == 0 {
return nil, errors.New("db.GetByIDs received empty array")
}
idStrs := []interface{}{}
recordType := ""
for _, recordID := range ids {
if recordID.Key != "" {
idStrs = append(idStrs, recordID.Key)
}
if recordID.Type != "" && recordType == "" {
recordType = recordID.Type
}
}
log.Debugf("GetByIDs Type: %s", recordType)
typemap, err := db.remoteColumnTypes(recordType)
if err != nil {
return nil, err
}
if len(typemap) == 0 {
log.Debugf("Record Type has not been created")
return nil, skydb.ErrRecordNotFound
}
inCause, inArgs := literalToSQLOperand(idStrs)
query := db.selectQuery(psql.Select(), recordType, typemap).
Where(pq.QuoteIdentifier("_id")+" IN "+inCause, inArgs...)
rows, err := db.c.QueryWith(query)
if err != nil {
log.Debugf("Getting records by ID failed %v", err)
return nil, err
}
return newRows(recordType, typemap, rows, err)
}
// Save attempts to do a upsert
func (db *database) Save(record *skydb.Record) error {
if record.ID.Key == "" {
return errors.New("db.save: got empty record id")
}
if record.ID.Type == "" {
return fmt.Errorf("db.save %s: got empty record type", record.ID.Key)
}
if record.OwnerID == "" {
return fmt.Errorf("db.save %s: got empty OwnerID", record.ID.Key)
}
pkData := map[string]interface{}{
"_id": record.ID.Key,
"_database_id": db.userID,
}
upsert := upsertQuery(db.tableName(record.ID.Type), pkData, convert(record)).
IgnoreKeyOnUpdate("_owner_id").
IgnoreKeyOnUpdate("_created_at").
IgnoreKeyOnUpdate("_created_by")
typemap, err := db.remoteColumnTypes(record.ID.Type)
if err != nil {
return err
}
if err := db.preSave(typemap, record); err != nil {
return err
}
row := db.c.QueryRowWith(upsert)
if err = newRecordScanner(record.ID.Type, typemap, row).Scan(record); err != nil {
return err
}
record.DatabaseID = db.userID
return nil
}
func (db *database) preSave(schema skydb.RecordSchema, record *skydb.Record) error {
const SetSequenceMaxValue = `SELECT setval($1, GREATEST(max(%v), $2)) FROM %v;`
for key, value := range record.Data {
// we are setting a sequence field
if schema[key].Type == skydb.TypeInteger {
selectSQL := fmt.Sprintf(SetSequenceMaxValue, pq.QuoteIdentifier(key), db.tableName(record.ID.Type))
seqName := db.tableName(fmt.Sprintf(`%v_%v_seq`, record.ID.Type, key))
if _, err := db.c.Exec(selectSQL, seqName, value); err != nil {
return err
}
}
}
return nil
}
func convert(r *skydb.Record) map[string]interface{} {
m := map[string]interface{}{}
for key, rawValue := range r.Data {
switch value := rawValue.(type) {
case []interface{}:
m[key] = jsonSliceValue(value)
case map[string]interface{}:
m[key] = jsonMapValue(value)
case *skydb.Asset:
m[key] = assetValue(*value)
case skydb.Reference:
m[key] = referenceValue(value)
case skydb.Location:
m[key] = locationValue(value)
default:
m[key] = rawValue
}
}
m["_owner_id"] = r.OwnerID
m["_access"] = aclValue(r.ACL)
m["_created_at"] = r.CreatedAt
m["_created_by"] = r.CreatorID
m["_updated_at"] = r.UpdatedAt
m["_updated_by"] = r.UpdaterID
return m
}
func (db *database) Delete(id skydb.RecordID) error {
builder := psql.Delete(db.tableName(id.Type)).
Where("_id = ? AND _database_id = ?", id.Key, db.userID)
result, err := db.c.ExecWith(builder)
if isUndefinedTable(err) {
return skydb.ErrRecordNotFound
} else if err != nil {
return fmt.Errorf("delete %s: failed to delete record", id)
}
rowsAffected, err := result.RowsAffected()
if err != nil {
return fmt.Errorf("delete %s: failed to retrieve deletion status", id)
}
if rowsAffected == 0 {
return skydb.ErrRecordNotFound
} else if rowsAffected > 1 {
log.WithFields(log.Fields{
"id": id,
"rowsAffected": rowsAffected,
"err": err,
}).Errorln("Unexpected rows deleted")
return fmt.Errorf("delete %s: got %v rows deleted, want 1", id, rowsAffected)
}
return err
}
func (db *database) Query(query *skydb.Query) (*skydb.Rows, error) {
if query.Type == "" {
return nil, errors.New("got empty query type")
}
typemap, err := db.remoteColumnTypes(query.Type)
if err != nil {
return nil, err
}
if len(typemap) == 0 { // record type has not been created
return skydb.EmptyRows, nil
}
q := psql.Select()
factory := newPredicateSqlizerFactory(db, query.Type)
if p := query.Predicate; !p.IsEmpty() {
sqlizer, err := factory.newPredicateSqlizer(p)
if err != nil {
return nil, err
}
q = q.Where(sqlizer)
q = factory.addJoinsToSelectBuilder(q)
}
for _, sort := range query.Sorts {
orderBy, err := sortOrderBySQL(query.Type, sort)
if err != nil {
return nil, err
}
q = q.OrderBy(orderBy)
}
if db.ID() == "_public" && query.ReadableBy.ID != "" {
aclSqlizer, err := factory.newAccessControlSqlizer(query.ReadableBy, skydb.ReadLevel)
if err != nil {
return nil, err
}
q = q.Where(aclSqlizer)
}
if query.Limit != nil {
q = q.Limit(*query.Limit)
}
if query.Offset > 0 {
q = q.Offset(query.Offset)
}
// Select columns to return, this is the last step so that predicate
// have a chance to change typemap, and the generated sql
// depends on the alias name used in table joins.
typemap, err = updateTypemapForQuery(query, typemap)
if err != nil {
return nil, err
}
typemap = factory.updateTypemap(typemap)
q = db.selectQuery(q, query.Type, typemap)
rows, err := db.c.QueryWith(q)
return newRows(query.Type, typemap, rows, err)
}
func (db *database) QueryCount(query *skydb.Query) (uint64, error) {
if query.Type == "" {
return 0, errors.New("got empty query type")
}
typemap, err := db.remoteColumnTypes(query.Type)
if err != nil || len(typemap) == 0 { // error or record type has not been created
return 0, err
}
typemap = skydb.RecordSchema{
"_record_count": skydb.FieldType{
Type: skydb.TypeNumber,
Expression: skydb.Expression{
Type: skydb.Function,
Value: skydb.CountFunc{
OverallRecords: false,
},
},
},
}
q := db.selectQuery(psql.Select(), query.Type, typemap)
factory := newPredicateSqlizerFactory(db, query.Type)
if p := query.Predicate; !p.IsEmpty() {
sqlizer, err := factory.newPredicateSqlizer(p)
if err != nil {
return 0, err
}
q = q.Where(sqlizer)
q = factory.addJoinsToSelectBuilder(q)
}
if db.ID() == "_public" && query.ReadableBy.ID != "" {
aclSqlizer, err := factory.newAccessControlSqlizer(query.ReadableBy, skydb.ReadLevel)
if err != nil {
return 0, err
}
q = q.Where(aclSqlizer)
}
rows, err := db.c.QueryWith(q)
if err != nil {
return 0, err
}
defer rows.Close()
if !rows.Next() {
panic("Unexpected zero rows returned for aggregate count function.")
}
var recordCount uint64
err = rows.Scan(&recordCount)
if err != nil {
return 0, err
}
return recordCount, nil
}
// columnsScanner wraps over sqlx.Rows and sqlx.Row to provide
// a consistent interface for column scanning.
type columnsScanner interface {
Columns() ([]string, error)
Scan(dest ...interface{}) error
}
type recordScanner struct {
recordType string
typemap skydb.RecordSchema
cs columnsScanner
columns []string
err error
recordCount *uint64
}
func newRecordScanner(recordType string, typemap skydb.RecordSchema, cs columnsScanner) *recordScanner {
columns, err := cs.Columns()
return &recordScanner{recordType, typemap, cs, columns, err, nil}
}
func (rs *recordScanner) Scan(record *skydb.Record) error {
if rs.err != nil {
return rs.err
}
values := make([]interface{}, 0, len(rs.columns))
for _, column := range rs.columns {
schema, ok := rs.typemap[column]
if !ok {
return fmt.Errorf("received unknown column = %s", column)
}
switch schema.Type {
case skydb.TypeNumber:
var number sql.NullFloat64
values = append(values, &number)
case skydb.TypeString, skydb.TypeReference, skydb.TypeACL:
var str sql.NullString
values = append(values, &str)
case skydb.TypeDateTime:
var ts pq.NullTime
values = append(values, &ts)
case skydb.TypeBoolean:
var boolean sql.NullBool
values = append(values, &boolean)
case skydb.TypeAsset:
var asset nullAsset
values = append(values, &asset)
case skydb.TypeJSON:
var j nullJSON
values = append(values, &j)
case skydb.TypeLocation:
var l nullLocation
values = append(values, &l)
case skydb.TypeInteger:
var i sql.NullInt64
values = append(values, &i)
default:
return fmt.Errorf("received unknown data type = %v for column = %s", schema.Type, column)
}
}
if err := rs.cs.Scan(values...); err != nil {
rs.err = err
return err
}
record.ID.Type = rs.recordType
record.Data = map[string]interface{}{}
for i, column := range rs.columns {
value := values[i]
if column == "_record_count" {
svalue, ok := value.(*sql.NullFloat64)
if !ok || !svalue.Valid {
panic("Unexpected missing column or column is null for _record_count.")
}
rs.recordCount = new(uint64)
*rs.recordCount = uint64(svalue.Float64)
continue
}
switch svalue := value.(type) {
default:
return fmt.Errorf("received unexpected scanned type = %T for column = %s", value, column)
case *sql.NullFloat64:
if svalue.Valid {
record.Set(column, svalue.Float64)
}
case *sql.NullString:
if svalue.Valid {
schema := rs.typemap[column]
if schema.Type == skydb.TypeReference {
record.Set(column, skydb.NewReference(schema.ReferenceType, svalue.String))
} else if schema.Type == skydb.TypeACL {
acl := skydb.RecordACL{}
json.Unmarshal([]byte(svalue.String), &acl)
record.Set(column, acl)
} else {
record.Set(column, svalue.String)
}
}
case *pq.NullTime:
if svalue.Valid {
// it is to support direct deep-equal of value between
// a empty record and a record materialized from the database
if svalue.Time.IsZero() {
record.Set(column, time.Time{})
} else {
record.Set(column, svalue.Time.In(time.UTC))
}
}
case *sql.NullBool:
if svalue.Valid {
record.Set(column, svalue.Bool)
}
case *nullAsset:
if svalue.Valid {
record.Set(column, svalue.Asset)
}
case *nullJSON:
if svalue.Valid {
record.Set(column, svalue.JSON)
}
case *nullLocation:
if svalue.Valid {
record.Set(column, svalue.Location)
}
case *sql.NullInt64:
if svalue.Valid {
record.Set(column, svalue.Int64)
}
}
}
return nil
}
type rowsIter struct {
rows *sqlx.Rows
rs *recordScanner
}
func (rowsi rowsIter) Close() error {
return rowsi.rows.Close()
}
func (rowsi rowsIter) Next(record *skydb.Record) error {
if rowsi.rows.Next() {
return rowsi.rs.Scan(record)
} else if rowsi.rows.Err() != nil {
return rowsi.rows.Err()
} else {
return io.EOF
}
}
func (rowsi rowsIter) OverallRecordCount() *uint64 {
return rowsi.rs.recordCount
}
func newRows(recordType string, typemap skydb.RecordSchema, rows *sqlx.Rows, err error) (*skydb.Rows, error) {
if err != nil {
return nil, err
}
rs := newRecordScanner(recordType, typemap, rows)
return skydb.NewRows(rowsIter{rows, rs}), nil
}
func (db *database) selectQuery(q sq.SelectBuilder, recordType string, typemap skydb.RecordSchema) sq.SelectBuilder {
for column, fieldType := range typemap {
expr := fieldType.Expression
if expr.IsEmpty() {
expr = skydb.Expression{
Type: skydb.KeyPath,
Value: column,
}
}
e := expressionSqlizer{recordType, expr}
sqlOperand, opArgs, _ := e.ToSql()
q = q.Column(sqlOperand+" as "+pq.QuoteIdentifier(column), opArgs...)
}
q = q.From(db.tableName(recordType)).
Where("_database_id = ?", db.userID)
return q
}
func updateTypemapForQuery(query *skydb.Query, typemap skydb.RecordSchema) (skydb.RecordSchema, error) {
if query.DesiredKeys != nil {
newtypemap, err := whitelistedRecordSchema(typemap, query.DesiredKeys)
if err != nil {
return nil, err
}
typemap = newtypemap
}
for key, value := range query.ComputedKeys {
if value.Type == skydb.KeyPath {
// recorddb does not support querying with computed keys
continue
}
v := value // because value will be overwritten in the next loop
typemap["_transient_"+key] = skydb.FieldType{
Type: skydb.TypeNumber,
Expression: v,
}
}
if query.GetCount {
typemap["_record_count"] = skydb.FieldType{
Type: skydb.TypeNumber,
Expression: skydb.Expression{
Type: skydb.Function,
Value: skydb.CountFunc{
OverallRecords: true,
},
},
}
}
return typemap, nil
}
func whitelistedRecordSchema(schema skydb.RecordSchema, whitelistKeys []string) (skydb.RecordSchema, error) {
wlSchema := skydb.RecordSchema{}
for _, key := range whitelistKeys {
columnType, ok := schema[key]
if !ok {
return nil, fmt.Errorf(`unexpected key "%s"`, key)
}
wlSchema[key] = columnType
}
for key, value := range schema {
if strings.HasPrefix(key, "_") {
wlSchema[key] = value
}
}
return wlSchema, nil
}