1 /*-------------------------------------------------------------------------
4 * plan and query descriptor accessor macros used by the executor
8 * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
9 * Portions Copyright (c) 1994, Regents of the University of California
11 * $PostgreSQL: pgsql/src/include/executor/execdesc.h,v 1.38 2008/11/19 01:10:23 tgl Exp $
13 *-------------------------------------------------------------------------
18 #include "nodes/execnodes.h"
19 #include "nodes/plannodes.h"
20 #include "tcop/dest.h"
26 * a QueryDesc encapsulates everything that the executor
27 * needs to execute the query.
29 * For the convenience of SQL-language functions, we also support QueryDescs
30 * containing utility statements; these must not be passed to the executor
32 * ---------------------
34 typedef struct QueryDesc
36 /* These fields are provided by CreateQueryDesc */
37 CmdType operation; /* CMD_SELECT, CMD_UPDATE, etc. */
38 PlannedStmt *plannedstmt; /* planner's output, or null if utility */
39 Node *utilitystmt; /* utility statement, or null */
40 Snapshot snapshot; /* snapshot to use for query */
41 Snapshot crosscheck_snapshot; /* crosscheck for RI update/delete */
42 DestReceiver *dest; /* the destination for tuple output */
43 ParamListInfo params; /* param values being passed in */
44 bool doInstrument; /* TRUE requests runtime instrumentation */
46 /* These fields are set by ExecutorStart */
47 TupleDesc tupDesc; /* descriptor for result tuples */
48 EState *estate; /* executor's query-wide state */
49 PlanState *planstate; /* tree of per-plan-node state */
51 /* This is always set NULL by the core system, but plugins can change it */
52 struct Instrumentation *totaltime; /* total time spent in ExecutorRun */
56 extern QueryDesc *CreateQueryDesc(PlannedStmt *plannedstmt,
58 Snapshot crosscheck_snapshot,
63 extern QueryDesc *CreateUtilityQueryDesc(Node *utilitystmt,
66 ParamListInfo params);
68 extern void FreeQueryDesc(QueryDesc *qdesc);
70 #endif /* EXECDESC_H */