PostgreSQL Source Code  git master
prepare.c File Reference
#include "postgres.h"
#include <limits.h>
#include "access/xact.h"
#include "catalog/pg_type.h"
#include "commands/createas.h"
#include "commands/prepare.h"
#include "miscadmin.h"
#include "nodes/nodeFuncs.h"
#include "parser/analyze.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
#include "parser/parse_type.h"
#include "rewrite/rewriteHandler.h"
#include "tcop/pquery.h"
#include "tcop/utility.h"
#include "utils/builtins.h"
#include "utils/snapmgr.h"
#include "utils/timestamp.h"
Include dependency graph for prepare.c:

Go to the source code of this file.

Functions

static void InitQueryHashTable (void)
 
static ParamListInfo EvaluateParams (ParseState *pstate, PreparedStatement *pstmt, List *params, EState *estate)
 
static Datum build_regtype_array (Oid *param_types, int num_params)
 
void PrepareQuery (ParseState *pstate, PrepareStmt *stmt, int stmt_location, int stmt_len)
 
void ExecuteQuery (ParseState *pstate, ExecuteStmt *stmt, IntoClause *intoClause, ParamListInfo params, DestReceiver *dest, QueryCompletion *qc)
 
void StorePreparedStatement (const char *stmt_name, CachedPlanSource *plansource, bool from_sql)
 
PreparedStatementFetchPreparedStatement (const char *stmt_name, bool throwError)
 
TupleDesc FetchPreparedStatementResultDesc (PreparedStatement *stmt)
 
ListFetchPreparedStatementTargetList (PreparedStatement *stmt)
 
void DeallocateQuery (DeallocateStmt *stmt)
 
void DropPreparedStatement (const char *stmt_name, bool showError)
 
void DropAllPreparedStatements (void)
 
