db tools preliminary work; --src.schema changes (#392)

- Preliminary work on the (currently hidden) `db` cmds.
- Improvements to `--src.schema`

Author: neilotoole

.gitignore

@@ -42,7 +42,7 @@ _testmain.go
 .envrc
 **/*.bench
 go.work*
-
+*.dump.sql
 # Some apps create temp files when editing, e.g. Excel with drivers/xlsx/testdata/~$test_header.xlsx
 **/testdata/~*
 
@@ -59,3 +59,5 @@ goreleaser-test.sh
 /*.db
 /.CHANGELOG.delta.md
 /testh/progress-remove.test.sh
+
+/*.dump

CHANGELOG.md

@@ -8,6 +8,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Breaking changes are annotated with ☢️, and alpha/beta features with 🐥.
 
 
+## [v0.47.4] - UPCOMING
+
+Minor changes to the behavior of the `--src.schema` flag.
+See the earlier [`v0.47.0`](https://github.com/neilotoole/sq/releases/tag/v0.47.0)
+release for recent headline features.
+
+### Changed
+
+- The [`--src.schema`](https://sq.io/docs/source#source-override) flag (as used in [`sq inspect`](https://sq.io/docs/cmd/inspect),
+  [`sq sql`](https://sq.io/docs/cmd/sql), and the root [`sq`](https://sq.io/docs/cmd/sq#override-active-schema) cmd)
+  now accepts `--src.schema=CATALOG.` (note the `.` suffix). This is in addition to the existing allowed forms `SCHEMA`
+  and `CATALOG.SCHEMA`. This new `CATALOG.` form is effectively equivalent to `CATALOG.CURRENT_SCHEMA`.
+  
+  ```shell
+  # Inspect using the default schema in the "sales" catalog
+  $ sq inspect --src.schema=sales. 
+  ```
+
+- The [`--src.schema`](https://sq.io/docs/source#source-override) flag is now validated. Previously, if you provided a non-existing catalog or schema
+  value, `sq` would silently ignore it and use the defaults. This could mislead the user into thinking that
+  they were getting valid results from the non-existent catalog or schema. Now an error is returned.
+
+
 ## [v0.47.3] - 2024-02-03
 
 Minor bug fix release. See the earlier [`v0.47.0`](https://github.com/neilotoole/sq/releases/tag/v0.47.0)
@@ -1138,3 +1161,4 @@ make working with lots of sources much easier.
 [v0.47.1]: https://github.com/neilotoole/sq/compare/v0.47.0...v0.47.1
 [v0.47.2]: https://github.com/neilotoole/sq/compare/v0.47.1...v0.47.2
 [v0.47.3]: https://github.com/neilotoole/sq/compare/v0.47.2...v0.47.3
+[v0.47.4]: https://github.com/neilotoole/sq/compare/v0.47.3...v0.47.4

Makefile

@@ -29,11 +29,13 @@ gen:
 .PHONY: fmt
 fmt:
 	@# https://github.com/incu6us/goimports-reviser
-	@# Note that *_windows.go is excluded because the tool seems
+	@# Note that termz_windows.go is excluded because the tool seems
 	@# to mangle Go code that is guarded by build tags that
-	@# are not in use.
+	@# are not in use. Alas, we can't provide a double star glob,
+	@# e.g. **/*_windows.go, because filepath.Match doesn't support
+	@# double star, so we explicitly name the file.
 	@goimports-reviser -company-prefixes github.com/neilotoole -set-alias \
-		-excludes '**/*_windows.go' \
+		-excludes 'libsq/core/termz/termz_windows.go' \
 		-rm-unused -output write \
 		-project-name github.com/neilotoole/sq ./...
 

cli/cli.go

@@ -259,6 +259,15 @@ func newCommandTree(ru *run.Run) (rootCmd *cobra.Command) {
 	addCmd(ru, tblCmd, newTblTruncateCmd())
 	addCmd(ru, tblCmd, newTblDropCmd())
 
+	dbCmd := addCmd(ru, rootCmd, newDBCmd())
+	addCmd(ru, dbCmd, newDBExecCmd())
+	dbDumpCmd := addCmd(ru, dbCmd, newDBDumpCmd())
+	addCmd(ru, dbDumpCmd, newDBDumpCatalogCmd())
+	addCmd(ru, dbDumpCmd, newDBDumpClusterCmd())
+	dbRestoreCmd := addCmd(ru, dbCmd, newDBRestoreCmd())
+	addCmd(ru, dbRestoreCmd, newDBRestoreCatalogCmd())
+	addCmd(ru, dbRestoreCmd, newDBRestoreClusterCmd())
+
 	addCmd(ru, rootCmd, newDiffCmd())
 
 	driverCmd := addCmd(ru, rootCmd, newDriverCmd())

cli/cmd_add.go

@@ -156,7 +156,7 @@ More examples:
 		Long:  `Add data source specified by LOCATION, optionally identified by @HANDLE.`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	addTextFormatFlags(cmd)
 	cmd.Flags().BoolP(flag.JSON, flag.JSONShort, false, flag.JSONUsage)
 	cmd.Flags().BoolP(flag.Compact, flag.CompactShort, false, flag.CompactUsage)
@@ -242,7 +242,7 @@ func execSrcAdd(cmd *cobra.Command, args []string) error {
 	// or sq prompts the user.
 	if cmdFlagIsSetTrue(cmd, flag.PasswordPrompt) {
 		var passwd []byte
-		if passwd, err = readPassword(ctx, ru.Stdin, ru.Out, ru.Writers.Printing); err != nil {
+		if passwd, err = readPassword(ctx, ru.Stdin, ru.Out, ru.Writers.OutPrinting); err != nil {
 			return err
 		}
 

cli/cmd_add_test.go

@@ -141,14 +141,12 @@ func TestCmdAdd(t *testing.T) {
 			wantHandle: "@sakila",
 			wantType:   drivertype.SQLite,
 		},
-
 		{
 			// with scheme
 			loc:        proj.Abs(sakila.PathSL3),
 			wantHandle: "@sakila",
 			wantType:   drivertype.SQLite,
 		},
-
 		{
 			// without scheme, relative path
 			loc:        proj.Rel(sakila.PathSL3),

cli/cmd_cache.go

@@ -74,7 +74,7 @@ func newCacheStatCmd() *cobra.Command {
   /Users/neilotoole/Library/Caches/sq/f36ac695  enabled  (472.8MB)`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	addTextFormatFlags(cmd)
 	cmd.Flags().BoolP(flag.JSON, flag.JSONShort, false, flag.JSONUsage)
 	cmd.Flags().BoolP(flag.YAML, flag.YAMLShort, false, flag.YAMLUsage)
@@ -111,7 +111,7 @@ func newCacheClearCmd() *cobra.Command {
   $ sq cache clear @sakila`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	return cmd
 }
 
@@ -150,7 +150,7 @@ func newCacheTreeCmd() *cobra.Command {
   $ sq cache tree --size`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	_ = cmd.Flags().BoolP(flag.CacheTreeSize, flag.CacheTreeSizeShort, false, flag.CacheTreeSizeUsage)
 	return cmd
 }
@@ -163,7 +163,7 @@ func execCacheTree(cmd *cobra.Command, _ []string) error {
 	}
 
 	showSize := cmdFlagBool(cmd, flag.CacheTreeSize)
-	return ioz.PrintTree(ru.Out, cacheDir, showSize, !ru.Writers.Printing.IsMonochrome())
+	return ioz.PrintTree(ru.Out, cacheDir, showSize, !ru.Writers.OutPrinting.IsMonochrome())
 }
 
 func newCacheEnableCmd() *cobra.Command { //nolint:dupl
@@ -200,7 +200,7 @@ func newCacheEnableCmd() *cobra.Command { //nolint:dupl
   $ sq cache enable @sakila`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	return cmd
 }
 
@@ -238,6 +238,6 @@ func newCacheDisableCmd() *cobra.Command { //nolint:dupl
   $ sq cache disable @sakila`,
 	}
 
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	return cmd
 }

cli/cmd_config_edit.go

@@ -51,7 +51,7 @@ in envar $SQ_EDITOR or $EDITOR.`,
   # Use a different editor
   $ SQ_EDITOR=nano sq config edit`,
 	}
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	return cmd
 }
 
@@ -134,7 +134,7 @@ func execConfigEditSource(cmd *cobra.Command, args []string) error {
 
 	// The Catalog and Schema fields have yaml tag 'omitempty',
 	// so they wouldn't be rendered in the editor yaml if empty.
-	// However, we to render the fields commented-out if empty.
+	// However, we want to render the fields commented-out if empty.
 	// Hence this little hack.
 	if tmpSrc.Catalog == "" {
 		// Forces yaml rendering

cli/cmd_config_set.go

@@ -41,7 +41,7 @@ Use "sq config ls -v" to list available options.`,
   # Help for an individual option
   $ sq config set conn.max-open --help`,
 	}
-	markCmdRequiresConfigLock(cmd)
+	cmdMarkRequiresConfigLock(cmd)
 	addTextFormatFlags(cmd)
 	cmd.Flags().BoolP(flag.JSON, flag.JSONShort, false, flag.JSONUsage)
 	cmd.Flags().BoolP(flag.Compact, flag.CompactShort, false, flag.CompactUsage)

cli/cmd_db.go

@@ -0,0 +1,18 @@
+package cli
+
+import (
+	"github.com/spf13/cobra"
+)
+
+func newDBCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "db",
+		Short: "Useful database actions",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return cmd.Help()
+		},
+		Example: `  # TBD`,
+	}
+
+	return cmd
+}