postgresql/src/include/executor/tstoreReceiver.h

/*-------------------------------------------------------------------------
 *
 * tstoreReceiver.h
 *	  prototypes for tstoreReceiver.c
 *
 *
 * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * $PostgreSQL: pgsql/src/include/executor/tstoreReceiver.h,v 1.13 2009/01/01 17:23:59 momjian Exp $
 *
 *-------------------------------------------------------------------------
 */

#ifndef TSTORE_RECEIVER_H
#define TSTORE_RECEIVER_H

#include "tcop/dest.h"
#include "utils/tuplestore.h"


extern DestReceiver *CreateTuplestoreDestReceiver(void);

extern void SetTuplestoreDestReceiverParams(DestReceiver *self,
											Tuplestorestate *tStore,
											MemoryContext tContext,
											bool detoast);

#endif   /* TSTORE_RECEIVER_H */
Add new file. 2003-03-27 11:55:11 -05:00			`/*-------------------------------------------------------------------------`
			`*`
			`* tstoreReceiver.h`
			`* prototypes for tstoreReceiver.c`
			`*`
			`*`
Update copyright for 2009. 2009-01-01 12:24:05 -05:00			`* Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group`
Add new file. 2003-03-27 11:55:11 -05:00			`* Portions Copyright (c) 1994, Regents of the University of California`
			`*`
Update copyright for 2009. 2009-01-01 12:24:05 -05:00			`* $PostgreSQL: pgsql/src/include/executor/tstoreReceiver.h,v 1.13 2009/01/01 17:23:59 momjian Exp $`
Add new file. 2003-03-27 11:55:11 -05:00			`*`
			`*-------------------------------------------------------------------------`
			`*/`

			`#ifndef TSTORE_RECEIVER_H`
			`#define TSTORE_RECEIVER_H`

			`#include "tcop/dest.h"`
Restructure command destination handling so that we pass around DestReceiver pointers instead of just CommandDest values. The DestReceiver is made at the point where the destination is selected, rather than deep inside the executor. This cleans up the original kluge implementation of tstoreReceiver.c, and makes it easy to support retrieving results from utility statements inside portals. Thus, you can now do fun things like Bind and Execute a FETCH or EXPLAIN command, and it'll all work as expected (e.g., you can Describe the portal, or use Execute's count parameter to suspend the output partway through). Implementation involves stuffing the utility command's output into a Tuplestore, which would be kind of annoying for huge output sets, but should be quite acceptable for typical uses of utility commands. 2003-05-06 16:26:28 -04:00			`#include "utils/tuplestore.h"`
Add new file. 2003-03-27 11:55:11 -05:00
Restructure command destination handling so that we pass around DestReceiver pointers instead of just CommandDest values. The DestReceiver is made at the point where the destination is selected, rather than deep inside the executor. This cleans up the original kluge implementation of tstoreReceiver.c, and makes it easy to support retrieving results from utility statements inside portals. Thus, you can now do fun things like Bind and Execute a FETCH or EXPLAIN command, and it'll all work as expected (e.g., you can Describe the portal, or use Execute's count parameter to suspend the output partway through). Implementation involves stuffing the utility command's output into a Tuplestore, which would be kind of annoying for huge output sets, but should be quite acceptable for typical uses of utility commands. 2003-05-06 16:26:28 -04:00
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. 2008-11-30 15:51:25 -05:00			`extern DestReceiver *CreateTuplestoreDestReceiver(void);`

			`extern void SetTuplestoreDestReceiverParams(DestReceiver *self,`
			`Tuplestorestate *tStore,`
Ensure that the contents of a holdable cursor don't depend on out-of-line toasted values, since those could get dropped once the cursor's transaction is over. Per bug #4553 from Andrew Gierth. Back-patch as far as 8.1. The bug actually exists back to 7.4 when holdable cursors were introduced, but this patch won't work before 8.1 without significant adjustments. Given the lack of field complaints, it doesn't seem worth the work (and risk of introducing new bugs) to try to make a patch for the older branches. 2008-12-01 12:06:21 -05:00			`MemoryContext tContext,`
			`bool detoast);`
Add new file. 2003-03-27 11:55:11 -05:00
pgindent run. 2003-08-03 20:43:34 -04:00			`#endif /* TSTORE_RECEIVER_H */`