void ExplainExecuteQuery (ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
 
Datum pg_prepared_statement (PG_FUNCTION_ARGS)
 

Variables

static HTABprepared_queries = NULL
 

Function Documentation

◆ build_regtype_array()

static Datum build_regtype_array ( Oid param_types,
int  num_params 
)
static

Definition at line 796 of file prepare.c.

References construct_array(), i, ObjectIdGetDatum, palloc(), and PointerGetDatum.

Referenced by pg_prepared_statement().

797 {
798  Datum *tmp_ary;
799  ArrayType *result;
800  int i;
801 
802  tmp_ary = (Datum *) palloc(num_params * sizeof(Datum));
803 
804  for (i = 0; i < num_params; i++)
805  tmp_ary[i] = ObjectIdGetDatum(param_types[i]);
806 
807  /* XXX: this hardcodes assumptions about the regtype type */
808  result = construct_array(tmp_ary, num_params, REGTYPEOID,
809  4, true, TYPALIGN_INT);
810  return PointerGetDatum(result);
811 }
#define PointerGetDatum(X)
Definition: postgres.h:600
ArrayType * construct_array(Datum *elems, int nelems, Oid elmtype, int elmlen, bool elmbyval, char elmalign)
Definition: arrayfuncs.c:3318
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
uintptr_t Datum
Definition: postgres.h:411
void * palloc(Size size)
Definition: mcxt.c:1062
int i

◆ DeallocateQuery()

void DeallocateQuery ( DeallocateStmt stmt)

Definition at line 538 of file prepare.c.

References DropAllPreparedStatements(), DropPreparedStatement(), and DeallocateStmt::name.

Referenced by standard_ProcessUtility().

539 {
540  if (stmt->name)
541  DropPreparedStatement(stmt->name, true);
542  else
544 }
void DropAllPreparedStatements(void)
Definition: prepare.c:573
void DropPreparedStatement(const char *stmt_name, bool showError)
Definition: prepare.c:552

◆ DropAllPreparedStatements()

void DropAllPreparedStatements ( void  )

Definition at line 573 of file prepare.c.

References DropCachedPlan(), HASH_REMOVE, hash_search(), hash_seq_init(), hash_seq_search(), PreparedStatement::plansource, and PreparedStatement::stmt_name.

Referenced by DeallocateQuery(), and DiscardAll().

574 {
575  HASH_SEQ_STATUS seq;
576  PreparedStatement *entry;
577 
578  /* nothing cached */
579  if (!prepared_queries)
580  return;
581 
582  /* walk over cache */
584  while ((entry = hash_seq_search(&seq)) != NULL)
585  {
586  /* Release the plancache entry */
587  DropCachedPlan(entry->plansource);
588 
589  /* Now we can remove the hash table entry */
591  }
592 }
CachedPlanSource * plansource
Definition: prepare.h:31
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:954
static HTAB * prepared_queries
Definition: prepare.c:46
char stmt_name[NAMEDATALEN]
Definition: prepare.h:30
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1436
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1426
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:498

◆ DropPreparedStatement()

void DropPreparedStatement ( const char *  stmt_name,
bool  showError 
)

Definition at line 552 of file prepare.c.

References DropCachedPlan(), FetchPreparedStatement(), HASH_REMOVE, hash_search(), PreparedStatement::plansource, and PreparedStatement::stmt_name.

Referenced by DeallocateQuery(), and PostgresMain().

553 {
554  PreparedStatement *entry;
555 
556  /* Find the query's hash table entry; raise error if wanted */
557  entry = FetchPreparedStatement(stmt_name, showError);
558 
559  if (entry)
560  {
561  /* Release the plancache entry */
562  DropCachedPlan(entry->plansource);
563 
564  /* Now we can remove the hash table entry */
566  }
567 }
CachedPlanSource * plansource
Definition: prepare.h:31
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:954
static HTAB * prepared_queries
Definition: prepare.c:46
char stmt_name[NAMEDATALEN]
Definition: prepare.h:30
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:498
PreparedStatement * FetchPreparedStatement(const char *stmt_name, bool throwError)
Definition: prepare.c:467

◆ EvaluateParams()

static ParamListInfo EvaluateParams ( ParseState pstate,
PreparedStatement pstmt,
List params,
EState estate 
)
static

Definition at line 314 of file prepare.c.

References assign_expr_collations(), COERCE_IMPLICIT_CAST, coerce_to_target_type(), COERCION_ASSIGNMENT, copyObject, ereport, errcode(), errdetail(), errhint(), errmsg(), ERROR, ExecEvalExprSwitchContext(), ExecPrepareExprList(), EXPR_KIND_EXECUTE_PARAMETER, exprLocation(), exprType(), format_type_be(), GetPerTupleExprContext, i, ParamExternData::isnull, lfirst, list_length(), makeParamList(), CachedPlanSource::num_params, PARAM_FLAG_CONST, CachedPlanSource::param_types, ParamListInfoData::params, parser_errposition(), ParamExternData::pflags, PreparedStatement::plansource, ParamExternData::ptype, PreparedStatement::stmt_name, transformExpr(), and ParamExternData::value.

Referenced by ExecuteQuery(), and ExplainExecuteQuery().

316 {
317  Oid *param_types = pstmt->plansource->param_types;
318  int num_params = pstmt->plansource->num_params;
319  int nparams = list_length(params);
320  ParamListInfo paramLI;
321  List *exprstates;
322  ListCell *l;
323  int i;
324 
325  if (nparams != num_params)
326  ereport(ERROR,
327  (errcode(ERRCODE_SYNTAX_ERROR),
328  errmsg("wrong number of parameters for prepared statement \"%s\"",
329  pstmt->stmt_name),
330  errdetail("Expected %d parameters but got %d.",
331  num_params, nparams)));
332 
333  /* Quick exit if no parameters */
334  if (num_params == 0)
335  return NULL;
336 
337  /*
338  * We have to run parse analysis for the expressions. Since the parser is
339  * not cool about scribbling on its input, copy first.
340  */
341  params = copyObject(params);
342 
343  i = 0;
344  foreach(l, params)
345  {
346  Node *expr = lfirst(l);
347  Oid expected_type_id = param_types[i];
348  Oid given_type_id;
349 
350  expr = transformExpr(pstate, expr, EXPR_KIND_EXECUTE_PARAMETER);
351 
352  given_type_id = exprType(expr);
353 
354  expr = coerce_to_target_type(pstate, expr, given_type_id,
355  expected_type_id, -1,
358  -1);
359 
360  if (expr == NULL)
361  ereport(ERROR,
362  (errcode(ERRCODE_DATATYPE_MISMATCH),
363  errmsg("parameter $%d of type %s cannot be coerced to the expected type %s",
364  i + 1,
365  format_type_be(given_type_id),
366  format_type_be(expected_type_id)),
367  errhint("You will need to rewrite or cast the expression."),
368  parser_errposition(pstate, exprLocation(lfirst(l)))));
369 
370  /* Take care of collations in the finished expression. */
371  assign_expr_collations(pstate, expr);
372 
373  lfirst(l) = expr;
374  i++;
375  }
376 
377  /* Prepare the expressions for execution */
378  exprstates = ExecPrepareExprList(params, estate);
379 
380  paramLI = makeParamList(num_params);
381 
382  i = 0;
383  foreach(l, exprstates)
384  {
385  ExprState *n = (ExprState *) lfirst(l);
386  ParamExternData *prm = &paramLI->params[i];
387 
388  prm->ptype = param_types[i];
389  prm->pflags = PARAM_FLAG_CONST;
391  GetPerTupleExprContext(estate),
392  &prm->isnull);
393 
394  i++;
395  }
396 
397  return paramLI;
398 }
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
static Datum ExecEvalExprSwitchContext(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:330
int errhint(const char *fmt,...)
Definition: elog.c:1156
int exprLocation(const Node *expr)
Definition: nodeFuncs.c:1250
CachedPlanSource * plansource
Definition: prepare.h:31
Node * transformExpr(ParseState *pstate, Node *expr, ParseExprKind exprKind)
Definition: parse_expr.c:94
Definition: nodes.h:539
int errcode(int sqlerrcode)
Definition: elog.c:698
char * format_type_be(Oid type_oid)
Definition: format_type.c:339
unsigned int Oid
Definition: postgres_ext.h:31
ParamListInfo makeParamList(int numParams)
Definition: params.c:44
void assign_expr_collations(ParseState *pstate, Node *expr)
#define GetPerTupleExprContext(estate)
Definition: executor.h:532
char stmt_name[NAMEDATALEN]
Definition: prepare.h:30
#define ERROR
Definition: elog.h:46
Node * coerce_to_target_type(ParseState *pstate, Node *expr, Oid exprtype, Oid targettype, int32 targettypmod, CoercionContext ccontext, CoercionForm cformat, int location)
Definition: parse_coerce.c:78
int errdetail(const char *fmt,...)
Definition: elog.c:1042
List * ExecPrepareExprList(List *nodes, EState *estate)
Definition: execExpr.c:766
#define ereport(elevel,...)
Definition: elog.h:157
#define lfirst(lc)
Definition: pg_list.h:169
uint16 pflags
Definition: params.h:94
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:41
static int list_length(const List *l)
Definition: pg_list.h:149
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:111
int errmsg(const char *fmt,...)
Definition: elog.c:909
int i
#define copyObject(obj)
Definition: nodes.h:655
Definition: pg_list.h:50
bool isnull
Definition: params.h:93
#define PARAM_FLAG_CONST
Definition: params.h:88

◆ ExecuteQuery()

void ExecuteQuery ( ParseState pstate,
ExecuteStmt stmt,
IntoClause intoClause,
ParamListInfo  params,
DestReceiver dest,
QueryCompletion qc 
)

Definition at line 187 of file prepare.c.

References CMD_SELECT, CachedPlanSource::commandTag, PlannedStmt::commandType, CreateExecutorState(), CreateNewPortal(), elog, ereport, errcode(), errmsg(), ERROR, EState::es_param_list_info, EvaluateParams(), FETCH_ALL, FetchPreparedStatement(), CachedPlanSource::fixed_result, FreeExecutorState(), GetActiveSnapshot(), GetCachedPlan(), GetIntoRelEFlags(), linitial_node, list_length(), MemoryContextStrdup(), ExecuteStmt::name, CachedPlanSource::num_params, ExecuteStmt::params, PreparedStatement::plansource, PortalData::portalContext, PortalDefineQuery(), PortalDrop(), PortalRun(), PortalStart(), CachedPlanSource::query_string, IntoClause::skipData, CachedPlan::stmt_list, and PortalData::visible.

Referenced by ExecCreateTableAs(), and standard_ProcessUtility().

191 {
192  PreparedStatement *entry;
193  CachedPlan *cplan;
194  List *plan_list;
195  ParamListInfo paramLI = NULL;
196  EState *estate = NULL;
197  Portal portal;
198  char *query_string;
199  int eflags;
200  long count;
201 
202  /* Look it up in the hash table */
203  entry = FetchPreparedStatement(stmt->name, true);
204 
205  /* Shouldn't find a non-fixed-result cached plan */
206  if (!entry->plansource->fixed_result)
207  elog(ERROR, "EXECUTE does not support variable-result cached plans");
208 
209  /* Evaluate parameters, if any */
210  if (entry->plansource->num_params > 0)
211  {
212  /*
213  * Need an EState to evaluate parameters; must not delete it till end
214  * of query, in case parameters are pass-by-reference. Note that the
215  * passed-in "params" could possibly be referenced in the parameter
216  * expressions.
217  */
218  estate = CreateExecutorState();
219  estate->es_param_list_info = params;
220  paramLI = EvaluateParams(pstate, entry, stmt->params, estate);
221  }
222 
223  /* Create a new portal to run the query in */
224  portal = CreateNewPortal();
225  /* Don't display the portal in pg_cursors, it is for internal use only */
226  portal->visible = false;
227 
228  /* Copy the plan's saved query string into the portal's memory */
229  query_string = MemoryContextStrdup(portal->portalContext,
230  entry->plansource->query_string);
231 
232  /* Replan if needed, and increment plan refcount for portal */
233  cplan = GetCachedPlan(entry->plansource, paramLI, NULL, NULL);
234  plan_list = cplan->stmt_list;
235 
236  /*
237  * For CREATE TABLE ... AS EXECUTE, we must verify that the prepared
238  * statement is one that produces tuples. Currently we insist that it be
239  * a plain old SELECT. In future we might consider supporting other
240  * things such as INSERT ... RETURNING, but there are a couple of issues
241  * to be settled first, notably how WITH NO DATA should be handled in such
242  * a case (do we really want to suppress execution?) and how to pass down
243  * the OID-determining eflags (PortalStart won't handle them in such a
244  * case, and for that matter it's not clear the executor will either).
245  *
246  * For CREATE TABLE ... AS EXECUTE, we also have to ensure that the proper
247  * eflags and fetch count are passed to PortalStart/PortalRun.
248  */
249  if (intoClause)
250  {
251  PlannedStmt *pstmt;
252 
253  if (list_length(plan_list) != 1)
254  ereport(ERROR,
255  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
256  errmsg("prepared statement is not a SELECT")));
257  pstmt = linitial_node(PlannedStmt, plan_list);
258  if (pstmt->commandType != CMD_SELECT)
259  ereport(ERROR,
260  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
261  errmsg("prepared statement is not a SELECT")));
262 
263  /* Set appropriate eflags */
264  eflags = GetIntoRelEFlags(intoClause);
265 
266  /* And tell PortalRun whether to run to completion or not */
267  if (intoClause->skipData)
268  count = 0;
269  else
270  count = FETCH_ALL;
271  }
272  else
273  {
274  /* Plain old EXECUTE */
275  eflags = 0;
276  count = FETCH_ALL;
277  }
278 
279  PortalDefineQuery(portal,
280  NULL,
281  query_string,
282  entry->plansource->commandTag,
283  plan_list,
284  cplan);
285 
286  /*
287  * Run the portal as appropriate.
288  */
289  PortalStart(portal, paramLI, eflags, GetActiveSnapshot());
290 
291  (void) PortalRun(portal, count, false, true, dest, dest, qc);
292 
293  PortalDrop(portal, false);
294 
295  if (estate)
296  FreeExecutorState(estate);
297 
298  /* No need to pfree other memory, MemoryContext will be reset */
299 }
Portal CreateNewPortal(void)
Definition: portalmem.c:234
void PortalStart(Portal portal, ParamListInfo params, int eflags, Snapshot snapshot)
Definition: pquery.c:430
bool visible
Definition: portal.h:196
CachedPlanSource * plansource
Definition: prepare.h:31
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:786
static ParamListInfo EvaluateParams(ParseState *pstate, PreparedStatement *pstmt, List *params, EState *estate)
Definition: prepare.c:314
int errcode(int sqlerrcode)
Definition: elog.c:698
bool skipData
Definition: primnodes.h:119
void PortalDefineQuery(Portal portal, const char *prepStmtName, const char *sourceText, CommandTag commandTag, List *stmts, CachedPlan *cplan)
Definition: portalmem.c:281
#define linitial_node(type, l)
Definition: pg_list.h:177
MemoryContext portalContext
Definition: portal.h:120
bool PortalRun(Portal portal, long count, bool isTopLevel, bool run_once, DestReceiver *dest, DestReceiver *altdest, QueryCompletion *qc)
Definition: pquery.c:672
void FreeExecutorState(EState *estate)
Definition: execUtils.c:186
int GetIntoRelEFlags(IntoClause *intoClause)
Definition: createas.c:381
#define ERROR
Definition: elog.h:46
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv)
Definition: plancache.c:1141
EState * CreateExecutorState(void)
Definition: execUtils.c:90
CmdType commandType
Definition: plannodes.h:46
#define ereport(elevel,...)
Definition: elog.h:157
const char * query_string
Definition: plancache.h:100
CommandTag commandTag
Definition: plancache.h:101
static int list_length(const List *l)
Definition: pg_list.h:149
int errmsg(const char *fmt,...)
Definition: elog.c:909
void PortalDrop(Portal portal, bool isTopCommit)
Definition: portalmem.c:467
char * MemoryContextStrdup(MemoryContext context, const char *string)
Definition: mcxt.c:1286
#define elog(elevel,...)
Definition: elog.h:232
char * name
Definition: parsenodes.h:3523
ParamListInfo es_param_list_info
Definition: execnodes.h:592
List * params
Definition: parsenodes.h:3524
List * stmt_list
Definition: plancache.h:150
PreparedStatement * FetchPreparedStatement(const char *stmt_name, bool throwError)
Definition: prepare.c:467
Definition: pg_list.h:50
#define FETCH_ALL
Definition: parsenodes.h:2830

