Update comments about index parallel builds

tvondra · tvondra · commit 42eae257cfca · 2024-12-17T15:48:29.000+01:00
Commit b437571 allowed parallel builds for BRIN, but left behind two comments claiming only btree indexes support parallel builds. Reported by Egor Rogov, along with similar issues in SGML docs. Backpatch to 17, where parallel builds for BRIN were introduced. Reported-by: Egor Rogov Backpatch-through: 17 Discussion: https://postgr.es/m/114e2d5d-125e-07d8-94aa-5ad175fb7443@postgrespro.ru
diff --git a/src/backend/catalog/index.c b/src/backend/catalog/index.c
@@ -2958,7 +2958,7 @@ index_build(Relation heapRelation,
 
 	/*
 	 * Determine worker process details for parallel CREATE INDEX.  Currently,
-	 * only btree has support for parallel builds.
+	 * only btree and BRIN have support for parallel builds.
 	 *
 	 * Note that planner considers parallel safety for us.
 	 */
diff --git a/src/backend/optimizer/plan/planner.c b/src/backend/optimizer/plan/planner.c
@@ -6768,7 +6768,8 @@ plan_cluster_use_sort(Oid tableOid, Oid indexOid)
  *		CREATE INDEX should request for use
  *
  * tableOid is the table on which the index is to be built.  indexOid is the
- * OID of an index to be created or reindexed (which must be a btree index).
+ * OID of an index to be created or reindexed (which must be an index with
+ * support for parallel builds - currently btree or BRIN).
  *
  * Return value is the number of parallel worker processes to request.  It
  * may be unsafe to proceed if this is 0.  Note that this does not include the

Original file line number	Diff line number	Diff line change
`@@ -2958,7 +2958,7 @@ index_build(Relation heapRelation,`
`2958`	`2958`
`2959`	`2959`	`/*`
`2960`	`2960`	`* Determine worker process details for parallel CREATE INDEX. Currently,`
`2961`		`- * only btree has support for parallel builds.`
	`2961`	`+ * only btree and BRIN have support for parallel builds.`
`2962`	`2962`	`*`
`2963`	`2963`	`* Note that planner considers parallel safety for us.`
`2964`	`2964`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6768,7 +6768,8 @@ plan_cluster_use_sort(Oid tableOid, Oid indexOid)`
`6768`	`6768`	`* CREATE INDEX should request for use`
`6769`	`6769`	`*`
`6770`	`6770`	`* tableOid is the table on which the index is to be built. indexOid is the`
`6771`		`- * OID of an index to be created or reindexed (which must be a btree index).`
	`6771`	`+ * OID of an index to be created or reindexed (which must be an index with`
	`6772`	`+ * support for parallel builds - currently btree or BRIN).`
`6772`	`6773`	`*`
`6773`	`6774`	`* Return value is the number of parallel worker processes to request. It`
`6774`	`6775`	`* may be unsafe to proceed if this is 0. Note that this does not include the`