-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathformat.go
More file actions
599 lines (575 loc) · 17.1 KB
/
format.go
File metadata and controls
599 lines (575 loc) · 17.1 KB
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
package explain
import (
"fmt"
"math"
"strconv"
"strings"
"github.com/sqlc-dev/doubleclick/ast"
)
// FormatFloat formats a float value for EXPLAIN AST output
func FormatFloat(val float64) string {
// Handle special float values - ClickHouse uses lowercase
if math.IsInf(val, 1) {
return "inf"
}
if math.IsInf(val, -1) {
return "-inf"
}
if math.IsNaN(val) {
return "nan"
}
// Use scientific notation for very small numbers (< 1e-6) or very large numbers (>= 1e21)
// This matches ClickHouse's behavior
absVal := math.Abs(val)
if (absVal > 0 && absVal < 1e-6) || absVal >= 1e21 {
s := strconv.FormatFloat(val, 'e', -1, 64)
// Remove leading zeros from exponent (e-07 -> e-7, e+07 -> e+7)
s = strings.Replace(s, "e-0", "e-", 1)
s = strings.Replace(s, "e+0", "e+", 1)
// Remove the + from positive exponents (e+21 -> e21)
s = strings.Replace(s, "e+", "e", 1)
return s
}
// Use decimal notation for normal-sized numbers
return strconv.FormatFloat(val, 'f', -1, 64)
}
// EscapeIdentifier escapes single quotes in identifiers for EXPLAIN AST output
// ClickHouse escapes ' as \' in identifier names
func EscapeIdentifier(s string) string {
return strings.ReplaceAll(s, "'", "\\'")
}
// escapeStringLiteral escapes special characters in a string for EXPLAIN AST output
// Uses double-escaping as ClickHouse EXPLAIN AST displays strings
// Iterates over bytes to preserve raw bytes (including invalid UTF-8)
func escapeStringLiteral(s string) string {
var sb strings.Builder
for i := 0; i < len(s); i++ {
b := s[i]
switch b {
case '\\':
sb.WriteString("\\\\\\\\") // backslash becomes four backslashes (\\\\)
case '\'':
sb.WriteString("\\\\\\'") // single quote becomes \\\' (three backslashes + quote)
case '\n':
sb.WriteString("\\\\n") // newline becomes \\n
case '\t':
sb.WriteString("\\\\t") // tab becomes \\t
case '\r':
sb.WriteString("\\\\r") // carriage return becomes \\r
case '\x00':
sb.WriteString("\\\\0") // null becomes \\0
case '\b':
sb.WriteString("\\\\b") // backspace becomes \\b
case '\f':
sb.WriteString("\\\\f") // form feed becomes \\f
default:
sb.WriteByte(b)
}
}
return sb.String()
}
// escapeStringForTypeParam escapes special characters for use in type parameters
// Uses extra escaping because type strings are embedded inside another string literal
func escapeStringForTypeParam(s string) string {
var sb strings.Builder
for i := 0; i < len(s); i++ {
b := s[i]
switch b {
case '\\':
sb.WriteString("\\\\\\\\\\\\\\\\") // backslash becomes 8 backslashes
case '\'':
sb.WriteString("\\\\\\\\\\'") // single quote becomes 5 backslashes + quote
case '\n':
sb.WriteString("\\\\\\\\n") // newline becomes \\\\n
case '\t':
sb.WriteString("\\\\\\\\t") // tab becomes \\\\t
case '\r':
sb.WriteString("\\\\\\\\r") // carriage return becomes \\\\r
case '\x00':
sb.WriteString("\\\\\\\\0") // null becomes \\\\0
case '\b':
sb.WriteString("\\\\\\\\b") // backspace becomes \\\\b
case '\f':
sb.WriteString("\\\\\\\\f") // form feed becomes \\\\f
default:
sb.WriteByte(b)
}
}
return sb.String()
}
// FormatLiteral formats a literal value for EXPLAIN AST output
func FormatLiteral(lit *ast.Literal) string {
switch lit.Type {
case ast.LiteralInteger:
// Handle both int64 and uint64 values
switch val := lit.Value.(type) {
case int64:
if val >= 0 {
return fmt.Sprintf("UInt64_%d", val)
}
return fmt.Sprintf("Int64_%d", val)
case uint64:
return fmt.Sprintf("UInt64_%d", val)
default:
return fmt.Sprintf("UInt64_%v", lit.Value)
}
case ast.LiteralFloat:
val := lit.Value.(float64)
return fmt.Sprintf("Float64_%s", FormatFloat(val))
case ast.LiteralString:
s := lit.Value.(string)
// Escape special characters for display
s = escapeStringLiteral(s)
return fmt.Sprintf("\\'%s\\'", s)
case ast.LiteralBoolean:
if lit.Value.(bool) {
return "Bool_1"
}
return "Bool_0"
case ast.LiteralNull:
return "NULL"
case ast.LiteralArray:
return formatArrayLiteral(lit.Value)
case ast.LiteralTuple:
return formatTupleLiteral(lit.Value)
default:
return fmt.Sprintf("%v", lit.Value)
}
}
// formatArrayLiteral formats an array literal for EXPLAIN AST output
func formatArrayLiteral(val interface{}) string {
exprs, ok := val.([]ast.Expression)
if !ok {
return "Array_[]"
}
var parts []string
for _, e := range exprs {
if lit, ok := e.(*ast.Literal); ok {
parts = append(parts, FormatLiteral(lit))
} else if unary, ok := e.(*ast.UnaryExpr); ok && unary.Op == "-" {
// Handle negation of numeric literals
if lit, ok := unary.Operand.(*ast.Literal); ok {
if lit.Type == ast.LiteralInteger {
switch val := lit.Value.(type) {
case int64:
parts = append(parts, fmt.Sprintf("Int64_%d", -val))
case uint64:
parts = append(parts, fmt.Sprintf("Int64_-%d", val))
default:
parts = append(parts, fmt.Sprintf("Int64_-%v", lit.Value))
}
} else if lit.Type == ast.LiteralFloat {
val := lit.Value.(float64)
parts = append(parts, fmt.Sprintf("Float64_%s", FormatFloat(-val)))
} else {
parts = append(parts, formatExprAsString(e))
}
} else {
parts = append(parts, formatExprAsString(e))
}
} else if ident, ok := e.(*ast.Identifier); ok {
parts = append(parts, ident.Name())
} else {
parts = append(parts, formatExprAsString(e))
}
}
return fmt.Sprintf("Array_[%s]", strings.Join(parts, ", "))
}
// formatNumericExpr formats a numeric expression (literal or unary minus of literal)
func formatNumericExpr(e ast.Expression) (string, bool) {
if lit, ok := e.(*ast.Literal); ok {
if lit.Type == ast.LiteralInteger || lit.Type == ast.LiteralFloat {
return FormatLiteral(lit), true
}
}
if unary, ok := e.(*ast.UnaryExpr); ok && unary.Op == "-" {
if lit, ok := unary.Operand.(*ast.Literal); ok {
switch val := lit.Value.(type) {
case int64:
return fmt.Sprintf("Int64_%d", -val), true
case uint64:
return fmt.Sprintf("Int64_%d", -int64(val)), true
case float64:
return fmt.Sprintf("Float64_%s", FormatFloat(-val)), true
}
}
}
return "", false
}
// formatTupleLiteral formats a tuple literal for EXPLAIN AST output
func formatTupleLiteral(val interface{}) string {
exprs, ok := val.([]ast.Expression)
if !ok {
return "Tuple_()"
}
var parts []string
for _, e := range exprs {
if formatted, ok := formatNumericExpr(e); ok {
parts = append(parts, formatted)
} else if lit, ok := e.(*ast.Literal); ok {
parts = append(parts, FormatLiteral(lit))
} else if ident, ok := e.(*ast.Identifier); ok {
parts = append(parts, ident.Name())
} else {
parts = append(parts, formatExprAsString(e))
}
}
return fmt.Sprintf("Tuple_(%s)", strings.Join(parts, ", "))
}
// formatInListAsTuple formats an IN expression's value list as a tuple literal
func formatInListAsTuple(list []ast.Expression) string {
var parts []string
for _, e := range list {
if formatted, ok := formatNumericExpr(e); ok {
parts = append(parts, formatted)
} else if lit, ok := e.(*ast.Literal); ok {
parts = append(parts, FormatLiteral(lit))
} else if ident, ok := e.(*ast.Identifier); ok {
parts = append(parts, ident.Name())
} else {
parts = append(parts, formatExprAsString(e))
}
}
return fmt.Sprintf("Tuple_(%s)", strings.Join(parts, ", "))
}
// FormatDataType formats a DataType for EXPLAIN AST output
func FormatDataType(dt *ast.DataType) string {
if dt == nil {
return ""
}
if len(dt.Parameters) == 0 {
return dt.Name
}
var params []string
for _, p := range dt.Parameters {
// Unwrap ObjectTypeArgument if present (used for JSON/OBJECT types)
if ota, ok := p.(*ast.ObjectTypeArgument); ok {
p = ota.Expr
}
if lit, ok := p.(*ast.Literal); ok {
if lit.Type == ast.LiteralString {
// String parameters in type need extra escaping: 'val' -> \\\'val\\\'
params = append(params, fmt.Sprintf("\\\\\\'%s\\\\\\'", lit.Value))
} else {
params = append(params, fmt.Sprintf("%v", lit.Value))
}
} else if nested, ok := p.(*ast.DataType); ok {
params = append(params, FormatDataType(nested))
} else if ntp, ok := p.(*ast.NameTypePair); ok {
// Named tuple field: "name Type"
params = append(params, ntp.Name+" "+FormatDataType(ntp.Type))
} else if binExpr, ok := p.(*ast.BinaryExpr); ok {
// Binary expression (e.g., 'hello' = 1 for Enum types)
params = append(params, formatBinaryExprForType(binExpr))
} else if fn, ok := p.(*ast.FunctionCall); ok {
// Function call (e.g., SKIP for JSON types)
if fn.Name == "SKIP" && len(fn.Arguments) > 0 {
if ident, ok := fn.Arguments[0].(*ast.Identifier); ok {
params = append(params, "SKIP "+ident.Name())
}
} else if fn.Name == "SKIP REGEXP" && len(fn.Arguments) > 0 {
if lit, ok := fn.Arguments[0].(*ast.Literal); ok {
params = append(params, fmt.Sprintf("SKIP REGEXP \\\\\\'%s\\\\\\'", lit.Value))
}
} else {
params = append(params, fmt.Sprintf("%v", p))
}
} else if ident, ok := p.(*ast.Identifier); ok {
// Identifier (e.g., function name in AggregateFunction types)
params = append(params, ident.Name())
} else {
params = append(params, fmt.Sprintf("%v", p))
}
}
return fmt.Sprintf("%s(%s)", dt.Name, strings.Join(params, ", "))
}
// formatBinaryExprForType formats a binary expression for use in type parameters
func formatBinaryExprForType(expr *ast.BinaryExpr) string {
var left, right string
// Format left side
if lit, ok := expr.Left.(*ast.Literal); ok {
if lit.Type == ast.LiteralString {
// Use extra escaping for type parameters since they're embedded in another string literal
escaped := escapeStringForTypeParam(fmt.Sprintf("%v", lit.Value))
left = fmt.Sprintf("\\\\\\'%s\\\\\\'", escaped)
} else {
left = fmt.Sprintf("%v", lit.Value)
}
} else if ident, ok := expr.Left.(*ast.Identifier); ok {
left = ident.Name()
} else {
left = fmt.Sprintf("%v", expr.Left)
}
// Format right side
if lit, ok := expr.Right.(*ast.Literal); ok {
right = fmt.Sprintf("%v", lit.Value)
} else if ident, ok := expr.Right.(*ast.Identifier); ok {
right = ident.Name()
} else if unary, ok := expr.Right.(*ast.UnaryExpr); ok {
// Handle unary expressions like -100
right = formatUnaryExprForType(unary)
} else {
right = fmt.Sprintf("%v", expr.Right)
}
return left + " " + expr.Op + " " + right
}
// formatUnaryExprForType formats a unary expression for use in type parameters (e.g., -100)
func formatUnaryExprForType(expr *ast.UnaryExpr) string {
if lit, ok := expr.Operand.(*ast.Literal); ok {
return expr.Op + fmt.Sprintf("%v", lit.Value)
}
return expr.Op + fmt.Sprintf("%v", expr.Operand)
}
// NormalizeFunctionName normalizes function names to match ClickHouse's EXPLAIN AST output
func NormalizeFunctionName(name string) string {
// ClickHouse normalizes certain function names in EXPLAIN AST
// Note: lcase, ucase, mid are preserved as-is by ClickHouse EXPLAIN AST
normalized := map[string]string{
"trim": "trimBoth",
"ltrim": "trimLeft",
"rtrim": "trimRight",
"ceiling": "ceil",
"ln": "log",
"log10": "log10",
"log2": "log2",
"rand": "rand",
"ifnull": "ifNull",
"nullif": "nullIf",
"coalesce": "coalesce",
"greatest": "greatest",
"least": "least",
"concat_ws": "concat",
"position": "position",
"date_diff": "dateDiff",
"datediff": "dateDiff",
// SQL standard ANY/ALL subquery operators - simple cases
"anyequals": "in",
"allnotequals": "notIn",
}
if n, ok := normalized[strings.ToLower(name)]; ok {
return n
}
return name
}
// OperatorToFunction maps binary operators to ClickHouse function names
func OperatorToFunction(op string) string {
switch op {
case "+":
return "plus"
case "-":
return "minus"
case "*":
return "multiply"
case "/":
return "divide"
case "DIV":
return "intDiv"
case "%", "MOD":
return "modulo"
case "=", "==":
return "equals"
case "!=", "<>":
return "notEquals"
case "<":
return "less"
case ">":
return "greater"
case "<=":
return "lessOrEquals"
case ">=":
return "greaterOrEquals"
case "<=>":
return "isNotDistinctFrom"
case "AND":
return "and"
case "OR":
return "or"
case "||":
return "concat"
default:
return strings.ToLower(op)
}
}
// UnaryOperatorToFunction maps unary operators to ClickHouse function names
func UnaryOperatorToFunction(op string) string {
switch op {
case "-":
return "negate"
case "NOT":
return "not"
default:
return strings.ToLower(op)
}
}
// formatExprAsString formats an expression as a string literal for :: cast syntax
func formatExprAsString(expr ast.Expression) string {
switch e := expr.(type) {
case *ast.Literal:
// Handle explicitly negative literals (like -0 in -0::Int16)
prefix := ""
if e.Negative {
prefix = "-"
}
switch e.Type {
case ast.LiteralInteger:
// For explicitly negative literals, show the absolute value with prefix
if e.Negative {
switch v := e.Value.(type) {
case int64:
if v <= 0 {
return fmt.Sprintf("-%d", -v)
}
case uint64:
return fmt.Sprintf("-%d", v)
}
}
return fmt.Sprintf("%d", e.Value)
case ast.LiteralFloat:
// Use Source field if available to preserve original representation (e.g., "0.0")
if e.Source != "" {
return e.Source
}
if e.Negative {
switch v := e.Value.(type) {
case float64:
if v <= 0 {
return fmt.Sprintf("%s%v", prefix, -v)
}
}
}
return fmt.Sprintf("%v", e.Value)
case ast.LiteralString:
return e.Value.(string)
case ast.LiteralBoolean:
if e.Value.(bool) {
return "true"
}
return "false"
case ast.LiteralNull:
return "NULL"
case ast.LiteralArray:
return formatArrayAsString(e.Value)
case ast.LiteralTuple:
return formatTupleAsString(e.Value)
default:
return fmt.Sprintf("%v", e.Value)
}
case *ast.Identifier:
return e.Name()
case *ast.FunctionCall:
// Format function call as name(args)
var args []string
for _, arg := range e.Arguments {
args = append(args, formatExprAsString(arg))
}
return e.Name + "(" + strings.Join(args, ", ") + ")"
case *ast.BinaryExpr:
// Format binary expression as left op right
left := formatExprAsString(e.Left)
right := formatExprAsString(e.Right)
return left + " " + e.Op + " " + right
case *ast.UnaryExpr:
// Format unary expression (prefix operators)
operand := formatExprAsString(e.Operand)
return e.Op + operand
case *ast.InExpr:
// Format IN expression as expr IN (...)
exprStr := formatExprAsString(e.Expr)
var listStr string
if e.Query != nil {
listStr = "(SELECT ...)" // Simplified for nested queries
} else if len(e.List) > 0 {
var parts []string
for _, item := range e.List {
parts = append(parts, formatExprAsString(item))
}
listStr = "(" + strings.Join(parts, ", ") + ")"
}
keyword := "IN"
if e.Not {
keyword = "NOT IN"
}
if e.Global {
keyword = "GLOBAL " + keyword
}
return exprStr + " " + keyword + " " + listStr
default:
return fmt.Sprintf("%v", expr)
}
}
// formatArrayAsString formats an array literal as a string for :: cast syntax
func formatArrayAsString(val interface{}) string {
exprs, ok := val.([]ast.Expression)
if !ok {
return "[]"
}
var parts []string
for _, e := range exprs {
parts = append(parts, formatElementAsString(e))
}
return "[" + strings.Join(parts, ", ") + "]"
}
// formatTupleAsString formats a tuple literal as a string for :: cast syntax
func formatTupleAsString(val interface{}) string {
exprs, ok := val.([]ast.Expression)
if !ok {
return "()"
}
var parts []string
for _, e := range exprs {
parts = append(parts, formatElementAsString(e))
}
return "(" + strings.Join(parts, ", ") + ")"
}
// formatElementAsString formats a single element for array/tuple string representation
func formatElementAsString(expr ast.Expression) string {
switch e := expr.(type) {
case *ast.Literal:
switch e.Type {
case ast.LiteralInteger:
return fmt.Sprintf("%d", e.Value)
case ast.LiteralFloat:
return fmt.Sprintf("%v", e.Value)
case ast.LiteralString:
// Quote strings with single quotes, triple-escape for nested context
// Expected output format is \\\' (three backslashes + quote)
s := e.Value.(string)
// Triple-escape single quotes for nested string literal context
s = strings.ReplaceAll(s, "'", "\\\\\\'")
return "\\\\\\'" + s + "\\\\\\'"
case ast.LiteralBoolean:
if e.Value.(bool) {
return "true"
}
return "false"
case ast.LiteralNull:
return "NULL"
case ast.LiteralArray:
return formatArrayAsString(e.Value)
case ast.LiteralTuple:
return formatTupleAsString(e.Value)
default:
return fmt.Sprintf("%v", e.Value)
}
case *ast.Identifier:
return e.Name()
case *ast.FunctionCall:
// Format function call as name(args)
var args []string
for _, arg := range e.Arguments {
args = append(args, formatElementAsString(arg))
}
return e.Name + "(" + strings.Join(args, ", ") + ")"
case *ast.BinaryExpr:
// Format binary expression as left op right
left := formatElementAsString(e.Left)
right := formatElementAsString(e.Right)
return left + " " + e.Op + " " + right
case *ast.UnaryExpr:
// Format unary expression (prefix operators)
operand := formatElementAsString(e.Operand)
return e.Op + operand
default:
return formatExprAsString(expr)
}
}