◆ ExplainExecuteQuery()

void ExplainExecuteQuery ( ExecuteStmt execstmt,
IntoClause into,
ExplainState es,
const char *  queryString,
ParamListInfo  params,
QueryEnvironment queryEnv 
)

Definition at line 604 of file prepare.c.

References ExplainState::buffers, BufferUsageAccumDiff(), CMD_UTILITY, PlannedStmt::commandType, CreateExecutorState(), CurrentResourceOwner, elog, ERROR, EState::es_param_list_info, EvaluateParams(), ExplainOnePlan(), ExplainOneUtility(), ExplainSeparatePlans(), FetchPreparedStatement(), CachedPlanSource::fixed_result, FreeExecutorState(), GetCachedPlan(), INSTR_TIME_SET_CURRENT, INSTR_TIME_SUBTRACT, lfirst_node, lnext(), make_parsestate(), ExecuteStmt::name, CachedPlanSource::num_params, ParseState::p_sourcetext, ExecuteStmt::params, pgBufferUsage, PreparedStatement::plansource, CachedPlanSource::query_string, ReleaseCachedPlan(), CachedPlan::stmt_list, and PlannedStmt::utilityStmt.

Referenced by ExplainOneUtility().

607 {
608  PreparedStatement *entry;
609  const char *query_string;
610  CachedPlan *cplan;
611  List *plan_list;
612  ListCell *p;
613  ParamListInfo paramLI = NULL;
614  EState *estate = NULL;
615  instr_time planstart;
616  instr_time planduration;
617  BufferUsage bufusage_start,
618  bufusage;
619 
620  if (es->buffers)
621  bufusage_start = pgBufferUsage;
622  INSTR_TIME_SET_CURRENT(planstart);
623 
624  /* Look it up in the hash table */
625  entry = FetchPreparedStatement(execstmt->name, true);
626 
627  /* Shouldn't find a non-fixed-result cached plan */
628  if (!entry->plansource->fixed_result)
629  elog(ERROR, "EXPLAIN EXECUTE does not support variable-result cached plans");
630 
631  query_string = entry->plansource->query_string;
632 
633  /* Evaluate parameters, if any */
634  if (entry->plansource->num_params)
635  {
636  ParseState *pstate;
637 
638  pstate = make_parsestate(NULL);
639  pstate->p_sourcetext = queryString;
640 
641  /*
642  * Need an EState to evaluate parameters; must not delete it till end
643  * of query, in case parameters are pass-by-reference. Note that the
644  * passed-in "params" could possibly be referenced in the parameter
645  * expressions.
646  */
647  estate = CreateExecutorState();
648  estate->es_param_list_info = params;
649 
650  paramLI = EvaluateParams(pstate, entry, execstmt->params, estate);
651  }
652 
653  /* Replan if needed, and acquire a transient refcount */
654  cplan = GetCachedPlan(entry->plansource, paramLI,
655  CurrentResourceOwner, queryEnv);
656 
657  INSTR_TIME_SET_CURRENT(planduration);
658  INSTR_TIME_SUBTRACT(planduration, planstart);
659 
660  /* calc differences of buffer counters. */
661  if (es->buffers)
662  {
663  memset(&bufusage, 0, sizeof(BufferUsage));
664  BufferUsageAccumDiff(&bufusage, &pgBufferUsage, &bufusage_start);
665  }
666 
667  plan_list = cplan->stmt_list;
668 
669  /* Explain each query */
670  foreach(p, plan_list)
671  {
672  PlannedStmt *pstmt = lfirst_node(PlannedStmt, p);
673 
674  if (pstmt->commandType != CMD_UTILITY)
675  ExplainOnePlan(pstmt, into, es, query_string, paramLI, queryEnv,
676  &planduration, (es->buffers ? &bufusage : NULL));
677  else
678  ExplainOneUtility(pstmt->utilityStmt, into, es, query_string,
679  paramLI, queryEnv);
680 
681  /* No need for CommandCounterIncrement, as ExplainOnePlan did it */
682 
683  /* Separate plans with an appropriate separator */
684  if (lnext(plan_list, p) != NULL)
686  }
687 
688  if (estate)
689  FreeExecutorState(estate);
690 
692 }
void ExplainSeparatePlans(ExplainState *es)
Definition: explain.c:4804
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:322
CachedPlanSource * plansource
Definition: prepare.h:31
ResourceOwner CurrentResourceOwner
Definition: resowner.c:146
struct timeval instr_time
Definition: instr_time.h:150
static ParamListInfo EvaluateParams(ParseState *pstate, PreparedStatement *pstmt, List *params, EState *estate)
Definition: prepare.c:314
void ReleaseCachedPlan(CachedPlan *plan, ResourceOwner owner)
Definition: plancache.c:1264
void BufferUsageAccumDiff(BufferUsage *dst, const BufferUsage *add, const BufferUsage *sub)
Definition: instrument.c:225
ParseState * make_parsestate(ParseState *parentParseState)
Definition: parse_node.c:44
void FreeExecutorState(EState *estate)
Definition: execUtils.c:186
#define ERROR
Definition: elog.h:46
#define INSTR_TIME_SUBTRACT(x, y)
Definition: instr_time.h:170
#define lfirst_node(type, lc)
Definition: pg_list.h:172
Node * utilityStmt
Definition: plannodes.h:86
const char * p_sourcetext
Definition: parse_node.h:181
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv)
Definition: plancache.c:1141
EState * CreateExecutorState(void)
Definition: execUtils.c:90
CmdType commandType
Definition: plannodes.h:46
void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, const instr_time *planduration, const BufferUsage *bufusage)
Definition: explain.c:524
const char * query_string
Definition: plancache.h:100
#define INSTR_TIME_SET_CURRENT(t)
Definition: instr_time.h:156
#define elog(elevel,...)
Definition: elog.h:232
char * name
Definition: parsenodes.h:3523
bool buffers
Definition: explain.h:44
ParamListInfo es_param_list_info
Definition: execnodes.h:592
List * params
Definition: parsenodes.h:3524
List * stmt_list
Definition: plancache.h:150
PreparedStatement * FetchPreparedStatement(const char *stmt_name, bool throwError)
Definition: prepare.c:467
Definition: pg_list.h:50
void ExplainOneUtility(Node *utilityStmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition: explain.c:433
BufferUsage pgBufferUsage
Definition: instrument.c:20

◆ FetchPreparedStatement()

PreparedStatement* FetchPreparedStatement ( const char *  stmt_name,
bool  throwError 
)

Definition at line 467 of file prepare.c.

References ereport, errcode(), errmsg(), ERROR, HASH_FIND, and hash_search().

Referenced by DropPreparedStatement(), errdetail_execute(), exec_bind_message(), exec_describe_statement_message(), ExecuteQuery(), ExplainExecuteQuery(), FetchStatementTargetList(), GetCommandLogLevel(), UtilityReturnsTuples(), and UtilityTupleDescriptor().

468 {
469  PreparedStatement *entry;
470 
471  /*
472  * If the hash table hasn't been initialized, it can't be storing
473  * anything, therefore it couldn't possibly store our plan.
474  */
475  if (prepared_queries)
477  stmt_name,
478  HASH_FIND,
479  NULL);
480  else
481  entry = NULL;
482 
483  if (!entry && throwError)
484  ereport(ERROR,
485  (errcode(ERRCODE_UNDEFINED_PSTATEMENT),
486  errmsg("prepared statement \"%s\" does not exist",
487  stmt_name)));
488 
489  return entry;
490 }
int errcode(int sqlerrcode)
Definition: elog.c:698
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:954
static HTAB * prepared_queries
Definition: prepare.c:46
#define ERROR
Definition: elog.h:46
#define ereport(elevel,...)
Definition: elog.h:157
int errmsg(const char *fmt,...)
Definition: elog.c:909

