forked from cockroachdb/cockroach
/
dump.go
468 lines (433 loc) · 12.1 KB
/
dump.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
// Copyright 2016 The Cockroach Authors.
//
// 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.
//
// Author: Matt Jibson (mjibson@cockroachlabs.com)
package cli
import (
"bytes"
"database/sql/driver"
"fmt"
"io"
"os"
"strings"
"time"
"github.com/cockroachdb/cockroach/pkg/sql/parser"
"github.com/pkg/errors"
"github.com/spf13/cobra"
)
// dumpCmd dumps SQL tables.
var dumpCmd = &cobra.Command{
Use: "dump [options] <database> [<table> [<table>...]]",
Short: "dump sql tables\n",
Long: `
Dump SQL tables of a cockroach database. If the table name
is omitted, dump all tables in the database.
`,
RunE: MaybeDecorateGRPCError(runDump),
}
func runDump(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return usageAndError(cmd)
}
conn, err := getPasswordAndMakeSQLClient()
if err != nil {
return err
}
defer conn.Close()
dbName := args[0]
var tableNames []string
if len(args) > 1 {
tableNames = args[1:]
}
mds, ts, err := getDumpMetadata(conn, dbName, tableNames, dumpCtx.asOf)
if err != nil {
return err
}
// TODO(knz/mjibson): dump foreign key constraints and dump in
// topological order to ensure key relationships can be verified
// during load.
w := os.Stdout
if dumpCtx.dumpMode != dumpDataOnly {
for i, md := range mds {
if i > 0 {
fmt.Fprintln(w)
}
if err := dumpCreateTable(w, md); err != nil {
return err
}
}
}
if dumpCtx.dumpMode != dumpSchemaOnly {
for _, md := range mds {
if err := dumpTableData(w, conn, ts, md); err != nil {
return err
}
}
}
return nil
}
// tableMetadata describes one table to dump.
type tableMetadata struct {
name *parser.TableName
primaryIndex string
numIndexCols int
idxColNames string
columnNames string
columnTypes map[string]string
createStmt string
}
// getDumpMetadata retrieves the table information for the specified table(s).
// It also retrieves the cluster timestamp at which the metadata was
// retrieved.
func getDumpMetadata(
conn *sqlConn, dbName string, tableNames []string, asOf string,
) (mds []tableMetadata, clusterTS string, err error) {
if asOf == "" {
vals, err := conn.QueryRow("SELECT cluster_logical_timestamp()", nil)
if err != nil {
return nil, "", err
}
clusterTS = string(vals[0].([]byte))
} else {
// Validate the timestamp. This prevents SQL injection.
if _, err := parser.ParseDTimestamp(asOf, time.Nanosecond); err != nil {
return nil, "", err
}
clusterTS = asOf
}
if tableNames == nil {
tableNames, err = getTableNames(conn, dbName, clusterTS)
if err != nil {
return nil, "", err
}
}
mds = make([]tableMetadata, len(tableNames))
for i, tableName := range tableNames {
md, err := getMetadataForTable(conn, dbName, tableName, clusterTS)
if err != nil {
return nil, "", err
}
mds[i] = md
}
return mds, clusterTS, nil
}
// getTableNames retrieves all tables names in the given database.
func getTableNames(conn *sqlConn, dbName string, ts string) (tableNames []string, err error) {
rows, err := conn.Query(fmt.Sprintf(`
SELECT TABLE_NAME
FROM "".information_schema.tables
AS OF SYSTEM TIME '%s'
WHERE TABLE_SCHEMA = $1
`, ts), []driver.Value{dbName})
if err != nil {
return nil, err
}
vals := make([]driver.Value, 1)
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return nil, err
}
nameI := vals[0]
name, ok := nameI.(string)
if !ok {
return nil, fmt.Errorf("unexpected value: %T", nameI)
}
tableNames = append(tableNames, name)
}
if err := rows.Close(); err != nil {
return nil, err
}
return tableNames, nil
}
func getMetadataForTable(
conn *sqlConn, dbName, tableName string, ts string,
) (tableMetadata, error) {
// Fetch column types.
rows, err := conn.Query(fmt.Sprintf(`
SELECT COLUMN_NAME, DATA_TYPE
FROM "".information_schema.columns
AS OF SYSTEM TIME '%s'
WHERE TABLE_SCHEMA = $1
AND TABLE_NAME = $2
`, ts), []driver.Value{dbName, tableName})
if err != nil {
return tableMetadata{}, err
}
vals := make([]driver.Value, 2)
coltypes := make(map[string]string)
var colnames bytes.Buffer
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return tableMetadata{}, err
}
nameI, typI := vals[0], vals[1]
name, ok := nameI.(string)
if !ok {
return tableMetadata{}, fmt.Errorf("unexpected value: %T", nameI)
}
typ, ok := typI.(string)
if !ok {
return tableMetadata{}, fmt.Errorf("unexpected value: %T", typI)
}
coltypes[name] = typ
if colnames.Len() > 0 {
colnames.WriteString(", ")
}
parser.FormatNode(&colnames, parser.FmtSimple, parser.Name(name))
}
if err := rows.Close(); err != nil {
return tableMetadata{}, err
}
// Fetch the primary index name.
vals, err = conn.QueryRow(fmt.Sprintf(`
SELECT CONSTRAINT_NAME
FROM "".information_schema.table_constraints
AS OF SYSTEM TIME '%s'
WHERE TABLE_SCHEMA = $1
AND TABLE_NAME = $2
AND CONSTRAINT_TYPE='PRIMARY KEY'
`, ts), []driver.Value{dbName, tableName})
var primaryIndex string
if err != nil {
// If the above query returns no rows, err will be set to io.EOF.
// This indicates that there is no visible primary index in the table.
if err != io.EOF {
return tableMetadata{}, err
}
} else {
primaryIndex = vals[0].(string)
}
rows, err = conn.Query(fmt.Sprintf(`
SELECT COLUMN_NAME
FROM "".information_schema.key_column_usage
AS OF SYSTEM TIME '%s'
WHERE TABLE_SCHEMA = $1
AND TABLE_NAME = $2
AND CONSTRAINT_NAME = $3
ORDER BY ORDINAL_POSITION
`, ts), []driver.Value{dbName, tableName, primaryIndex})
if err != nil {
return tableMetadata{}, err
}
vals = make([]driver.Value, 1)
var numIndexCols int
var idxColNames bytes.Buffer
// Find the primary index columns.
for {
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return tableMetadata{}, err
}
name := vals[0].(string)
if idxColNames.Len() > 0 {
idxColNames.WriteString(", ")
}
parser.FormatNode(&idxColNames, parser.FmtSimple, parser.Name(name))
numIndexCols++
}
if err := rows.Close(); err != nil {
return tableMetadata{}, err
}
name := &parser.TableName{DatabaseName: parser.Name(dbName), TableName: parser.Name(tableName)}
vals, err = conn.QueryRow(fmt.Sprintf(`
SELECT CREATE_TABLE
FROM "".crdb_internal.tables
AS OF SYSTEM TIME '%s'
WHERE NAME = $1
AND DATABASE_NAME = $2
`, ts), []driver.Value{tableName, dbName})
if err != nil {
if err == io.EOF {
return tableMetadata{}, errors.Errorf("table %s.%s does not exist", dbName, tableName)
}
return tableMetadata{}, err
}
create := vals[0].(string)
return tableMetadata{
name: name,
primaryIndex: primaryIndex,
numIndexCols: numIndexCols,
idxColNames: idxColNames.String(),
columnNames: colnames.String(),
columnTypes: coltypes,
createStmt: create,
}, nil
}
// dumpCreateTable dumps the CREATE statement of the specified table to w.
func dumpCreateTable(w io.Writer, md tableMetadata) error {
if _, err := w.Write([]byte(md.createStmt)); err != nil {
return err
}
if _, err := w.Write([]byte(";\n")); err != nil {
return err
}
return nil
}
const (
// limit is the number of rows to dump at a time (in each SELECT statement).
limit = 10000
// insertRows is the number of rows per INSERT statement.
insertRows = 100
)
// dumpTableData dumps the data of the specified table to w.
func dumpTableData(w io.Writer, conn *sqlConn, clusterTS string, md tableMetadata) error {
// Build the SELECT query.
var sbuf bytes.Buffer
if md.idxColNames == "" {
// TODO(mjibson): remove hard coded rowid. Maybe create a crdb_internal
// table with the information we need instead.
md.idxColNames = "rowid"
md.numIndexCols = 1
}
fmt.Fprintf(&sbuf, "SELECT %s, %s FROM %s", md.idxColNames, md.columnNames, md.name)
if md.primaryIndex != "" {
fmt.Fprintf(&sbuf, "@%s", parser.Name(md.primaryIndex))
}
fmt.Fprintf(&sbuf, " AS OF SYSTEM TIME '%s'", clusterTS)
var wbuf bytes.Buffer
fmt.Fprintf(&wbuf, " WHERE ROW (%s) > ROW (", md.idxColNames)
for i := 0; i < md.numIndexCols; i++ {
if i > 0 {
wbuf.WriteString(", ")
}
fmt.Fprintf(&wbuf, "$%d", i+1)
}
wbuf.WriteString(")")
// No WHERE clause first time, so add a place to inject it.
fmt.Fprintf(&sbuf, "%%s ORDER BY %s LIMIT %d", md.idxColNames, limit)
bs := sbuf.String()
// pk holds the last values of the fetched primary keys
var pk []driver.Value
q := fmt.Sprintf(bs, "")
inserts := make([][]string, 0, insertRows)
for {
rows, err := conn.Query(q, pk)
if err != nil {
return err
}
cols := rows.Columns()
pkcols := cols[:md.numIndexCols]
cols = cols[md.numIndexCols:]
i := 0
for {
vals := make([]driver.Value, len(cols)+len(pkcols))
if err := rows.Next(vals); err == io.EOF {
break
} else if err != nil {
return err
}
if pk == nil {
q = fmt.Sprintf(bs, wbuf.String())
}
pk = vals[:md.numIndexCols]
vals = vals[md.numIndexCols:]
ivals := make([]string, len(vals))
// Values need to be correctly encoded for INSERT statements in a text file.
for si, sv := range vals {
switch t := sv.(type) {
case nil:
ivals[si] = "NULL"
case bool:
ivals[si] = parser.MakeDBool(parser.DBool(t)).String()
case int64:
ivals[si] = parser.NewDInt(parser.DInt(t)).String()
case float64:
ivals[si] = parser.NewDFloat(parser.DFloat(t)).String()
case string:
ivals[si] = parser.NewDString(t).String()
case []byte:
switch ct := md.columnTypes[cols[si]]; ct {
case "INTERVAL":
ivals[si] = fmt.Sprintf("'%s'", t)
case "BYTES":
ivals[si] = parser.NewDBytes(parser.DBytes(t)).String()
default:
// STRING and DECIMAL types can have optional length
// suffixes, so only examine the prefix of the type.
if strings.HasPrefix(md.columnTypes[cols[si]], "STRING") {
ivals[si] = parser.NewDString(string(t)).String()
} else if strings.HasPrefix(md.columnTypes[cols[si]], "DECIMAL") {
ivals[si] = string(t)
} else {
panic(errors.Errorf("unknown []byte type: %s, %v: %s", t, cols[si], md.columnTypes[cols[si]]))
}
}
case time.Time:
var d parser.Datum
ct := md.columnTypes[cols[si]]
switch ct {
case "DATE":
d = parser.NewDDateFromTime(t, time.UTC)
case "TIMESTAMP":
d = parser.MakeDTimestamp(t, time.Nanosecond)
case "TIMESTAMP WITH TIME ZONE":
d = parser.MakeDTimestampTZ(t, time.Nanosecond)
default:
panic(errors.Errorf("unknown timestamp type: %s, %v: %s", t, cols[si], md.columnTypes[cols[si]]))
}
ivals[si] = d.String()
default:
panic(errors.Errorf("unknown field type: %T (%s)", t, cols[si]))
}
}
inserts = append(inserts, ivals)
i++
if len(inserts) == cap(inserts) {
writeInserts(w, md, inserts)
inserts = inserts[:0]
}
}
for si, sv := range pk {
b, ok := sv.([]byte)
if ok && strings.HasPrefix(md.columnTypes[pkcols[si]], "STRING") {
// Primary key strings need to be converted to a go string, but not SQL
// encoded since they aren't being written to a text file.
pk[si] = string(b)
}
}
if err := rows.Close(); err != nil {
return err
}
if len(inserts) != 0 {
writeInserts(w, md, inserts)
inserts = inserts[:0]
}
if i < limit {
break
}
}
return nil
}
func writeInserts(w io.Writer, md tableMetadata, inserts [][]string) {
fmt.Fprintf(w, "\nINSERT INTO %s (%s) VALUES", md.name.TableName, md.columnNames)
for idx, values := range inserts {
if idx > 0 {
fmt.Fprint(w, ",")
}
fmt.Fprint(w, "\n\t(")
for vi, v := range values {
if vi > 0 {
fmt.Fprint(w, ", ")
}
fmt.Fprint(w, v)
}
fmt.Fprint(w, ")")
}
fmt.Fprintln(w, ";")
}