Document "relrewrite" at the top of heap_create_with_catalog()

michaelpq · michaelpq · commit 9e1183953f0a · 2025-06-18T11:03:21.000+09:00
This parameter has been introduced in 325f2ec, and it was not documented contrary to all the other arguments of heap_create_with_catalog(). Reviewed-by: Yugo Nagata <nagata@sraoss.co.jp> Reviewed-by: Steven Niu <niushiji@gmail.com> Discussion: https://postgr.es/m/aE--bmEv-gJUTH5v@paquier.xyz
diff --git a/src/backend/catalog/heap.c b/src/backend/catalog/heap.c
@@ -1100,6 +1100,7 @@ AddNewRelationType(const char *typeName,
  *		if false, relacl is always set NULL
  *	allow_system_table_mods: true to allow creation in system namespaces
  *	is_internal: is this a system-generated catalog?
+ *	relrewrite: link to original relation during a table rewrite
  *
  * Output parameters:
  *	typaddress: if not null, gets the object address of the new pg_type entry

Original file line number	Diff line number	Diff line change
`@@ -1100,6 +1100,7 @@ AddNewRelationType(const char *typeName,`
`1100`	`1100`	`* if false, relacl is always set NULL`
`1101`	`1101`	`* allow_system_table_mods: true to allow creation in system namespaces`
`1102`	`1102`	`* is_internal: is this a system-generated catalog?`
	`1103`	`+ * relrewrite: link to original relation during a table rewrite`
`1103`	`1104`	`*`
`1104`	`1105`	`* Output parameters:`
`1105`	`1106`	`* typaddress: if not null, gets the object address of the new pg_type entry`