2002-08-27 06:55:12 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* prepare.h
|
2003-05-05 02:44:56 +02:00
|
|
|
* PREPARE, EXECUTE and DEALLOCATE commands, and prepared-stmt storage
|
2002-08-27 06:55:12 +02:00
|
|
|
*
|
|
|
|
*
|
2007-01-05 23:20:05 +01:00
|
|
|
* Copyright (c) 2002-2007, PostgreSQL Global Development Group
|
2002-08-27 06:55:12 +02:00
|
|
|
*
|
2007-03-13 01:33:44 +01:00
|
|
|
* $PostgreSQL: pgsql/src/include/commands/prepare.h,v 1.25 2007/03/13 00:33:43 tgl Exp $
|
2002-08-27 06:55:12 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
#ifndef PREPARE_H
|
|
|
|
#define PREPARE_H
|
|
|
|
|
2003-02-03 00:46:38 +01:00
|
|
|
#include "executor/executor.h"
|
2007-03-13 01:33:44 +01:00
|
|
|
#include "utils/plancache.h"
|
2006-07-13 18:49:20 +02:00
|
|
|
#include "utils/timestamp.h"
|
2002-08-27 06:55:12 +02:00
|
|
|
|
2003-05-05 02:44:56 +02:00
|
|
|
/*
|
2007-03-13 01:33:44 +01:00
|
|
|
* The data structure representing a prepared statement. This is now just
|
|
|
|
* a thin veneer over a plancache entry --- the main addition is that of
|
|
|
|
* a name.
|
2003-05-05 02:44:56 +02:00
|
|
|
*
|
2007-03-13 01:33:44 +01:00
|
|
|
* Note: all subsidiary storage lives in the referenced plancache entry.
|
2003-05-05 02:44:56 +02:00
|
|
|
*/
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
/* dynahash.c requires key to be first field */
|
2006-10-04 02:30:14 +02:00
|
|
|
char stmt_name[NAMEDATALEN];
|
2007-03-13 01:33:44 +01:00
|
|
|
CachedPlanSource *plansource; /* the actual cached plan */
|
2007-02-20 18:32:18 +01:00
|
|
|
bool from_sql; /* prepared via SQL, not FE/BE protocol? */
|
2006-10-04 02:30:14 +02:00
|
|
|
TimestampTz prepare_time; /* the time when the stmt was prepared */
|
2003-08-08 23:42:59 +02:00
|
|
|
} PreparedStatement;
|
2003-05-05 02:44:56 +02:00
|
|
|
|
|
|
|
|
|
|
|
/* Utility statements PREPARE, EXECUTE, DEALLOCATE, EXPLAIN EXECUTE */
|
2007-03-13 01:33:44 +01:00
|
|
|
extern void PrepareQuery(PrepareStmt *stmt, const char *queryString);
|
|
|
|
extern void ExecuteQuery(ExecuteStmt *stmt, const char *queryString,
|
|
|
|
ParamListInfo params,
|
2006-10-04 02:30:14 +02:00
|
|
|
DestReceiver *dest, char *completionTag);
|
2002-08-27 06:55:12 +02:00
|
|
|
extern void DeallocateQuery(DeallocateStmt *stmt);
|
2007-03-13 01:33:44 +01:00
|
|
|
extern void ExplainExecuteQuery(ExecuteStmt *execstmt, ExplainStmt *stmt,
|
|
|
|
const char *queryString,
|
|
|
|
ParamListInfo params, TupOutputState *tstate);
|
2002-08-27 06:55:12 +02:00
|
|
|
|
2003-05-05 02:44:56 +02:00
|
|
|
/* Low-level access to stored prepared statements */
|
|
|
|
extern void StorePreparedStatement(const char *stmt_name,
|
2007-03-13 01:33:44 +01:00
|
|
|
Node *raw_parse_tree,
|
2003-08-04 02:43:34 +02:00
|
|
|
const char *query_string,
|
|
|
|
const char *commandTag,
|
2007-03-13 01:33:44 +01:00
|
|
|
Oid *param_types,
|
|
|
|
int num_params,
|
2007-02-20 18:32:18 +01:00
|
|
|
List *stmt_list,
|
2006-01-08 08:00:27 +01:00
|
|
|
bool from_sql);
|
2003-05-05 02:44:56 +02:00
|
|
|
extern PreparedStatement *FetchPreparedStatement(const char *stmt_name,
|
2003-08-04 02:43:34 +02:00
|
|
|
bool throwError);
|
2003-05-05 02:44:56 +02:00
|
|
|
extern void DropPreparedStatement(const char *stmt_name, bool showError);
|
2003-08-08 23:42:59 +02:00
|
|
|
extern TupleDesc FetchPreparedStatementResultDesc(PreparedStatement *stmt);
|
2005-06-22 19:45:46 +02:00
|
|
|
extern List *FetchPreparedStatementTargetList(PreparedStatement *stmt);
|
2003-05-05 02:44:56 +02:00
|
|
|
|
2002-09-04 22:31:48 +02:00
|
|
|
#endif /* PREPARE_H */
|