-
Notifications
You must be signed in to change notification settings - Fork 19
/
cursor.go
363 lines (311 loc) · 11 KB
/
cursor.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
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package sqlstore
import (
"bytes"
"encoding/gob"
"fmt"
"strings"
"code.vegaprotocol.io/vega/datanode/entities"
)
type (
Sorting = string
Compare = string
)
const (
ASC Sorting = "ASC"
DESC Sorting = "DESC"
EQ Compare = "="
NE Compare = "!="
GT Compare = ">"
LT Compare = "<"
GE Compare = ">="
LE Compare = "<="
)
type ColumnOrdering struct {
// Name of the column in the database table to match to the struct field
Name string
// Sorting is the sorting order to use for the column
Sorting Sorting
// Prefix is the prefix to add to the column name in order to resolve duplicate
// column names that might be in the query
Prefix string
// If the column originates from parsing a JSON field, how it should be referenced in the query.
Ref string
}
func NewColumnOrdering(name string, sorting Sorting) ColumnOrdering {
return ColumnOrdering{Name: name, Sorting: sorting}
}
type TableOrdering []ColumnOrdering
func (t *TableOrdering) OrderByClause() string {
if len(*t) == 0 {
return ""
}
fragments := make([]string, len(*t))
for i, column := range *t {
prefix := column.Prefix
if column.Prefix != "" && !strings.HasSuffix(column.Prefix, ".") {
prefix += "."
}
fragments[i] = fmt.Sprintf("%s%s %s", prefix, column.Name, column.Sorting)
}
return fmt.Sprintf("ORDER BY %s", strings.Join(fragments, ","))
}
func (t *TableOrdering) Reversed() TableOrdering {
reversed := make([]ColumnOrdering, len(*t))
for i, column := range *t {
if column.Sorting == DESC {
reversed[i] = ColumnOrdering{Name: column.Name, Sorting: ASC, Ref: column.Ref}
}
if column.Sorting == ASC {
reversed[i] = ColumnOrdering{Name: column.Name, Sorting: DESC, Ref: column.Ref}
}
}
return reversed
}
// CursorPredicate generates an SQL predicate which excludes all rows before the supplied cursor,
// with regards to the supplied table ordering. The values used for comparison are added to
// the args list and bind variables used in the query fragment.
//
// For example, with if you had a query with columns sorted foo ASCENDING, bar DESCENDING and a
// cursor with {foo=1, bar=2}, it would yield a string predicate like this:
//
// (foo > $1) OR (foo = $1 AND bar <= $2)
//
// And 'args' would have 1 and 2 appended to it.
//
// Notes:
// - The predicate *includes* the value at the cursor
// - Only fields that are present in both the cursor and the ordering are considered
// - The union of those fields must have enough information to uniquely identify a row
// - The table ordering must be sufficient to ensure that a row identified by a cursor cannot
// change position in relation to the other rows
func CursorPredicate(args []interface{}, cursor interface{}, ordering TableOrdering) (string, []interface{}, error) {
cursorPredicates := []string{}
equalPredicates := []string{}
for i, column := range ordering {
// For the non-last columns, use LT/GT, so we don't include stuff before the cursor
var operator string
if column.Sorting == ASC {
operator = ">"
} else if column.Sorting == DESC {
operator = "<"
} else {
return "", nil, fmt.Errorf("unknown sort direction %s", column.Sorting)
}
// For the last column, we want to use GTE/LTE so we include the value at the cursor
isLast := i == (len(ordering) - 1)
if isLast {
operator = operator + "="
}
value, err := StructValueForColumn(cursor, column.Name)
if err != nil {
return "", nil, err
}
prefix := column.Prefix
if column.Prefix != "" && !strings.HasSuffix(column.Prefix, ".") {
prefix += "."
}
bindVar := nextBindVar(&args, value)
ref := column.Name
if len(column.Ref) > 0 {
ref = column.Ref
}
inequalityPredicate := fmt.Sprintf("%s%s %s %s", prefix, ref, operator, bindVar)
colPredicates := append(equalPredicates, inequalityPredicate)
colPredicateString := strings.Join(colPredicates, " AND ")
colPredicateString = fmt.Sprintf("(%s)", colPredicateString)
cursorPredicates = append(cursorPredicates, colPredicateString)
equalityPredicate := fmt.Sprintf("%s%s = %s", prefix, ref, bindVar)
equalPredicates = append(equalPredicates, equalityPredicate)
}
predicateString := strings.Join(cursorPredicates, " OR ")
return predicateString, args, nil
}
type parser interface {
Parse(string) error
}
// This is a bit magical, it allows us to use the real cursor type for instantiation and the pointer
// type for calling methods with pointer receivers (e.g. Parse) for details see
// https://go.googlesource.com/proposal/+/refs/heads/master/design/43651-type-parameters.md#pointer-method-example
type parserPtr[T any] interface {
parser
*T
}
// We have to roll our own equals function here for comparing the cursors because some cursor parameters use
// types that do not implement `comparable`.
func equals[T any](actual, other T) (bool, error) {
var a, b bytes.Buffer
enc := gob.NewEncoder(&a)
err := enc.Encode(actual)
if err != nil {
return false, err
}
enc = gob.NewEncoder(&b)
err = enc.Encode(other)
if err != nil {
return false, err
}
return bytes.Equal(a.Bytes(), b.Bytes()), nil
}
// PaginateQuery takes a query string & bind arg list and returns the same with additional SQL to
// - exclude rows before the cursor (or after it if the cursor is a backwards looking one)
// - limit the number of rows to the pagination limit +1 (no cursor) or +2 (cursor)
// [for purposes of later figuring out whether there are next or previous pages]
// - order the query according to the TableOrdering supplied
// the order is reversed if pagination request is backwards
//
// For example with cursor to a row where foo=42, and a pagination saying get the next 3 then:
// PaginateQuery[MyCursor]("SELECT foo FROM my_table", args, ordering, pagination)
//
// Would append `42` to the arg list and return
// SELECT foo FROM my_table WHERE foo>=$1 ORDER BY foo ASC LIMIT 5
//
// See CursorPredicate() for more details about how the cursor filtering is done.
func PaginateQuery[T any, PT parserPtr[T]](
query string,
args []interface{},
ordering TableOrdering,
pagination entities.CursorPagination,
) (string, []interface{}, error) {
return paginateQueryInternal[T, PT](query, args, ordering, pagination, false, false)
}
func PaginateQueryWithWhere[T any, PT parserPtr[T]](
query string,
args []interface{},
ordering TableOrdering,
pagination entities.CursorPagination,
) (string, []interface{}, error) {
return paginateQueryInternal[T, PT](query, args, ordering, pagination, false, true)
}
func PaginateQueryWithoutOrderBy[T any, PT parserPtr[T]](
query string,
args []interface{},
ordering TableOrdering,
pagination entities.CursorPagination,
) (string, []interface{}, error) {
return paginateQueryInternal[T, PT](query, args, ordering, pagination, true, false)
}
func paginateQueryInternal[T any, PT parserPtr[T]](
query string,
args []interface{},
ordering TableOrdering,
pagination entities.CursorPagination,
omitOrderBy bool,
forceWhere bool,
) (string, []interface{}, error) {
// Extract a cursor struct from the pagination struct
cursor, err := parseCursor[T, PT](pagination)
if err != nil {
return "", nil, fmt.Errorf("parsing cursor: %w", err)
}
// If we're fetching rows before the cursor, reverse the ordering
if (pagination.HasBackward() && !pagination.NewestFirst) || // Navigating backwards in time order
(pagination.HasForward() && pagination.NewestFirst) || // Navigating forward in reverse time order
(!pagination.HasBackward() && !pagination.HasForward() && pagination.NewestFirst) { // No pagination provided, but in reverse time order
ordering = ordering.Reversed()
}
// If the cursor wasn't empty, exclude rows preceding the cursor's row
var emptyCursor T
isEmpty, err := equals[T](cursor, emptyCursor)
if err != nil {
return "", nil, fmt.Errorf("checking empty cursor: %w", err)
}
if !isEmpty {
whereOrAnd := "WHERE"
if !forceWhere && strings.Contains(strings.ToUpper(query), "WHERE") {
whereOrAnd = "AND"
}
var predicate string
predicate, args, err = CursorPredicate(args, cursor, ordering)
if err != nil {
return "", nil, fmt.Errorf("building cursor predicate: %w", err)
}
query = fmt.Sprintf("%s %s (%s)", query, whereOrAnd, predicate)
}
// Add an ORDER BY clause if requested
if !omitOrderBy {
query = fmt.Sprintf("%s %s", query, ordering.OrderByClause())
}
// And a LIMIT clause
limit := calculateLimit(pagination)
if limit != 0 {
query = fmt.Sprintf("%s LIMIT %d", query, limit)
}
return query, args, nil
}
func parseCursor[T any, PT parserPtr[T]](pagination entities.CursorPagination) (T, error) {
cursor := PT(new(T))
cursorStr := ""
if pagination.HasForward() && pagination.Forward.HasCursor() {
cursorStr = pagination.Forward.Cursor.Value()
} else if pagination.HasBackward() && pagination.Backward.HasCursor() {
cursorStr = pagination.Backward.Cursor.Value()
}
if cursorStr != "" {
err := cursor.Parse(cursorStr)
if err != nil {
return *cursor, fmt.Errorf("parsing cursor: %w", err)
}
}
return *cursor, nil
}
type CursorQueryParameter struct {
ColumnName string
Sort Sorting
Cmp Compare
Value any
}
func NewCursorQueryParameter(columnName string, sort Sorting, cmp Compare, value any) CursorQueryParameter {
return CursorQueryParameter{
ColumnName: columnName,
Sort: sort,
Cmp: cmp,
Value: value,
}
}
func (c CursorQueryParameter) Where(args ...interface{}) (string, []interface{}) {
if c.Cmp == "" || c.Value == nil {
return "", args
}
where := fmt.Sprintf("%s %s %v", c.ColumnName, c.Cmp, nextBindVar(&args, c.Value))
return where, args
}
func (c CursorQueryParameter) OrderBy() string {
return fmt.Sprintf("%s %s", c.ColumnName, c.Sort)
}
type CursorQueryParameters []CursorQueryParameter
func (c CursorQueryParameters) Where(args ...interface{}) (string, []interface{}) {
var where string
for i, cursor := range c {
var cursorCondition string
cursorCondition, args = cursor.Where(args...)
if i > 0 && strings.TrimSpace(where) != "" && strings.TrimSpace(cursorCondition) != "" {
where = fmt.Sprintf("%s AND", where)
}
where = fmt.Sprintf("%s %s", where, cursorCondition)
}
return strings.TrimSpace(where), args
}
func (c CursorQueryParameters) OrderBy() string {
var orderBy string
for i, cursor := range c {
if i > 0 {
orderBy = fmt.Sprintf("%s,", orderBy)
}
orderBy = fmt.Sprintf("%s %s", orderBy, cursor.OrderBy())
}
return strings.TrimSpace(orderBy)
}