◆ FetchPreparedStatementResultDesc()

TupleDesc FetchPreparedStatementResultDesc ( PreparedStatement stmt)

Definition at line 499 of file prepare.c.

References Assert, CreateTupleDescCopy(), CachedPlanSource::fixed_result, PreparedStatement::plansource, and CachedPlanSource::resultDesc.

Referenced by UtilityTupleDescriptor().

500 {
501  /*
502  * Since we don't allow prepared statements' result tupdescs to change,
503  * there's no need to worry about revalidating the cached plan here.
504  */
506  if (stmt->plansource->resultDesc)
508  else
509  return NULL;
510 }
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:111
CachedPlanSource * plansource
Definition: prepare.h:31
TupleDesc resultDesc
Definition: plancache.h:108
#define Assert(condition)
Definition: c.h:804

◆ FetchPreparedStatementTargetList()

List* FetchPreparedStatementTargetList ( PreparedStatement stmt)

Definition at line 522 of file prepare.c.

References CachedPlanGetTargetList(), copyObject, and PreparedStatement::plansource.

Referenced by FetchStatementTargetList().

523 {
524  List *tlist;
525 
526  /* Get the plan's primary targetlist */
527  tlist = CachedPlanGetTargetList(stmt->plansource, NULL);
528 
529  /* Copy into caller's context in case plan gets invalidated */
530  return copyObject(tlist);
531 }
CachedPlanSource * plansource
Definition: prepare.h:31
List * CachedPlanGetTargetList(CachedPlanSource *plansource, QueryEnvironment *queryEnv)
Definition: plancache.c:1611
#define copyObject(obj)
Definition: nodes.h:655
Definition: pg_list.h:50

