Merge cockroachdb#43099

43099: docs: fix diagrams for 'table_name @ index_name' syntax r=rafiss a=rafiss Previously, some of the syntax diagrams would indicate that table_name was required, and index_name was optional. However, the opposite is true. part of cockroachdb/docs#5948 Release note: None Co-authored-by: Rafi Shamim <[email protected]>
spaskob · Dec 12, 2019 · 1c54631 · 1c54631
2 parents e81faed + e4b29c7
commit 1c54631
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 24 deletions.
diff --git a/docs/generated/sql/bnf/alter_index_partition_by.bnf b/docs/generated/sql/bnf/alter_index_partition_by.bnf
@@ -2,6 +2,12 @@ alter_oneindex_stmt ::=
 	'ALTER' 'INDEX' table_name '@' index_name 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
 	| 'ALTER' 'INDEX' table_name '@' index_name 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
 	| 'ALTER' 'INDEX' table_name '@' index_name 'PARTITION' 'BY' 'NOTHING' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' index_name 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' index_name 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' index_name 'PARTITION' 'BY' 'NOTHING' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
 	| 'ALTER' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
 	| 'ALTER' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
 	| 'ALTER' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'PARTITION' 'BY' 'NOTHING' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' 'IF' 'EXISTS' index_name 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' 'IF' 'EXISTS' index_name 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
+	| 'ALTER' 'INDEX' 'IF' 'EXISTS' index_name 'PARTITION' 'BY' 'NOTHING' ( ( ',' ( ( 'PARTITION' 'BY' 'LIST' '(' name_list ')' '(' list_partitions ')' | 'PARTITION' 'BY' 'RANGE' '(' name_list ')' '(' range_partitions ')' | 'PARTITION' 'BY' 'NOTHING' ) ) ) )*
diff --git a/docs/generated/sql/bnf/drop_index.bnf b/docs/generated/sql/bnf/drop_index.bnf
@@ -2,12 +2,12 @@ drop_index_stmt ::=
 	'DROP' 'INDEX' table_name '@' index_name 'CASCADE'
 	| 'DROP' 'INDEX' table_name '@' index_name 'RESTRICT'
 	| 'DROP' 'INDEX' table_name '@' index_name 
-	| 'DROP' 'INDEX' standalone_index_name 'CASCADE'
-	| 'DROP' 'INDEX' standalone_index_name 'RESTRICT'
-	| 'DROP' 'INDEX' standalone_index_name 
+	| 'DROP' 'INDEX' index_name 'CASCADE'
+	| 'DROP' 'INDEX' index_name 'RESTRICT'
+	| 'DROP' 'INDEX' index_name 
 	| 'DROP' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'CASCADE'
 	| 'DROP' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'RESTRICT'
 	| 'DROP' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 
-	| 'DROP' 'INDEX' 'IF' 'EXISTS' standalone_index_name 'CASCADE'
-	| 'DROP' 'INDEX' 'IF' 'EXISTS' standalone_index_name 'RESTRICT'
-	| 'DROP' 'INDEX' 'IF' 'EXISTS' standalone_index_name 
+	| 'DROP' 'INDEX' 'IF' 'EXISTS' index_name 'CASCADE'
+	| 'DROP' 'INDEX' 'IF' 'EXISTS' index_name 'RESTRICT'
+	| 'DROP' 'INDEX' 'IF' 'EXISTS' index_name 
diff --git a/docs/generated/sql/bnf/rename_index.bnf b/docs/generated/sql/bnf/rename_index.bnf
@@ -1,5 +1,5 @@
 alter_rename_index_stmt ::=
 	'ALTER' 'INDEX' table_name '@' index_name 'RENAME' 'TO' index_name
-	| 'ALTER' 'INDEX' standalone_index_name 'RENAME' 'TO' index_name
+	| 'ALTER' 'INDEX' index_name 'RENAME' 'TO' index_name
 	| 'ALTER' 'INDEX' 'IF' 'EXISTS' table_name '@' index_name 'RENAME' 'TO' index_name
-	| 'ALTER' 'INDEX' 'IF' 'EXISTS' standalone_index_name 'RENAME' 'TO' index_name
+	| 'ALTER' 'INDEX' 'IF' 'EXISTS' index_name 'RENAME' 'TO' index_name
diff --git a/docs/generated/sql/bnf/split_index_at.bnf b/docs/generated/sql/bnf/split_index_at.bnf
@@ -1,5 +1,5 @@
 alter_split_index_stmt ::=
 	'ALTER' 'INDEX' table_name '@' index_name 'SPLIT' 'AT' select_stmt
