d4382c4ae7
The original syntax made it difficult to add options without making them into reserved words. This change parenthesizes the options to avoid that problem, and makes provision for an explicit (and perhaps non-Boolean) value for each option. The original syntax is still supported, but only for the two original options ANALYZE and VERBOSE. As a test case, add a COSTS option that can suppress the planner cost estimates. This may be useful for including EXPLAIN output in the regression tests, which are otherwise unable to cope with cross-platform variations in cost estimates. Robert Haas
65 lines
2.2 KiB
C
65 lines
2.2 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* prepare.h
|
|
* PREPARE, EXECUTE and DEALLOCATE commands, and prepared-stmt storage
|
|
*
|
|
*
|
|
* Copyright (c) 2002-2009, PostgreSQL Global Development Group
|
|
*
|
|
* $PostgreSQL: pgsql/src/include/commands/prepare.h,v 1.31 2009/07/26 23:34:18 tgl Exp $
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef PREPARE_H
|
|
#define PREPARE_H
|
|
|
|
#include "commands/explain.h"
|
|
#include "utils/plancache.h"
|
|
#include "utils/timestamp.h"
|
|
|
|
/*
|
|
* 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.
|
|
*
|
|
* Note: all subsidiary storage lives in the referenced plancache entry.
|
|
*/
|
|
typedef struct
|
|
{
|
|
/* dynahash.c requires key to be first field */
|
|
char stmt_name[NAMEDATALEN];
|
|
CachedPlanSource *plansource; /* the actual cached plan */
|
|
bool from_sql; /* prepared via SQL, not FE/BE protocol? */
|
|
TimestampTz prepare_time; /* the time when the stmt was prepared */
|
|
} PreparedStatement;
|
|
|
|
|
|
/* Utility statements PREPARE, EXECUTE, DEALLOCATE, EXPLAIN EXECUTE */
|
|
extern void PrepareQuery(PrepareStmt *stmt, const char *queryString);
|
|
extern void ExecuteQuery(ExecuteStmt *stmt, const char *queryString,
|
|
ParamListInfo params,
|
|
DestReceiver *dest, char *completionTag);
|
|
extern void DeallocateQuery(DeallocateStmt *stmt);
|
|
extern void ExplainExecuteQuery(ExecuteStmt *execstmt, ExplainState *es,
|
|
const char *queryString, ParamListInfo params);
|
|
|
|
/* Low-level access to stored prepared statements */
|
|
extern void StorePreparedStatement(const char *stmt_name,
|
|
Node *raw_parse_tree,
|
|
const char *query_string,
|
|
const char *commandTag,
|
|
Oid *param_types,
|
|
int num_params,
|
|
int cursor_options,
|
|
List *stmt_list,
|
|
bool from_sql);
|
|
extern PreparedStatement *FetchPreparedStatement(const char *stmt_name,
|
|
bool throwError);
|
|
extern void DropPreparedStatement(const char *stmt_name, bool showError);
|
|
extern TupleDesc FetchPreparedStatementResultDesc(PreparedStatement *stmt);
|
|
extern List *FetchPreparedStatementTargetList(PreparedStatement *stmt);
|
|
|
|
void DropAllPreparedStatements(void);
|
|
|
|
#endif /* PREPARE_H */
|