Fixes QUIET issues

Cleans up various output statements around the code base, better
matching psql's output. Corrects --quiet behavior.

Fixes #437.

Author: kenshaw

env/types.go

@@ -258,6 +258,7 @@ func init() {
 		"SHOW_HOST_INFORMATION": enableHostInformation,
 		"PAGER":                 pagerCmd,
 		"EDITOR":                editorCmd,
+		"QUIET":                 "off",
 		"ON_ERROR_STOP":         "off",
 		// prompts
 		"PROMPT1": "%S%N%m%/%R%# ",

go.mod

@@ -58,7 +58,7 @@ require (
 	github.com/uber/athenadriver v1.1.15
 	github.com/vertica/vertica-sql-go v1.3.3
 	github.com/xo/dburl v0.22.0
-	github.com/xo/tblfmt v0.12.1
+	github.com/xo/tblfmt v0.13.0
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e
 	github.com/ydb-platform/ydb-go-sdk/v3 v3.61.2
 	github.com/yookoala/realpath v1.0.0

go.sum

@@ -1039,8 +1039,8 @@ github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQ
 github.com/xo/dburl v0.22.0 h1:sO5WLm2ywMzyiLxEcLBlw5AyKvdR5hirq9U7s3fCoeM=
 github.com/xo/dburl v0.22.0/go.mod h1:B7/G9FGungw6ighV8xJNwWYQPMfn3gsi2sn5SE8Bzco=
 github.com/xo/tblfmt v0.0.0-20190609041254-28c54ec42ce8/go.mod h1:3U5kKQdIhwACye7ml3acccHmjGExY9WmUGU7rnDWgv0=
-github.com/xo/tblfmt v0.12.1 h1:kohkoLtIuuM7FiRkoYDsURPBz4viVr9wj13XUJvVSxs=
-github.com/xo/tblfmt v0.12.1/go.mod h1:AKivZTttxEXXrztqGl0dGVh4hsEOSGIfSZNbRhnKZuo=
+github.com/xo/tblfmt v0.13.0 h1:mh0ilx9rKZNoMqGwvyMpQv3MED+X6te6ZqB+BzSypck=
+github.com/xo/tblfmt v0.13.0/go.mod h1:BLPC+dRy68cgSK/mPgQRfFQ/xLg231Fyic178ybjB34=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
 github.com/xwb1989/sqlparser v0.0.0-20180606152119-120387863bf2 h1:zzrxE1FKn5ryBNl9eKOeqQ58Y/Qpo3Q9QNxKHX5uzzQ=

handler/handler.go

@@ -228,8 +228,8 @@ var helpQuitExitRE = regexp.MustCompile(fmt.Sprintf(`(?im)^(%s|%s|%s)\s*$`, text
 func (h *Handler) Run() error {
 	stdout, stderr, iactive := h.l.Stdout(), h.l.Stderr(), h.l.Interactive()
 	// display welcome info
-	if iactive {
-		// graphics logo
+	if iactive && env.Get("QUIET") == "off" {
+		// logo
 		if typ := env.TermGraphics(); typ.Available() {
 			if err := typ.Encode(stdout, text.Logo); err != nil {
 				return err
@@ -756,7 +756,7 @@ func (h *Handler) Open(ctx context.Context, params ...string) error {
 	}
 	// open connection
 	var err error
-	h.db, err = drivers.Open(ctx, h.u, h.GetOutput, h.IO().Stderr)
+	h.db, err = drivers.Open(ctx, h.u, h.GetOutput, h.l.Stderr)
 	if err != nil && !drivers.IsPasswordErr(h.u, err) {
 		defer h.Close()
 		return err
@@ -971,19 +971,20 @@ func (h *Handler) ChangePassword(user string) (string, error) {
 
 // Version prints the database version information after a successful connection.
 func (h *Handler) Version(ctx context.Context) error {
-	if env.Get("SHOW_HOST_INFORMATION") != "true" || !h.IO().Interactive() {
+	if env.Get("SHOW_HOST_INFORMATION") != "true" || !h.l.Interactive() {
 		return nil
 	}
 	if h.db == nil {
 		return text.ErrNotConnected
 	}
 	ver, err := drivers.Version(ctx, h.u, h.DB())
-	if err != nil {
+	switch {
+	case err != nil:
 		ver = fmt.Sprintf("<unknown, error: %v>", err)
+	case ver == "":
+		ver = "<unknown>"
 	}
-	if ver != "" {
-		h.Print(text.ConnInfo, h.u.Driver, ver)
-	}
+	h.Print(text.ConnInfo, h.u.Driver, ver)
 	return nil
 }
 
@@ -1030,13 +1031,13 @@ func (h *Handler) doExecSingle(ctx context.Context, w io.Writer, opt metacmd.Opt
 	}
 	if h.timing {
 		d := time.Since(start)
-		format := text.TimingDesc
+		s := text.TimingDesc
 		v := []interface{}{float64(d.Microseconds()) / 1000}
 		if d > 1*time.Second {
-			format += " (%v)"
+			s += " (%v)"
 			v = append(v, d.Round(1*time.Millisecond))
 		}
-		h.Print(format, v...)
+		fmt.Fprintln(h.l.Stdout(), fmt.Sprintf(s, v...))
 	}
 	return nil
 }
@@ -1123,7 +1124,7 @@ func (h *Handler) doQuery(ctx context.Context, w io.Writer, opt metacmd.Option,
 		}
 		if pipeName != "" {
 			if pipeName[0] == '|' {
-				pipe, cmd, err = env.Pipe(h.IO().Stdout(), h.IO().Stderr(), pipeName[1:])
+				pipe, cmd, err = env.Pipe(h.l.Stdout(), h.l.Stderr(), pipeName[1:])
 			} else {
 				pipe, err = os.OpenFile(pipeName, os.O_TRUNC|os.O_CREATE|os.O_WRONLY, 0o644)
 			}
@@ -1275,12 +1276,14 @@ func (h *Handler) doExec(ctx context.Context, w io.Writer, _ metacmd.Option, typ
 		return err
 	}
 	// print name
-	fmt.Fprint(w, typ)
-	// print count
-	if count > 0 {
-		fmt.Fprint(w, " ", count)
+	if env.Get("QUIET") == "off" {
+		fmt.Fprint(w, typ)
+		// print count
+		if count > 0 {
+			fmt.Fprint(w, " ", count)
+		}
+		fmt.Fprintln(w)
 	}
-	fmt.Fprintln(w)
 	return env.Set("ROW_COUNT", strconv.FormatInt(count, 10))
 }
 

metacmd/cmds.go

@@ -94,10 +94,11 @@ func init() {
 			Name:    "copyright",
 			Desc:    Desc{"show " + text.CommandName + " usage and distribution terms", ""},
 			Process: func(p *Params) error {
+				stdout := p.Handler.IO().Stdout()
 				if typ := env.TermGraphics(); typ.Available() {
-					typ.Encode(p.Handler.IO().Stdout(), text.Logo)
+					typ.Encode(stdout, text.Logo)
 				}
-				p.Handler.Print(text.Copyright)
+				fmt.Fprintln(stdout, text.Copyright)
 				return nil
 			},
 		},
@@ -106,11 +107,11 @@ func init() {
 			Name:    "conninfo",
 			Desc:    Desc{"display information about the current database connection", ""},
 			Process: func(p *Params) error {
+				s := text.NotConnected
 				if db, u := p.Handler.DB(), p.Handler.URL(); db != nil && u != nil {
-					p.Handler.Print(text.ConnInfo, u.Driver, u.DSN)
-				} else {
-					p.Handler.Print(text.NotConnected)
+					s = fmt.Sprintf(text.ConnInfo, u.Driver, u.DSN)
 				}
+				fmt.Fprintln(p.Handler.IO().Stdout(), s)
 				return nil
 			},
 		},
@@ -119,7 +120,7 @@ func init() {
 			Name:    "drivers",
 			Desc:    Desc{"display information about available database drivers", ""},
 			Process: func(p *Params) error {
-				out := p.Handler.IO().Stdout()
+				stdout := p.Handler.IO().Stdout()
 				available := drivers.Available()
 				names := make([]string, len(available))
 				var z int
@@ -128,7 +129,7 @@ func init() {
 					z++
 				}
 				sort.Strings(names)
-				fmt.Fprintln(out, text.AvailableDrivers)
+				fmt.Fprintln(stdout, text.AvailableDrivers)
 				for _, n := range names {
 					s := "  " + n
 					driver, aliases := dburl.SchemeDriverAndAliases(n)
@@ -140,7 +141,7 @@ func init() {
 							s += " [" + strings.Join(aliases, ", ") + "]"
 						}
 					}
-					fmt.Fprintln(out, s)
+					fmt.Fprintln(stdout, s)
 				}
 				return nil
 			},
@@ -366,7 +367,7 @@ func init() {
 			Aliases: map[string]Desc{"reset": {}},
 			Process: func(p *Params) error {
 				p.Handler.Reset(nil)
-				fmt.Fprintln(p.Handler.IO().Stdout(), text.QueryBufferReset)
+				p.Handler.Print(text.QueryBufferReset)
 				return nil
 			},
 		},
@@ -379,30 +380,32 @@ func init() {
 				"warn":  {"write string to standard error (-n for no newline)", "[-n] [STRING]"},
 			},
 			Process: func(p *Params) error {
-				nl := "\n"
-				var vals []string
 				ok, n, err := p.GetOptional(true)
 				if err != nil {
 					return err
 				}
-				if ok && n == "n" {
-					nl = ""
-				} else if ok {
+				f := fmt.Fprintln
+				var vals []string
+				switch {
+				case ok && n == "n":
+					f = fmt.Fprint
+				case ok:
 					vals = append(vals, "-"+n)
-				} else {
+				default:
 					vals = append(vals, n)
 				}
 				v, err := p.GetAll(true)
 				if err != nil {
 					return err
 				}
 				out := p.Handler.IO().Stdout()
-				if o := p.Handler.GetOutput(); p.Name == "qecho" && o != nil {
+				switch o := p.Handler.GetOutput(); {
+				case p.Name == "qecho" && o != nil:
 					out = o
-				} else if p.Name == "warn" {
+				case p.Name == "warn":
 					out = p.Handler.IO().Stderr()
 				}
-				fmt.Fprint(out, strings.Join(append(vals, v...), " ")+nl)
+				f(out, strings.Join(append(vals, v...), " "))
 				return nil
 			},
 		},
@@ -521,9 +524,7 @@ func init() {
 			Desc:    Desc{"send all query results to file or |pipe", "[FILE]"},
 			Aliases: map[string]Desc{"out": {}},
 			Process: func(p *Params) error {
-				if p.Handler.GetOutput() != nil {
-					p.Handler.SetOutput(nil)
-				}
+				p.Handler.SetOutput(nil)
 				params, err := p.GetAll(true)
 				if err != nil {
 					return err