sql: support wildcard in ALTER PARTITION OF INDEX

`ALTER PARTITION ... OF INDEX` now allows a user to specify all indexes of a table via `tbl@*` syntax. This means that every partition with the specified name across all of a table's indexes should be affected. Refers #39357 Release note (sql change): The `ALTER PARTITION` statement now supports applying a zone configuration to all the partitions of a table and its indexes that share the same partition name. The syntax for this is `ALTER PARTITION <partition name> OF INDEX <table name>@*`.
cockroachdb · Aug 26, 2019 · 12a33d7 · 12a33d7
1 parent 497167b
commit 12a33d7
Show file tree

Hide file tree

Showing 10 changed files with 390 additions and 268 deletions.
diff --git a/docs/generated/sql/bnf/alter_zone_index_stmt.bnf b/docs/generated/sql/bnf/alter_zone_index_stmt.bnf
@@ -5,9 +5,3 @@ alter_zone_index_stmt ::=
 	| 'ALTER' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
 	| 'ALTER' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
 	| 'ALTER' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'DISCARD'
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'DISCARD'
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'DISCARD'
diff --git a/docs/generated/sql/bnf/alter_zone_partition_stmt.bnf b/docs/generated/sql/bnf/alter_zone_partition_stmt.bnf
@@ -0,0 +1,13 @@
+alter_zone_partition_stmt ::=
+	'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'DISCARD'
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' index_name 'CONFIGURE' 'ZONE' 'DISCARD'
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' index_name 'CONFIGURE' 'ZONE' 'DISCARD'
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' '*' 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' '*' 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' '*' 'CONFIGURE' 'ZONE' 'DISCARD'
diff --git a/docs/generated/sql/bnf/alter_zone_table_stmt.bnf b/docs/generated/sql/bnf/alter_zone_table_stmt.bnf
@@ -2,6 +2,3 @@ alter_zone_table_stmt ::=
 	'ALTER' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
 	| 'ALTER' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
 	| 'ALTER' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'DISCARD'
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' 'COPY' 'FROM' 'PARENT' ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'USING' variable '=' value ( ( ',' variable '=' value | ',' variable '=' 'COPY' 'FROM' 'PARENT' ) )*
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name 'CONFIGURE' 'ZONE' 'DISCARD'
diff --git a/docs/generated/sql/bnf/stmt_block.bnf b/docs/generated/sql/bnf/stmt_block.bnf
@@ -280,6 +280,7 @@ alter_ddl_stmt ::=
 	| alter_sequence_stmt
 	| alter_database_stmt
 	| alter_range_stmt
+	| alter_partition_stmt
 
 alter_user_stmt ::=
 	alter_user_password_stmt
@@ -961,6 +962,9 @@ alter_database_stmt ::=
 alter_range_stmt ::=
 	alter_zone_range_stmt
 
+alter_partition_stmt ::=
+	alter_zone_partition_stmt
+
 alter_user_password_stmt ::=
 	'ALTER' 'USER' string_or_placeholder 'WITH' 'PASSWORD' string_or_placeholder
 	| 'ALTER' 'USER' 'IF' 'EXISTS' string_or_placeholder 'WITH' 'PASSWORD' string_or_placeholder
@@ -1252,7 +1256,6 @@ alter_scatter_stmt ::=
 
 alter_zone_table_stmt ::=
 	'ALTER' 'TABLE' table_name set_zone_config
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name set_zone_config
 
 alter_rename_table_stmt ::=
 	'ALTER' 'TABLE' relation_expr 'RENAME' 'TO' table_name
@@ -1280,7 +1283,6 @@ alter_rename_index_stmt ::=
 
 alter_zone_index_stmt ::=
 	'ALTER' 'INDEX' table_index_name set_zone_config
-	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_index_name set_zone_config
 
 alter_rename_view_stmt ::=
 	'ALTER' 'VIEW' relation_expr 'RENAME' 'TO' view_name