◆ InitQueryHashTable()

static void InitQueryHashTable ( void  )
static

Definition at line 405 of file prepare.c.

References HASHCTL::entrysize, hash_create(), HASH_ELEM, HASH_STRINGS, HASHCTL::keysize, and NAMEDATALEN.

Referenced by StorePreparedStatement().

406 {
407  HASHCTL hash_ctl;
408 
409  hash_ctl.keysize = NAMEDATALEN;
410  hash_ctl.entrysize = sizeof(PreparedStatement);
411 
412  prepared_queries = hash_create("Prepared Queries",
413  32,
414  &hash_ctl,
416 }
#define HASH_ELEM
Definition: hsearch.h:95
Size entrysize
Definition: hsearch.h:76
#define NAMEDATALEN
static HTAB * prepared_queries
Definition: prepare.c:46
HTAB * hash_create(const char *tabname, long nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:349
Size keysize
Definition: hsearch.h:75
#define HASH_STRINGS
Definition: hsearch.h:96

◆ pg_prepared_statement()

Datum pg_prepared_statement ( PG_FUNCTION_ARGS  )

Definition at line 700 of file prepare.c.

References ReturnSetInfo::allowedModes, BoolGetDatum, build_regtype_array(), CreateTemplateTupleDesc(), CStringGetTextDatum, ReturnSetInfo::econtext, ExprContext::ecxt_per_query_memory, ereport, errcode(), errmsg(), ERROR, PreparedStatement::from_sql, hash_seq_init(), hash_seq_search(), Int64GetDatumFast, IsA, MemoryContextSwitchTo(), MemSet, CachedPlanSource::num_custom_plans, CachedPlanSource::num_generic_plans, CachedPlanSource::num_params, CachedPlanSource::param_types, PreparedStatement::plansource, PreparedStatement::prepare_time, CachedPlanSource::query_string, ReturnSetInfo::returnMode, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, SFRM_Materialize, SFRM_Materialize_Random, PreparedStatement::stmt_name, TimestampTzGetDatum, TupleDescInitEntry(), tuplestore_begin_heap(), tuplestore_donestoring, tuplestore_putvalues(), values, and work_mem.

701 {
702  ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
703  TupleDesc tupdesc;
704  Tuplestorestate *tupstore;
705  MemoryContext per_query_ctx;
706  MemoryContext oldcontext;
707 
708  /* check to see if caller supports us returning a tuplestore */
709  if (rsinfo == NULL || !IsA(rsinfo, ReturnSetInfo))
710  ereport(ERROR,
711  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
712  errmsg("set-valued function called in context that cannot accept a set")));
713  if (!(rsinfo->allowedModes & SFRM_Materialize))
714  ereport(ERROR,
715  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
716  errmsg("materialize mode required, but it is not allowed in this context")));
717 
718  /* need to build tuplestore in query context */
719  per_query_ctx = rsinfo->econtext->ecxt_per_query_memory;
720  oldcontext = MemoryContextSwitchTo(per_query_ctx);
721 
722  /*
723  * build tupdesc for result tuples. This must match the definition of the
724  * pg_prepared_statements view in system_views.sql
725  */
726  tupdesc = CreateTemplateTupleDesc(7);
727  TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
728  TEXTOID, -1, 0);
729  TupleDescInitEntry(tupdesc, (AttrNumber) 2, "statement",
730  TEXTOID, -1, 0);
731  TupleDescInitEntry(tupdesc, (AttrNumber) 3, "prepare_time",
732  TIMESTAMPTZOID, -1, 0);
733  TupleDescInitEntry(tupdesc, (AttrNumber) 4, "parameter_types",
734  REGTYPEARRAYOID, -1, 0);
735  TupleDescInitEntry(tupdesc, (AttrNumber) 5, "from_sql",
736  BOOLOID, -1, 0);
737  TupleDescInitEntry(tupdesc, (AttrNumber) 6, "generic_plans",
738  INT8OID, -1, 0);
739  TupleDescInitEntry(tupdesc, (AttrNumber) 7, "custom_plans",
740  INT8OID, -1, 0);
741 
742  /*
743  * We put all the tuples into a tuplestore in one scan of the hashtable.
744  * This avoids any issue of the hashtable possibly changing between calls.
745  */
746  tupstore =
748  false, work_mem);
749 
750  /* generate junk in short-term context */
751  MemoryContextSwitchTo(oldcontext);
752 
753  /* hash table might be uninitialized */
754  if (prepared_queries)
755  {
756  HASH_SEQ_STATUS hash_seq;
757  PreparedStatement *prep_stmt;
758 
759  hash_seq_init(&hash_seq, prepared_queries);
760  while ((prep_stmt = hash_seq_search(&hash_seq)) != NULL)
761  {
762  Datum values[7];
763  bool nulls[7];
764 
765  MemSet(nulls, 0, sizeof(nulls));
766 
767  values[0] = CStringGetTextDatum(prep_stmt->stmt_name);
768  values[1] = CStringGetTextDatum(prep_stmt->plansource->query_string);
769  values[2] = TimestampTzGetDatum(prep_stmt->prepare_time);
770  values[3] = build_regtype_array(prep_stmt->plansource->param_types,
771  prep_stmt->plansource->num_params);
772  values[4] = BoolGetDatum(prep_stmt->from_sql);
773  values[5] = Int64GetDatumFast(prep_stmt->plansource->num_generic_plans);
774  values[6] = Int64GetDatumFast(prep_stmt->plansource->num_custom_plans);
775 
776  tuplestore_putvalues(tupstore, tupdesc, values, nulls);
777  }
778  }
779 
780  /* clean up and return the tuplestore */
781  tuplestore_donestoring(tupstore);
782 
783  rsinfo->returnMode = SFRM_Materialize;
784  rsinfo->setResult = tupstore;
785  rsinfo->setDesc = tupdesc;
786 
787  return (Datum) 0;
788 }
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, Datum *values, bool *isnull)
Definition: tuplestore.c:750
#define IsA(nodeptr, _type_)
Definition: nodes.h:590
TupleDesc CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:45
CachedPlanSource * plansource
Definition: prepare.h:31
#define tuplestore_donestoring(state)
Definition: tuplestore.h:60
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
int errcode(int sqlerrcode)
Definition: elog.c:698
#define MemSet(start, val, len)
Definition: c.h:1008
int64 num_custom_plans
Definition: plancache.h:133
static HTAB * prepared_queries
Definition: prepare.c:46
char stmt_name[NAMEDATALEN]
Definition: prepare.h:30
#define ERROR
Definition: elog.h:46
#define TimestampTzGetDatum(X)
Definition: timestamp.h:32
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:580
static Datum build_regtype_array(Oid *param_types, int num_params)
Definition: prepare.c:796
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:318
uintptr_t Datum
Definition: postgres.h:411
#define Int64GetDatumFast(X)
Definition: postgres.h:804
int work_mem
Definition: globals.c:124
int64 num_generic_plans
Definition: plancache.h:134
#define BoolGetDatum(X)
Definition: postgres.h:446
#define ereport(elevel,...)
Definition: elog.h:157
int allowedModes
Definition: execnodes.h:305
TimestampTz prepare_time
Definition: prepare.h:33
SetFunctionReturnMode returnMode
Definition: execnodes.h:307
const char * query_string
Definition: plancache.h:100
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1436
MemoryContext ecxt_per_query_memory
Definition: execnodes.h:233
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1426
Tuplestorestate * setResult
Definition: execnodes.h:310
static Datum values[MAXATTR]
Definition: bootstrap.c:166
ExprContext * econtext
Definition: execnodes.h:303
TupleDesc setDesc
Definition: execnodes.h:311
int errmsg(const char *fmt,...)
Definition: elog.c:909
#define CStringGetTextDatum(s)
Definition: builtins.h:82
int16 AttrNumber
Definition: attnum.h:21

