cherry pick pingcap#15583 to release-3.1

Signed-off-by: sre-bot <sre-bot@pingcap.com>
sre-bot · Mar 30, 2020 · 72c1f41 · 72c1f41
1 parent c85d8d7
commit 72c1f41
Show file tree

Hide file tree

Showing 4 changed files with 187 additions and 2 deletions.
diff --git a/planner/core/integration_test.go b/planner/core/integration_test.go
@@ -532,3 +532,35 @@ func (s *testIntegrationSuite) TestIssue15546(c *C) {
 	tk.MustExec("create definer='root'@'localhost' view vt(a1, b1) as select a1, b1 from t")
 	tk.MustQuery("select * from pt, vt where a2 = a1").Check(testkit.Rows("1 1 1 1"))
 }
+
+func (s *testIntegrationSuite) TestHintWithoutTableWarning(c *C) {
+	tk := testkit.NewTestKit(c, s.store)
+	tk.MustExec("use test")
+	tk.MustExec("drop table if exists t1, t2")
+	tk.MustExec("create table t1(a int, b int, c int, key a(a))")
+	tk.MustExec("create table t2(a int, b int, c int, key a(a))")
+	var input []string
+	var output []struct {
+		SQL      string
+		Warnings []string
+	}
+	s.testData.GetTestCases(c, &input, &output)
+	for i, tt := range input {
+		s.testData.OnRecord(func() {
+			output[i].SQL = tt
+			tk.MustQuery(tt)
+			warns := tk.Se.GetSessionVars().StmtCtx.GetWarnings()
+			output[i].Warnings = make([]string, len(warns))
+			for j := range warns {
+				output[i].Warnings[j] = warns[j].Err.Error()
+			}
+		})
+		tk.MustQuery(tt)
+		warns := tk.Se.GetSessionVars().StmtCtx.GetWarnings()
+		c.Assert(len(warns), Equals, len(output[i].Warnings))
+		for j := range warns {
+			c.Assert(warns[j].Level, Equals, stmtctx.WarnLevelWarning)
+			c.Assert(warns[j].Err.Error(), Equals, output[i].Warnings[j])
+		}
+	}
+}
diff --git a/planner/core/logical_plan_builder.go b/planner/core/logical_plan_builder.go
@@ -2021,7 +2021,21 @@ func (b *PlanBuilder) unfoldWildStar(p LogicalPlan, selectFields []*ast.SelectFi
 	return resultList, nil
 }
 