@@ -1303,6 +1305,11 @@ alter_zone_database_stmt ::=
 alter_zone_range_stmt ::=
 	'ALTER' 'RANGE' zone_name set_zone_config
 
+alter_zone_partition_stmt ::=
+	'ALTER' 'PARTITION' partition_name 'OF' 'TABLE' table_name set_zone_config
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_index_name set_zone_config
+	| 'ALTER' 'PARTITION' partition_name 'OF' 'INDEX' table_name '@' '*' set_zone_config
+
 kv_option ::=
 	name '=' string_or_placeholder
 	| name

diff --git a/pkg/ccl/logictestccl/testdata/logic_test/zone b/pkg/ccl/logictestccl/testdata/logic_test/zone
@@ -566,3 +566,30 @@ ALTER PARTITION p1 OF INDEX "my database".public.show_test@primary CONFIGURE ZON
   constraints = '[+dc=dc1]';
 ALTER PARTITION p2 OF INDEX "my database".public.show_test@primary CONFIGURE ZONE USING
   constraints = '[+dc=dc2]'
+
+subtest alter_partition_across_all_indexes
+
+statement ok
+CREATE TABLE t2 (x INT PRIMARY KEY) PARTITION BY LIST (x) (
+  PARTITION p1 VALUES IN (1),
+  PARTITION p2 VALUES IN (2)
+);
+CREATE INDEX x1 ON t2 (x) PARTITION BY LIST (x) (
+  PARTITION p1 VALUES IN (1),
+  PARTITION p2 VALUES IN (2)
+);
+CREATE INDEX x2 ON t2 (x) PARTITION BY LIST (x) (
+  PARTITION p1 VALUES IN (1),
+  PARTITION p2 VALUES IN (2)
+);
+ALTER PARTITION p1 OF INDEX t2@* CONFIGURE ZONE USING num_replicas = 1
+
+query TT
+SELECT * FROM [SHOW ALL ZONE CONFIGURATIONS] WHERE target LIKE '%t2@%'
+----
+PARTITION p1 OF INDEX "my database".public.t2@primary  ALTER PARTITION p1 OF INDEX "my database".public.t2@primary CONFIGURE ZONE USING
+                                                       num_replicas = 1
+PARTITION p1 OF INDEX "my database".public.t2@x1       ALTER PARTITION p1 OF INDEX "my database".public.t2@x1 CONFIGURE ZONE USING
+                                                       num_replicas = 1
+PARTITION p1 OF INDEX "my database".public.t2@x2       ALTER PARTITION p1 OF INDEX "my database".public.t2@x2 CONFIGURE ZONE USING
+                                                       num_replicas = 1
diff --git a/pkg/cmd/docgen/diagrams.go b/pkg/cmd/docgen/diagrams.go
@@ -417,6 +417,12 @@ var specs = []stmtSpec{
 		replace: map[string]string{"var_name": "variable", "var_value": "value"},
 		unlink:  []string{"variable", "value"},
 	},
