sq/cli/cmd_scratch.go

package cli

import (
	"github.com/spf13/cobra"

	"github.com/neilotoole/sq/cli/run"
	"github.com/neilotoole/sq/libsq/source"
	"github.com/neilotoole/sq/libsq/source/drivertype"
)

// TODO: dump all this "internal" stuff: make the options as follows: @HANDLE, file, memory

func newScratchCmd() *cobra.Command {
	cmd := &cobra.Command{
		Use: "scratch [@HANDLE|internal|internal:file|internal:mem|@scratch]",
		// This command is likely to be ditched in favor of a generalized "config" cmd
		// such as "sq config scratchdb=@my1"
		Hidden: true,
		Args:   cobra.ExactArgs(1),
		RunE:   execScratch,
		Example: `   # get scratch data source
   $ sq scratch
   # set @my1 as scratch data source
   $ sq scratch @my1
   # use the default embedded db
   $ sq scratch internal
   # explicitly specify use of embedded file db
   $ sq scratch internal:file
   # explicitly specify use of embedded memory db
   $ sq scratch internal:mem
   # restore default scratch db (equivalent to "internal")
   $ sq scratch @scratch`,
		Short: "Get or set scratch data source",
		Long: `Get or set scratch data source. The scratch db is used internally by sq for multiple purposes such as
importing non-SQL data, or cross-database joins. If no argument provided, get the current scratch data
source. Otherwise, set @HANDLE or an internal db as the scratch data source. The reserved handle "@scratch" resets the
`,
	}
	markCmdRequiresConfigLock(cmd)

	return cmd
}

func execScratch(cmd *cobra.Command, args []string) error {
	ru := run.FromContext(cmd.Context())
	cfg := ru.Config

	var src *source.Source
	var err error
	defaultScratch := &source.Source{
		Handle:   source.ScratchHandle,
		Location: "internal:file",
		Type:     drivertype.SQLite,
	}

	if len(args) == 0 {
		// Print the scratch src
		src = cfg.Collection.Scratch()
		if src == nil {
			src = defaultScratch
		}

		return ru.Writers.Source.Source(cfg.Collection, src)
	}

	// Set the scratch src
	switch args[0] {
	case "internal", "internal:file", "internal:mem":
		// TODO: currently only supports file sqlite3 db, fairly trivial to do mem as well
		_, _ = cfg.Collection.SetScratch("")
		src = defaultScratch
	default:
		src, err = cfg.Collection.SetScratch(args[0])
		if err != nil {
			return err
		}
	}

	err = ru.ConfigStore.Save(cmd.Context(), ru.Config)
	if err != nil {
		return err
	}

	return ru.Writers.Source.Source(cfg.Collection, src)
}