Fix prologue of get_partition_ancestors()

petere · petere · commit e557db106ef6 · 2023-12-21T11:42:12.000+01:00
The callers of this function assume that the first Oid in the list returned by this function corresponds to the immediate parent and the last on corresponds to the topmost parent. Make that explicit in the function prologue. Author: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com> Discussion: https://www.postgresql.org/message-id/CAExHW5vCbATEmht861=G-BFPHNwLUqyeGa_=8-xibJ6Q1UxAeA@mail.gmail.com
diff --git a/src/backend/catalog/partition.c b/src/backend/catalog/partition.c
@@ -123,7 +123,9 @@ get_partition_parent_worker(Relation inhRel, Oid relid, bool *detach_pending)
  * get_partition_ancestors
  *		Obtain ancestors of given relation
  *
- * Returns a list of ancestors of the given relation.
+ * Returns a list of ancestors of the given relation.  The list is ordered:
+ * The first element is the immediate parent and the last one is the topmost
+ * parent in the partition hierarchy.
  *
  * Note: Because this function assumes that the relation whose OID is passed
  * as an argument and each ancestor will have precisely one parent, it should

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,9 @@ get_partition_parent_worker(Relation inhRel, Oid relid, bool *detach_pending)`
`123`	`123`	`* get_partition_ancestors`
`124`	`124`	`* Obtain ancestors of given relation`
`125`	`125`	`*`
`126`		`- * Returns a list of ancestors of the given relation.`
	`126`	`+ * Returns a list of ancestors of the given relation. The list is ordered:`
	`127`	`+ * The first element is the immediate parent and the last one is the topmost`
	`128`	`+ * parent in the partition hierarchy.`
`127`	`129`	`*`
`128`	`130`	`* Note: Because this function assumes that the relation whose OID is passed`
`129`	`131`	`* as an argument and each ancestor will have precisely one parent, it should`