postgresql/src/include/executor/functions.h

/*-------------------------------------------------------------------------
 *
 * functions.h
 *		Declarations for execution of SQL-language functions.
 *
 *
 * Portions Copyright (c) 1996-2010, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * $PostgreSQL: pgsql/src/include/executor/functions.h,v 1.35 2010/01/02 16:58:03 momjian Exp $
 *
 *-------------------------------------------------------------------------
 */
#ifndef FUNCTIONS_H
#define FUNCTIONS_H

#include "nodes/execnodes.h"
#include "tcop/dest.h"


extern Datum fmgr_sql(PG_FUNCTION_ARGS);

extern bool check_sql_fn_retval(Oid func_id, Oid rettype,
					List *queryTreeList,
					bool *modifyTargetList,
					JunkFilter **junkFilter);

extern DestReceiver *CreateSQLFunctionDestReceiver(void);

#endif   /* FUNCTIONS_H */
Postgres95 1.01 Distribution - Virgin Sources 1996-07-09 02:22:35 -04:00			`/*-------------------------------------------------------------------------`
			`*`
Change my-function-name-- to my_function_name, and optimizer renames. 1999-02-13 18:22:53 -05:00			`* functions.h`
SQL-language functions are now callable in ordinary fmgr contexts ... for example, an SQL function can be used in a functional index. (I make no promises about speed, but it'll work ;-).) Clean up and simplify handling of functions returning sets. 2000-08-23 23:29:15 -04:00			`* Declarations for execution of SQL-language functions.`
Postgres95 1.01 Distribution - Virgin Sources 1996-07-09 02:22:35 -04:00			`*`
			`*`
Update copyright for the year 2010. 2010-01-02 11:58:17 -05:00			`* Portions Copyright (c) 1996-2010, PostgreSQL Global Development Group`
Add: * Portions Copyright (c) 1996-2000, PostgreSQL, Inc to all files copyright Regents of Berkeley. Man, that's a lot of files. 2000-01-26 00:58:53 -05:00			`* Portions Copyright (c) 1994, Regents of the University of California`
Postgres95 1.01 Distribution - Virgin Sources 1996-07-09 02:22:35 -04:00			`*`
Update copyright for the year 2010. 2010-01-02 11:58:17 -05:00			`* $PostgreSQL: pgsql/src/include/executor/functions.h,v 1.35 2010/01/02 16:58:03 momjian Exp $`
Postgres95 1.01 Distribution - Virgin Sources 1996-07-09 02:22:35 -04:00			`*`
			`*-------------------------------------------------------------------------`
			`*/`
Massive commit to run PGINDENT on all .c and .h files. 1997-09-07 01:04:48 -04:00			`#ifndef FUNCTIONS_H`
Postgres95 1.01 Distribution - Virgin Sources 1996-07-09 02:22:35 -04:00			`#define FUNCTIONS_H`

Fix problems with SQL functions returning rowtypes that have dropped columns. The returned tuple needs to have appropriate NULL columns inserted so that it actually matches the declared rowtype. It seemed convenient to use a JunkFilter for this, so I made some cleanups and simplifications in the JunkFilter code to allow it to support this additional functionality. (That in turn exposed a latent bug in nodeAppend.c, which is that it was returning a tuple slot whose descriptor didn't match its data.) Also, move check_sql_fn_retval out of pg_proc.c and into functions.c, where it seems to more naturally belong. 2004-10-07 14:38:51 -04:00			`#include "nodes/execnodes.h"`
Allow SQL-language functions to return the output of an INSERT/UPDATE/DELETE RETURNING clause, not just a SELECT as formerly. A side effect of this patch is that when a set-returning SQL function is used in a FROM clause, performance is improved because the output is collected into a tuplestore within the function, rather than using the less efficient value-per-call mechanism. 2008-10-31 15:37:56 -04:00			`#include "tcop/dest.h"`
Fix problems with SQL functions returning rowtypes that have dropped columns. The returned tuple needs to have appropriate NULL columns inserted so that it actually matches the declared rowtype. It seemed convenient to use a JunkFilter for this, so I made some cleanups and simplifications in the JunkFilter code to allow it to support this additional functionality. (That in turn exposed a latent bug in nodeAppend.c, which is that it was returning a tuple slot whose descriptor didn't match its data.) Also, move check_sql_fn_retval out of pg_proc.c and into functions.c, where it seems to more naturally belong. 2004-10-07 14:38:51 -04:00
Cleanup up include files. 1997-11-25 20:14:33 -05:00
SQL-language functions are now callable in ordinary fmgr contexts ... for example, an SQL function can be used in a functional index. (I make no promises about speed, but it'll work ;-).) Clean up and simplify handling of functions returning sets. 2000-08-23 23:29:15 -04:00			`extern Datum fmgr_sql(PG_FUNCTION_ARGS);`
Another pgindent run. Fixes enum indenting, and improves #endif spacing. Also adds space for one-line comments. 2001-10-28 01:26:15 -05:00
First phase of OUT-parameters project. We can now define and use SQL functions with OUT parameters. The various PLs still need work, as does pg_dump. Rudimentary docs and regression tests included. 2005-03-31 17:46:33 -05:00			`extern bool check_sql_fn_retval(Oid func_id, Oid rettype,`
Standard pgindent run for 8.1. 2005-10-14 22:49:52 -04:00			`List *queryTreeList,`
Fix a bug introduced when set-returning SQL functions were made inline-able: we have to cope with the possibility that the declared result rowtype contains dropped columns. This fails in 8.4, as per bug #5240. While at it, be more paranoid about inserting binary coercions when inlining. The pre-8.4 code did not really need to worry about that because it could not inline at all in any case where an added coercion could change the behavior of the function's statement. However, when inlining a SRF we allow sorting, grouping, and set-ops such as UNION. In these cases, modifying one of the targetlist entries that the sort/group/setop depends on could conceivably change the behavior of the function's statement --- so don't inline when such a case applies. 2009-12-13 21:15:54 -05:00			`bool *modifyTargetList,`
Standard pgindent run for 8.1. 2005-10-14 22:49:52 -04:00			`JunkFilter **junkFilter);`
Fix problems with SQL functions returning rowtypes that have dropped columns. The returned tuple needs to have appropriate NULL columns inserted so that it actually matches the declared rowtype. It seemed convenient to use a JunkFilter for this, so I made some cleanups and simplifications in the JunkFilter code to allow it to support this additional functionality. (That in turn exposed a latent bug in nodeAppend.c, which is that it was returning a tuple slot whose descriptor didn't match its data.) Also, move check_sql_fn_retval out of pg_proc.c and into functions.c, where it seems to more naturally belong. 2004-10-07 14:38:51 -04:00
Allow SQL-language functions to return the output of an INSERT/UPDATE/DELETE RETURNING clause, not just a SELECT as formerly. A side effect of this patch is that when a set-returning SQL function is used in a FROM clause, performance is improved because the output is collected into a tuplestore within the function, rather than using the less efficient value-per-call mechanism. 2008-10-31 15:37:56 -04:00			`extern DestReceiver *CreateSQLFunctionDestReceiver(void);`

New pgindent run with fixes suggested by Tom. Patch manually reviewed, initdb/regression tests pass. 2001-11-05 12:46:40 -05:00			`#endif /* FUNCTIONS_H */`