Correct code comments for PartitionedRelPruneInfo struct

The comments above the PartitionedRelPruneInfo struct incorrectly
document how subplan_map and subpart_map are indexed.  This seems to
have snuck in on 4e23236403.

Author: David Rowley <david.rowley@2ndquadrant.com>
This commit is contained in:
Peter Eisentraut 2018-11-15 23:04:48 +01:00
parent fd5274a65b
commit 59f372e082

View File

@ -1089,15 +1089,16 @@ typedef struct PartitionPruneInfo
* PartitionedRelPruneInfo - Details required to allow the executor to prune * PartitionedRelPruneInfo - Details required to allow the executor to prune
* partitions for a single partitioned table. * partitions for a single partitioned table.
* *
* subplan_map[] and subpart_map[] are indexed by partition index (where * subplan_map[] and subpart_map[] are indexed by partition index of the
* zero is the topmost partition, and non-leaf partitions must come before * partitioned table referenced by 'rtindex', the partition index being the
* their children). For a leaf partition p, subplan_map[p] contains the * order that the partitions are defined in the table's PartitionDesc. For a
* zero-based index of the partition's subplan in the parent plan's subplan * leaf partition p, subplan_map[p] contains the zero-based index of the
* list; it is -1 if the partition is non-leaf or has been pruned. For a * partition's subplan in the parent plan's subplan list; it is -1 if the
* non-leaf partition p, subpart_map[p] contains the zero-based index of * partition is non-leaf or has been pruned. For a non-leaf partition p,
* that sub-partition's PartitionedRelPruneInfo in the hierarchy's * subpart_map[p] contains the zero-based index of that sub-partition's
* PartitionedRelPruneInfo list; it is -1 if the partition is a leaf or has * PartitionedRelPruneInfo in the hierarchy's PartitionedRelPruneInfo list;
* been pruned. Note that subplan indexes are global across the parent plan * it is -1 if the partition is a leaf or has been pruned. Note that subplan
* indexes, as stored in 'subplan_map', are global across the parent plan
* node, but partition indexes are valid only within a particular hierarchy. * node, but partition indexes are valid only within a particular hierarchy.
*/ */
typedef struct PartitionedRelPruneInfo typedef struct PartitionedRelPruneInfo