planner,executor,variable: warn and deprecate analyze v1 usage

Author: 0xPoe

pkg/executor/test/analyzetest/analyze_test.go

@@ -544,6 +544,21 @@ func TestAnalyzeIndex(t *testing.T) {
 	require.Greater(t, len(tk.MustQuery("show stats_buckets where table_name = 't1' and column_name = 'k' and is_index = 1").Rows()), 1)
 }
 
+func TestAnalyzeV1DeprecationWarning(t *testing.T) {
+	store := testkit.CreateMockStore(t)
+
+	tk := testkit.NewTestKit(t, store)
+	tk.MustExec("use test")
+	tk.MustExec("drop table if exists t")
+	tk.MustExec("create table t (a int, index idx(a))")
+	tk.MustExec("insert into t values (1), (2), (3)")
+	tk.MustExec("set @@tidb_analyze_version=1")
+	tk.MustExec("analyze table t")
+	tk.MustQuery("show warnings").Check(testkit.Rows(
+		"Warning 1681 ANALYZE with tidb_analyze_version=1 is deprecated and will be removed in a future release.",
+	))
+}
+
 func TestIssue20874(t *testing.T) {
 	store := testkit.CreateMockStore(t)
 
@@ -2598,10 +2613,9 @@ PARTITION BY RANGE ( a ) (
 
 	// analyze partition with index and with options are allowed under dynamic V1
 	tk.MustExec("analyze table t partition p0 with 1 topn, 3 buckets")
-	rows := tk.MustQuery("show warnings").Rows()
-	require.Len(t, rows, 0)
+	tk.MustQuery("show warnings").Check(testkit.Rows("Warning 1681 ANALYZE with tidb_analyze_version=1 is deprecated and will be removed in a future release."))
 	tk.MustExec("analyze table t partition p1 with 1 topn, 3 buckets")
-	tk.MustQuery("show warnings").Sort().Check(testkit.Rows())
+	tk.MustQuery("show warnings").Check(testkit.Rows("Warning 1681 ANALYZE with tidb_analyze_version=1 is deprecated and will be removed in a future release."))
 	tk.MustQuery("select * from t where a > 1 and b > 1 and c > 1 and d > 1")
 	require.NoError(t, h.LoadNeededHistograms(dom.InfoSchema()))
 	tbl := h.GetPhysicalTableStats(tableInfo.ID, tableInfo)
@@ -2610,7 +2624,7 @@ PARTITION BY RANGE ( a ) (
 	require.Equal(t, 3, len(tbl.GetCol(tableInfo.Columns[3].ID).Buckets))
 
 	tk.MustExec("analyze table t partition p1 index idx with 1 topn, 2 buckets")
-	tk.MustQuery("show warnings").Sort().Check(testkit.Rows())
+	tk.MustQuery("show warnings").Check(testkit.Rows("Warning 1681 ANALYZE with tidb_analyze_version=1 is deprecated and will be removed in a future release."))
 	tbl = h.GetPhysicalTableStats(tableInfo.ID, tableInfo)
 	require.Greater(t, tbl.Version, lastVersion)
 	require.Equal(t, 2, len(tbl.GetIdx(tableInfo.Indices[0].ID).Buckets))

pkg/planner/core/planbuilder.go

@@ -2911,8 +2911,15 @@ func pickColumnList(astColChoice pmodel.ColumnChoice, astColList []*model.Column
 	return tblSavedColChoice, tblSavedColList
 }
 
+func appendAnalyzeV1DeprecationWarning(sctx base.PlanContext, version int) {
+	if version == statistics.Version1 {
+		sctx.GetSessionVars().StmtCtx.AppendWarning(variable.ErrWarnDeprecatedSyntaxSimpleMsg.FastGenByArgs("ANALYZE with tidb_analyze_version=1"))
+	}
+}
+
 // buildAnalyzeTable constructs analyze tasks for each table.
 func (b *PlanBuilder) buildAnalyzeTable(as *ast.AnalyzeTableStmt, opts map[ast.AnalyzeOptionType]uint64, version int) (base.Plan, error) {
+	appendAnalyzeV1DeprecationWarning(b.ctx, version)
 	p := &Analyze{Opts: opts}
 	p.OptionsMap = make(map[int64]V2AnalyzeOptions)
 	usePersistedOptions := variable.PersistAnalyzeOptions.Load()
@@ -3008,6 +3015,7 @@ func (b *PlanBuilder) buildAnalyzeIndex(as *ast.AnalyzeTableStmt, opts map[ast.A
 	if !versionIsSame {
 		b.ctx.GetSessionVars().StmtCtx.AppendWarning(errors.NewNoStackError("The analyze version from the session is not compatible with the existing statistics of the table. Use the existing version instead"))
 	}
+	appendAnalyzeV1DeprecationWarning(b.ctx, version)
 	if version == statistics.Version2 {
 		return b.buildAnalyzeTable(as, opts, version)
 	}
@@ -3064,6 +3072,7 @@ func (b *PlanBuilder) buildAnalyzeAllIndex(as *ast.AnalyzeTableStmt, opts map[as
 	if !versionIsSame {
 		b.ctx.GetSessionVars().StmtCtx.AppendWarning(errors.NewNoStackErrorf("The analyze version from the session is not compatible with the existing statistics of the table. Use the existing version instead"))
 	}
+	appendAnalyzeV1DeprecationWarning(b.ctx, version)
 	if version == statistics.Version2 {
 		return b.buildAnalyzeTable(as, opts, version)
 	}

pkg/sessionctx/variable/sysvar.go

@@ -2537,10 +2537,17 @@ var defaultSysVars = []*SysVar{
 		s.GuaranteeLinearizability = TiDBOptOn(val)
 		return nil
 	}},
-	{Scope: ScopeGlobal | ScopeSession, Name: TiDBAnalyzeVersion, Value: strconv.Itoa(DefTiDBAnalyzeVersion), Type: TypeInt, MinValue: 1, MaxValue: 2, SetSession: func(s *SessionVars, val string) error {
-		s.AnalyzeVersion = tidbOptPositiveInt32(val, DefTiDBAnalyzeVersion)
-		return nil
-	}},
+	{Scope: ScopeGlobal | ScopeSession, Name: TiDBAnalyzeVersion, Value: strconv.Itoa(DefTiDBAnalyzeVersion), Type: TypeInt, MinValue: 1, MaxValue: 2,
+		Validation: func(vars *SessionVars, normalizedValue string, originalValue string, scope ScopeFlag) (string, error) {
+			if normalizedValue == "1" {
+				vars.StmtCtx.AppendWarning(errWarnDeprecatedSyntax.FastGenByArgs("tidb_analyze_version=1", "tidb_analyze_version=2"))
+			}
+			return normalizedValue, nil
+		},
+		SetSession: func(s *SessionVars, val string) error {
+			s.AnalyzeVersion = tidbOptPositiveInt32(val, DefTiDBAnalyzeVersion)
+			return nil
+		}},
 	{Scope: ScopeGlobal | ScopeSession, Name: TiDBHashJoinVersion, Value: DefTiDBHashJoinVersion, Type: TypeStr,
 		Validation: func(_ *SessionVars, normalizedValue string, originalValue string, _ ScopeFlag) (string, error) {
 			lowerValue := strings.ToLower(normalizedValue)

pkg/sessionctx/variable/varsutil_test.go

@@ -421,9 +421,18 @@ func TestVarsutil(t *testing.T) {
 	v.StmtCtx.TruncateWarnings(0)
 	require.Len(t, v.StmtCtx.GetWarnings(), 0)
 
+	err = v.SetSystemVar(TiDBAnalyzeVersion, "1")
+	require.NoError(t, err)
+	warn := v.StmtCtx.GetWarnings()[0]
+	require.Error(t, warn.Err)
+	require.Equal(t, "[variable:1287]'tidb_analyze_version=1' is deprecated and will be removed in a future release. Please use tidb_analyze_version=2 instead", warn.Err.Error())
+
+	v.StmtCtx.TruncateWarnings(0)
+	require.Len(t, v.StmtCtx.GetWarnings(), 0)
+
 	err = v.SetSystemVar(TiDBAnalyzeVersion, "4")
 	require.NoError(t, err) // converts to max value
-	warn := v.StmtCtx.GetWarnings()[0]
+	warn = v.StmtCtx.GetWarnings()[0]
 	require.Error(t, warn.Err)
 	require.Contains(t, warn.Err.Error(), "Truncated incorrect tidb_analyze_version value")