+<<<<<<< HEAD
 func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType nodeType, currentLevel int) bool {
+=======
+func (b *PlanBuilder) pushHintWithoutTableWarning(hint *ast.TableOptimizerHint) {
+	var sb strings.Builder
+	ctx := format.NewRestoreCtx(0, &sb)
+	if err := hint.Restore(ctx); err != nil {
+		return
+	}
+	errMsg := fmt.Sprintf("Hint %s is inapplicable. Please specify the table names in the arguments.", sb.String())
+	b.ctx.GetSessionVars().StmtCtx.AppendWarning(ErrInternal.GenWithStack(errMsg))
+}
+
+func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType nodeType, currentLevel int) {
+>>>>>>> 5067639... planner: add warning when join hint has no arguments (#15583)
 	hints = b.hintProcessor.getCurrentStmtHints(hints, nodeType, currentLevel)
 	var (
 		sortMergeTables, INLJTables, hashJoinTables []hintTableInfo
@@ -2030,6 +2044,16 @@ func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType n
 		aggHints                                    aggHintInfo
 	)
 	for _, hint := range hints {
+		// Set warning for the hint that requires the table name.
+		switch hint.HintName.L {
+		case TiDBMergeJoin, HintSMJ, TiDBIndexNestedLoopJoin, HintINLJ, HintINLHJ, HintINLMJ,
+			TiDBHashJoin, HintHJ, HintUseIndex, HintIgnoreIndex, HintIndexMerge:
+			if len(hint.Tables) == 0 {
+				b.pushHintWithoutTableWarning(hint)
+				continue
+			}
+		}
+
 		switch hint.HintName.L {
 		case TiDBMergeJoin, HintSMJ:
 			sortMergeTables = append(sortMergeTables, tableNames2HintTableInfo(hint.Tables)...)
@@ -2044,6 +2068,7 @@ func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType n
 		case HintAggToCop:
 			aggHints.preferAggToCop = true
 		case HintUseIndex:
+<<<<<<< HEAD
 			if len(hint.Tables) != 0 {
 				indexHintList = append(indexHintList, indexHintInfo{
 					tblName: hint.Tables[0].TableName,
@@ -2053,8 +2078,23 @@ func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType n
 						HintScope:  ast.HintForScan,
 					},
 				})
-			}
+=======
+			dbName := hint.Tables[0].DBName
+			if dbName.L == "" {
+				dbName = model.NewCIStr(b.ctx.GetSessionVars().CurrentDB)
+>>>>>>> 5067639... planner: add warning when join hint has no arguments (#15583)
+			}
+			indexHintList = append(indexHintList, indexHintInfo{
+				dbName:  dbName,
+				tblName: hint.Tables[0].TableName,
+				indexHint: &ast.IndexHint{
+					IndexNames: hint.Indexes,
+					HintType:   ast.HintUse,
+					HintScope:  ast.HintForScan,
+				},
+			})
 		case HintIgnoreIndex:
+<<<<<<< HEAD
 			if len(hint.Tables) != 0 {
 				indexHintList = append(indexHintList, indexHintInfo{
 					tblName: hint.Tables[0].TableName,
@@ -2064,14 +2104,47 @@ func (b *PlanBuilder) pushTableHints(hints []*ast.TableOptimizerHint, nodeType n
 						HintScope:  ast.HintForScan,
 					},
 				})
-			}
+=======
+			dbName := hint.Tables[0].DBName
+			if dbName.L == "" {
+				dbName = model.NewCIStr(b.ctx.GetSessionVars().CurrentDB)
+>>>>>>> 5067639... planner: add warning when join hint has no arguments (#15583)
+			}
+			indexHintList = append(indexHintList, indexHintInfo{
+				dbName:  dbName,
+				tblName: hint.Tables[0].TableName,
+				indexHint: &ast.IndexHint{
+					IndexNames: hint.Indexes,
+					HintType:   ast.HintIgnore,
+					HintScope:  ast.HintForScan,
+				},
+			})
 		case HintReadFromStorage:
 			if hint.StoreType.L == HintTiFlash {
 				tiflashTables = tableNames2HintTableInfo(hint.Tables)
 			}
+<<<<<<< HEAD
 			if hint.StoreType.L == HintTiKV {
 				tikvTables = tableNames2HintTableInfo(hint.Tables)
 			}
+=======
+		case HintIndexMerge:
+			dbName := hint.Tables[0].DBName
+			if dbName.L == "" {
+				dbName = model.NewCIStr(b.ctx.GetSessionVars().CurrentDB)
+			}
+			indexMergeHintList = append(indexMergeHintList, indexHintInfo{
+				dbName:  dbName,
+				tblName: hint.Tables[0].TableName,
+				indexHint: &ast.IndexHint{
+					IndexNames: hint.Indexes,
+					HintType:   ast.HintUse,
+					HintScope:  ast.HintForScan,
+				},
+			})
+		case HintTimeRange:
+			timeRangeHint = hint.HintData.(ast.HintTimeRange)
+>>>>>>> 5067639... planner: add warning when join hint has no arguments (#15583)
 		default:
 			// ignore hints that not implemented
 		}

diff --git a/planner/core/testdata/integration_suite_in.json b/planner/core/testdata/integration_suite_in.json
@@ -72,5 +72,20 @@
       "explain select /*+ use_index(t, idx)*/ * from t",
       "explain select /*+ use_index(t)*/ * from t"
     ]
+  },
+  {
+    "name": "TestHintWithoutTableWarning",
+    "cases": [
+      "select /*+ TIDB_SMJ() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ MERGE_JOIN() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ INL_JOIN() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ TIDB_INLJ() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ INL_HASH_JOIN() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ INL_MERGE_JOIN() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ HASH_JOIN() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ USE_INDEX() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ IGNORE_INDEX() */ * from t1, t2 where t1.a=t2.a",
+      "select /*+ USE_INDEX_MERGE() */ * from t1, t2 where t1.a=t2.a"
+    ]
   }
 ]
diff --git a/planner/core/testdata/integration_suite_out.json b/planner/core/testdata/integration_suite_out.json
@@ -286,5 +286,70 @@
         "Warn": null
       }
     ]
+  },
+  {
+    "Name": "TestHintWithoutTableWarning",
+    "Cases": [
+      {
+        "SQL": "select /*+ TIDB_SMJ() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint TIDB_SMJ() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ MERGE_JOIN() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint MERGE_JOIN() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ INL_JOIN() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint INL_JOIN() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ TIDB_INLJ() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint TIDB_INLJ() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ INL_HASH_JOIN() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint INL_HASH_JOIN() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ INL_MERGE_JOIN() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint INL_MERGE_JOIN() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ HASH_JOIN() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[planner:1815]Hint HASH_JOIN() is inapplicable. Please specify the table names in the arguments."
+        ]
+      },
+      {
+        "SQL": "select /*+ USE_INDEX() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[parser:1064]You have an error in your SQL syntax; check the manual that corresponds to your TiDB version for the right syntax to use [parser:8064]Optimizer hint syntax error at line 1 column 22 near \") */\" "
+        ]
+      },
+      {
+        "SQL": "select /*+ IGNORE_INDEX() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[parser:1064]You have an error in your SQL syntax; check the manual that corresponds to your TiDB version for the right syntax to use [parser:8064]Optimizer hint syntax error at line 1 column 25 near \") */\" "
+        ]
+      },
+      {
+        "SQL": "select /*+ USE_INDEX_MERGE() */ * from t1, t2 where t1.a=t2.a",
+        "Warnings": [
+          "[parser:1064]You have an error in your SQL syntax; check the manual that corresponds to your TiDB version for the right syntax to use [parser:8064]Optimizer hint syntax error at line 1 column 28 near \") */\" "
+        ]
+      }
+    ]
   }
 ]