PostgreSQL Source Code git master
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
tcopprot.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * tcopprot.h
4 * prototypes for postgres.c.
5 *
6 *
7 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
9 *
10 * src/include/tcop/tcopprot.h
11 *
12 *-------------------------------------------------------------------------
13 */
14#ifndef TCOPPROT_H
15#define TCOPPROT_H
16
17#include "nodes/params.h"
18#include "nodes/plannodes.h"
19#include "storage/procsignal.h"
20#include "utils/guc.h"
21#include "utils/queryenvironment.h"
22
23
24extern PGDLLIMPORT CommandDest whereToSendOutput;
25extern PGDLLIMPORT const char *debug_query_string;
26extern PGDLLIMPORT int PostAuthDelay;
27extern PGDLLIMPORT int client_connection_check_interval;
28
29/* GUC-configurable parameters */
30
31typedef enum
32{
33 LOGSTMT_NONE, /* log no statements */
34 LOGSTMT_DDL, /* log data definition statements */
35 LOGSTMT_MOD, /* log modification statements, plus DDL */
36 LOGSTMT_ALL, /* log all statements */
37} LogStmtLevel;
38
39extern PGDLLIMPORT bool Log_disconnections;
40extern PGDLLIMPORT int log_statement;
41
42/* Flags for restrict_nonsystem_relation_kind value */
43#define RESTRICT_RELKIND_VIEW 0x01
44#define RESTRICT_RELKIND_FOREIGN_TABLE 0x02
45
46extern PGDLLIMPORT int restrict_nonsystem_relation_kind;
47
48extern List *pg_parse_query(const char *query_string);
49extern List *pg_rewrite_query(Query *query);
50extern List *pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree,
51 const char *query_string,
52 const Oid *paramTypes, int numParams,
53 QueryEnvironment *queryEnv);
54extern List *pg_analyze_and_rewrite_varparams(RawStmt *parsetree,
55 const char *query_string,
56 Oid **paramTypes,
57 int *numParams,
58 QueryEnvironment *queryEnv);
59extern List *pg_analyze_and_rewrite_withcb(RawStmt *parsetree,
60 const char *query_string,
61 ParserSetupHook parserSetup,
62 void *parserSetupArg,
63 QueryEnvironment *queryEnv);
64extern PlannedStmt *pg_plan_query(Query *querytree, const char *query_string,
65 int cursorOptions,
66 ParamListInfo boundParams);
67extern List *pg_plan_queries(List *querytrees, const char *query_string,
68 int cursorOptions,
69 ParamListInfo boundParams);
70
71extern void die(SIGNAL_ARGS);
72pg_noreturn extern void quickdie(SIGNAL_ARGS);
73extern void StatementCancelHandler(SIGNAL_ARGS);
74pg_noreturn extern void FloatExceptionHandler(SIGNAL_ARGS);
75extern void HandleRecoveryConflictInterrupt(ProcSignalReason reason);
76extern void ProcessClientReadInterrupt(bool blocked);
77extern void ProcessClientWriteInterrupt(bool blocked);
78
79extern void process_postgres_switches(int argc, char *argv[],
80 GucContext ctx, const char **dbname);
81pg_noreturn extern void PostgresSingleUserMain(int argc, char *argv[],
82 const char *username);
83pg_noreturn extern void PostgresMain(const char *dbname,
84 const char *username);
85extern void ResetUsage(void);
86extern void ShowUsage(const char *title);
87extern int check_log_duration(char *msec_str, bool was_logged);
88extern void set_debug_options(int debug_flag,
89 GucContext context, GucSource source);
90extern bool set_plan_disabling_options(const char *arg,
91 GucContext context, GucSource source);
92extern const char *get_stats_option_name(const char *arg);
93
94#endif /* TCOPPROT_H */
querytree
Datum querytree(PG_FUNCTION_ARGS)
Definition: _int_bool.c:665
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1291
pg_noreturn
#define pg_noreturn
Definition: c.h:165
SIGNAL_ARGS
#define SIGNAL_ARGS
Definition: c.h:1320
CommandDest
CommandDest
Definition: dest.h:86
GucSource
GucSource
Definition: guc.h:112
GucContext
GucContext
Definition: guc.h:72
username
static char * username
Definition: initdb.c:153
ParserSetupHook
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
arg
void * arg
Definition: pg_backup_utils.c:29
source
static rewind_source * source
Definition: pg_rewind.c:89
Oid
unsigned int Oid
Definition: postgres_ext.h:30
ProcSignalReason
ProcSignalReason
Definition: procsignal.h:31
dbname
char * dbname
Definition: streamutil.c:49
List
Definition: pg_list.h:54
pg_plan_query
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:882
pg_analyze_and_rewrite_withcb
List * pg_analyze_and_rewrite_withcb(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:758
pg_parse_query
List * pg_parse_query(const char *query_string)
Definition: postgres.c:603
process_postgres_switches
void process_postgres_switches(int argc, char *argv[], GucContext ctx, const char **dbname)
Definition: postgres.c:3786
PostAuthDelay
PGDLLIMPORT int PostAuthDelay
Definition: postgres.c:99
restrict_nonsystem_relation_kind
PGDLLIMPORT int restrict_nonsystem_relation_kind
Definition: postgres.c:105
PostgresSingleUserMain
pg_noreturn void PostgresSingleUserMain(int argc, char *argv[], const char *username)
Definition: postgres.c:4051
pg_plan_queries
List * pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:970
set_debug_options
void set_debug_options(int debug_flag, GucContext context, GucSource source)
Definition: postgres.c:3675
debug_query_string
PGDLLIMPORT const char * debug_query_string
Definition: postgres.c:88
StatementCancelHandler
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:3058
set_plan_disabling_options
bool set_plan_disabling_options(const char *arg, GucContext context, GucSource source)
Definition: postgres.c:3704
pg_analyze_and_rewrite_fixedparams
List * pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree, const char *query_string, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:665
check_log_duration
int check_log_duration(char *msec_str, bool was_logged)
Definition: postgres.c:2425
get_stats_option_name
const char * get_stats_option_name(const char *arg)
Definition: postgres.c:3746
PostgresMain
pg_noreturn void PostgresMain(const char *dbname, const char *username)
Definition: postgres.c:4180
HandleRecoveryConflictInterrupt
void HandleRecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:3091
pg_rewrite_query
List * pg_rewrite_query(Query *query)
Definition: postgres.c:798
LogStmtLevel
LogStmtLevel
Definition: tcopprot.h:32
LOGSTMT_NONE
@ LOGSTMT_NONE
Definition: tcopprot.h:33
LOGSTMT_MOD
@ LOGSTMT_MOD
Definition: tcopprot.h:35
LOGSTMT_DDL
@ LOGSTMT_DDL
Definition: tcopprot.h:34
LOGSTMT_ALL
@ LOGSTMT_ALL
Definition: tcopprot.h:36
ShowUsage
void ShowUsage(const char *title)
Definition: postgres.c:5050
log_statement
PGDLLIMPORT int log_statement
Definition: postgres.c:96
die
void die(SIGNAL_ARGS)
Definition: postgres.c:3028
ProcessClientReadInterrupt
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:501
FloatExceptionHandler
pg_noreturn void FloatExceptionHandler(SIGNAL_ARGS)
Definition: postgres.c:3075
ProcessClientWriteInterrupt
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:547
ResetUsage
void ResetUsage(void)
Definition: postgres.c:5043
Log_disconnections
PGDLLIMPORT bool Log_disconnections
Definition: postgres.c:94
whereToSendOutput
PGDLLIMPORT CommandDest whereToSendOutput
Definition: postgres.c:91
client_connection_check_interval
PGDLLIMPORT int client_connection_check_interval
Definition: postgres.c:102
pg_analyze_and_rewrite_varparams
List * pg_analyze_and_rewrite_varparams(RawStmt *parsetree, const char *query_string, Oid **paramTypes, int *numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:704
quickdie
pg_noreturn void quickdie(SIGNAL_ARGS)
Definition: postgres.c:2931