8000 Clean up the API for DestReceiver objects by eliminating the assumption · postgrespro/postgres_cluster@c1f3073 · GitHub
[go: up one dir, main page]
Skip to content

Commit c1f3073

Browse files
tglsfdctglsfdc
committed
Clean up the API for DestReceiver objects by eliminating the assumption
that a Portal is a useful and sufficient additional argument for CreateDestReceiver --- it just isn't, in most cases. Instead formalize the approach of passing any needed parameters to the receiver separately. One unexpected benefit of this change is that we can declare typedef Portal in a less surprising location. This patch is just code rearrangement and doesn't change any functionality. I'll tackle the HOLD-cursor-vs-toast problem in a follow-on patch.
1 parent 3f936aa commit c1f3073

File tree

14 files changed

+108
-83
lines changed

14 files changed

+108
-83
lines changed

‎src/backend/access/common/printtup.c‎

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Portions Copyright (c) 1994, Regents of the University of California
1010
*
1111
* IDENTIFICATION
12-
* $PostgreSQL: pgsql/src/backend/access/common/printtup.c,v 1.102 2008/04/17 21:37:28 alvherre Exp $
12+
* $PostgreSQL: pgsql/src/backend/access/common/printtup.c,v 1.103 2008/11/30 20:51:24 tgl Exp $
1313
*
1414
*-------------------------------------------------------------------------
1515
*/
@@ -67,31 +67,16 @@ typedef struct
6767
* ----------------
6868
*/
6969
DestReceiver *
70-
printtup_create_DR(CommandDest dest, Portal portal)
70+
printtup_create_DR(CommandDest dest)
7171
{
72-
DR_printtup *self = (DR_printtup *) palloc(sizeof(DR_printtup));
72+
DR_printtup *self = (DR_printtup *) palloc0(sizeof(DR_printtup));
7373

74-
if (PG_PROTOCOL_MAJOR(FrontendProtocol) >= 3)
75-
self->pub.receiveSlot = printtup;
76-
else
77-
{
78-
/*
79-
* In protocol 2.0 the Bind message does not exist, so there is no way
80-
* for the columns to have different print formats; it's sufficient to
81-
* look at the first one.
82-
*/
83-
if (portal->formats && portal->formats[0] != 0)
84-
self->pub.receiveSlot = printtup_internal_20;
85-
else
86-
self->pub.receiveSlot = printtup_20;
87-
}
74+
self->pub.receiveSlot = printtup; /* might get changed later */
8875
self->pub.rStartup = printtup_startup;
8976
self->pub.rShutdown = printtup_shutdown;
9077
self->pub.rDestroy = printtup_destroy;
9178
self->pub.mydest = dest;
9279

93-
self->portal = portal;
94-
9580
/*
9681
* Send T message automatically if DestRemote, but not if
9782
* DestRemoteExecute
@@ -105,6 +90,33 @@ printtup_create_DR(CommandDest dest, Portal portal)
10590
return (DestReceiver *) self;
10691
}
10792

93+
/*
94+
* Set parameters for a DestRemote (or DestRemoteExecute) receiver
95+
*/
96+
void
97+
SetRemoteDestReceiverParams(DestReceiver *self, Portal portal)
98+
{
99+
DR_printtup *myState = (DR_printtup *) self;
100+
101+
Assert(myState->pub.mydest == DestRemote ||
102+
myState->pub.mydest == DestRemoteExecute);
103+
104+
myState->portal = portal;
105+
106+
if (PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
107+
{
108+
/*
109+
* In protocol 2.0 the Bind message does not exist, so there is no way
110+
* for the columns to have different print formats; it's sufficient to
111+
* look at the first one.
112+
*/
113+
if (portal->formats && portal->formats[0] != 0)
114+
myState->pub.receiveSlot = printtup_internal_20;
115+
else
116+
myState->pub.receiveSlot = printtup_20;
117+
}
118+
}
119+
108120
static void
109121
printtup_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
110122
{

‎src/backend/commands/copy.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/commands/copy.c,v 1.301 2008/11/06 20:51:14 tgl Exp $
11+
* $PostgreSQL: pgsql/src/backend/commands/copy.c,v 1.302 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -1050,7 +1050,7 @@ DoCopy(const CopyStmt *stmt, const char *queryString)
10501050
PushUpdatedSnapshot(GetActiveSnapshot());
10511051

10521052
/* Create dest receiver for COPY OUT */
1053-
dest = CreateDestReceiver(DestCopyOut, NULL);
1053+
dest = CreateDestReceiver(DestCopyOut);
10541054
((DR_copy *) dest)->cstate = cstate;
10551055

10561056
/* Create a QueryDesc requesting no output */

‎src/backend/commands/portalcmds.c‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
*
1616
* IDENTIFICATION
17-
* $PostgreSQL: pgsql/src/backend/commands/portalcmds.c,v 1.75 2008/07/18 20:26:06 tgl Exp $
17+
* $PostgreSQL: pgsql/src/backend/commands/portalcmds.c,v 1.76 2008/11/30 20:51:25 tgl Exp $
1818
*
1919
*-------------------------------------------------------------------------
2020
*/
@@ -26,6 +26,7 @@
2626
#include "access/xact.h"
2727
#include "commands/portalcmds.h"
2828
#include "executor/executor.h"
29+
#include "executor/tstoreReceiver.h"
2930
#include "tcop/pquery.h"
3031
#include "utils/memutils.h"
3132
#include "utils/snapmgr.h"
@@ -351,7 +352,10 @@ PersistHoldablePortal(Portal portal)
351352
ExecutorRewind(queryDesc);
352353

353354
/* Change the destination to output to the tuplestore */
354-
queryDesc->dest = CreateDestReceiver(DestTuplestore, portal);
355+
queryDesc->dest = CreateDestReceiver(DestTuplestore);
356+
SetTuplestoreDestReceiverParams(queryDesc->dest,
357+
portal->holdStore,
358+
portal->holdContext);
355359

356360
/* Fetch the result set into the tuplestore */
357361
ExecutorRun(queryDesc, ForwardScanDirection, 0L);

‎src/backend/executor/execMain.c‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
*
2828
* IDENTIFICATION
29-
* $PostgreSQL: pgsql/src/backend/executor/execMain.c,v 1.318 2008/11/19 01:10:23 tgl Exp $
29+
* $PostgreSQL: pgsql/src/backend/executor/execMain.c,v 1.319 2008/11/30 20:51:25 tgl Exp $
3030
*
3131
*-------------------------------------------------------------------------
3232
*/
@@ -2833,7 +2833,7 @@ OpenIntoRel(QueryDesc *queryDesc)
28332833
/*
28342834
* Now replace the query's DestReceiver with one for SELECT INTO
28352835
*/
2836-
queryDesc->dest = CreateDestReceiver(DestIntoRel, NULL);
2836+
queryDesc->dest = CreateDestReceiver(DestIntoRel);
28372837
myState = (DR_intorel *) queryDesc->dest;
28382838
Assert(myState->pub.mydest == DestIntoRel);
28392839
myState->estate = estate;
@@ -2877,10 +2877,6 @@ CloseIntoRel(QueryDesc *queryDesc)
28772877

28782878
/*
28792879
* CreateIntoRelDestReceiver -- create a suitable DestReceiver object
2880-
*
2881-
* Since CreateDestReceiver doesn't accept the parameters we'd need,
2882-
* we just leave the private fields zeroed here. OpenIntoRel will
2883-
* fill them in.
28842880
*/
28852881
DestReceiver *
28862882
CreateIntoRelDestReceiver(void)
@@ -2893,6 +2889,8 @@ CreateIntoRelDestReceiver(void)
28932889
self->pub.rDestroy = intorel_destroy;
28942890
self->pub.mydest = DestIntoRel;
28952891

2892+
/* private fields will be set by OpenIntoRel */
2893+
28962894
return (DestReceiver *) self;
28972895
}
28982896

‎src/backend/executor/functions.c‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/executor/functions.c,v 1.129 2008/11/27 00:10:04 tgl Exp $
11+
* $PostgreSQL: pgsql/src/backend/executor/functions.c,v 1.130 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -398,7 +398,7 @@ postquel_start(execution_state *es, SQLFunctionCachePtr fcache)
398398
{
399399
DR_sqlfunction *myState;
400400

401-
dest = CreateDestReceiver(DestSQLFunction, NULL);
401+
dest = CreateDestReceiver(DestSQLFunction);
402402
/* pass down the needed info to the dest receiver routines */
403403
myState = (DR_sqlfunction *) dest;
404404
Assert(myState->pub.mydest == DestSQLFunction);
@@ -1269,10 +1269,6 @@ check_sql_fn_retval(Oid func_id, Oid rettype, List *queryTreeList,
12691269

12701270
/*
12711271
* CreateSQLFunctionDestReceiver -- create a suitable DestReceiver object
1272-
*
 C852
1273-
* Since CreateDestReceiver doesn't accept the parameters we'd need,
1274-
* we just leave the private fields zeroed here. postquel_start will
1275-
* fill them in.
12761272
*/
12771273
DestReceiver *
12781274
CreateSQLFunctionDestReceiver(void)
@@ -1285,6 +1281,8 @@ CreateSQLFunctionDestReceiver(void)
12851281
self->pub.rDestroy = sqlfunction_destroy;
12861282
self->pub.mydest = DestSQLFunction;
12871283

1284+
/* private fields will be set by postquel_start */
1285+
12881286
return (DestReceiver *) self;
12891287
}
12901288

‎src/backend/executor/spi.c‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/executor/spi.c,v 1.200 2008/11/02 01:45:28 tgl Exp $
11+
* $PostgreSQL: pgsql/src/backend/executor/spi.c,v 1.201 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -1227,7 +1227,7 @@ SPI_cursor_fetch(Portal portal, bool forward, long count)
12271227
{
12281228
_SPI_cursor_operation(portal,
12291229
forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1230-
CreateDestReceiver(DestSPI, NULL));
1230+
CreateDestReceiver(DestSPI));
12311231
/* we know that the DestSPI receiver doesn't need a destroy call */
12321232
}
12331233

@@ -1256,7 +1256,7 @@ SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction, long count)
12561256
{
12571257
_SPI_cursor_operation(portal,
12581258
direction, count,
1259-
CreateDestReceiver(DestSPI, NULL));
1259+
CreateDestReceiver(DestSPI));
12601260
/* we know that the DestSPI receiver doesn't need a destroy call */
12611261
}
12621262

