mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-09-07 17:15:56 +00:00
c681642734
Cobra automatically displays usage messages, and also a gratuitous "Error: [...]" line in some cases, when any error at all occurs running a command. To suppress the usage message, you have to set cmd.SilenceUsage to true. But the code that would do this doesn't have access to it. To address this, we introduce a category of "usage error", implemented with stdlib error wrapping (%w) and use errors.Is to check for it. There's also utility functions to do this checking automatically, or indeed, to handle wrapping of the ctl.SomethingCommand and handle running it with a suitable context and everything. In fact, several of the places we're checking for usage errors, we can never actually report one, but we're checking consistently so that if we want to report usage errors, we can. For instance, server.Start and (dax)server.Start don't ever return usage errors, right now, but we're checking their responses anyway.
35 lines
1.7 KiB
Go
35 lines
1.7 KiB
Go
// Copyright 2021 Molecula Corp. All rights reserved.
|
|
package cmd
|
|
|
|
import (
|
|
"io"
|
|
|
|
"github.com/molecula/featurebase/v3/ctl"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func newBackupCommand(stdin io.Reader, stdout io.Writer, stderr io.Writer) *cobra.Command {
|
|
cmd := ctl.NewBackupCommand(stdin, stdout, stderr)
|
|
ccmd := &cobra.Command{
|
|
Use: "backup",
|
|
Short: "Back up FeatureBase server",
|
|
Long: `
|
|
Backs up a FeatureBase server to a local, tar-formatted snapshot file.
|
|
`,
|
|
RunE: usageErrorWrapper(cmd),
|
|
}
|
|
|
|
flags := ccmd.Flags()
|
|
flags.StringVarP(&cmd.OutputDir, "output", "o", "", "Output directory to write to.")
|
|
flags.BoolVar(&cmd.NoSync, "no-sync", false, "Disable file sync")
|
|
flags.IntVar(&cmd.Concurrency, "concurrency", cmd.Concurrency, "Number of concurrent backup goroutines.")
|
|
flags.StringVar(&cmd.Host, "host", "localhost:10101", "The address (host:port) of FeatureBase (HTTP).")
|
|
flags.StringVar(&cmd.Index, "index", "", "Index to backup, default backs up all indexes. ")
|
|
flags.DurationVar(&cmd.RetryPeriod, "retry-period", cmd.RetryPeriod, "Length of time after HTTP request failure to continue retrying request.")
|
|
flags.StringVar(&cmd.Pprof, "pprof", cmd.Pprof, "host:port to listen for profiling requests at /debug/pprof and /debug/fgprof.")
|
|
ctl.SetTLSConfig(flags, "", &cmd.TLS.CertificatePath, &cmd.TLS.CertificateKeyPath, &cmd.TLS.CACertPath, &cmd.TLS.SkipVerify, &cmd.TLS.EnableClientVerification)
|
|
flags.StringVar(&cmd.AuthToken, "auth-token", "", "Authentication token")
|
|
flags.StringVar(&cmd.HeaderTimeoutStr, "header-timeout", cmd.HeaderTimeoutStr, "Length of time to wait for initial HTTP response before giving up.")
|
|
flags.BoolVar(&cmd.IgnoreSpaceCheck, "ignore-space-check", false, "Disable disk space check")
|
|
return ccmd
|
|
}
|