diff --git a/pkg/ccl/backupccl/targets.go b/pkg/ccl/backupccl/targets.go index 0b395d77ff85..7982096de809 100644 --- a/pkg/ccl/backupccl/targets.go +++ b/pkg/ccl/backupccl/targets.go @@ -474,9 +474,12 @@ func MakeBackupTableEntry( for i, b := range backupManifests { if b.StartTime.Less(endTime) && endTime.LessEq(b.EndTime) { if endTime != b.EndTime && b.MVCCFilter != MVCCFilter_All { - return BackupTableEntry{}, errors.Newf( - "reading data for requested time requires that BACKUP was created with %q"+ - " or should specify the time to be an exact backup time, nearest backup time is %s", backupOptRevisionHistory, timeutil.Unix(0, b.EndTime.WallTime).UTC()) + errorHints := "reading data for requested time requires that BACKUP was created with %q" + + " or should specify the time to be an exact backup time, nearest backup time is %s" + return BackupTableEntry{}, errors.WithHintf( + errors.Newf("unknown read time: %s", timeutil.Unix(0, endTime.WallTime).UTC()), + errorHints, backupOptRevisionHistory, timeutil.Unix(0, b.EndTime.WallTime).UTC(), + ) } ind = i break diff --git a/pkg/ccl/cliccl/BUILD.bazel b/pkg/ccl/cliccl/BUILD.bazel index 67842ad216a6..43af066cdf13 100644 --- a/pkg/ccl/cliccl/BUILD.bazel +++ b/pkg/ccl/cliccl/BUILD.bazel @@ -5,8 +5,8 @@ go_library( srcs = [ "cliccl.go", "debug.go", + "debug_backup.go", "demo.go", - "load.go", "mtproxy.go", "start.go", ], @@ -65,7 +65,7 @@ go_test( name = "cliccl_test", size = "small", srcs = [ - "load_test.go", + "debug_backup_test.go", "main_test.go", ], embed = [":cliccl"], diff --git a/pkg/ccl/cliccl/load.go b/pkg/ccl/cliccl/debug_backup.go similarity index 86% rename from pkg/ccl/cliccl/load.go rename to pkg/ccl/cliccl/debug_backup.go index 480e35981e13..ebf504611841 100644 --- a/pkg/ccl/cliccl/load.go +++ b/pkg/ccl/cliccl/debug_backup.go @@ -18,7 +18,6 @@ import ( "os" "path/filepath" "strings" - "text/tabwriter" "time" "github.com/cockroachdb/apd/v2" @@ -54,6 +53,7 @@ import ( ) var externalIODir string +var exportTableName string var readTime string var destination string var format string @@ -61,41 +61,41 @@ var nullas string func init() { - loadShowSummaryCmd := &cobra.Command{ - Use: "summary ", - Short: "show backups summary", + showCmd := &cobra.Command{ + Use: "show ", + Short: "show backup summary", Long: "Shows summary of meta information about a SQL backup.", Args: cobra.ExactArgs(1), - RunE: cli.MaybeDecorateGRPCError(runLoadShowSummary), + RunE: cli.MaybeDecorateGRPCError(runShowCmd), } - loadShowBackupsCmd := &cobra.Command{ - Use: "backups ", - Short: "show backups in collections", - Long: "Shows full backups in a backup collections.", + listBackupsCmd := &cobra.Command{ + Use: "list-backups ", + Short: "show backups in collection", + Long: "Shows full backup paths in a backup collection.", Args: cobra.ExactArgs(1), - RunE: cli.MaybeDecorateGRPCError(runLoadShowBackups), + RunE: cli.MaybeDecorateGRPCError(runListBackupsCmd), } - loadShowIncrementalCmd := &cobra.Command{ - Use: "incremental ", + listIncrementalCmd := &cobra.Command{ + Use: "list-incremental ", Short: "show incremental backups", Long: "Shows incremental chain of a SQL backup.", Args: cobra.ExactArgs(1), - RunE: cli.MaybeDecorateGRPCError(runLoadShowIncremental), + RunE: cli.MaybeDecorateGRPCError(runListIncrementalCmd), } - loadShowDataCmd := &cobra.Command{ - Use: "data ", - Short: "show data", - Long: "Shows data of a SQL backup.", - Args: cobra.MinimumNArgs(2), - RunE: cli.MaybeDecorateGRPCError(runLoadShowData), + exportDataCmd := &cobra.Command{ + Use: "export ", + Short: "export table data from a backup", + Long: "export table data from a backup, requires specifying --table to export data from", + Args: cobra.MinimumNArgs(1), + RunE: cli.MaybeDecorateGRPCError(runExportDataCmd), } - loadShowCmds := &cobra.Command{ - Use: "show [command]", - Short: "show backups", + backupCmds := &cobra.Command{ + Use: "backup [command]", + Short: "debug backups", Long: "Shows information about a SQL backup.", Args: cobra.MinimumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { @@ -103,64 +103,61 @@ func init() { }, } - loadCmds := &cobra.Command{ - Use: "load [command]", - Short: "load backup commands", - Long: `Commands for bulk loading external files.`, - RunE: func(cmd *cobra.Command, args []string) error { - return cmd.Usage() - }, - } - - loadFlags := loadCmds.Flags() - loadFlags.StringVarP( + backupFlags := backupCmds.Flags() + backupFlags.StringVarP( &externalIODir, cliflags.ExternalIODir.Name, cliflags.ExternalIODir.Shorthand, "", /*value*/ cliflags.ExternalIODir.Usage()) - loadShowDataCmd.Flags().StringVarP( + exportDataCmd.Flags().StringVarP( + &exportTableName, + cliflags.ExportTableTarget.Name, + cliflags.ExportTableTarget.Shorthand, + "", /*value*/ + cliflags.ExportTableTarget.Usage()) + + exportDataCmd.Flags().StringVarP( &readTime, cliflags.ReadTime.Name, cliflags.ReadTime.Shorthand, "", /*value*/ cliflags.ReadTime.Usage()) - loadShowDataCmd.Flags().StringVarP( + exportDataCmd.Flags().StringVarP( &destination, cliflags.ExportDestination.Name, cliflags.ExportDestination.Shorthand, "", /*value*/ cliflags.ExportDestination.Usage()) - loadShowDataCmd.Flags().StringVarP( + exportDataCmd.Flags().StringVarP( &format, cliflags.ExportTableFormat.Name, cliflags.ExportTableFormat.Shorthand, "csv", /*value*/ cliflags.ExportTableFormat.Usage()) - loadShowDataCmd.Flags().StringVarP( + exportDataCmd.Flags().StringVarP( &nullas, cliflags.ExportCSVNullas.Name, cliflags.ExportCSVNullas.Shorthand, "null", /*value*/ cliflags.ExportCSVNullas.Usage()) - cli.AddCmd(loadCmds) - loadCmds.AddCommand(loadShowCmds) + cli.DebugCmd.AddCommand(backupCmds) - loadShowSubCmds := []*cobra.Command{ - loadShowSummaryCmd, - loadShowBackupsCmd, - loadShowIncrementalCmd, - loadShowDataCmd, + backupSubCmds := []*cobra.Command{ + showCmd, + listBackupsCmd, + listIncrementalCmd, + exportDataCmd, } - for _, cmd := range loadShowSubCmds { - loadShowCmds.AddCommand(cmd) - cmd.Flags().AddFlagSet(loadFlags) + for _, cmd := range backupSubCmds { + backupCmds.AddCommand(cmd) + cmd.Flags().AddFlagSet(backupFlags) } } @@ -198,7 +195,7 @@ func getManifestFromURI(ctx context.Context, path string) (backupccl.BackupManif return backupManifest, nil } -func runLoadShowSummary(cmd *cobra.Command, args []string) error { +func runShowCmd(cmd *cobra.Command, args []string) error { path := args[0] ctx := context.Background() @@ -217,7 +214,7 @@ func runLoadShowSummary(cmd *cobra.Command, args []string) error { return nil } -func runLoadShowBackups(cmd *cobra.Command, args []string) error { +func runListBackupsCmd(cmd *cobra.Command, args []string) error { path := args[0] if !strings.Contains(path, "://") { @@ -235,18 +232,17 @@ func runLoadShowBackups(cmd *cobra.Command, args []string) error { return errors.Wrapf(err, "list full backups in collection") } - if len(backupPaths) == 0 { - fmt.Println("no backups found.") - } - + cols := []string{"path"} + rows := make([][]string, 0) for _, backupPath := range backupPaths { - fmt.Println("./" + backupPath) + newRow := []string{"./" + backupPath} + rows = append(rows, newRow) } - - return nil + rowSliceIter := cli.NewRowSliceIter(rows, "l" /*align*/) + return cli.PrintQueryOutput(os.Stdout, cols, rowSliceIter) } -func runLoadShowIncremental(cmd *cobra.Command, args []string) error { +func runListIncrementalCmd(cmd *cobra.Command, args []string) error { path := args[0] if !strings.Contains(path, "://") { @@ -270,12 +266,12 @@ func runLoadShowIncremental(cmd *cobra.Command, args []string) error { return err } - w := tabwriter.NewWriter(os.Stdout, 28 /*minwidth*/, 1 /*tabwidth*/, 2 /*padding*/, ' ' /*padchar*/, 0 /*flags*/) basepath := uri.Path manifestPaths := append([]string{""}, incPaths...) stores := make([]cloud.ExternalStorage, len(manifestPaths)) stores[0] = store + rows := make([][]string, 0) for i := range manifestPaths { if i > 0 { @@ -296,19 +292,21 @@ func runLoadShowIncremental(cmd *cobra.Command, args []string) error { if i == 0 { startTime = "-" } - fmt.Fprintf(w, "%s %s %s\n", uri.Path, startTime, endTime) - } - - if err := w.Flush(); err != nil { - return err + newRow := []string{uri.Path, startTime, endTime} + rows = append(rows, newRow) } - return nil + cols := []string{"path", "start time", "end time"} + rowSliceIter := cli.NewRowSliceIter(rows, "lll" /*align*/) + return cli.PrintQueryOutput(os.Stdout, cols, rowSliceIter) } -func runLoadShowData(cmd *cobra.Command, args []string) error { +func runExportDataCmd(cmd *cobra.Command, args []string) error { - fullyQualifiedTableName := strings.ToLower(args[0]) - manifestPaths := args[1:] + if exportTableName == "" { + return errors.New("export data requires table name specified by --table flag") + } + fullyQualifiedTableName := strings.ToLower(exportTableName) + manifestPaths := args ctx := context.Background() manifests := make([]backupccl.BackupManifest, 0, len(manifestPaths)) diff --git a/pkg/ccl/cliccl/load_test.go b/pkg/ccl/cliccl/debug_backup_test.go similarity index 88% rename from pkg/ccl/cliccl/load_test.go rename to pkg/ccl/cliccl/debug_backup_test.go index d49fef6caca6..6bdf13fdefaf 100644 --- a/pkg/ccl/cliccl/load_test.go +++ b/pkg/ccl/cliccl/debug_backup_test.go @@ -14,7 +14,6 @@ import ( "fmt" "strings" "testing" - "text/tabwriter" "time" "github.com/cockroachdb/cockroach/pkg/base" @@ -31,7 +30,7 @@ import ( "github.com/stretchr/testify/require" ) -func TestLoadShowSummary(t *testing.T) { +func TestShowSummary(t *testing.T) { defer leaktest.AfterTest(t)() defer log.Scope(t).Close(t) @@ -63,7 +62,7 @@ func TestLoadShowSummary(t *testing.T) { sqlDB.Exec(t, `BACKUP DATABASE testDB TO $1 AS OF SYSTEM TIME `+ts2.AsOfSystemTime(), backupPath) t.Run("show-summary-without-types-or-tables", func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show summary %s --external-io-dir=%s", dbOnlyBackupPath, dir)) + out, err := c.RunWithCapture(fmt.Sprintf("debug backup show %s --external-io-dir=%s", dbOnlyBackupPath, dir)) require.NoError(t, err) expectedOutput := fmt.Sprintf( `{ @@ -92,7 +91,7 @@ func TestLoadShowSummary(t *testing.T) { }) t.Run("show-summary-with-full-information", func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show summary %s --external-io-dir=%s", backupPath, dir)) + out, err := c.RunWithCapture(fmt.Sprintf("debug backup show %s --external-io-dir=%s", backupPath, dir)) require.NoError(t, err) var sstFile string @@ -149,7 +148,7 @@ func TestLoadShowSummary(t *testing.T) { }) } -func TestLoadShowBackups(t *testing.T) { +func TestListBackups(t *testing.T) { defer leaktest.AfterTest(t)() defer log.Scope(t).Close(t) @@ -168,30 +167,30 @@ func TestLoadShowBackups(t *testing.T) { const backupPath = "nodelocal://0/fooFolder" ts := generateBackupTimestamps(3) - t.Run("show-backups-without-backups-in-collection", func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show backups %s --external-io-dir=%s", backupPath, dir)) - require.NoError(t, err) - expectedOutput := "no backups found.\n" - checkExpectedOutput(t, expectedOutput, out) - }) - sqlDB.Exec(t, fmt.Sprintf(`BACKUP DATABASE testDB INTO $1 AS OF SYSTEM TIME '%s'`, ts[0].AsOfSystemTime()), backupPath) sqlDB.Exec(t, fmt.Sprintf(`BACKUP DATABASE testDB INTO $1 AS OF SYSTEM TIME '%s'`, ts[1].AsOfSystemTime()), backupPath) sqlDB.Exec(t, fmt.Sprintf(`BACKUP DATABASE testDB INTO $1 AS OF SYSTEM TIME '%s'`, ts[2].AsOfSystemTime()), backupPath) t.Run("show-backups-with-backups-in-collection", func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show backups %s --external-io-dir=%s", backupPath, dir)) + out, err := c.RunWithCapture(fmt.Sprintf("debug backup list-backups %s --external-io-dir=%s", backupPath, dir)) require.NoError(t, err) - expectedOutput := fmt.Sprintf(".%s\n.%s\n.%s\n", - ts[0].GoTime().Format(backupccl.DateBasedIntoFolderName), - ts[1].GoTime().Format(backupccl.DateBasedIntoFolderName), - ts[2].GoTime().Format(backupccl.DateBasedIntoFolderName)) - checkExpectedOutput(t, expectedOutput, out) + var buf bytes.Buffer + rows := [][]string{ + {"." + ts[0].GoTime().Format(backupccl.DateBasedIntoFolderName)}, + {"." + ts[1].GoTime().Format(backupccl.DateBasedIntoFolderName)}, + {"." + ts[2].GoTime().Format(backupccl.DateBasedIntoFolderName)}, + } + cols := []string{"path"} + rowSliceIter := cli.NewRowSliceIter(rows, "l" /*align*/) + if err := cli.PrintQueryOutput(&buf, cols, rowSliceIter); err != nil { + t.Fatalf("TestListBackups: PrintQueryOutput: %v", err) + } + checkExpectedOutput(t, buf.String(), out) }) } -func TestLoadShowIncremental(t *testing.T) { +func TestListIncremental(t *testing.T) { defer leaktest.AfterTest(t)() defer log.Scope(t).Close(t) @@ -213,23 +212,26 @@ func TestLoadShowIncremental(t *testing.T) { sqlDB.Exec(t, fmt.Sprintf(`BACKUP DATABASE testDB TO $1 AS OF SYSTEM TIME '%s'`, ts[1].AsOfSystemTime()), backupPath) sqlDB.Exec(t, fmt.Sprintf(`BACKUP DATABASE testDB TO $1 AS OF SYSTEM TIME '%s'`, ts[2].AsOfSystemTime()), backupPath) - out, err := c.RunWithCapture(fmt.Sprintf("load show incremental %s --external-io-dir=%s", backupPath, dir)) + out, err := c.RunWithCapture(fmt.Sprintf("debug backup list-incremental %s --external-io-dir=%s", backupPath, dir)) require.NoError(t, err) expectedIncFolder := ts[1].GoTime().Format(backupccl.DateBasedIncFolderName) expectedIncFolder2 := ts[2].GoTime().Format(backupccl.DateBasedIncFolderName) var buf bytes.Buffer - w := tabwriter.NewWriter(&buf, 28 /*minwidth*/, 1 /*tabwidth*/, 2 /*padding*/, ' ' /*padchar*/, 0 /*flags*/) - fmt.Fprintf(w, "/fooFolder - %s\n", ts[0].GoTime().Format(time.RFC3339)) - fmt.Fprintf(w, "/fooFolder%s %s %s\n", expectedIncFolder, ts[0].GoTime().Format(time.RFC3339), ts[1].GoTime().Format(time.RFC3339)) - fmt.Fprintf(w, "/fooFolder%s %s %s\n", expectedIncFolder2, ts[1].GoTime().Format(time.RFC3339), ts[2].GoTime().Format(time.RFC3339)) - if err := w.Flush(); err != nil { - t.Fatalf("TestLoadShowIncremental: flush: %v", err) + rows := [][]string{ + {"/fooFolder", "-", ts[0].GoTime().Format(time.RFC3339)}, + {"/fooFolder" + expectedIncFolder, ts[0].GoTime().Format(time.RFC3339), ts[1].GoTime().Format(time.RFC3339)}, + {"/fooFolder" + expectedIncFolder2, ts[1].GoTime().Format(time.RFC3339), ts[2].GoTime().Format(time.RFC3339)}, + } + cols := []string{"path", "start time", "end time"} + rowSliceIter := cli.NewRowSliceIter(rows, "lll" /*align*/) + if err := cli.PrintQueryOutput(&buf, cols, rowSliceIter); err != nil { + t.Fatalf("TestListIncremental: PrintQueryOutput: %v", err) } checkExpectedOutput(t, buf.String(), out) } -func TestLoadShowData(t *testing.T) { +func TestShowData(t *testing.T) { defer leaktest.AfterTest(t)() defer log.Scope(t).Close(t) @@ -283,13 +285,18 @@ func TestLoadShowData(t *testing.T) { "testDB.testschema.fooTable", []string{backupPublicSchemaPath}, "ERROR: fetching entry: table testdb.testschema.footable not found\n", + }, { + "show-data-fail-without-table-specified", + "", + []string{backupPublicSchemaPath}, + "ERROR: export data requires table name specified by --table flag\n", }, } for _, tc := range testCasesOnError { t.Run(tc.name, func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show data %s %s --external-io-dir=%s", - tc.tableName, + out, err := c.RunWithCapture(fmt.Sprintf("debug backup export %s --table=%s --external-io-dir=%s", strings.Join(tc.backupPaths, " "), + tc.tableName, dir)) require.NoError(t, err) checkExpectedOutput(t, tc.expectedOutput, out) @@ -323,9 +330,9 @@ func TestLoadShowData(t *testing.T) { for _, tc := range testCasesDatumOutput { t.Run(tc.name, func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show data %s %s --external-io-dir=%s", - tc.tableName, + out, err := c.RunWithCapture(fmt.Sprintf("debug backup export %s --table=%s --external-io-dir=%s", strings.Join(tc.backupPaths, " "), + tc.tableName, dir)) require.NoError(t, err) checkExpectedOutput(t, tc.expectedDatums, out) @@ -333,7 +340,7 @@ func TestLoadShowData(t *testing.T) { } } -func TestLoadShowDataAOST(t *testing.T) { +func TestShowDataAOST(t *testing.T) { defer leaktest.AfterTest(t)() defer log.Scope(t).Close(t) @@ -384,9 +391,9 @@ func TestLoadShowDataAOST(t *testing.T) { t.Run("show-data-as-of-a-uncovered-timestamp", func(t *testing.T) { tsNotCovered := hlc.Timestamp{WallTime: timeutil.Now().UnixNano()} - out, err := c.RunWithCapture(fmt.Sprintf("load show data %s %s --as-of=%s --external-io-dir=%s", - "testDB.public.fooTable", + out, err := c.RunWithCapture(fmt.Sprintf("debug backup export %s --table=%s --as-of=%s --external-io-dir=%s", backupPath, + "testDB.public.fooTable", tsNotCovered.AsOfSystemTime(), dir)) require.NoError(t, err) @@ -397,15 +404,17 @@ func TestLoadShowDataAOST(t *testing.T) { }) t.Run("show-data-as-of-non-backup-ts-should-return-error", func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show data %s %s --as-of=%s --external-io-dir=%s", - "testDB.public.fooTable", + out, err := c.RunWithCapture(fmt.Sprintf("debug backup export %s --table=%s --as-of=%s --external-io-dir=%s", backupPath, + "testDB.public.fooTable", ts.AsOfSystemTime(), dir)) require.NoError(t, err) expectedError := fmt.Sprintf( - "ERROR: fetching entry: reading data for requested time requires that BACKUP was created with \"revision_history\" "+ + "ERROR: fetching entry: unknown read time: %s\n"+ + "HINT: reading data for requested time requires that BACKUP was created with \"revision_history\" "+ "or should specify the time to be an exact backup time, nearest backup time is %s\n", + timeutil.Unix(0, ts.WallTime).UTC(), timeutil.Unix(0, ts1.WallTime).UTC()) checkExpectedOutput(t, expectedError, out) }) @@ -558,9 +567,9 @@ func TestLoadShowDataAOST(t *testing.T) { for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { - out, err := c.RunWithCapture(fmt.Sprintf("load show data %s %s --as-of=%s --external-io-dir=%s ", - tc.tableName, + out, err := c.RunWithCapture(fmt.Sprintf("debug backup export %s --table=%s --as-of=%s --external-io-dir=%s ", strings.Join(tc.backupPaths, " "), + tc.tableName, tc.asof, dir)) require.NoError(t, err) diff --git a/pkg/cli/auth.go b/pkg/cli/auth.go index 682871525367..41bffa862f1e 100644 --- a/pkg/cli/auth.go +++ b/pkg/cli/auth.go @@ -66,7 +66,7 @@ func runLogin(cmd *cobra.Command, args []string) error { rows := [][]string{ {username, fmt.Sprintf("%d", id), hC}, } - if err := printQueryOutput(os.Stdout, cols, newRowSliceIter(rows, "ll")); err != nil { + if err := PrintQueryOutput(os.Stdout, cols, NewRowSliceIter(rows, "ll")); err != nil { return err } diff --git a/pkg/cli/cert.go b/pkg/cli/cert.go index fd2477a19936..2344dd1781bc 100644 --- a/pkg/cli/cert.go +++ b/pkg/cli/cert.go @@ -299,7 +299,7 @@ func runListCerts(cmd *cobra.Command, args []string) error { addRow(cert, fmt.Sprintf("user: %s", user)) } - return printQueryOutput(os.Stdout, certTableHeaders, newRowSliceIter(rows, alignment)) + return PrintQueryOutput(os.Stdout, certTableHeaders, NewRowSliceIter(rows, alignment)) } var certCmds = []*cobra.Command{ diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go index cc87aa1fb010..14d31154019d 100644 --- a/pkg/cli/cli.go +++ b/pkg/cli/cli.go @@ -309,11 +309,6 @@ func hasParentCmd(cmd, refParent *cobra.Command) bool { return hasParent } -// AddCmd adds a command to the cli. -func AddCmd(c *cobra.Command) { - cockroachCmd.AddCommand(c) -} - // Run ... func Run(args []string) error { cockroachCmd.SetArgs(args) diff --git a/pkg/cli/cli_test.go b/pkg/cli/cli_test.go index 4f8b25eb3550..106b780f663b 100644 --- a/pkg/cli/cli_test.go +++ b/pkg/cli/cli_test.go @@ -1018,7 +1018,7 @@ func TestRenderHTML(t *testing.T) { t.Run(name, func(t *testing.T) { var buf bytes.Buffer err := render(&tc.reporter, &buf, - cols, newRowSliceIter(rows, align), + cols, NewRowSliceIter(rows, align), nil /* completedHook */, nil /* noRowsHook */) if err != nil { t.Fatal(err) diff --git a/pkg/cli/cliflags/flags.go b/pkg/cli/cliflags/flags.go index 67338df08ec3..eff1b076ce80 100644 --- a/pkg/cli/cliflags/flags.go +++ b/pkg/cli/cliflags/flags.go @@ -1434,12 +1434,17 @@ exist. The interval is specified with a suffix of 's' for seconds, `, } + ExportTableTarget = FlagInfo{ + Name: "table", + Description: `Select the table to export data from.`, + } + ExportDestination = FlagInfo{ Name: "destination", Description: ` The destination to export data. -If the export format is readable and this flag left specified, -defaults to displays the exported data in the terminal output. +If the export format is readable and this flag left unspecified, +defaults to display the exported data in the terminal output. `, } diff --git a/pkg/cli/format_table.go b/pkg/cli/format_table.go index 137c6d5e5b3f..220ef0777eb9 100644 --- a/pkg/cli/format_table.go +++ b/pkg/cli/format_table.go @@ -29,7 +29,7 @@ import ( "github.com/olekukonko/tablewriter" ) -// rowStrIter is an iterator interface for the printQueryOutput function. It is +// rowStrIter is an iterator interface for the PrintQueryOutput function. It is // used so that results can be streamed to the row formatters as they arrive // to the CLI. type rowStrIter interface { @@ -38,16 +38,17 @@ type rowStrIter interface { Align() []int } -// rowSliceIter is an implementation of the rowStrIter interface and it is used +// RowSliceIter is an implementation of the rowStrIter interface and it is used // to wrap a slice of rows that have already been completely buffered into // memory. -type rowSliceIter struct { +type RowSliceIter struct { allRows [][]string index int align []int } -func (iter *rowSliceIter) Next() (row []string, err error) { +// Next returns next row of RowSliceIter. +func (iter *RowSliceIter) Next() (row []string, err error) { if iter.index >= len(iter.allRows) { return nil, io.EOF } @@ -56,11 +57,13 @@ func (iter *rowSliceIter) Next() (row []string, err error) { return row, nil } -func (iter *rowSliceIter) ToSlice() ([][]string, error) { +// ToSlice returns all rows of RowSliceIter. +func (iter *RowSliceIter) ToSlice() ([][]string, error) { return iter.allRows, nil } -func (iter *rowSliceIter) Align() []int { +// Align returns alignment setting of RowSliceIter. +func (iter *RowSliceIter) Align() []int { return iter.align } @@ -81,11 +84,11 @@ func convertAlign(align string) []int { return result } -// newRowSliceIter is an implementation of the rowStrIter interface and it is +// NewRowSliceIter is an implementation of the rowStrIter interface and it is // used when the rows have not been buffered into memory yet and we want to // stream them to the row formatters as they arrive over the network. -func newRowSliceIter(allRows [][]string, align string) *rowSliceIter { - return &rowSliceIter{ +func NewRowSliceIter(allRows [][]string, align string) *RowSliceIter { + return &RowSliceIter{ allRows: allRows, index: 0, align: convertAlign(align), @@ -639,9 +642,9 @@ func makeReporter(w io.Writer) (rowReporter, func(), error) { } } -// printQueryOutput takes a list of column names and a list of row +// PrintQueryOutput takes a list of column names and a list of row // contents writes a formatted table to 'w'. -func printQueryOutput(w io.Writer, cols []string, allRows rowStrIter) error { +func PrintQueryOutput(w io.Writer, cols []string, allRows rowStrIter) error { reporter, cleanup, err := makeReporter(w) if err != nil { return err diff --git a/pkg/cli/gen.go b/pkg/cli/gen.go index 295c1ef76b5a..22055c5c0b93 100644 --- a/pkg/cli/gen.go +++ b/pkg/cli/gen.go @@ -253,7 +253,7 @@ Output the list of cluster settings known to this binary. } cols := []string{"Setting", "Type", "Default", "Description"} return render(reporter, os.Stdout, - cols, newRowSliceIter(rows, "dddd"), nil /* completedHook */, nil /* noRowsHook*/) + cols, NewRowSliceIter(rows, "dddd"), nil /* completedHook */, nil /* noRowsHook*/) }, } diff --git a/pkg/cli/node.go b/pkg/cli/node.go index 1eb6ba9dfb8b..5c57a1a4b07a 100644 --- a/pkg/cli/node.go +++ b/pkg/cli/node.go @@ -74,7 +74,7 @@ func runLsNodes(cmd *cobra.Command, args []string) error { return err } - return printQueryOutput(os.Stdout, lsNodesColumnHeaders, newRowSliceIter(rows, "r")) + return PrintQueryOutput(os.Stdout, lsNodesColumnHeaders, NewRowSliceIter(rows, "r")) } var baseNodeColumnHeaders = []string{ @@ -129,8 +129,8 @@ func runStatusNode(cmd *cobra.Command, args []string) error { return err } - sliceIter := newRowSliceIter(rows, getStatusNodeAlignment()) - return printQueryOutput(os.Stdout, getStatusNodeHeaders(), sliceIter) + sliceIter := NewRowSliceIter(rows, getStatusNodeAlignment()) + return PrintQueryOutput(os.Stdout, getStatusNodeHeaders(), sliceIter) } func runStatusNodeInner(showDecommissioned bool, args []string) ([]string, [][]string, error) { @@ -528,8 +528,8 @@ signaling the affected nodes to participate in the cluster again. } func printDecommissionStatus(resp serverpb.DecommissionStatusResponse) error { - return printQueryOutput(os.Stdout, decommissionNodesColumnHeaders, - newRowSliceIter(decommissionResponseValueToRows(resp.Status), decommissionResponseAlignment())) + return PrintQueryOutput(os.Stdout, decommissionNodesColumnHeaders, + NewRowSliceIter(decommissionResponseValueToRows(resp.Status), decommissionResponseAlignment())) } func runRecommissionNode(cmd *cobra.Command, args []string) error { diff --git a/pkg/cli/sql.go b/pkg/cli/sql.go index 0606ee47b8d1..cfc8bba48116 100644 --- a/pkg/cli/sql.go +++ b/pkg/cli/sql.go @@ -448,9 +448,9 @@ func (c *cliState) handleSet(args []string, nextState, errState cliStateEnum) cl } optData = append(optData, []string{n, options[n].display(), options[n].description}) } - err := printQueryOutput(os.Stdout, + err := PrintQueryOutput(os.Stdout, []string{"Option", "Value", "Description"}, - newRowSliceIter(optData, "lll" /*align*/)) + NewRowSliceIter(optData, "lll" /*align*/)) if err != nil { panic(err) }