@@ -1744,8 +1744,7 @@ _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI,
17441744
if (!read_only)
17451745
CommandCounterIncrement();
17461746

1747-
dest = CreateDestReceiver(canSetTag ? DestSPI : DestNone,
1748-
NULL);
1747+
dest = CreateDestReceiver(canSetTag ? DestSPI : DestNone);
17491748

17501749
if (snapshot == InvalidSnapshot)
17511750
{

‎src/backend/executor/tstoreReceiver.c‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Portions Copyright (c) 1994, Regents of the University of California
1010
*
1111
* IDENTIFICATION
12-
* $PostgreSQL: pgsql/src/backend/executor/tstoreReceiver.c,v 1.19 2008/01/01 19:45:49 momjian Exp $
12+
* $PostgreSQL: pgsql/src/backend/executor/tstoreReceiver.c,v 1.20 2008/11/30 20:51:25 tgl Exp $
1313
*
1414
*-------------------------------------------------------------------------
1515
*/
@@ -72,19 +72,32 @@ tstoreDestroyReceiver(DestReceiver *self)
7272
* Initially create a DestReceiver object.
7373
*/
7474
DestReceiver *
75-
CreateTuplestoreDestReceiver(Tuplestorestate *tStore,
76-
MemoryContext tContext)
75+
CreateTuplestoreDestReceiver(void)
7776
{
78-
TStoreState *self = (TStoreState *) palloc(sizeof(TStoreState));
77+
TStoreState *self 436E = (TStoreState *) palloc0(sizeof(TStoreState));
7978

8079
self->pub.receiveSlot = tstoreReceiveSlot;
8180
self->pub.rStartup = tstoreStartupReceiver;
8281
self->pub.rShutdown = tstoreShutdownReceiver;
8382
self->pub.rDestroy = tstoreDestroyReceiver;
8483
self->pub.mydest = DestTuplestore;
8584

86-
self->tstore = tStore;
87-
self->cxt = tContext;
85+
/* private fields will be set by SetTuplestoreDestReceiverParams */
8886

8987
return (DestReceiver *) self;
9088
}
89+
90+
/*
91+
* Set parameters for a TuplestoreDestReceiver
92+
*/
93+
void
94+
SetTuplestoreDestReceiverParams(DestReceiver *self,
95+
Tuplestorestate *tStore,
96+
MemoryContext tContext)
97+
{
98+
TStoreState *myState = (TStoreState *) self;
99+
100+
Assert(myState->pub.mydest == DestTuplestore);
101+
myState->tstore = tStore;
102+
myState->cxt = tContext;
103+
}

‎src/backend/tcop/dest.c‎

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* Portions Copyright (c) 1994, Regents of the University of California
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/tcop/dest.c,v 1.73 2008/10/31 19:37:56 tgl Exp $
11+
* $PostgreSQL: pgsql/src/backend/tcop/dest.c,v 1.74 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -94,21 +94,16 @@ BeginCommand(const char *commandTag, CommandDest dest)
9494

9595
/* ----------------
9696
* CreateDestReceiver - return appropriate receiver function set for dest
97-
*
98-
* Note: a Portal must be specified for destinations DestRemote,
99-
* DestRemoteExecute, and DestTuplestore. It can be NULL for the others.
10097
* ----------------
10198
*/
10299
DestReceiver *
103-
CreateDestReceiver(CommandDest dest, Portal portal)
100+
CreateDestReceiver(CommandDest dest)
104101
{
105102
switch (dest)
106103
{
107104
case DestRemote:
108105
case DestRemoteExecute:
109-
if (portal == NULL)
110-
elog(ERROR, "no portal specified for DestRemote receiver");
111-
return printtup_create_DR(dest, portal);
106+
return printtup_create_DR(dest);
112107

113108
case DestNone:
114109
return &donothingDR;
@@ -120,13 +115,7 @@ CreateDestReceiver(CommandDest dest, Portal portal)
120115
return &spi_printtupDR;
121116

122117
case DestTuplestore:
123-
if (portal == NULL)
124-
elog(ERROR, "no portal specified for DestTuplestore receiver");
125-
if (portal->holdStore == NULL ||
126-
portal->holdContext == NULL)
127-
elog(ERROR, "portal has no holdStore");
128-
return CreateTuplestoreDestReceiver(portal->holdStore,
129-
portal->holdContext);
118+
return CreateTuplestoreDestReceiver();
130119

131120
case DestIntoRel:
132121
return CreateIntoRelDestReceiver();

‎src/backend/tcop/postgres.c‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/tcop/postgres.c,v 1.557 2008/09/30 10:52:13 heikki Exp $
11+
* $PostgreSQL: pgsql/src/backend/tcop/postgres.c,v 1.558 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
* NOTES
1414
* this is the "main" module of the postgres backend and
@@ -979,7 +979,9 @@ exec_simple_query(const char *query_string)
979979
/*
980980
* Now we can create the destination receiver object.
981981
*/
982-
receiver = CreateDestReceiver(dest, portal);
982+
receiver = CreateDestReceiver(dest);
983+
if (dest == DestRemote)
984+
SetRemoteDestReceiverParams(receiver, portal);
983985

984986
/*
985987
* Switch back to transaction context for execution.
@@ -1835,7 +1837,9 @@ exec_execute_message(const char *portal_name, long max_rows)
18351837
* Create dest receiver in MessageContext (we don't want it in transaction
18361838
* context, because that may get deleted if portal contains VACUUM).
18371839
*/
1838-
receiver = CreateDestReceiver(dest, portal);
1840+
receiver = CreateDestReceiver(dest);
1841+
if (dest == DestRemoteExecute)
1842+
SetRemoteDestReceiverParams(receiver, portal);
18391843

18401844
/*
18411845
* Ensure we are in a transaction command (this should normally be the

‎src/backend/tcop/pquery.c‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/src/backend/tcop/pquery.c,v 1.125 2008/11/19 01:10:23 tgl Exp $
11+
* $PostgreSQL: pgsql/src/backend/tcop/pquery.c,v 1.126 2008/11/30 20:51:25 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -18,6 +18,7 @@
1818
#include "access/xact.h"
1919
#include "commands/prepare.h"
2020
#include "commands/trigger.h"
21+
#include "executor/tstoreReceiver.h"
2122
#include "miscadmin.h"
2223
#include "pg_trace.h"
2324
#include "tcop/pquery.h"
@@ -1032,7 +1033,10 @@ FillPortalStore(Portal portal, bool isTopLevel)
10321033
char completionTag[COMPLETION_TAG_BUFSIZE];
10331034

10341035
PortalCreateHoldStore(portal);
1035-
treceiver = CreateDestReceiver(DestTuplestore, portal);
1036+
treceiver = CreateDestReceiver(DestTuplestore);
1037+
SetTuplestoreDestReceiverParams(treceiver,
1038+
portal->holdStore,
1039+
portal->holdContext);
10361040

10371041
completionTag[0] = '\0';
10381042

0 commit comments

Comments
 (0)
0