-	| 'ALTER' 'INDEX' standalone_index_name 'SPLIT' 'AT' select_stmt
+	| 'ALTER' 'INDEX' index_name 'SPLIT' 'AT' select_stmt
 	| 'ALTER' 'INDEX' table_name '@' index_name 'SPLIT' 'AT' select_stmt 'WITH' 'EXPIRATION' a_expr
-	| 'ALTER' 'INDEX' standalone_index_name 'SPLIT' 'AT' select_stmt 'WITH' 'EXPIRATION' a_expr
+	| 'ALTER' 'INDEX' index_name 'SPLIT' 'AT' select_stmt 'WITH' 'EXPIRATION' a_expr
diff --git a/docs/generated/sql/bnf/unsplit_index_at.bnf b/docs/generated/sql/bnf/unsplit_index_at.bnf
@@ -1,5 +1,5 @@
 alter_unsplit_index_stmt ::=
 	'ALTER' 'INDEX' table_name '@' index_name 'UNSPLIT' 'AT' select_stmt
-	| 'ALTER' 'INDEX' standalone_index_name 'UNSPLIT' 'AT' select_stmt
+	| 'ALTER' 'INDEX' index_name 'UNSPLIT' 'AT' select_stmt
 	| 'ALTER' 'INDEX' table_name '@' index_name 'UNSPLIT' 'ALL'
-	| 'ALTER' 'INDEX' standalone_index_name 'UNSPLIT' 'ALL'
+	| 'ALTER' 'INDEX' index_name 'UNSPLIT' 'ALL'
diff --git a/pkg/cmd/docgen/diagrams.go b/pkg/cmd/docgen/diagrams.go
@@ -666,10 +666,7 @@ var specs = []stmtSpec{
 		regreplace: map[string]string{
 			regList: "",
 		},
-		replace: map[string]string{
-			"qualified_name": "table_name",
-		},
-		unlink: []string{"table_name", "index_name"},
+		replace: map[string]string{"standalone_index_name": "index_name"},
 	},
 	{
 		name:    "drop_role_stmt",
@@ -723,8 +720,8 @@ var specs = []stmtSpec{
 	{
 		name:    "alter_index_partition_by",
 		stmt:    "alter_oneindex_stmt",
-		inline:  []string{"alter_index_cmds", "alter_index_cmd", "partition_by"},
-		replace: map[string]string{"table_index_name": "table_name '@' index_name"},
+		inline:  []string{"alter_index_cmds", "alter_index_cmd", "partition_by", "table_index_name"},
+		replace: map[string]string{"standalone_index_name": "index_name"},
 	},
 	{
 		name:    "create_table_partition_by",
@@ -931,8 +928,8 @@ var specs = []stmtSpec{
 		stmt:    "alter_rename_index_stmt",
 		match:   []*regexp.Regexp{regexp.MustCompile("'ALTER' 'INDEX'")},
 		inline:  []string{"table_index_name"},
-		replace: map[string]string{"qualified_name": "table_name", "'@' name": "'@' index_name"},
-		unlink:  []string{"table_name", "index_name"}},
+		replace: map[string]string{"standalone_index_name": "index_name"},
+	},
 	{
 		name:    "rename_sequence",
 		stmt:    "alter_rename_sequence_stmt",
@@ -1263,8 +1260,7 @@ var specs = []stmtSpec{
 		name:    "split_index_at",
 		stmt:    "alter_split_index_stmt",
 		inline:  []string{"table_index_name"},
-		replace: map[string]string{"qualified_name": "table_name", "'@' name": "'@' index_name"},
-		unlink:  []string{"table_name", "index_name"},
+		replace: map[string]string{"standalone_index_name": "index_name"},
 	},
 	{
 		name:   "split_table_at",
@@ -1297,8 +1293,7 @@ var specs = []stmtSpec{
 		name:    "unsplit_index_at",
 		stmt:    "alter_unsplit_index_stmt",
 		inline:  []string{"table_index_name"},
-		replace: map[string]string{"qualified_name": "table_name", "'@' name": "'@' index_name"},
-		unlink:  []string{"table_name", "index_name"},
+		replace: map[string]string{"standalone_index_name": "index_name"},
 	},
 	{
 		name:   "unsplit_table_at",