PostgreSQL Source Code  git master
prepare.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * prepare.h
4  * PREPARE, EXECUTE and DEALLOCATE commands, and prepared-stmt storage
5  *
6  *
7  * Copyright (c) 2002-2020, PostgreSQL Global Development Group
8  *
9  * src/include/commands/prepare.h
10  *
11  *-------------------------------------------------------------------------
12  */
13 #ifndef PREPARE_H
14 #define PREPARE_H
15 
16 #include "commands/explain.h"
17 #include "datatype/timestamp.h"
18 #include "utils/plancache.h"
19 
20 /*
21  * The data structure representing a prepared statement. This is now just
22  * a thin veneer over a plancache entry --- the main addition is that of
23  * a name.
24  *
25  * Note: all subsidiary storage lives in the referenced plancache entry.
26  */
27 typedef struct
28 {
29  /* dynahash.c requires key to be first field */
30  char stmt_name[NAMEDATALEN];
31  CachedPlanSource *plansource; /* the actual cached plan */
32  bool from_sql; /* prepared via SQL, not FE/BE protocol? */
33  TimestampTz prepare_time; /* the time when the stmt was prepared */
35 
36 
37 /* Utility statements PREPARE, EXECUTE, DEALLOCATE, EXPLAIN EXECUTE */
38 extern void PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
39  int stmt_location, int stmt_len);
40 extern void ExecuteQuery(ParseState *pstate,
41  ExecuteStmt *stmt, IntoClause *intoClause,
42  ParamListInfo params,
44 extern void DeallocateQuery(DeallocateStmt *stmt);
45 extern void ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into,
46  ExplainState *es, const char *queryString,
47  ParamListInfo params, QueryEnvironment *queryEnv);
48 
49 /* Low-level access to stored prepared statements */
50 extern void StorePreparedStatement(const char *stmt_name,
51  CachedPlanSource *plansource,
52  bool from_sql);
53 extern PreparedStatement *FetchPreparedStatement(const char *stmt_name,
54  bool throwError);
55 extern void DropPreparedStatement(const char *stmt_name, bool showError);
58 
59 extern void DropAllPreparedStatements(void);
60 
61 #endif /* PREPARE_H */
PreparedStatement * FetchPreparedStatement(const char *stmt_name, bool throwError)
Definition: prepare.c:469
void PrepareQuery(ParseState *pstate, PrepareStmt *stmt, int stmt_location, int stmt_len)
Definition: prepare.c:58
CachedPlanSource * plansource
Definition: prepare.h:31
int64 TimestampTz
Definition: timestamp.h:39
void ExecuteQuery(ParseState *pstate, ExecuteStmt *stmt, IntoClause *intoClause, ParamListInfo params, DestReceiver *dest, QueryCompletion *qc)
Definition: prepare.c:187
void ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition: prepare.c:606
void DropAllPreparedStatements(void)
Definition: prepare.c:575
#define NAMEDATALEN
TupleDesc FetchPreparedStatementResultDesc(PreparedStatement *stmt)
Definition: prepare.c:501
void DeallocateQuery(DeallocateStmt *stmt)
Definition: prepare.c:540
void StorePreparedStatement(const char *stmt_name, CachedPlanSource *plansource, bool from_sql)
Definition: prepare.c:427
List * FetchPreparedStatementTargetList(PreparedStatement *stmt)
Definition: prepare.c:524
TimestampTz prepare_time
Definition: prepare.h:33
void DropPreparedStatement(const char *stmt_name, bool showError)
Definition: prepare.c:554
Definition: pg_list.h:50