+	{
+		name:    "alter_zone_partition_stmt",
+		inline:  []string{"table_index_name", "set_zone_config", "var_set_list"},
+		replace: map[string]string{"var_name": "variable", "var_value": "value", "standalone_index_name": "index_name"},
+		unlink:  []string{"variable", "value"},
+	},
 	{
 		name:   "backup",
 		stmt:   "backup_stmt",

diff --git a/pkg/sql/parser/help_test.go b/pkg/sql/parser/help_test.go
@@ -69,6 +69,9 @@ func TestContextualHelp(t *testing.T) {
 		{`ALTER RANGE foo CONFIGURE ??`, `ALTER RANGE`},
 		{`ALTER RANGE ??`, `ALTER RANGE`},
 
+		{`ALTER PARTITION ??`, `ALTER PARTITION`},
+		{`ALTER PARTITION p OF INDEX tbl@idx ??`, `ALTER PARTITION`},
+
 		{`CANCEL ??`, `CANCEL`},
 		{`CANCEL JOB ??`, `CANCEL JOBS`},
 		{`CANCEL JOBS ??`, `CANCEL JOBS`},

diff --git a/pkg/sql/parser/sql.y b/pkg/sql/parser/sql.y
@@ -604,6 +604,7 @@ func newNameFromStr(s string) *tree.Name {
 %type <tree.Statement> alter_database_stmt
 %type <tree.Statement> alter_user_stmt
 %type <tree.Statement> alter_range_stmt
+%type <tree.Statement> alter_partition_stmt
 
 // ALTER RANGE
 %type <tree.Statement> alter_zone_range_stmt
@@ -618,6 +619,9 @@ func newNameFromStr(s string) *tree.Name {
 %type <tree.Statement> alter_relocate_lease_stmt
 %type <tree.Statement> alter_zone_table_stmt
 
+// ALTER PARTITION
+%type <tree.Statement> alter_zone_partition_stmt
+
 // ALTER DATABASE
 %type <tree.Statement> alter_rename_database_stmt
 %type <tree.Statement> alter_zone_database_stmt
@@ -1096,12 +1100,13 @@ alter_stmt:
 | ALTER error         // SHOW HELP: ALTER
 
 alter_ddl_stmt:
-  alter_table_stmt    // EXTEND WITH HELP: ALTER TABLE
-| alter_index_stmt    // EXTEND WITH HELP: ALTER INDEX
-| alter_view_stmt     // EXTEND WITH HELP: ALTER VIEW
-| alter_sequence_stmt // EXTEND WITH HELP: ALTER SEQUENCE
-| alter_database_stmt // EXTEND WITH HELP: ALTER DATABASE
-| alter_range_stmt    // EXTEND WITH HELP: ALTER RANGE
+  alter_table_stmt     // EXTEND WITH HELP: ALTER TABLE
+| alter_index_stmt     // EXTEND WITH HELP: ALTER INDEX
+| alter_view_stmt      // EXTEND WITH HELP: ALTER VIEW
+| alter_sequence_stmt  // EXTEND WITH HELP: ALTER SEQUENCE
+| alter_database_stmt  // EXTEND WITH HELP: ALTER DATABASE
+| alter_range_stmt     // EXTEND WITH HELP: ALTER RANGE
+| alter_partition_stmt // EXTEND WITH HELP: ALTER PARTITION
 
 // %Help: ALTER TABLE - change the definition of a table
 // %Category: DDL
@@ -1129,7 +1134,6 @@ alter_ddl_stmt:
 //   ALTER TABLE ... PARTITION BY LIST ( <name...> ) ( <listspec> )
 //   ALTER TABLE ... PARTITION BY NOTHING
 //   ALTER TABLE ... CONFIGURE ZONE <zoneconfig>
-//   ALTER PARTITION ... OF TABLE ... CONFIGURE ZONE <zoneconfig>
 //
 // Column qualifiers:
 //   [CONSTRAINT <constraintname>] {NULL | NOT NULL | UNIQUE | PRIMARY KEY | CHECK (<expr>) | DEFAULT <expr>}
@@ -1156,7 +1160,26 @@ alter_table_stmt:
 // ALTER TABLE has its error help token here because the ALTER TABLE
 // prefix is spread over multiple non-terminals.
 | ALTER TABLE error     // SHOW HELP: ALTER TABLE
-| ALTER PARTITION error // SHOW HELP: ALTER TABLE
+
+// %Help: ALTER PARTITION - apply zone configurations to a partition
+// %Category: DDL
+// %Text:
+// ALTER PARTITION <name> <command>
+//
+// Commands:
+//   ALTER PARTITION ... OF TABLE ... CONFIGURE ZONE <zoneconfig>
+//   ALTER PARTITION ... OF INDEX ... CONFIGURE ZONE <zoneconfig>
+//
+// Zone configurations:
+//   DISCARD
+//   USING <var> = <expr> [, ...]
+//   USING <var> = COPY FROM PARENT [, ...]
+//   { TO | = } <expr>
+//
+// %SeeAlso: WEBDOCS/configure-zone.html
+alter_partition_stmt:
+  alter_zone_partition_stmt
+| ALTER PARTITION error // SHOW HELP: ALTER PARTITION
 
 // %Help: ALTER VIEW - change the definition of a view
 // %Category: DDL
@@ -1245,7 +1268,6 @@ alter_range_stmt:
 //   ALTER INDEX ... UNSPLIT AT <selectclause>
 //   ALTER INDEX ... UNSPLIT ALL
 //   ALTER INDEX ... SCATTER [ FROM ( <exprs...> ) TO ( <exprs...> ) ]
-//   ALTER PARTITION ... OF INDEX ... CONFIGURE ZONE <zoneconfig>
 //
 // Zone configurations:
 //   DISCARD
@@ -1432,23 +1454,25 @@ alter_zone_table_stmt:
     }
     $$.val = s
   }
-| ALTER PARTITION partition_name OF TABLE table_name set_zone_config
+
+alter_zone_index_stmt:
+  ALTER INDEX table_index_name set_zone_config
   {
-    name := $6.unresolvedObjectName().ToTableName()
-    s := $7.setZoneConfig()
+    s := $4.setZoneConfig()
     s.ZoneSpecifier = tree.ZoneSpecifier{
-       TableOrIndex: tree.TableIndexName{Table: name},
-       Partition: tree.Name($3),
+       TableOrIndex: $3.tableIndexName(),
     }
     $$.val = s
   }
 
-alter_zone_index_stmt:
-  ALTER INDEX table_index_name set_zone_config
+alter_zone_partition_stmt:
+  ALTER PARTITION partition_name OF TABLE table_name set_zone_config
   {
-    s := $4.setZoneConfig()
+    name := $6.unresolvedObjectName().ToTableName()
+    s := $7.setZoneConfig()
     s.ZoneSpecifier = tree.ZoneSpecifier{
-       TableOrIndex: $3.tableIndexName(),
+       TableOrIndex: tree.TableIndexName{Table: name},
+       Partition: tree.Name($3),
     }
     $$.val = s
   }
@@ -1461,6 +1485,17 @@ alter_zone_index_stmt:
     }
     $$.val = s
   }