◆ PrepareQuery()

void PrepareQuery ( ParseState pstate,
PrepareStmt stmt,
int  stmt_location,
int  stmt_len 
)

Definition at line 58 of file prepare.c.

References PrepareStmt::argtypes, CMD_DELETE, CMD_INSERT, CMD_SELECT, CMD_UPDATE, Query::commandType, CompleteCachedPlan(), copyObject, CreateCachedPlan(), CreateCommandTag(), CURSOR_OPT_PARALLEL_OK, ereport, errcode(), errmsg(), ERROR, i, InvalidOid, lfirst, list_length(), makeNode, PrepareStmt::name, ParseState::p_sourcetext, palloc(), parse_analyze_varparams(), PrepareStmt::query, QueryRewrite(), RawStmt::stmt, RawStmt::stmt_len, RawStmt::stmt_location, StorePreparedStatement(), and typenameTypeId().

Referenced by standard_ProcessUtility().

60 {
61  RawStmt *rawstmt;
62  CachedPlanSource *plansource;
63  Oid *argtypes = NULL;
64  int nargs;
65  Query *query;
66  List *query_list;
67  int i;
68 
69  /*
70  * Disallow empty-string statement name (conflicts with protocol-level
71  * unnamed statement).
72  */
73  if (!stmt->name || stmt->name[0] == '\0')
74  ereport(ERROR,
75  (errcode(ERRCODE_INVALID_PSTATEMENT_DEFINITION),
76  errmsg("invalid statement name: must not be empty")));
77 
78  /*
79  * Need to wrap the contained statement in a RawStmt node to pass it to
80  * parse analysis.
81  *
82  * Because parse analysis scribbles on the raw querytree, we must make a
83  * copy to ensure we don't modify the passed-in tree. FIXME someday.
84  */
85  rawstmt = makeNode(RawStmt);
86  rawstmt->stmt = (Node *) copyObject(stmt->query);
87  rawstmt->stmt_location = stmt_location;
88  rawstmt->stmt_len = stmt_len;
89 
90  /*
91  * Create the CachedPlanSource before we do parse analysis, since it needs
92  * to see the unmodified raw parse tree.
93  */
94  plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
95  CreateCommandTag(stmt->query));
96 
97  /* Transform list of TypeNames to array of type OIDs */
98  nargs = list_length(stmt->argtypes);
99 
100  if (nargs)
101  {
102  ListCell *l;
103 
104  argtypes = (Oid *) palloc(nargs * sizeof(Oid));
105  i = 0;
106 
107  foreach(l, stmt->argtypes)
108  {
109  TypeName *tn = lfirst(l);
110  Oid toid = typenameTypeId(pstate, tn);
111 
112  argtypes[i++] = toid;
113  }
114  }
115 
116  /*
117  * Analyze the statement using these parameter types (any parameters
118  * passed in from above us will not be visible to it), allowing
119  * information about unknown parameters to be deduced from context.
120  */
121  query = parse_analyze_varparams(rawstmt, pstate->p_sourcetext,
122  &argtypes, &nargs);
123 
124  /*
125  * Check that all parameter types were determined.
126  */
127  for (i = 0; i < nargs; i++)
128  {
129  Oid argtype = argtypes[i];
130 
131  if (argtype == InvalidOid || argtype == UNKNOWNOID)
132  ereport(ERROR,
133  (errcode(ERRCODE_INDETERMINATE_DATATYPE),
134  errmsg("could not determine data type of parameter $%d",
135  i + 1)));
136  }
137 
138  /*
139  * grammar only allows PreparableStmt, so this check should be redundant
140  */
141  switch (query->commandType)
142  {
143  case CMD_SELECT:
144  case CMD_INSERT:
145  case CMD_UPDATE:
146  case CMD_DELETE:
147  /* OK */
148  break;
149  default:
150  ereport(ERROR,
151  (errcode(ERRCODE_INVALID_PSTATEMENT_DEFINITION),
152  errmsg("utility statements cannot be prepared")));
153  break;
154  }
155 
156  /* Rewrite the query. The result could be 0, 1, or many queries. */
157  query_list = QueryRewrite(query);
158 
159  /* Finish filling in the CachedPlanSource */
160  CompleteCachedPlan(plansource,
161  query_list,
162  NULL,
163  argtypes,
164  nargs,
165  NULL,
166  NULL,
167  CURSOR_OPT_PARALLEL_OK, /* allow parallel mode */
168  true); /* fixed result */
169 
170  /*
171  * Save the results.
172  */
174  plansource,
175  true);
176 }
List * QueryRewrite(Query *parsetree)
CachedPlanSource * CreateCachedPlan(RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
Definition: plancache.c:164
Definition: nodes.h:539
int errcode(int sqlerrcode)
Definition: elog.c:698
Query * parse_analyze_varparams(RawStmt *parseTree, const char *sourceText, Oid **paramTypes, int *numParams)
Definition: analyze.c:148
unsigned int Oid
Definition: postgres_ext.h:31
#define ERROR
Definition: elog.h:46
Node * stmt
Definition: parsenodes.h:1560
const char * p_sourcetext
Definition: parse_node.h:181
int stmt_len
Definition: parsenodes.h:1562
int stmt_location
Definition: parsenodes.h:1561
void StorePreparedStatement(const char *stmt_name, CachedPlanSource *plansource, bool from_sql)
Definition: prepare.c:425
#define InvalidOid
Definition: postgres_ext.h:36
#define ereport(elevel,...)
Definition: elog.h:157
CmdType commandType
Definition: parsenodes.h:120
#define makeNode(_type_)
Definition: nodes.h:587
char * name
Definition: parsenodes.h:3509
#define lfirst(lc)
Definition: pg_list.h:169
CommandTag CreateCommandTag(Node *parsetree)
Definition: utility.c:2297
void CompleteCachedPlan(CachedPlanSource *plansource, List *querytree_list, MemoryContext querytree_context, Oid *param_types, int num_params, ParserSetupHook parserSetup, void *parserSetupArg, int cursor_options, bool fixed_result)
Definition: plancache.c:338
Node * query
Definition: parsenodes.h:3511
static int list_length(const List *l)
Definition: pg_list.h:149
List * argtypes
Definition: parsenodes.h:3510
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:2795
void * palloc(Size size)
Definition: mcxt.c:1062
int errmsg(const char *fmt,...)
Definition: elog.c:909
int i
#define copyObject(obj)
Definition: nodes.h:655
Definition: pg_list.h:50
Oid typenameTypeId(ParseState *pstate, const TypeName *typeName)
Definition: parse_type.c:291

◆ StorePreparedStatement()

void StorePreparedStatement ( const char *  stmt_name,
CachedPlanSource plansource,
bool  from_sql 
)

Definition at line 425 of file prepare.c.

References ereport, errcode(), errmsg(), ERROR, PreparedStatement::from_sql, GetCurrentStatementStartTimestamp(), HASH_ENTER, hash_search(), InitQueryHashTable(), PreparedStatement::plansource, PreparedStatement::prepare_time, and SaveCachedPlan().

Referenced by exec_parse_message(), and PrepareQuery().

428 {
429  PreparedStatement *entry;
431  bool found;
432 
433  /* Initialize the hash table, if necessary */
434  if (!prepared_queries)
436 
437  /* Add entry to hash table */
439  stmt_name,
440  HASH_ENTER,
441  &found);
442 
443  /* Shouldn't get a duplicate entry */
444  if (found)
445  ereport(ERROR,
446  (errcode(ERRCODE_DUPLICATE_PSTATEMENT),
447  errmsg("prepared statement \"%s\" already exists",
448  stmt_name)));
449 
450  /* Fill in the hash table entry */
451  entry->plansource = plansource;
452  entry->from_sql = from_sql;
453  entry->prepare_time = cur_ts;
454 
455  /* Now it's safe to move the CachedPlanSource to permanent memory */
456  SaveCachedPlan(plansource);
457 }
static void InitQueryHashTable(void)
Definition: prepare.c:405
CachedPlanSource * plansource
Definition: prepare.h:31
int64 TimestampTz
Definition: timestamp.h:39
int errcode(int sqlerrcode)
Definition: elog.c:698
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:954
static HTAB * prepared_queries
Definition: prepare.c:46
#define ERROR
Definition: elog.h:46
#define ereport(elevel,...)
Definition: elog.h:157
void SaveCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:454
TimestampTz prepare_time
Definition: prepare.h:33
int errmsg(const char *fmt,...)
Definition: elog.c:909
TimestampTz GetCurrentStatementStartTimestamp(void)
Definition: xact.c:807

Variable Documentation

◆ prepared_queries

HTAB* prepared_queries = NULL
static

Definition at line 46 of file prepare.c.