distsql: add setting "sql.defaults.distsql"

This cluster setting replaces the environment variable. The session
variable accessible through `SET distsql = ?` is still available, and
defaults to the cluster setting upon session creation. Closes #15045.

pkg/sql/helpers_test.go

@@ -98,13 +98,3 @@ func (m *LeaseManager) ExpireLeases(clock *hlc.Clock) {
 	}
 	m.tableNames.mu.Unlock()
 }
-
-// SetDefaultDistSQLMode changes the default DistSQL mode; returns a function
-// that can be used to restore the previous mode.
-func SetDefaultDistSQLMode(mode string) func() {
-	prevMode := defaultDistSQLMode
-	defaultDistSQLMode = distSQLExecModeFromString(mode)
-	return func() {
-		defaultDistSQLMode = prevMode
-	}
-}

pkg/sql/logic_test.go

@@ -1321,9 +1321,8 @@ func (t *logicTest) success(file string) {
 	}
 }
 
-func (t *logicTest) setupAndRunFile(path string, config testClusterConfig) {
+func (t *logicTest) runFile(path string, config testClusterConfig) {
 	defer t.close()
-	t.setup(config.numNodes, config.useFakeSpanResolver)
 
 	defer func() {
 		if r := recover(); r != nil {
@@ -1438,9 +1437,15 @@ func TestLogic(t *testing.T) {
 		if len(paths) == 0 {
 			continue
 		}
+		var startupFuncs []func(lt *logicTest)
 		var cleanupFuncs []func()
 		if cfg.defaultDistSQLMode != "" {
-			cleanupFuncs = append(cleanupFuncs, sql.SetDefaultDistSQLMode(cfg.defaultDistSQLMode))
+			startupFuncs = append(startupFuncs, func(lt *logicTest) {
+				// TODO(DONOTMERGE)
+			})
+			cleanupFuncs = append(cleanupFuncs, func() {
+				// TODO(DONOTMERGE): how we run a SET CLUSTER SETTING distsql.mode = off SQL command here?
+			})
 		}
 		// Top-level test: one per test configuration.
 		t.Run(cfg.name, func(t *testing.T) {
@@ -1466,7 +1471,11 @@ func TestLogic(t *testing.T) {
 					if *printErrorSummary {
 						defer lt.printErrorSummary()
 					}
-					lt.setupAndRunFile(path, cfg)
+					lt.setup(cfg.numNodes, cfg.useFakeSpanResolver)
+					for _, startupFunc := range startupFuncs {
+						startupFunc(&lt)
+					}
+					lt.runFile(path, cfg)
 
 					progress.Lock()
 					defer progress.Unlock()

pkg/sql/session.go

@@ -20,7 +20,6 @@ package sql
 import (
 	"fmt"
 	"net"
-	"strings"
 	"time"
 
 	opentracing "github.com/opentracing/opentracing-go"
@@ -93,25 +92,19 @@ const (
 	distSQLAlways
 )
 
-func distSQLExecModeFromString(val string) distSQLExecMode {
-	switch strings.ToUpper(val) {
-	case "OFF":
-		return distSQLOff
-	case "AUTO":
-		return distSQLAuto
-	case "ON":
-		return distSQLOn
-	case "ALWAYS":
-		return distSQLAlways
-	default:
-		panic(fmt.Sprintf("unknown DistSQL mode %s", val))
-	}
+func distSQLExecModeFromInt(val int64) distSQLExecMode {
+	return distSQLExecMode(val)
 }
 
-// defaultDistSQLMode controls the default DistSQL mode (see above). It can
-// still be overridden per-session using `SET DIST_SQL = ...`.
-var defaultDistSQLMode = distSQLExecModeFromString(
-	envutil.EnvOrDefaultString("COCKROACH_DISTSQL_MODE", "OFF"),
+var distSQLClusterExecMode = settings.RegisterEnumSetting(
+	"sql.defaults.distsql",
+	"Default distributed SQL execution mode",
+	"Off",
+	map[string]int64{
+		"Off":    int64(distSQLOff),
+		"Auto":   int64(distSQLAuto),
+		"On":     int64(distSQLOn),
+	},
 )
 
 // Session contains the state of a SQL client connection.
@@ -262,9 +255,10 @@ func NewSession(
 	ctx context.Context, args SessionArgs, e *Executor, remote net.Addr, memMetrics *MemoryMetrics,
 ) *Session {
 	ctx = e.AnnotateCtx(ctx)
+
 	s := &Session{
 		Database:         args.Database,
-		DistSQLMode:      defaultDistSQLMode,
+		DistSQLMode:      distSQLExecModeFromInt(distSQLClusterExecMode.Get()),
 		SearchPath:       parser.SearchPath{"pg_catalog"},
 		Location:         time.UTC,
 		User:             args.User,

pkg/sql/vars.go

@@ -120,6 +120,8 @@ var varGen = map[string]sessionVar{
 				p.session.DistSQLMode = distSQLOff
 			case parser.ReNormalizeName("on"):
 				p.session.DistSQLMode = distSQLOn
+			case parser.ReNormalizeName("auto"):
+				p.session.DistSQLMode = distSQLAuto
 			case parser.ReNormalizeName("always"):
 				p.session.DistSQLMode = distSQLAlways
 			default:
@@ -141,7 +143,7 @@ var varGen = map[string]sessionVar{
 			return "auto"
 		},
 		Reset: func(p *planner) error {
-			p.session.DistSQLMode = defaultDistSQLMode
+			p.session.DistSQLMode = distSQLExecModeFromInt(distSQLClusterExecMode.Get())
 			return nil
 		},
 	},