PostgreSQL Source Code  git master
settings.h
Go to the documentation of this file.
1 /*
2  * psql - the PostgreSQL interactive terminal
3  *
4  * Copyright (c) 2000-2024, PostgreSQL Global Development Group
5  *
6  * src/bin/psql/settings.h
7  */
8 #ifndef SETTINGS_H
9 #define SETTINGS_H
10 
11 #include "fe_utils/print.h"
12 #include "variables.h"
13 
14 #define DEFAULT_CSV_FIELD_SEP ','
15 #define DEFAULT_FIELD_SEP "|"
16 #define DEFAULT_RECORD_SEP "\n"
17 
18 #if defined(WIN32) || defined(__CYGWIN__)
19 #define DEFAULT_EDITOR "notepad.exe"
20 /* no DEFAULT_EDITOR_LINENUMBER_ARG for Notepad */
21 #else
22 #define DEFAULT_EDITOR "vi"
23 #define DEFAULT_EDITOR_LINENUMBER_ARG "+"
24 #endif
25 
26 #define DEFAULT_PROMPT1 "%/%R%x%# "
27 #define DEFAULT_PROMPT2 "%/%R%x%# "
28 #define DEFAULT_PROMPT3 ">> "
29 
30 /*
31  * Note: these enums should generally be chosen so that zero corresponds
32  * to the default behavior.
33  */
34 
35 typedef enum
36 {
41 } PSQL_ECHO;
42 
43 typedef enum
44 {
49 
50 typedef enum
51 {
56 
57 typedef enum
58 {
64 
65 typedef enum
66 {
67  hctl_none = 0,
71 } HistControl;
72 
74 {
78 };
79 
80 typedef struct _psqlSettings
81 {
82  PGconn *db; /* connection to backend */
83  int encoding; /* client_encoding */
84  FILE *queryFout; /* where to send the query results */
85  bool queryFoutPipe; /* queryFout is from a popen() */
86 
87  FILE *copyStream; /* Stream to read/write for \copy command */
88 
89  PGresult *last_error_result; /* most recent error result, if any */
90 
91  printQueryOpt popt; /* The active print format settings */
92 
93  char *gfname; /* one-shot file output argument for \g */
94  printQueryOpt *gsavepopt; /* if not null, saved print format settings */
95 
96  char *gset_prefix; /* one-shot prefix argument for \gset */
97  bool gdesc_flag; /* one-shot request to describe query result */
98  bool gexec_flag; /* one-shot request to execute query result */
99  bool bind_flag; /* one-shot request to use extended query
100  * protocol */
101  int bind_nparams; /* number of parameters */
102  char **bind_params; /* parameters for extended query protocol call */
103  bool crosstab_flag; /* one-shot request to crosstab result */
104  char *ctv_args[4]; /* \crosstabview arguments */
105 
106  bool notty; /* stdin or stdout is not a tty (as determined
107  * on startup) */
108  enum trivalue getPassword; /* prompt the user for a username and password */
109  FILE *cur_cmd_source; /* describe the status of the current main
110  * loop */
112  int sversion; /* backend server version */
113  const char *progname; /* in case you renamed psql */
114  char *inputfile; /* file being currently processed, if any */
115  uint64 lineno; /* also for error reporting */
116  uint64 stmt_lineno; /* line number inside the current statement */
117 
118  bool timing; /* enable timing of all queries */
119 
120  FILE *logfile; /* session log file handle */
121 
122  VariableSpace vars; /* "shell variable" repository */
123 
124  /*
125  * If we get a connection failure, the now-unusable PGconn is stashed here
126  * until we can successfully reconnect. Never attempt to do anything with
127  * this PGconn except extract parameters for a \connect attempt.
128  */
129  PGconn *dead_conn; /* previous connection to backend */
130 
131  /*
132  * The remaining fields are set by assign hooks associated with entries in
133  * "vars". They should not be set directly except by those hook
134  * functions.
135  */
138  bool quiet;
144  int histsize;
151  const char *prompt1;
152  const char *prompt2;
153  const char *prompt3;
154  PGVerbosity verbosity; /* current error verbosity level */
156  PGContextVisibility show_context; /* current context display level */
158 
159 extern PsqlSettings pset;
160 
161 
162 #ifndef EXIT_SUCCESS
163 #define EXIT_SUCCESS 0
164 #endif
165 
166 #ifndef EXIT_FAILURE
167 #define EXIT_FAILURE 1
168 #endif
169 
170 #define EXIT_BADCONN 2
171 
172 #define EXIT_USER 3
173 
174 #endif
PGContextVisibility
Definition: libpq-fe.h:134
PGVerbosity
Definition: libpq-fe.h:126
PSQL_ERROR_ROLLBACK
Definition: settings.h:51
@ PSQL_ERROR_ROLLBACK_INTERACTIVE
Definition: settings.h:53
@ PSQL_ERROR_ROLLBACK_ON
Definition: settings.h:54
@ PSQL_ERROR_ROLLBACK_OFF
Definition: settings.h:52
HistControl
Definition: settings.h:66
@ hctl_ignoredups
Definition: settings.h:69
@ hctl_ignoreboth
Definition: settings.h:70
@ hctl_none
Definition: settings.h:67
@ hctl_ignorespace
Definition: settings.h:68
PSQL_ECHO
Definition: settings.h:36
@ PSQL_ECHO_ALL
Definition: settings.h:40
@ PSQL_ECHO_ERRORS
Definition: settings.h:39
@ PSQL_ECHO_NONE
Definition: settings.h:37
@ PSQL_ECHO_QUERIES
Definition: settings.h:38
struct _psqlSettings PsqlSettings
PSQL_ECHO_HIDDEN
Definition: settings.h:44
@ PSQL_ECHO_HIDDEN_NOEXEC
Definition: settings.h:47
@ PSQL_ECHO_HIDDEN_OFF
Definition: settings.h:45
@ PSQL_ECHO_HIDDEN_ON
Definition: settings.h:46
@ TRI_YES
Definition: settings.h:77
@ TRI_DEFAULT
Definition: settings.h:75
@ TRI_NO
Definition: settings.h:76
PsqlSettings pset
Definition: startup.c:32
PSQL_COMP_CASE
Definition: settings.h:58
@ PSQL_COMP_CASE_PRESERVE_LOWER
Definition: settings.h:60
@ PSQL_COMP_CASE_LOWER
Definition: settings.h:62
@ PSQL_COMP_CASE_PRESERVE_UPPER
Definition: settings.h:59
@ PSQL_COMP_CASE_UPPER
Definition: settings.h:61
uint64 lineno
Definition: settings.h:115
printQueryOpt popt
Definition: settings.h:91
bool bind_flag
Definition: settings.h:99
char * gset_prefix
Definition: settings.h:96
PSQL_ERROR_ROLLBACK on_error_rollback
Definition: settings.h:148
bool hide_tableam
Definition: settings.h:142
VariableSpace vars
Definition: settings.h:122
PSQL_COMP_CASE comp_case
Definition: settings.h:149
int encoding
Definition: settings.h:83
char * inputfile
Definition: settings.h:114
PGVerbosity verbosity
Definition: settings.h:154
bool hide_compression
Definition: settings.h:141
FILE * logfile
Definition: settings.h:120
bool on_error_stop
Definition: settings.h:137
PGconn * dead_conn
Definition: settings.h:129
bool autocommit
Definition: settings.h:136
char * ctv_args[4]
Definition: settings.h:104
PGresult * last_error_result
Definition: settings.h:89
bool show_all_results
Definition: settings.h:155
const char * prompt2
Definition: settings.h:152
const char * prompt3
Definition: settings.h:153
FILE * copyStream
Definition: settings.h:87
char ** bind_params
Definition: settings.h:102
PGconn * db
Definition: settings.h:82
FILE * queryFout
Definition: settings.h:84
bool queryFoutPipe
Definition: settings.h:85
PSQL_ECHO echo
Definition: settings.h:146
bool singlestep
Definition: settings.h:140
enum trivalue getPassword
Definition: settings.h:108
uint64 stmt_lineno
Definition: settings.h:116
bool singleline
Definition: settings.h:139
PGContextVisibility show_context
Definition: settings.h:156
const char * prompt1
Definition: settings.h:151
PSQL_ECHO_HIDDEN echo_hidden
Definition: settings.h:147
printQueryOpt * gsavepopt
Definition: settings.h:94
char * gfname
Definition: settings.h:93
int fetch_count
Definition: settings.h:143
bool cur_cmd_interactive
Definition: settings.h:111
bool gexec_flag
Definition: settings.h:98
bool crosstab_flag
Definition: settings.h:103
FILE * cur_cmd_source
Definition: settings.h:109
HistControl histcontrol
Definition: settings.h:150
const char * progname
Definition: settings.h:113
bool gdesc_flag
Definition: settings.h:97
int bind_nparams
Definition: settings.h:101
trivalue
Definition: vacuumlo.c:35