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-2020, 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 results */
98  bool gexec_flag; /* one-shot request to execute query results */
99  bool crosstab_flag; /* one-shot request to crosstab results */
100  char *ctv_args[4]; /* \crosstabview arguments */
101 
102  bool notty; /* stdin or stdout is not a tty (as determined
103  * on startup) */
104  enum trivalue getPassword; /* prompt the user for a username and password */
105  FILE *cur_cmd_source; /* describe the status of the current main
106  * loop */
108  int sversion; /* backend server version */
109  const char *progname; /* in case you renamed psql */
110  char *inputfile; /* file being currently processed, if any */
111  uint64 lineno; /* also for error reporting */
112  uint64 stmt_lineno; /* line number inside the current statement */
113 
114  bool timing; /* enable timing of all queries */
115 
116  FILE *logfile; /* session log file handle */
117 
118  VariableSpace vars; /* "shell variable" repository */
119 
120  /*
121  * If we get a connection failure, the now-unusable PGconn is stashed here
122  * until we can successfully reconnect. Never attempt to do anything with
123  * this PGconn except extract parameters for a \connect attempt.
124  */
125  PGconn *dead_conn; /* previous connection to backend */
126 
127  /*
128  * The remaining fields are set by assign hooks associated with entries in
129  * "vars". They should not be set directly except by those hook
130  * functions.
131  */
134  bool quiet;
139  int histsize;
146  const char *prompt1;
147  const char *prompt2;
148  const char *prompt3;
149  PGVerbosity verbosity; /* current error verbosity level */
150  PGContextVisibility show_context; /* current context display level */
151 } PsqlSettings;
152 
153 extern PsqlSettings pset;
154 
155 
156 #ifndef EXIT_SUCCESS
157 #define EXIT_SUCCESS 0
158 #endif
159 
160 #ifndef EXIT_FAILURE
161 #define EXIT_FAILURE 1
162 #endif
163 
164 #define EXIT_BADCONN 2
165 
166 #define EXIT_USER 3
167 
168 #endif
PSQL_ECHO echo
Definition: settings.h:141
bool singlestep
Definition: settings.h:136
char * gset_prefix
Definition: settings.h:96
PGconn * db
Definition: settings.h:82
PsqlSettings pset
Definition: startup.c:32
const char * prompt3
Definition: settings.h:148
bool gexec_flag
Definition: settings.h:98
PSQL_ECHO_HIDDEN
Definition: settings.h:43
printQueryOpt * gsavepopt
Definition: settings.h:94
bool queryFoutPipe
Definition: settings.h:85
PSQL_COMP_CASE comp_case
Definition: settings.h:144
FILE * queryFout
Definition: settings.h:84
char * inputfile
Definition: settings.h:110
bool on_error_stop
Definition: settings.h:133
bool autocommit
Definition: settings.h:132
FILE * copyStream
Definition: settings.h:87
PSQL_ERROR_ROLLBACK on_error_rollback
Definition: settings.h:143
FILE * cur_cmd_source
Definition: settings.h:105
char * ctv_args[4]
Definition: settings.h:100
bool cur_cmd_interactive
Definition: settings.h:107
PSQL_ECHO_HIDDEN echo_hidden
Definition: settings.h:142
bool gdesc_flag
Definition: settings.h:97
int fetch_count
Definition: settings.h:138
struct _psqlSettings PsqlSettings
HistControl
Definition: settings.h:65
bool singleline
Definition: settings.h:135
PSQL_ECHO
Definition: settings.h:35
trivalue
Definition: vacuumlo.c:34
PGContextVisibility show_context
Definition: settings.h:150
char * gfname
Definition: settings.h:93
PGContextVisibility
Definition: libpq-fe.h:120
PGresult * last_error_result
Definition: settings.h:89
FILE * logfile
Definition: settings.h:116
PGVerbosity
Definition: libpq-fe.h:112
PSQL_ERROR_ROLLBACK
Definition: settings.h:50
PGVerbosity verbosity
Definition: settings.h:149
const char * progname
Definition: settings.h:109
printQueryOpt popt
Definition: settings.h:91
enum trivalue getPassword
Definition: settings.h:104
const char * prompt2
Definition: settings.h:147
PGconn * dead_conn
Definition: settings.h:125
const char * prompt1
Definition: settings.h:146
uint64 lineno
Definition: settings.h:111
bool crosstab_flag
Definition: settings.h:99
bool hide_tableam
Definition: settings.h:137
int encoding
Definition: settings.h:83
uint64 stmt_lineno
Definition: settings.h:112
HistControl histcontrol
Definition: settings.h:145
VariableSpace vars
Definition: settings.h:118
PSQL_COMP_CASE
Definition: settings.h:57