+| ALTER PARTITION partition_name OF INDEX table_name '@' '*' set_zone_config
+  {
+    name := $6.unresolvedObjectName().ToTableName()
+    s := $9.setZoneConfig()
+    s.ZoneSpecifier = tree.ZoneSpecifier{
+       TableOrIndex: tree.TableIndexName{Table: name},
+       Partition: tree.Name($3),
+    }
+    s.AllIndexes = true
+    $$.val = s
+  }
 
 var_set_list:
   var_name '=' COPY FROM PARENT

diff --git a/pkg/sql/sem/tree/zone.go b/pkg/sql/sem/tree/zone.go
@@ -34,6 +34,11 @@ func (node ZoneSpecifier) TargetsIndex() bool {
 	return node.TargetsTable() && node.TableOrIndex.Index != ""
 }
 
+// TargetsPartition returns whether the zone specifier targets a partition.
+func (node ZoneSpecifier) TargetsPartition() bool {
+	return node.TargetsTable() && node.Partition != ""
+}
+
 // Format implements the NodeFormatter interface.
 func (node *ZoneSpecifier) Format(ctx *FmtCtx) {
 	if node.NamedZone != "" {
@@ -79,6 +84,9 @@ func (node *ShowZoneConfig) Format(ctx *FmtCtx) {
 // statement.
 type SetZoneConfig struct {
 	ZoneSpecifier
+	// AllIndexes indicates that the zone configuration should be applied across
+	// all of a tables indexes. (ALTER PARTITION ... OF INDEX <tablename>@*)
+	AllIndexes bool
 	SetDefault bool
 	YAMLConfig Expr
 	Options    KVOptions