PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
execPartition.h
Go to the documentation of this file.
1/*--------------------------------------------------------------------
2 * execPartition.h
3 * POSTGRES partitioning executor interface
4 *
5 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
6 * Portions Copyright (c) 1994, Regents of the University of California
7 *
8 * IDENTIFICATION
9 * src/include/executor/execPartition.h
10 *--------------------------------------------------------------------
11 */
12
13#ifndef EXECPARTITION_H
14#define EXECPARTITION_H
15
16#include "nodes/execnodes.h"
17#include "nodes/parsenodes.h"
18#include "nodes/plannodes.h"
20
21/* See execPartition.c for the definitions. */
24
26 Relation rel);
28 ResultRelInfo *rootResultRelInfo,
30 TupleTableSlot *slot,
31 EState *estate);
32extern void ExecCleanupTupleRouting(ModifyTableState *mtstate,
33 PartitionTupleRouting *proute);
34
35
36/*
37 * PartitionedRelPruningData - Per-partitioned-table data for run-time pruning
38 * of partitions. For a multilevel partitioned table, we have one of these
39 * for the topmost partition plus one for each non-leaf child partition.
40 *
41 * subplan_map[] and subpart_map[] have the same definitions as in
42 * PartitionedRelPruneInfo (see plannodes.h); though note that here,
43 * subpart_map contains indexes into PartitionPruningData.partrelprunedata[].
44 *
45 * nparts Length of subplan_map[] and subpart_map[].
46 * subplan_map Subplan index by partition index, or -1.
47 * subpart_map Subpart index by partition index, or -1.
48 * present_parts A Bitmapset of the partition indexes that we
49 * have subplans or subparts for.
50 * initial_pruning_steps List of PartitionPruneSteps used to
51 * perform executor startup pruning.
52 * exec_pruning_steps List of PartitionPruneSteps used to
53 * perform per-scan pruning.
54 * initial_context If initial_pruning_steps isn't NIL, contains
55 * the details needed to execute those steps.
56 * exec_context If exec_pruning_steps isn't NIL, contains
57 * the details needed to execute those steps.
58 */
60{
61 int nparts;
70
71/*
72 * PartitionPruningData - Holds all the run-time pruning information for
73 * a single partitioning hierarchy containing one or more partitions.
74 * partrelprunedata[] is an array ordered such that parents appear before
75 * their children; in particular, the first entry is the topmost partition,
76 * which was actually named in the SQL query.
77 */
79{
80 int num_partrelprunedata; /* number of array entries */
83
84/*
85 * PartitionPruneState - State object required for plan nodes to perform
86 * run-time partition pruning.
87 *
88 * This struct can be attached to plan types which support arbitrary Lists of
89 * subplans containing partitions, to allow subplans to be eliminated due to
90 * the clauses being unable to match to any tuple that the subplan could
91 * possibly produce.
92 *
93 * execparamids Contains paramids of PARAM_EXEC Params found within
94 * any of the partprunedata structs. Pruning must be
95 * done again each time the value of one of these
96 * parameters changes.
97 * other_subplans Contains indexes of subplans that don't belong to any
98 * "partprunedata", e.g UNION ALL children that are not
99 * partitioned tables, or a partitioned table that the
100 * planner deemed run-time pruning to be useless for.
101 * These must not be pruned.
102 * prune_context A short-lived memory context in which to execute the
103 * partition pruning functions.
104 * do_initial_prune true if pruning should be performed during executor
105 * startup (at any hierarchy level).
106 * do_exec_prune true if pruning should be performed during
107 * executor run (at any hierarchy level).
108 * num_partprunedata Number of items in "partprunedata" array.
109 * partprunedata Array of PartitionPruningData pointers for the plan's
110 * partitioned relation(s), one for each partitioning
111 * hierarchy that requires run-time pruning.
112 */
114{
123
125 int n_total_subplans,
126 PartitionPruneInfo *pruneinfo,
127 Bitmapset **initially_valid_subplans);
129 bool initial_prune);
130
131#endif /* EXECPARTITION_H */
#define FLEXIBLE_ARRAY_MEMBER
Definition: c.h:417
Bitmapset * ExecFindMatchingSubPlans(PartitionPruneState *prunestate, bool initial_prune)
struct PartitionDispatchData * PartitionDispatch
Definition: execPartition.h:22
PartitionTupleRouting * ExecSetupPartitionTupleRouting(EState *estate, Relation rel)
ResultRelInfo * ExecFindPartition(ModifyTableState *mtstate, ResultRelInfo *rootResultRelInfo, PartitionTupleRouting *proute, TupleTableSlot *slot, EState *estate)
struct PartitionPruneState PartitionPruneState
PartitionPruneState * ExecInitPartitionPruning(PlanState *planstate, int n_total_subplans, PartitionPruneInfo *pruneinfo, Bitmapset **initially_valid_subplans)
struct PartitionedRelPruningData PartitionedRelPruningData
struct PartitionPruningData PartitionPruningData
void ExecCleanupTupleRouting(ModifyTableState *mtstate, PartitionTupleRouting *proute)
Definition: pg_list.h:54
PartitionPruningData * partprunedata[FLEXIBLE_ARRAY_MEMBER]
Bitmapset * execparamids
Bitmapset * other_subplans
MemoryContext prune_context
PartitionedRelPruningData partrelprunedata[FLEXIBLE_ARRAY_MEMBER]
Definition: execPartition.h:81
PartitionPruneContext exec_context
Definition: execPartition.h:68
PartitionPruneContext initial_context
Definition: execPartition.h:67