PostgreSQL Source Code git master
common.c
Go to the documentation of this file.
1/*
2 * psql - the PostgreSQL interactive terminal
3 *
4 * Copyright (c) 2000-2025, PostgreSQL Global Development Group
5 *
6 * src/bin/psql/common.c
7 */
8#include "postgres_fe.h"
9
10#include <ctype.h>
11#include <limits.h>
12#include <math.h>
13#include <pwd.h>
14#include <signal.h>
15#ifndef WIN32
16#include <unistd.h> /* for write() */
17#else
18#include <io.h> /* for _write() */
19#include <win32.h>
20#endif
21
22#include "command.h"
23#include "common.h"
24#include "common/logging.h"
25#include "copy.h"
26#include "crosstabview.h"
27#include "fe_utils/cancel.h"
28#include "fe_utils/mbprint.h"
31#include "settings.h"
32
33static bool DescribeQuery(const char *query, double *elapsed_msec);
34static int ExecQueryAndProcessResults(const char *query,
35 double *elapsed_msec,
36 bool *svpt_gone_p,
37 bool is_watch,
38 int min_rows,
39 const printQueryOpt *opt,
40 FILE *printQueryFout);
41static bool command_no_begin(const char *query);
42
43
44/*
45 * openQueryOutputFile --- attempt to open a query output file
46 *
47 * fname == NULL selects stdout, else an initial '|' selects a pipe,
48 * else plain file.
49 *
50 * Returns output file pointer into *fout, and is-a-pipe flag into *is_pipe.
51 * Caller is responsible for adjusting SIGPIPE state if it's a pipe.
52 *
53 * On error, reports suitable error message and returns false.
54 */
55bool
56openQueryOutputFile(const char *fname, FILE **fout, bool *is_pipe)
57{
58 if (!fname || fname[0] == '\0')
59 {
60 *fout = stdout;
61 *is_pipe = false;
62 }
63 else if (*fname == '|')
64 {
65 fflush(NULL);
66 *fout = popen(fname + 1, "w");
67 *is_pipe = true;
68 }
69 else
70 {
71 *fout = fopen(fname, "w");
72 *is_pipe = false;
73 }
74
75 if (*fout == NULL)
76 {
77 pg_log_error("%s: %m", fname);
78 return false;
79 }
80
81 return true;
82}
83
84/*
85 * Check if an output stream for \g needs to be opened, and if yes,
86 * open it and update the caller's gfile_fout and is_pipe state variables.
87 * Return true if OK, false if an error occurred.
88 */
89static bool
90SetupGOutput(FILE **gfile_fout, bool *is_pipe)
91{
92 /* If there is a \g file or program, and it's not already open, open it */
93 if (pset.gfname != NULL && *gfile_fout == NULL)
94 {
95 if (openQueryOutputFile(pset.gfname, gfile_fout, is_pipe))
96 {
97 if (*is_pipe)
99 }
100 else
101 return false;
102 }
103 return true;
104}
105
106/*
107 * Close the output stream for \g, if we opened it.
108 */
109static void
110CloseGOutput(FILE *gfile_fout, bool is_pipe)
111{
112 if (gfile_fout)
113 {
114 if (is_pipe)
115 {
116 SetShellResultVariables(pclose(gfile_fout));
118 }
119 else
120 fclose(gfile_fout);
121 }
122}
123
124/*
125 * Reset pset pipeline state
126 */
127static void
129{
130 pset.piped_syncs = 0;
134}
135
136/*
137 * setQFout
138 * -- handler for -o command line option and \o command
139 *
140 * On success, updates pset with the new output file and returns true.
141 * On failure, returns false without changing pset state.
142 */
143bool
144setQFout(const char *fname)
145{
146 FILE *fout;
147 bool is_pipe;
148
149 /* First make sure we can open the new output file/pipe */
150 if (!openQueryOutputFile(fname, &fout, &is_pipe))
151 return false;
152
153 /* Close old file/pipe */
154 if (pset.queryFout && pset.queryFout != stdout && pset.queryFout != stderr)
155 {
158 else
159 fclose(pset.queryFout);
160 }
161
162 pset.queryFout = fout;
163 pset.queryFoutPipe = is_pipe;
164
165 /* Adjust SIGPIPE handling appropriately: ignore signal if is_pipe */
166 set_sigpipe_trap_state(is_pipe);
168
169 return true;
170}
171
172
173/*
174 * Variable-fetching callback for flex lexer
175 *
176 * If the specified variable exists, return its value as a string (malloc'd
177 * and expected to be freed by the caller); else return NULL.
178 *
179 * If "quote" isn't PQUOTE_PLAIN, then return the value suitably quoted and
180 * escaped for the specified quoting requirement. (Failure in escaping
181 * should lead to printing an error and returning NULL.)
182 *
183 * "passthrough" is the pointer previously given to psql_scan_set_passthrough.
184 * In psql, passthrough points to a ConditionalStack, which we check to
185 * determine whether variable expansion is allowed.
186 */
187char *
188psql_get_variable(const char *varname, PsqlScanQuoteType quote,
189 void *passthrough)
190{
191 char *result = NULL;
192 const char *value;
193
194 /* In an inactive \if branch, suppress all variable substitutions */
195 if (passthrough && !conditional_active((ConditionalStack) passthrough))
196 return NULL;
197
198 value = GetVariable(pset.vars, varname);
199 if (!value)
200 return NULL;
201
202 switch (quote)
203 {
204 case PQUOTE_PLAIN:
205 result = pg_strdup(value);
206 break;
208 case PQUOTE_SQL_IDENT:
209 {
210 /*
211 * For these cases, we use libpq's quoting functions, which
212 * assume the string is in the connection's client encoding.
213 */
214 char *escaped_value;
215
216 if (!pset.db)
217 {
218 pg_log_error("cannot escape without active connection");
219 return NULL;
220 }
221
222 if (quote == PQUOTE_SQL_LITERAL)
223 escaped_value =
224 PQescapeLiteral(pset.db, value, strlen(value));
225 else
226 escaped_value =
228
229 if (escaped_value == NULL)
230 {
231 const char *error = PQerrorMessage(pset.db);
232
233 pg_log_info("%s", error);
234 return NULL;
235 }
236
237 /*
238 * Rather than complicate the lexer's API with a notion of
239 * which free() routine to use, just pay the price of an extra
240 * strdup().
241 */
242 result = pg_strdup(escaped_value);
243 PQfreemem(escaped_value);
244 break;
245 }
246 case PQUOTE_SHELL_ARG:
247 {
248 /*
249 * For this we use appendShellStringNoError, which is
250 * encoding-agnostic, which is fine since the shell probably
251 * is too. In any case, the only special character is "'",
252 * which is not known to appear in valid multibyte characters.
253 */
255
258 {
259 pg_log_error("shell command argument contains a newline or carriage return: \"%s\"",
260 value);
261 free(buf.data);
262 return NULL;
263 }
264 result = buf.data;
265 break;
266 }
267
268 /* No default: we want a compiler warning for missing cases */
269 }
270
271 return result;
272}
273
274
275/*
276 * for backend Notice messages (INFO, WARNING, etc)
277 */
278void
279NoticeProcessor(void *arg, const char *message)
280{
281 (void) arg; /* not used */
282 pg_log_info("%s", message);
283}
284
285
286
287/*
288 * Code to support query cancellation
289 *
290 * Before we start a query, we enable the SIGINT signal catcher to send a
291 * cancel request to the backend.
292 *
293 * SIGINT is supposed to abort all long-running psql operations, not only
294 * database queries. In most places, this is accomplished by checking
295 * cancel_pressed during long-running loops. However, that won't work when
296 * blocked on user input (in readline() or fgets()). In those places, we
297 * set sigint_interrupt_enabled true while blocked, instructing the signal
298 * catcher to longjmp through sigint_interrupt_jmp. We assume readline and
299 * fgets are coded to handle possible interruption.
300 *
301 * On Windows, currently this does not work, so control-C is less useful
302 * there.
303 */
304volatile sig_atomic_t sigint_interrupt_enabled = false;
305
307
308static void
310{
311#ifndef WIN32
312 /* if we are waiting for input, longjmp out of it */
314 {
316 siglongjmp(sigint_interrupt_jmp, 1);
317 }
318#endif
319
320 /* else, set cancel flag to stop any long-running loops */
321 cancel_pressed = true;
322}
323
324void
326{
328}
329
330
331/* ConnectionUp
332 *
333 * Returns whether our backend connection is still there.
334 */
335static bool
337{
338 return PQstatus(pset.db) != CONNECTION_BAD;
339}
340
341
342
343/* CheckConnection
344 *
345 * Verify that we still have a good connection to the backend, and if not,
346 * see if it can be restored.
347 *
348 * Returns true if either the connection was still there, or it could be
349 * restored successfully; false otherwise. If, however, there was no
350 * connection and the session is non-interactive, this will exit the program
351 * with a code of EXIT_BADCONN.
352 */
353static bool
355{
356 bool OK;
357
358 OK = ConnectionUp();
359 if (!OK)
360 {
362 {
363 pg_log_error("connection to server was lost");
364 exit(EXIT_BADCONN);
365 }
366
367 fprintf(stderr, _("The connection to the server was lost. Attempting reset: "));
368 PQreset(pset.db);
370 OK = ConnectionUp();
371 if (!OK)
372 {
373 fprintf(stderr, _("Failed.\n"));
374
375 /*
376 * Transition to having no connection; but stash away the failed
377 * connection so that we can still refer to its parameters in a
378 * later \connect attempt. Keep the state cleanup here in sync
379 * with do_connect().
380 */
381 if (pset.dead_conn)
384 pset.db = NULL;
387 }
388 else
389 {
390 fprintf(stderr, _("Succeeded.\n"));
391
392 /*
393 * Re-sync, just in case anything changed. Keep this in sync with
394 * do_connect().
395 */
397 connection_warnings(false); /* Must be after SyncVariables */
398 }
399 }
400
401 return OK;
402}
403
404
405
406
407/*
408 * AcceptResult
409 *
410 * Checks whether a result is valid, giving an error message if necessary;
411 * and ensures that the connection to the backend is still up.
412 *
413 * Returns true for valid result, false for error state.
414 */
415static bool
416AcceptResult(const PGresult *result, bool show_error)
417{
418 bool OK;
419
420 if (!result)
421 OK = false;
422 else
423 switch (PQresultStatus(result))
424 {
425 case PGRES_COMMAND_OK:
426 case PGRES_TUPLES_OK:
429 case PGRES_COPY_IN:
430 case PGRES_COPY_OUT:
432 /* Fine, do nothing */
433 OK = true;
434 break;
435
440 OK = false;
441 break;
442
443 default:
444 OK = false;
445 pg_log_error("unexpected PQresultStatus: %d",
446 PQresultStatus(result));
447 break;
448 }
449
450 if (!OK && show_error)
451 {
452 const char *error = PQerrorMessage(pset.db);
453
454 if (strlen(error))
455 pg_log_info("%s", error);
456
458 }
459
460 return OK;
461}
462
463
464/*
465 * Set special variables from a query result
466 * - ERROR: true/false, whether an error occurred on this query
467 * - SQLSTATE: code of error, or "00000" if no error, or "" if unknown
468 * - ROW_COUNT: how many rows were returned or affected, or "0"
469 * - LAST_ERROR_SQLSTATE: same for last error
470 * - LAST_ERROR_MESSAGE: message of last error
471 *
472 * Note: current policy is to apply this only to the results of queries
473 * entered by the user, not queries generated by slash commands.
474 */
475static void
477{
478 if (success)
479 {
480 const char *ntuples = PQcmdTuples(result);
481
482 SetVariable(pset.vars, "ERROR", "false");
483 SetVariable(pset.vars, "SQLSTATE", "00000");
484 SetVariable(pset.vars, "ROW_COUNT", *ntuples ? ntuples : "0");
485 }
486 else
487 {
488 const char *code = PQresultErrorField(result, PG_DIAG_SQLSTATE);
489 const char *mesg = PQresultErrorField(result, PG_DIAG_MESSAGE_PRIMARY);
490
491 SetVariable(pset.vars, "ERROR", "true");
492
493 /*
494 * If there is no SQLSTATE code, use an empty string. This can happen
495 * for libpq-detected errors (e.g., lost connection, ENOMEM).
496 */
497 if (code == NULL)
498 code = "";
499 SetVariable(pset.vars, "SQLSTATE", code);
500 SetVariable(pset.vars, "ROW_COUNT", "0");
501 SetVariable(pset.vars, "LAST_ERROR_SQLSTATE", code);
502 SetVariable(pset.vars, "LAST_ERROR_MESSAGE", mesg ? mesg : "");
503 }
504}
505
506
507/*
508 * Set special variables from a shell command result
509 * - SHELL_ERROR: true/false, whether command returned exit code 0
510 * - SHELL_EXIT_CODE: exit code according to shell conventions
511 *
512 * The argument is a wait status as returned by wait(2) or waitpid(2),
513 * which also applies to pclose(3) and system(3).
514 */
515void
517{
518 char buf[32];
519
520 SetVariable(pset.vars, "SHELL_ERROR",
521 (wait_result == 0) ? "false" : "true");
522 snprintf(buf, sizeof(buf), "%d", wait_result_to_exit_code(wait_result));
523 SetVariable(pset.vars, "SHELL_EXIT_CODE", buf);
524}
525
526
527/*
528 * Set special pipeline variables
529 * - PIPELINE_SYNC_COUNT: The number of piped syncs
530 * - PIPELINE_COMMAND_COUNT: The number of piped commands
531 * - PIPELINE_RESULT_COUNT: The number of results available to read
532 */
533static void
535{
536 char buf[32];
537
538 snprintf(buf, sizeof(buf), "%d", pset.piped_syncs);
539 SetVariable(pset.vars, "PIPELINE_SYNC_COUNT", buf);
540 snprintf(buf, sizeof(buf), "%d", pset.piped_commands);
541 SetVariable(pset.vars, "PIPELINE_COMMAND_COUNT", buf);
542 snprintf(buf, sizeof(buf), "%d", pset.available_results);
543 SetVariable(pset.vars, "PIPELINE_RESULT_COUNT", buf);
544}
545
546
547/*
548 * ClearOrSaveResult
549 *
550 * If the result represents an error, remember it for possible display by
551 * \errverbose. Otherwise, just PQclear() it.
552 *
553 * Note: current policy is to apply this to the results of all queries,
554 * including "back door" queries, for debugging's sake. It's OK to use
555 * PQclear() directly on results known to not be error results, however.
556 */
557static void
559{
560 if (result)
561 {
562 switch (PQresultStatus(result))
563 {
567 pset.last_error_result = result;
568 break;
569
570 default:
571 PQclear(result);
572 break;
573 }
574 }
575}
576
577
578/*
579 * Consume all results
580 */
581static void
583{
584 PGresult *result;
585
586 while ((result = PQgetResult(pset.db)) != NULL)
587 ClearOrSaveResult(result);
588}
589
590
591/*
592 * Print microtiming output. Always print raw milliseconds; if the interval
593 * is >= 1 second, also break it down into days/hours/minutes/seconds.
594 */
595static void
596PrintTiming(double elapsed_msec)
597{
598 double seconds;
599 double minutes;
600 double hours;
601 double days;
602
603 if (elapsed_msec < 1000.0)
604 {
605 /* This is the traditional (pre-v10) output format */
606 printf(_("Time: %.3f ms\n"), elapsed_msec);
607 return;
608 }
609
610 /*
611 * Note: we could print just seconds, in a format like %06.3f, when the
612 * total is less than 1min. But that's hard to interpret unless we tack
613 * on "s" or otherwise annotate it. Forcing the display to include
614 * minutes seems like a better solution.
615 */
616 seconds = elapsed_msec / 1000.0;
617 minutes = floor(seconds / 60.0);
618 seconds -= 60.0 * minutes;
619 if (minutes < 60.0)
620 {
621 printf(_("Time: %.3f ms (%02d:%06.3f)\n"),
622 elapsed_msec, (int) minutes, seconds);
623 return;
624 }
625
626 hours = floor(minutes / 60.0);
627 minutes -= 60.0 * hours;
628 if (hours < 24.0)
629 {
630 printf(_("Time: %.3f ms (%02d:%02d:%06.3f)\n"),
631 elapsed_msec, (int) hours, (int) minutes, seconds);
632 return;
633 }
634
635 days = floor(hours / 24.0);
636 hours -= 24.0 * days;
637 printf(_("Time: %.3f ms (%.0f d %02d:%02d:%06.3f)\n"),
638 elapsed_msec, days, (int) hours, (int) minutes, seconds);
639}
640
641
642/*
643 * PSQLexec
644 *
645 * This is the way to send "backdoor" queries (those not directly entered
646 * by the user). It is subject to -E but not -e.
647 *
648 * Caller is responsible for handling the ensuing processing if a COPY
649 * command is sent.
650 *
651 * Note: we don't bother to check PQclientEncoding; it is assumed that no
652 * caller uses this path to issue "SET CLIENT_ENCODING".
653 */
654PGresult *
655PSQLexec(const char *query)
656{
657 PGresult *res;
658
659 if (!pset.db)
660 {
661 pg_log_error("You are currently not connected to a database.");
662 return NULL;
663 }
664
666 {
667 printf(_("/******** QUERY *********/\n"
668 "%s\n"
669 "/************************/\n\n"), query);
670 fflush(stdout);
671 if (pset.logfile)
672 {
674 _("/******** QUERY *********/\n"
675 "%s\n"
676 "/************************/\n\n"), query);
677 fflush(pset.logfile);
678 }
679
681 return NULL;
682 }
683
685
686 res = PQexec(pset.db, query);
687
689
690 if (!AcceptResult(res, true))
691 {
693 res = NULL;
694 }
695
696 return res;
697}
698
699
700/*
701 * PSQLexecWatch
702 *
703 * This function is used for \watch command to send the query to
704 * the server and print out the result.
705 *
706 * Returns 1 if the query executed successfully, 0 if it cannot be repeated,
707 * e.g., because of the interrupt, -1 on error.
708 */
709int
710PSQLexecWatch(const char *query, const printQueryOpt *opt, FILE *printQueryFout, int min_rows)
711{
712 bool timing = pset.timing;
713 double elapsed_msec = 0;
714 int res;
715
716 if (!pset.db)
717 {
718 pg_log_error("You are currently not connected to a database.");
719 return 0;
720 }
721
723
724 res = ExecQueryAndProcessResults(query, &elapsed_msec, NULL, true, min_rows, opt, printQueryFout);
725
727
728 /* Possible microtiming output */
729 if (timing)
730 PrintTiming(elapsed_msec);
731
732 return res;
733}
734
735
736/*
737 * PrintNotifications: check for asynchronous notifications, and print them out
738 */
739static void
741{
742 PGnotify *notify;
743
745 while ((notify = PQnotifies(pset.db)) != NULL)
746 {
747 /* for backward compatibility, only show payload if nonempty */
748 if (notify->extra[0])
749 fprintf(pset.queryFout, _("Asynchronous notification \"%s\" with payload \"%s\" received from server process with PID %d.\n"),
750 notify->relname, notify->extra, notify->be_pid);
751 else
752 fprintf(pset.queryFout, _("Asynchronous notification \"%s\" received from server process with PID %d.\n"),
753 notify->relname, notify->be_pid);
754 fflush(pset.queryFout);
755 PQfreemem(notify);
757 }
758}
759
760
761/*
762 * PrintQueryTuples: assuming query result is OK, print its tuples
763 *
764 * We use the options given by opt unless that's NULL, in which case
765 * we use pset.popt.
766 *
767 * Output is to printQueryFout unless that's NULL, in which case
768 * we use pset.queryFout.
769 *
770 * Returns true if successful, false otherwise.
771 */
772static bool
773PrintQueryTuples(const PGresult *result, const printQueryOpt *opt,
774 FILE *printQueryFout)
775{
776 bool ok = true;
777 FILE *fout = printQueryFout ? printQueryFout : pset.queryFout;
778
779 printQuery(result, opt ? opt : &pset.popt, fout, false, pset.logfile);
780 fflush(fout);
781 if (ferror(fout))
782 {
783 pg_log_error("could not print result table: %m");
784 ok = false;
785 }
786
787 return ok;
788}
789
790
791/*
792 * StoreQueryTuple: assuming query result is OK, save data into variables
793 *
794 * Returns true if successful, false otherwise.
795 */
796static bool
798{
799 bool success = true;
800
801 if (PQntuples(result) < 1)
802 {
803 pg_log_error("no rows returned for \\gset");
804 success = false;
805 }
806 else if (PQntuples(result) > 1)
807 {
808 pg_log_error("more than one row returned for \\gset");
809 success = false;
810 }
811 else
812 {
813 int i;
814
815 for (i = 0; i < PQnfields(result); i++)
816 {
817 char *colname = PQfname(result, i);
818 char *varname;
819 char *value;
820
821 /* concatenate prefix and column name */
822 varname = psprintf("%s%s", pset.gset_prefix, colname);
823
824 if (VariableHasHook(pset.vars, varname))
825 {
826 pg_log_warning("attempt to \\gset into specially treated variable \"%s\" ignored",
827 varname);
828 continue;
829 }
830
831 if (!PQgetisnull(result, 0, i))
832 value = PQgetvalue(result, 0, i);
833 else
834 {
835 /* for NULL value, unset rather than set the variable */
836 value = NULL;
837 }
838
839 if (!SetVariable(pset.vars, varname, value))
840 {
841 free(varname);
842 success = false;
843 break;
844 }
845
846 free(varname);
847 }
848 }
849
850 return success;
851}
852
853
854/*
855 * ExecQueryTuples: assuming query result is OK, execute each query
856 * result field as a SQL statement
857 *
858 * Returns true if successful, false otherwise.
859 */
860static bool
862{
863 bool success = true;
864 int nrows = PQntuples(result);
865 int ncolumns = PQnfields(result);
866 int r,
867 c;
868
869 /*
870 * We must turn off gexec_flag to avoid infinite recursion.
871 */
872 pset.gexec_flag = false;
873
874 for (r = 0; r < nrows; r++)
875 {
876 for (c = 0; c < ncolumns; c++)
877 {
878 if (!PQgetisnull(result, r, c))
879 {
880 const char *query = PQgetvalue(result, r, c);
881
882 /* Abandon execution if cancel_pressed */
883 if (cancel_pressed)
884 goto loop_exit;
885
886 /*
887 * ECHO_ALL mode should echo these queries, but SendQuery
888 * assumes that MainLoop did that, so we have to do it here.
889 */
891 {
892 puts(query);
893 fflush(stdout);
894 }
895
896 if (!SendQuery(query))
897 {
898 /* Error - abandon execution if ON_ERROR_STOP */
899 success = false;
901 goto loop_exit;
902 }
903 }
904 }
905 }
906
907loop_exit:
908
909 /*
910 * Restore state. We know gexec_flag was on, else we'd not be here. (We
911 * also know it'll get turned off at end of command, but that's not ours
912 * to do here.)
913 */
914 pset.gexec_flag = true;
915
916 /* Return true if all queries were successful */
917 return success;
918}
919
920
921/*
922 * Marshal the COPY data. Either path will get the
923 * connection out of its COPY state, then call PQresultStatus()
924 * once and report any error. Return whether all was ok.
925 *
926 * For COPY OUT, direct the output to copystream, or discard if that's NULL.
927 * For COPY IN, use pset.copyStream as data source if it's set,
928 * otherwise cur_cmd_source.
929 *
930 * Update *resultp if further processing is necessary; set to NULL otherwise.
931 * Return a result when queryFout can safely output a result status: on COPY
932 * IN, or on COPY OUT if written to something other than pset.queryFout.
933 * Returning NULL prevents the command status from being printed, which we
934 * want if the status line doesn't get taken as part of the COPY data.
935 */
936static bool
937HandleCopyResult(PGresult **resultp, FILE *copystream)
938{
939 bool success;
940 PGresult *copy_result;
941 ExecStatusType result_status = PQresultStatus(*resultp);
942
943 Assert(result_status == PGRES_COPY_OUT ||
944 result_status == PGRES_COPY_IN);
945
947
948 if (result_status == PGRES_COPY_OUT)
949 {
951 copystream,
952 &copy_result)
953 && (copystream != NULL);
954
955 /*
956 * Suppress status printing if the report would go to the same place
957 * as the COPY data just went. Note this doesn't prevent error
958 * reporting, since handleCopyOut did that.
959 */
960 if (copystream == pset.queryFout)
961 {
962 PQclear(copy_result);
963 copy_result = NULL;
964 }
965 }
966 else
967 {
968 /* COPY IN */
969 /* Ignore the copystream argument passed to the function */
972 copystream,
973 PQbinaryTuples(*resultp),
974 &copy_result);
975 }
977
978 /*
979 * Replace the PGRES_COPY_OUT/IN result with COPY command's exit status,
980 * or with NULL if we want to suppress printing anything.
981 */
982 PQclear(*resultp);
983 *resultp = copy_result;
984
985 return success;
986}
987
988/*
989 * PrintQueryStatus: report command status as required
990 */
991static void
992PrintQueryStatus(PGresult *result, FILE *printQueryFout)
993{
994 char buf[16];
995 const char *cmdstatus = PQcmdStatus(result);
996 FILE *fout = printQueryFout ? printQueryFout : pset.queryFout;
997
998 /* Do nothing if it's a TUPLES_OK result that isn't from RETURNING */
999 if (PQresultStatus(result) == PGRES_TUPLES_OK)
1000 {
1001 if (!(strncmp(cmdstatus, "INSERT", 6) == 0 ||
1002 strncmp(cmdstatus, "UPDATE", 6) == 0 ||
1003 strncmp(cmdstatus, "DELETE", 6) == 0 ||
1004 strncmp(cmdstatus, "MERGE", 5) == 0))
1005 return;
1006 }
1007
1008 if (!pset.quiet)
1009 {
1011 {
1012 fputs("<p>", fout);
1013 html_escaped_print(cmdstatus, fout);
1014 fputs("</p>\n", fout);
1015 }
1016 else
1017 fprintf(fout, "%s\n", cmdstatus);
1018 fflush(fout);
1019 }
1020
1021 if (pset.logfile)
1022 fprintf(pset.logfile, "%s\n", cmdstatus);
1023
1024 snprintf(buf, sizeof(buf), "%u", (unsigned int) PQoidValue(result));
1025 SetVariable(pset.vars, "LASTOID", buf);
1026}
1027
1028
1029/*
1030 * PrintQueryResult: print out (or store or execute) query result as required
1031 *
1032 * last is true if this is the last result of a command string.
1033 * opt and printQueryFout are defined as for PrintQueryTuples.
1034 * printStatusFout is where to send command status; NULL means pset.queryFout.
1035 *
1036 * Returns true if the query executed successfully, false otherwise.
1037 */
1038static bool
1039PrintQueryResult(PGresult *result, bool last,
1040 const printQueryOpt *opt, FILE *printQueryFout,
1041 FILE *printStatusFout)
1042{
1043 bool success;
1044
1045 if (!result)
1046 return false;
1047
1048 switch (PQresultStatus(result))
1049 {
1050 case PGRES_TUPLES_OK:
1051 /* store or execute or print the data ... */
1052 if (last && pset.gset_prefix)
1053 success = StoreQueryTuple(result);
1054 else if (last && pset.gexec_flag)
1055 success = ExecQueryTuples(result);
1056 else if (last && pset.crosstab_flag)
1058 else if (last || pset.show_all_results)
1059 success = PrintQueryTuples(result, opt, printQueryFout);
1060 else
1061 success = true;
1062
1063 /*
1064 * If it's INSERT/UPDATE/DELETE/MERGE RETURNING, also print
1065 * status.
1066 */
1067 if (last || pset.show_all_results)
1068 PrintQueryStatus(result, printStatusFout);
1069
1070 break;
1071
1072 case PGRES_COMMAND_OK:
1073 if (last || pset.show_all_results)
1074 PrintQueryStatus(result, printStatusFout);
1075 success = true;
1076 break;
1077
1078 case PGRES_EMPTY_QUERY:
1079 success = true;
1080 break;
1081
1082 case PGRES_COPY_OUT:
1083 case PGRES_COPY_IN:
1084 /* nothing to do here: already processed */
1085 success = true;
1086 break;
1087
1089 case PGRES_BAD_RESPONSE:
1091 case PGRES_FATAL_ERROR:
1092 success = false;
1093 break;
1094
1095 default:
1096 success = false;
1097 pg_log_error("unexpected PQresultStatus: %d",
1098 PQresultStatus(result));
1099 break;
1100 }
1101
1102 return success;
1103}
1104
1105/*
1106 * SendQuery: send the query string to the backend
1107 * (and print out result)
1108 *
1109 * Note: This is the "front door" way to send a query. That is, use it to
1110 * send queries actually entered by the user. These queries will be subject to
1111 * single step mode.
1112 * To send "back door" queries (generated by slash commands, etc.) in a
1113 * controlled way, use PSQLexec().
1114 *
1115 * Returns true if the query executed successfully, false otherwise.
1116 */
1117bool
1118SendQuery(const char *query)
1119{
1120 bool timing = pset.timing;
1121 PGTransactionStatusType transaction_status;
1122 double elapsed_msec = 0;
1123 bool OK = false;
1124 int i;
1125 bool on_error_rollback_savepoint = false;
1126 bool svpt_gone = false;
1127
1128 if (!pset.db)
1129 {
1130 pg_log_error("You are currently not connected to a database.");
1131 goto sendquery_cleanup;
1132 }
1133
1134 if (pset.singlestep)
1135 {
1136 char buf[3];
1137
1138 fflush(stderr);
1139 printf(_("/**(Single step mode: verify command)******************************************/\n"
1140 "%s\n"
1141 "/**(press return to proceed or enter x and return to cancel)*******************/\n"),
1142 query);
1143 fflush(stdout);
1144 if (fgets(buf, sizeof(buf), stdin) != NULL)
1145 if (buf[0] == 'x')
1146 goto sendquery_cleanup;
1147 if (cancel_pressed)
1148 goto sendquery_cleanup;
1149 }
1150 else if (pset.echo == PSQL_ECHO_QUERIES)
1151 {
1152 puts(query);
1153 fflush(stdout);
1154 }
1155
1156 if (pset.logfile)
1157 {
1159 _("/******** QUERY *********/\n"
1160 "%s\n"
1161 "/************************/\n\n"), query);
1162 fflush(pset.logfile);
1163 }
1164
1166
1167 transaction_status = PQtransactionStatus(pset.db);
1168
1169 if (transaction_status == PQTRANS_IDLE &&
1170 !pset.autocommit &&
1171 !command_no_begin(query))
1172 {
1173 PGresult *result;
1174
1175 result = PQexec(pset.db, "BEGIN");
1176 if (PQresultStatus(result) != PGRES_COMMAND_OK)
1177 {
1179 ClearOrSaveResult(result);
1180 goto sendquery_cleanup;
1181 }
1182 ClearOrSaveResult(result);
1183 transaction_status = PQtransactionStatus(pset.db);
1184 }
1185
1186 if (transaction_status == PQTRANS_INTRANS &&
1190 {
1191 PGresult *result;
1192
1193 result = PQexec(pset.db, "SAVEPOINT pg_psql_temporary_savepoint");
1194 if (PQresultStatus(result) != PGRES_COMMAND_OK)
1195 {
1197 ClearOrSaveResult(result);
1198 goto sendquery_cleanup;
1199 }
1200 ClearOrSaveResult(result);
1201 on_error_rollback_savepoint = true;
1202 }
1203
1204 if (pset.gdesc_flag)
1205 {
1206 /* Describe query's result columns, without executing it */
1207 OK = DescribeQuery(query, &elapsed_msec);
1208 }
1209 else
1210 {
1211 /* Default fetch-and-print mode */
1212 OK = (ExecQueryAndProcessResults(query, &elapsed_msec, &svpt_gone, false, 0, NULL, NULL) > 0);
1213 }
1214
1215 if (!OK && pset.echo == PSQL_ECHO_ERRORS)
1216 pg_log_info("STATEMENT: %s", query);
1217
1218 /* If we made a temporary savepoint, possibly release/rollback */
1219 if (on_error_rollback_savepoint)
1220 {
1221 const char *svptcmd = NULL;
1222
1223 transaction_status = PQtransactionStatus(pset.db);
1224
1225 switch (transaction_status)
1226 {
1227 case PQTRANS_INERROR:
1228 /* We always rollback on an error */
1229 svptcmd = "ROLLBACK TO pg_psql_temporary_savepoint";
1230 break;
1231
1232 case PQTRANS_IDLE:
1233 /* If they are no longer in a transaction, then do nothing */
1234 break;
1235
1236 case PQTRANS_INTRANS:
1237
1238 /*
1239 * Release our savepoint, but do nothing if they are messing
1240 * with savepoints themselves
1241 */
1242 if (!svpt_gone)
1243 svptcmd = "RELEASE pg_psql_temporary_savepoint";
1244 break;
1245
1246 case PQTRANS_ACTIVE:
1247 case PQTRANS_UNKNOWN:
1248 default:
1249 OK = false;
1250 /* PQTRANS_UNKNOWN is expected given a broken connection. */
1251 if (transaction_status != PQTRANS_UNKNOWN || ConnectionUp())
1252 pg_log_error("unexpected transaction status (%d)",
1253 transaction_status);
1254 break;
1255 }
1256
1257 if (svptcmd)
1258 {
1259 PGresult *svptres;
1260
1261 svptres = PQexec(pset.db, svptcmd);
1262 if (PQresultStatus(svptres) != PGRES_COMMAND_OK)
1263 {
1265 ClearOrSaveResult(svptres);
1266 OK = false;
1267
1268 goto sendquery_cleanup;
1269 }
1270 PQclear(svptres);
1271 }
1272 }
1273
1274 /* Possible microtiming output */
1275 if (timing)
1276 PrintTiming(elapsed_msec);
1277
1278 /* check for events that may occur during query execution */
1279
1281 PQclientEncoding(pset.db) >= 0)
1282 {
1283 /* track effects of SET CLIENT_ENCODING */
1286 SetVariable(pset.vars, "ENCODING",
1288 }
1289
1291
1292 /* perform cleanup that should occur after any attempted query */
1293
1294sendquery_cleanup:
1295
1296 /* global cancellation reset */
1298
1299 /* reset \g's output-to-filename trigger */
1300 if (pset.gfname)
1301 {
1302 free(pset.gfname);
1303 pset.gfname = NULL;
1304 }
1305
1306 /* restore print settings if \g changed them */
1307 if (pset.gsavepopt)
1308 {
1310 pset.gsavepopt = NULL;
1311 }
1312
1313 /* clean up after extended protocol queries */
1315
1316 /* reset \gset trigger */
1317 if (pset.gset_prefix)
1318 {
1320 pset.gset_prefix = NULL;
1321 }
1322
1323 /* reset \gdesc trigger */
1324 pset.gdesc_flag = false;
1325
1326 /* reset \gexec trigger */
1327 pset.gexec_flag = false;
1328
1329 /* reset \crosstabview trigger */
1330 pset.crosstab_flag = false;
1331 for (i = 0; i < lengthof(pset.ctv_args); i++)
1332 {
1334 pset.ctv_args[i] = NULL;
1335 }
1336
1337 return OK;
1338}
1339
1340
1341/*
1342 * DescribeQuery: describe the result columns of a query, without executing it
1343 *
1344 * Returns true if the operation executed successfully, false otherwise.
1345 *
1346 * If pset.timing is on, total query time (exclusive of result-printing) is
1347 * stored into *elapsed_msec.
1348 */
1349static bool
1350DescribeQuery(const char *query, double *elapsed_msec)
1351{
1352 bool timing = pset.timing;
1353 PGresult *result;
1354 bool OK;
1356 after;
1357
1358 *elapsed_msec = 0;
1359
1360 if (timing)
1362 else
1364
1365 /*
1366 * To parse the query but not execute it, we prepare it, using the unnamed
1367 * prepared statement. This is invisible to psql users, since there's no
1368 * way to access the unnamed prepared statement from psql user space. The
1369 * next Parse or Query protocol message would overwrite the statement
1370 * anyway. (So there's no great need to clear it when done, which is a
1371 * good thing because libpq provides no easy way to do that.)
1372 */
1373 result = PQprepare(pset.db, "", query, 0, NULL);
1374 if (PQresultStatus(result) != PGRES_COMMAND_OK)
1375 {
1377 SetResultVariables(result, false);
1378 ClearOrSaveResult(result);
1379 return false;
1380 }
1381 PQclear(result);
1382
1383 result = PQdescribePrepared(pset.db, "");
1384 OK = AcceptResult(result, true) &&
1385 (PQresultStatus(result) == PGRES_COMMAND_OK);
1386 if (OK && result)
1387 {
1388 if (PQnfields(result) > 0)
1389 {
1391 int i;
1392
1394
1396 "SELECT name AS \"%s\", pg_catalog.format_type(tp, tpm) AS \"%s\"\n"
1397 "FROM (VALUES ",
1398 gettext_noop("Column"),
1399 gettext_noop("Type"));
1400
1401 for (i = 0; i < PQnfields(result); i++)
1402 {
1403 const char *name;
1404 char *escname;
1405
1406 if (i > 0)
1408
1409 name = PQfname(result, i);
1410 escname = PQescapeLiteral(pset.db, name, strlen(name));
1411
1412 if (escname == NULL)
1413 {
1415 PQclear(result);
1417 return false;
1418 }
1419
1420 appendPQExpBuffer(&buf, "(%s, '%u'::pg_catalog.oid, %d)",
1421 escname,
1422 PQftype(result, i),
1423 PQfmod(result, i));
1424
1425 PQfreemem(escname);
1426 }
1427
1428 appendPQExpBufferStr(&buf, ") s(name, tp, tpm)");
1429 PQclear(result);
1430
1431 result = PQexec(pset.db, buf.data);
1432 OK = AcceptResult(result, true);
1433
1434 if (timing)
1435 {
1438 *elapsed_msec += INSTR_TIME_GET_MILLISEC(after);
1439 }
1440
1441 if (OK && result)
1442 OK = PrintQueryResult(result, true, NULL, NULL, NULL);
1443
1445 }
1446 else
1448 _("The command has no result, or the result has no columns.\n"));
1449 }
1450
1451 SetResultVariables(result, OK);
1452 ClearOrSaveResult(result);
1453
1454 return OK;
1455}
1456
1457/*
1458 * Read and discard all results in an aborted pipeline.
1459 *
1460 * If a synchronisation point is found, we can stop discarding results as
1461 * the pipeline will switch back to a clean state. If no synchronisation
1462 * point is available, we need to stop when there are no more pending
1463 * results, otherwise, calling PQgetResult() would block.
1464 */
1465static PGresult *
1467{
1468 for (;;)
1469 {
1470 PGresult *res = PQgetResult(pset.db);
1471 ExecStatusType result_status = PQresultStatus(res);
1472
1473 if (result_status == PGRES_PIPELINE_SYNC)
1474 {
1475 /*
1476 * Found a synchronisation point. The sync counter is decremented
1477 * by the caller.
1478 */
1479 return res;
1480 }
1481 else if (res != NULL && result_status == PGRES_FATAL_ERROR)
1482 {
1483 /*
1484 * Found a FATAL error sent by the backend, and we cannot recover
1485 * from this state. Instead, return the last result and let the
1486 * outer loop handle it.
1487 */
1489
1490 /*
1491 * Fetch result to consume the end of the current query being
1492 * processed.
1493 */
1494 fatal_res = PQgetResult(pset.db);
1495 Assert(fatal_res == NULL);
1496 return res;
1497 }
1498 else if (res == NULL)
1499 {
1500 /* A query was processed, decrement the counters */
1505 }
1506
1507 if (pset.requested_results == 0)
1508 {
1509 /* We have read all the requested results, leave */
1510 return res;
1511 }
1512
1513 if (pset.available_results == 0 && pset.piped_syncs == 0)
1514 {
1515 /*
1516 * There are no more results to get and there is no
1517 * synchronisation point to stop at. This will leave the pipeline
1518 * in an aborted state.
1519 */
1520 return res;
1521 }
1522
1523 /*
1524 * An aborted pipeline will have either NULL results or results in an
1525 * PGRES_PIPELINE_ABORTED status.
1526 */
1527 Assert(res == NULL || result_status == PGRES_PIPELINE_ABORTED);
1528 PQclear(res);
1529 }
1530}
1531
1532/*
1533 * ExecQueryAndProcessResults: utility function for use by SendQuery()
1534 * and PSQLexecWatch().
1535 *
1536 * Sends query and cycles through PGresult objects.
1537 *
1538 * If our command string contained a COPY FROM STDIN or COPY TO STDOUT, the
1539 * PGresult associated with these commands must be processed by providing an
1540 * input or output stream. In that event, we'll marshal data for the COPY.
1541 *
1542 * For other commands, the results are processed normally, depending on their
1543 * status and the status of a pipeline.
1544 *
1545 * When invoked from \watch, is_watch is true and min_rows is the value
1546 * of that option, or 0 if it wasn't set.
1547 *
1548 * Returns 1 on complete success, 0 on interrupt and -1 or errors. Possible
1549 * failure modes include purely client-side problems; check the transaction
1550 * status for the server-side opinion.
1551 *
1552 * Note that on a combined query, failure does not mean that nothing was
1553 * committed.
1554 */
1555static int
1557 double *elapsed_msec, bool *svpt_gone_p,
1558 bool is_watch, int min_rows,
1559 const printQueryOpt *opt, FILE *printQueryFout)
1560{
1561 bool timing = pset.timing;
1562 bool success = false;
1563 bool return_early = false;
1564 bool end_pipeline = false;
1566 after;
1567 PGresult *result;
1568 FILE *gfile_fout = NULL;
1569 bool gfile_is_pipe = false;
1570
1571 if (timing)
1573 else
1575
1576 switch (pset.send_mode)
1577 {
1582 break;
1584 success = PQsendPrepare(pset.db, pset.stmtName, query, 0, NULL);
1587 break;
1589 Assert(pset.stmtName == NULL);
1591 pset.bind_nparams, NULL,
1592 (const char *const *) pset.bind_params,
1593 NULL, NULL, 0);
1596 break;
1598 Assert(pset.stmtName != NULL);
1601 (const char *const *) pset.bind_params,
1602 NULL, NULL, 0);
1605 break;
1608 break;
1612 {
1613 /*
1614 * End of the pipeline, all queued commands need to be
1615 * processed.
1616 */
1617 end_pipeline = true;
1618 pset.piped_syncs++;
1619
1620 /*
1621 * The server will send a ReadyForQuery after a Sync is
1622 * processed, flushing all the results back to the client.
1623 */
1625 pset.piped_commands = 0;
1626
1627 /* We want to read all results */
1629 }
1630 break;
1634 {
1635 pset.piped_syncs++;
1636
1637 /*
1638 * The server will send a ReadyForQuery after a Sync is
1639 * processed, flushing all the results back to the client.
1640 */
1642 pset.piped_commands = 0;
1643 }
1644 break;
1645 case PSQL_SEND_FLUSH:
1647 break;
1651 {
1652 /*
1653 * With the flush request, all commands in the pipeline are
1654 * pushed and the server will flush the results back to the
1655 * client, making them available.
1656 */
1658 pset.piped_commands = 0;
1659 }
1660 break;
1662 if (pset.available_results == 0 && pset.piped_syncs == 0)
1663 {
1664 /*
1665 * If no sync or flush request were sent, PQgetResult() would
1666 * block as there are no results available. Forbid any
1667 * attempt to get pending results should we try to reach this
1668 * state.
1669 */
1670 pg_log_info("No pending results to get");
1671 success = false;
1673 }
1674 else
1675 {
1676 success = true;
1677
1678 /*
1679 * Cap requested_results to the maximum number of known
1680 * results.
1681 */
1682 if (pset.requested_results == 0 ||
1685 }
1686 break;
1687 case PSQL_SEND_QUERY:
1689 {
1691 0, NULL, NULL, NULL, NULL, 0);
1692 if (success)
1694 }
1695 else
1696 success = PQsendQuery(pset.db, query);
1697 break;
1698 }
1699
1700 if (!success)
1701 {
1702 const char *error = PQerrorMessage(pset.db);
1703
1704 if (strlen(error))
1705 pg_log_info("%s", error);
1706
1708
1710
1711 return -1;
1712 }
1713
1714 if (pset.requested_results == 0 && !end_pipeline &&
1716 {
1717 /*
1718 * We are in a pipeline and have not reached the pipeline end, or
1719 * there was no request to read pipeline results. Update the psql
1720 * variables tracking the pipeline activity and exit.
1721 */
1723 return 1;
1724 }
1725
1726 /*
1727 * Fetch the result in chunks if FETCH_COUNT is set, except when:
1728 *
1729 * * SHOW_ALL_RESULTS is false, since that requires us to complete the
1730 * query before we can tell if its results should be displayed.
1731 *
1732 * * We're doing \crosstab, which likewise needs to see all the rows at
1733 * once.
1734 *
1735 * * We're doing \gexec: we must complete the data fetch to make the
1736 * connection free for issuing the resulting commands.
1737 *
1738 * * We're doing \gset: only one result row is allowed anyway.
1739 *
1740 * * We're doing \watch: users probably don't want us to force use of the
1741 * pager for that, plus chunking could break the min_rows check.
1742 */
1745 !pset.gset_prefix && !is_watch)
1746 {
1748 pg_log_warning("fetching results in chunked mode failed");
1749 }
1750
1751 /*
1752 * If SIGINT is sent while the query is processing, the interrupt will be
1753 * consumed. The user's intention, though, is to cancel the entire watch
1754 * process, so detect a sent cancellation request and exit in this case.
1755 */
1756 if (is_watch && cancel_pressed)
1757 {
1759 return 0;
1760 }
1761
1762 /* first result */
1763 result = PQgetResult(pset.db);
1764 if (min_rows > 0 && PQntuples(result) < min_rows)
1765 {
1766 return_early = true;
1767 }
1768
1769 while (result != NULL)
1770 {
1771 ExecStatusType result_status;
1772 bool is_chunked_result = false;
1773 PGresult *next_result = NULL;
1774 bool last;
1775
1776 if (!AcceptResult(result, false))
1777 {
1778 /*
1779 * Some error occurred, either a server-side failure or a failure
1780 * to submit the command string. Record that.
1781 */
1782 const char *error = PQresultErrorMessage(result);
1783
1784 if (strlen(error))
1785 pg_log_info("%s", error);
1786
1788 if (!is_watch)
1789 SetResultVariables(result, false);
1790
1791 /* keep the result status before clearing it */
1792 result_status = PQresultStatus(result);
1793 ClearOrSaveResult(result);
1794 success = false;
1795
1796 if (result_status == PGRES_PIPELINE_ABORTED)
1797 pg_log_info("Pipeline aborted, command did not run");
1798
1799 /*
1800 * switch to next result
1801 */
1802 if (result_status == PGRES_COPY_BOTH ||
1803 result_status == PGRES_COPY_OUT ||
1804 result_status == PGRES_COPY_IN)
1805 {
1806 /*
1807 * For some obscure reason PQgetResult does *not* return a
1808 * NULL in copy cases despite the result having been cleared,
1809 * but keeps returning an "empty" result that we have to
1810 * ignore manually.
1811 */
1812 result = NULL;
1813 }
1814 else if ((end_pipeline || pset.requested_results > 0)
1816 {
1817 /*
1818 * Error within a pipeline. All commands are aborted until
1819 * the next synchronisation point. We need to consume all the
1820 * results until this synchronisation point, or stop when
1821 * there are no more result to discard.
1822 *
1823 * Checking the pipeline status is necessary for the case
1824 * where the connection was reset. The new connection is not
1825 * in any kind of pipeline state and thus has no result to
1826 * discard.
1827 */
1829 }
1830 else
1831 result = PQgetResult(pset.db);
1832
1833 /*
1834 * Get current timing measure in case an error occurs
1835 */
1836 if (timing)
1837 {
1840 *elapsed_msec = INSTR_TIME_GET_MILLISEC(after);
1841 }
1842
1843 continue;
1844 }
1845 else if (svpt_gone_p && !*svpt_gone_p)
1846 {
1847 /*
1848 * Check if the user ran any command that would destroy our
1849 * internal savepoint: If the user did COMMIT AND CHAIN, RELEASE
1850 * or ROLLBACK, our savepoint is gone. If they issued a SAVEPOINT,
1851 * releasing ours would remove theirs.
1852 */
1853 const char *cmd = PQcmdStatus(result);
1854
1855 *svpt_gone_p = (strcmp(cmd, "COMMIT") == 0 ||
1856 strcmp(cmd, "SAVEPOINT") == 0 ||
1857 strcmp(cmd, "RELEASE") == 0 ||
1858 strcmp(cmd, "ROLLBACK") == 0);
1859 }
1860
1861 result_status = PQresultStatus(result);
1862
1863 /* must handle COPY before changing the current result */
1864 Assert(result_status != PGRES_COPY_BOTH);
1865 if (result_status == PGRES_COPY_IN ||
1866 result_status == PGRES_COPY_OUT)
1867 {
1868 FILE *copy_stream = NULL;
1869
1870 /*
1871 * For COPY OUT, direct the output to the default place (probably
1872 * a pager pipe) for \watch, or to pset.copyStream for \copy,
1873 * otherwise to pset.gfname if that's set, otherwise to
1874 * pset.queryFout.
1875 */
1876 if (result_status == PGRES_COPY_OUT)
1877 {
1878 if (is_watch)
1879 {
1880 /* invoked by \watch */
1881 copy_stream = printQueryFout ? printQueryFout : pset.queryFout;
1882 }
1883 else if (pset.copyStream)
1884 {
1885 /* invoked by \copy */
1886 copy_stream = pset.copyStream;
1887 }
1888 else if (pset.gfname)
1889 {
1890 /* COPY followed by \g filename or \g |program */
1891 success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
1892 if (gfile_fout)
1893 copy_stream = gfile_fout;
1894 }
1895 else
1896 {
1897 /* fall back to the generic query output stream */
1898 copy_stream = pset.queryFout;
1899 }
1900 }
1901
1902 /*
1903 * Even if the output stream could not be opened, we call
1904 * HandleCopyResult() with a NULL output stream to collect and
1905 * discard the COPY data.
1906 */
1907 success &= HandleCopyResult(&result, copy_stream);
1908 }
1909
1910 /* If we have a chunked result, collect and print all chunks */
1911 if (result_status == PGRES_TUPLES_CHUNK)
1912 {
1913 FILE *tuples_fout = printQueryFout ? printQueryFout : pset.queryFout;
1914 printQueryOpt my_popt = opt ? *opt : pset.popt;
1915 int64 total_tuples = 0;
1916 bool is_pager = false;
1917 int flush_error = 0;
1918
1919 /* initialize print options for partial table output */
1920 my_popt.topt.start_table = true;
1921 my_popt.topt.stop_table = false;
1922 my_popt.topt.prior_records = 0;
1923
1924 /* open \g file if needed */
1925 success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
1926 if (gfile_fout)
1927 tuples_fout = gfile_fout;
1928
1929 /* force use of pager for any chunked resultset going to stdout */
1930 if (success && tuples_fout == stdout)
1931 {
1932 tuples_fout = PageOutput(INT_MAX, &(my_popt.topt));
1933 is_pager = true;
1934 }
1935
1936 do
1937 {
1938 /*
1939 * Display the current chunk of results, unless the output
1940 * stream stopped working or we got canceled. We skip use of
1941 * PrintQueryResult and go directly to printQuery, so that we
1942 * can pass the correct is_pager value and because we don't
1943 * want PrintQueryStatus to happen yet. Above, we rejected
1944 * use of chunking for all cases in which PrintQueryResult
1945 * would send the result to someplace other than printQuery.
1946 */
1947 if (success && !flush_error && !cancel_pressed)
1948 {
1949 printQuery(result, &my_popt, tuples_fout, is_pager, pset.logfile);
1950 flush_error = fflush(tuples_fout);
1951 }
1952
1953 /* after the first result set, disallow header decoration */
1954 my_popt.topt.start_table = false;
1955
1956 /* count tuples before dropping the result */
1957 my_popt.topt.prior_records += PQntuples(result);
1958 total_tuples += PQntuples(result);
1959
1960 ClearOrSaveResult(result);
1961
1962 /* get the next result, loop if it's PGRES_TUPLES_CHUNK */
1963 result = PQgetResult(pset.db);
1964 } while (PQresultStatus(result) == PGRES_TUPLES_CHUNK);
1965
1966 /* We expect an empty PGRES_TUPLES_OK, else there's a problem */
1967 if (PQresultStatus(result) == PGRES_TUPLES_OK)
1968 {
1969 char buf[32];
1970
1971 Assert(PQntuples(result) == 0);
1972
1973 /* Display the footer using the empty result */
1974 if (success && !flush_error && !cancel_pressed)
1975 {
1976 my_popt.topt.stop_table = true;
1977 printQuery(result, &my_popt, tuples_fout, is_pager, pset.logfile);
1978 fflush(tuples_fout);
1979 }
1980
1981 if (is_pager)
1982 ClosePager(tuples_fout);
1983
1984 /*
1985 * It's possible the data is from a RETURNING clause, in which
1986 * case we need to print query status.
1987 */
1988 PrintQueryStatus(result, printQueryFout);
1989
1990 /*
1991 * We must do a fake SetResultVariables(), since we don't have
1992 * a PGresult corresponding to the whole query.
1993 */
1994 SetVariable(pset.vars, "ERROR", "false");
1995 SetVariable(pset.vars, "SQLSTATE", "00000");
1996 snprintf(buf, sizeof(buf), INT64_FORMAT, total_tuples);
1997 SetVariable(pset.vars, "ROW_COUNT", buf);
1998 /* Prevent SetResultVariables call below */
1999 is_chunked_result = true;
2000
2001 /* Clear the empty result so it isn't printed below */
2002 ClearOrSaveResult(result);
2003 result = NULL;
2004 }
2005 else
2006 {
2007 /* Probably an error report, so close the pager and print it */
2008 if (is_pager)
2009 ClosePager(tuples_fout);
2010
2011 success &= AcceptResult(result, true);
2012 /* SetResultVariables and ClearOrSaveResult happen below */
2013 }
2014 }
2015
2016 if (result_status == PGRES_PIPELINE_SYNC)
2017 {
2018 Assert(pset.piped_syncs > 0);
2019
2020 /*
2021 * Sync response, decrease the sync and requested_results
2022 * counters.
2023 */
2024 pset.piped_syncs--;
2026
2027 /*
2028 * After a synchronisation point, reset success state to print
2029 * possible successful results that will be processed after this.
2030 */
2031 success = true;
2032
2033 /*
2034 * If all syncs were processed and pipeline end was requested,
2035 * exit pipeline mode.
2036 */
2037 if (end_pipeline && pset.piped_syncs == 0)
2039 }
2040 else if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF &&
2041 result_status != PGRES_PIPELINE_SYNC)
2042 {
2043 /*
2044 * In a pipeline with a non-sync response? Decrease the result
2045 * counters.
2046 */
2049 }
2050
2051 /*
2052 * Check PQgetResult() again. In the typical case of a single-command
2053 * string, it will return NULL. Otherwise, we'll have other results
2054 * to process. We need to do that to check whether this is the last.
2055 */
2057 next_result = PQgetResult(pset.db);
2058 else
2059 {
2060 /*
2061 * In pipeline mode, a NULL result indicates the end of the
2062 * current query being processed. Call PQgetResult() once to
2063 * consume this state.
2064 */
2065 if (result_status != PGRES_PIPELINE_SYNC)
2066 {
2067 next_result = PQgetResult(pset.db);
2068 Assert(next_result == NULL);
2069 }
2070
2071 /* Now, we can get the next result in the pipeline. */
2072 if (pset.requested_results > 0)
2073 next_result = PQgetResult(pset.db);
2074 }
2075
2076 last = (next_result == NULL);
2077
2078 /*
2079 * Update current timing measure.
2080 *
2081 * It will include the display of previous results, if any. This
2082 * cannot be helped because the server goes on processing further
2083 * queries anyway while the previous ones are being displayed. The
2084 * parallel execution of the client display hides the server time when
2085 * it is shorter.
2086 *
2087 * With combined queries, timing must be understood as an upper bound
2088 * of the time spent processing them.
2089 */
2090 if (timing)
2091 {
2094 *elapsed_msec = INSTR_TIME_GET_MILLISEC(after);
2095 }
2096
2097 /*
2098 * This may or may not print something depending on settings.
2099 *
2100 * A pipeline sync will have a non-NULL result but does not have
2101 * anything to print, thus ignore results in this case.
2102 */
2103 if (result != NULL && result_status != PGRES_PIPELINE_SYNC)
2104 {
2105 /*
2106 * If results need to be printed into the file specified by \g,
2107 * open it, unless we already did. Note that when pset.gfname is
2108 * set, the passed-in value of printQueryFout is not used for
2109 * tuple output, but it's still used for status output.
2110 */
2111 FILE *tuples_fout = printQueryFout;
2112
2113 if (PQresultStatus(result) == PGRES_TUPLES_OK)
2114 success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
2115 if (gfile_fout)
2116 tuples_fout = gfile_fout;
2117 if (success)
2118 success &= PrintQueryResult(result, last, opt,
2119 tuples_fout, printQueryFout);
2120 }
2121
2122 /* set variables from last result, unless dealt with elsewhere */
2123 if (last && !is_watch && !is_chunked_result)
2124 SetResultVariables(result, success);
2125
2126 ClearOrSaveResult(result);
2127 result = next_result;
2128
2130 {
2131 /*
2132 * Outside of a pipeline, drop the next result, as well as any
2133 * others not yet read.
2134 *
2135 * Within a pipeline, we can let the outer loop handle this as an
2136 * aborted pipeline, which will discard then all the results.
2137 */
2138 ClearOrSaveResult(result);
2140 break;
2141 }
2142 }
2143
2144 /* close \g file if we opened it */
2145 CloseGOutput(gfile_fout, gfile_is_pipe);
2146
2147 if (end_pipeline)
2148 {
2149 /* after a pipeline is processed, pipeline piped_syncs should be 0 */
2150 Assert(pset.piped_syncs == 0);
2151 /* all commands have been processed */
2153 /* all results were read */
2155 }
2158
2159 /* may need this to recover from conn loss during COPY */
2160 if (!CheckConnection())
2161 return -1;
2162
2163 if (cancel_pressed || return_early)
2164 return 0;
2165
2166 return success ? 1 : -1;
2167}
2168
2169
2170/*
2171 * Advance the given char pointer over white space and SQL comments.
2172 */
2173static const char *
2174skip_white_space(const char *query)
2175{
2176 int cnestlevel = 0; /* slash-star comment nest level */
2177
2178 while (*query)
2179 {
2180 int mblen = PQmblenBounded(query, pset.encoding);
2181
2182 /*
2183 * Note: we assume the encoding is a superset of ASCII, so that for
2184 * example "query[0] == '/'" is meaningful. However, we do NOT assume
2185 * that the second and subsequent bytes of a multibyte character
2186 * couldn't look like ASCII characters; so it is critical to advance
2187 * by mblen, not 1, whenever we haven't exactly identified the
2188 * character we are skipping over.
2189 */
2190 if (isspace((unsigned char) *query))
2191 query += mblen;
2192 else if (query[0] == '/' && query[1] == '*')
2193 {
2194 cnestlevel++;
2195 query += 2;
2196 }
2197 else if (cnestlevel > 0 && query[0] == '*' && query[1] == '/')
2198 {
2199 cnestlevel--;
2200 query += 2;
2201 }
2202 else if (cnestlevel == 0 && query[0] == '-' && query[1] == '-')
2203 {
2204 query += 2;
2205
2206 /*
2207 * We have to skip to end of line since any slash-star inside the
2208 * -- comment does NOT start a slash-star comment.
2209 */
2210 while (*query)
2211 {
2212 if (*query == '\n')
2213 {
2214 query++;
2215 break;
2216 }
2217 query += PQmblenBounded(query, pset.encoding);
2218 }
2219 }
2220 else if (cnestlevel > 0)
2221 query += mblen;
2222 else
2223 break; /* found first token */
2224 }
2225
2226 return query;
2227}
2228
2229
2230/*
2231 * Check whether a command is one of those for which we should NOT start
2232 * a new transaction block (ie, send a preceding BEGIN).
2233 *
2234 * These include the transaction control statements themselves, plus
2235 * certain statements that the backend disallows inside transaction blocks.
2236 */
2237static bool
2238command_no_begin(const char *query)
2239{
2240 int wordlen;
2241
2242 /*
2243 * First we must advance over any whitespace and comments.
2244 */
2245 query = skip_white_space(query);
2246
2247 /*
2248 * Check word length (since "beginx" is not "begin").
2249 */
2250 wordlen = 0;
2251 while (isalpha((unsigned char) query[wordlen]))
2252 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2253
2254 /*
2255 * Transaction control commands. These should include every keyword that
2256 * gives rise to a TransactionStmt in the backend grammar, except for the
2257 * savepoint-related commands.
2258 *
2259 * (We assume that START must be START TRANSACTION, since there is
2260 * presently no other "START foo" command.)
2261 */
2262 if (wordlen == 5 && pg_strncasecmp(query, "abort", 5) == 0)
2263 return true;
2264 if (wordlen == 5 && pg_strncasecmp(query, "begin", 5) == 0)
2265 return true;
2266 if (wordlen == 5 && pg_strncasecmp(query, "start", 5) == 0)
2267 return true;
2268 if (wordlen == 6 && pg_strncasecmp(query, "commit", 6) == 0)
2269 return true;
2270 if (wordlen == 3 && pg_strncasecmp(query, "end", 3) == 0)
2271 return true;
2272 if (wordlen == 8 && pg_strncasecmp(query, "rollback", 8) == 0)
2273 return true;
2274 if (wordlen == 7 && pg_strncasecmp(query, "prepare", 7) == 0)
2275 {
2276 /* PREPARE TRANSACTION is a TC command, PREPARE foo is not */
2277 query += wordlen;
2278
2279 query = skip_white_space(query);
2280
2281 wordlen = 0;
2282 while (isalpha((unsigned char) query[wordlen]))
2283 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2284
2285 if (wordlen == 11 && pg_strncasecmp(query, "transaction", 11) == 0)
2286 return true;
2287 return false;
2288 }
2289
2290 /*
2291 * Commands not allowed within transactions. The statements checked for
2292 * here should be exactly those that call PreventInTransactionBlock() in
2293 * the backend.
2294 */
2295 if (wordlen == 6 && pg_strncasecmp(query, "vacuum", 6) == 0)
2296 return true;
2297 if (wordlen == 7 && pg_strncasecmp(query, "cluster", 7) == 0)
2298 {
2299 /* CLUSTER with any arguments is allowed in transactions */
2300 query += wordlen;
2301
2302 query = skip_white_space(query);
2303
2304 if (isalpha((unsigned char) query[0]))
2305 return false; /* has additional words */
2306 return true; /* it's CLUSTER without arguments */
2307 }
2308
2309 if (wordlen == 6 && pg_strncasecmp(query, "create", 6) == 0)
2310 {
2311 query += wordlen;
2312
2313 query = skip_white_space(query);
2314
2315 wordlen = 0;
2316 while (isalpha((unsigned char) query[wordlen]))
2317 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2318
2319 if (wordlen == 8 && pg_strncasecmp(query, "database", 8) == 0)
2320 return true;
2321 if (wordlen == 10 && pg_strncasecmp(query, "tablespace", 10) == 0)
2322 return true;
2323
2324 /* CREATE [UNIQUE] INDEX CONCURRENTLY isn't allowed in xacts */
2325 if (wordlen == 6 && pg_strncasecmp(query, "unique", 6) == 0)
2326 {
2327 query += wordlen;
2328
2329 query = skip_white_space(query);
2330
2331 wordlen = 0;
2332 while (isalpha((unsigned char) query[wordlen]))
2333 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2334 }
2335
2336 if (wordlen == 5 && pg_strncasecmp(query, "index", 5) == 0)
2337 {
2338 query += wordlen;
2339
2340 query = skip_white_space(query);
2341
2342 wordlen = 0;
2343 while (isalpha((unsigned char) query[wordlen]))
2344 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2345
2346 if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2347 return true;
2348 }
2349
2350 return false;
2351 }
2352
2353 if (wordlen == 5 && pg_strncasecmp(query, "alter", 5) == 0)
2354 {
2355 query += wordlen;
2356
2357 query = skip_white_space(query);
2358
2359 wordlen = 0;
2360 while (isalpha((unsigned char) query[wordlen]))
2361 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2362
2363 /* ALTER SYSTEM isn't allowed in xacts */
2364 if (wordlen == 6 && pg_strncasecmp(query, "system", 6) == 0)
2365 return true;
2366
2367 return false;
2368 }
2369
2370 /*
2371 * Note: these tests will match DROP SYSTEM and REINDEX TABLESPACE, which
2372 * aren't really valid commands so we don't care much. The other four
2373 * possible matches are correct.
2374 */
2375 if ((wordlen == 4 && pg_strncasecmp(query, "drop", 4) == 0) ||
2376 (wordlen == 7 && pg_strncasecmp(query, "reindex", 7) == 0))
2377 {
2378 query += wordlen;
2379
2380 query = skip_white_space(query);
2381
2382 wordlen = 0;
2383 while (isalpha((unsigned char) query[wordlen]))
2384 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2385
2386 if (wordlen == 8 && pg_strncasecmp(query, "database", 8) == 0)
2387 return true;
2388 if (wordlen == 6 && pg_strncasecmp(query, "system", 6) == 0)
2389 return true;
2390 if (wordlen == 10 && pg_strncasecmp(query, "tablespace", 10) == 0)
2391 return true;
2392 if (wordlen == 5 && (pg_strncasecmp(query, "index", 5) == 0 ||
2393 pg_strncasecmp(query, "table", 5) == 0))
2394 {
2395 query += wordlen;
2396 query = skip_white_space(query);
2397 wordlen = 0;
2398 while (isalpha((unsigned char) query[wordlen]))
2399 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2400
2401 /*
2402 * REINDEX [ TABLE | INDEX ] CONCURRENTLY are not allowed in
2403 * xacts.
2404 */
2405 if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2406 return true;
2407 }
2408
2409 /* DROP INDEX CONCURRENTLY isn't allowed in xacts */
2410 if (wordlen == 5 && pg_strncasecmp(query, "index", 5) == 0)
2411 {
2412 query += wordlen;
2413
2414 query = skip_white_space(query);
2415
2416 wordlen = 0;
2417 while (isalpha((unsigned char) query[wordlen]))
2418 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2419
2420 if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2421 return true;
2422
2423 return false;
2424 }
2425
2426 return false;
2427 }
2428
2429 /* DISCARD ALL isn't allowed in xacts, but other variants are allowed. */
2430 if (wordlen == 7 && pg_strncasecmp(query, "discard", 7) == 0)
2431 {
2432 query += wordlen;
2433
2434 query = skip_white_space(query);
2435
2436 wordlen = 0;
2437 while (isalpha((unsigned char) query[wordlen]))
2438 wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2439
2440 if (wordlen == 3 && pg_strncasecmp(query, "all", 3) == 0)
2441 return true;
2442 return false;
2443 }
2444
2445 return false;
2446}
2447
2448
2449/*
2450 * Test if the current user is a database superuser.
2451 */
2452bool
2454{
2455 const char *val;
2456
2457 if (!pset.db)
2458 return false;
2459
2460 val = PQparameterStatus(pset.db, "is_superuser");
2461
2462 if (val && strcmp(val, "on") == 0)
2463 return true;
2464
2465 return false;
2466}
2467
2468
2469/*
2470 * Test if the current session uses standard string literals.
2471 */
2472bool
2474{
2475 const char *val;
2476
2477 if (!pset.db)
2478 return false;
2479
2480 val = PQparameterStatus(pset.db, "standard_conforming_strings");
2481
2482 if (val && strcmp(val, "on") == 0)
2483 return true;
2484
2485 return false;
2486}
2487
2488
2489/*
2490 * Return the session user of the current connection.
2491 */
2492const char *
2494{
2495 const char *val;
2496
2497 if (!pset.db)
2498 return NULL;
2499
2500 val = PQparameterStatus(pset.db, "session_authorization");
2501 if (val)
2502 return val;
2503 else
2504 return PQuser(pset.db);
2505}
2506
2507
2508/* expand_tilde
2509 *
2510 * substitute '~' with HOME or '~username' with username's home dir
2511 *
2512 */
2513void
2515{
2516 if (!filename || !(*filename))
2517 return;
2518
2519 /*
2520 * WIN32 doesn't use tilde expansion for file names. Also, it uses tilde
2521 * for short versions of long file names, though the tilde is usually
2522 * toward the end, not at the beginning.
2523 */
2524#ifndef WIN32
2525
2526 /* try tilde expansion */
2527 if (**filename == '~')
2528 {
2529 char *fn;
2530 char oldp,
2531 *p;
2532 struct passwd *pw;
2533 char home[MAXPGPATH];
2534
2535 fn = *filename;
2536 *home = '\0';
2537
2538 p = fn + 1;
2539 while (*p != '/' && *p != '\0')
2540 p++;
2541
2542 oldp = *p;
2543 *p = '\0';
2544
2545 if (*(fn + 1) == '\0')
2546 get_home_path(home); /* ~ or ~/ only */
2547 else if ((pw = getpwnam(fn + 1)) != NULL)
2548 strlcpy(home, pw->pw_dir, sizeof(home)); /* ~user */
2549
2550 *p = oldp;
2551 if (strlen(home) != 0)
2552 {
2553 char *newfn;
2554
2555 newfn = psprintf("%s%s", home, p);
2556 free(fn);
2557 *filename = newfn;
2558 }
2559 }
2560#endif
2561}
2562
2563/*
2564 * Checks if connection string starts with either of the valid URI prefix
2565 * designators.
2566 *
2567 * Returns the URI prefix length, 0 if the string doesn't contain a URI prefix.
2568 *
2569 * XXX This is a duplicate of the eponymous libpq function.
2570 */
2571static int
2573{
2574 /* The connection URI must start with either of the following designators: */
2575 static const char uri_designator[] = "postgresql://";
2576 static const char short_uri_designator[] = "postgres://";
2577
2578 if (strncmp(connstr, uri_designator,
2579 sizeof(uri_designator) - 1) == 0)
2580 return sizeof(uri_designator) - 1;
2581
2582 if (strncmp(connstr, short_uri_designator,
2583 sizeof(short_uri_designator) - 1) == 0)
2584 return sizeof(short_uri_designator) - 1;
2585
2586 return 0;
2587}
2588
2589/*
2590 * Reset state related to extended query protocol
2591 *
2592 * Clean up any state related to bind parameters, statement name and
2593 * PSQL_SEND_MODE. This needs to be called after processing a query or when
2594 * running a new meta-command that uses the extended query protocol, like
2595 * \parse, \bind, etc.
2596 */
2597void
2599{
2600 int i;
2601
2602 switch (pset.send_mode)
2603 {
2604 case PSQL_SEND_EXTENDED_CLOSE: /* \close */
2606 break;
2607 case PSQL_SEND_EXTENDED_PARSE: /* \parse */
2609 break;
2610 case PSQL_SEND_EXTENDED_QUERY_PARAMS: /* \bind */
2611 case PSQL_SEND_EXTENDED_QUERY_PREPARED: /* \bind_named */
2612 for (i = 0; i < pset.bind_nparams; i++)
2616 pset.bind_params = NULL;
2617 break;
2618 case PSQL_SEND_QUERY:
2619 case PSQL_SEND_START_PIPELINE_MODE: /* \startpipeline */
2620 case PSQL_SEND_END_PIPELINE_MODE: /* \endpipeline */
2621 case PSQL_SEND_PIPELINE_SYNC: /* \syncpipeline */
2622 case PSQL_SEND_FLUSH: /* \flush */
2623 case PSQL_SEND_GET_RESULTS: /* \getresults */
2624 case PSQL_SEND_FLUSH_REQUEST: /* \flushrequest */
2625 break;
2626 }
2627
2628 pset.stmtName = NULL;
2630}
2631
2632/*
2633 * Recognized connection string either starts with a valid URI prefix or
2634 * contains a "=" in it.
2635 *
2636 * Must be consistent with parse_connection_string: anything for which this
2637 * returns true should at least look like it's parseable by that routine.
2638 *
2639 * XXX This is a duplicate of the eponymous libpq function.
2640 */
2641bool
2643{
2644 return uri_prefix_length(connstr) != 0 || strchr(connstr, '=') != NULL;
2645}
const char *const days[]
Definition: datetime.c:84
void expand_tilde(char **filename)
Definition: common.c:2514
PGresult * PSQLexec(const char *query)
Definition: common.c:655
void psql_setup_cancel_handler(void)
Definition: common.c:325
volatile sig_atomic_t sigint_interrupt_enabled
Definition: common.c:304
static bool PrintQueryResult(PGresult *result, bool last, const printQueryOpt *opt, FILE *printQueryFout, FILE *printStatusFout)
Definition: common.c:1039
static bool CheckConnection(void)
Definition: common.c:354
const char * session_username(void)
Definition: common.c:2493
static void PrintQueryStatus(PGresult *result, FILE *printQueryFout)
Definition: common.c:992
static int uri_prefix_length(const char *connstr)
Definition: common.c:2572
static bool DescribeQuery(const char *query, double *elapsed_msec)
Definition: common.c:1350
static void ClearOrSaveAllResults(void)
Definition: common.c:582
static PGresult * discardAbortedPipelineResults(void)
Definition: common.c:1466
static bool ExecQueryTuples(const PGresult *result)
Definition: common.c:861
static void PrintNotifications(void)
Definition: common.c:740
static void SetResultVariables(PGresult *result, bool success)
Definition: common.c:476
char * psql_get_variable(const char *varname, PsqlScanQuoteType quote, void *passthrough)
Definition: common.c:188
sigjmp_buf sigint_interrupt_jmp
Definition: common.c:306
static void ClearOrSaveResult(PGresult *result)
Definition: common.c:558
static bool SetupGOutput(FILE **gfile_fout, bool *is_pipe)
Definition: common.c:90
static void psql_cancel_callback(void)
Definition: common.c:309
static bool AcceptResult(const PGresult *result, bool show_error)
Definition: common.c:416
static bool HandleCopyResult(PGresult **resultp, FILE *copystream)
Definition: common.c:937
int PSQLexecWatch(const char *query, const printQueryOpt *opt, FILE *printQueryFout, int min_rows)
Definition: common.c:710
void SetShellResultVariables(int wait_result)
Definition: common.c:516
void NoticeProcessor(void *arg, const char *message)
Definition: common.c:279
void clean_extended_state(void)
Definition: common.c:2598
static bool StoreQueryTuple(const PGresult *result)
Definition: common.c:797
static void CloseGOutput(FILE *gfile_fout, bool is_pipe)
Definition: common.c:110
static const char * skip_white_space(const char *query)
Definition: common.c:2174
bool standard_strings(void)
Definition: common.c:2473
static void SetPipelineVariables(void)
Definition: common.c:534
static bool PrintQueryTuples(const PGresult *result, const printQueryOpt *opt, FILE *printQueryFout)
Definition: common.c:773
static void pipelineReset(void)
Definition: common.c:128
static bool ConnectionUp(void)
Definition: common.c:336
bool is_superuser(void)
Definition: common.c:2453
bool setQFout(const char *fname)
Definition: common.c:144
static int ExecQueryAndProcessResults(const char *query, double *elapsed_msec, bool *svpt_gone_p, bool is_watch, int min_rows, const printQueryOpt *opt, FILE *printQueryFout)
Definition: common.c:1556
bool openQueryOutputFile(const char *fname, FILE **fout, bool *is_pipe)
Definition: common.c:56
bool recognized_connection_string(const char *connstr)
Definition: common.c:2642
static void PrintTiming(double elapsed_msec)
Definition: common.c:596
bool SendQuery(const char *query)
Definition: common.c:1118
static bool command_no_begin(const char *query)
Definition: common.c:2238
bool handleCopyOut(PGconn *conn, FILE *copystream, PGresult **res)
Definition: copy.c:434
bool handleCopyIn(PGconn *conn, FILE *copystream, bool isbinary, PGresult **res)
Definition: copy.c:511
#define gettext_noop(x)
Definition: c.h:1167
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:224
#define INT64_FORMAT
Definition: c.h:520
int64_t int64
Definition: c.h:499
#define lengthof(array)
Definition: c.h:759
void ResetCancelConn(void)
Definition: cancel.c:107
void SetCancelConn(PGconn *conn)
Definition: cancel.c:77
void setup_cancel_handler(void(*query_cancel_callback)(void))
Definition: cancel.c:183
void restorePsetInfo(printQueryOpt *popt, printQueryOpt *save)
Definition: command.c:5560
void UnsyncVariables(void)
Definition: command.c:4520
void SyncVariables(void)
Definition: command.c:4476
void connection_warnings(bool in_startup)
Definition: command.c:4348
bool conditional_active(ConditionalStack cstack)
Definition: conditional.c:140
bool PrintResultInCrosstab(const PGresult *res)
Definition: crosstabview.c:104
#define fprintf(file, fmt, msg)
Definition: cubescan.l:21
#define _(x)
Definition: elog.c:91
void PQreset(PGconn *conn)
Definition: fe-connect.c:5304
static const char short_uri_designator[]
Definition: fe-connect.c:440
PGTransactionStatusType PQtransactionStatus(const PGconn *conn)
Definition: fe-connect.c:7564
static const char uri_designator[]
Definition: fe-connect.c:439
const char * PQparameterStatus(const PGconn *conn, const char *paramName)
Definition: fe-connect.c:7574
ConnStatusType PQstatus(const PGconn *conn)
Definition: fe-connect.c:7556
int PQclientEncoding(const PGconn *conn)
Definition: fe-connect.c:7709
void PQfinish(PGconn *conn)
Definition: fe-connect.c:5290
char * PQuser(const PGconn *conn)
Definition: fe-connect.c:7463
PGpipelineStatus PQpipelineStatus(const PGconn *conn)
Definition: fe-connect.c:7663
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7619
int PQsendQueryParams(PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
Definition: fe-exec.c:1492
int PQbinaryTuples(const PGresult *res)
Definition: fe-exec.c:3497
int PQflush(PGconn *conn)
Definition: fe-exec.c:4000
void PQfreemem(void *ptr)
Definition: fe-exec.c:4032
Oid PQftype(const PGresult *res, int field_num)
Definition: fe-exec.c:3719
PGresult * PQdescribePrepared(PGconn *conn, const char *stmt)
Definition: fe-exec.c:2455
int PQexitPipelineMode(PGconn *conn)
Definition: fe-exec.c:3073
int PQenterPipelineMode(PGconn *conn)
Definition: fe-exec.c:3042
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3876
PGresult * PQgetResult(PGconn *conn)
Definition: fe-exec.c:2062
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3411
void PQclear(PGresult *res)
Definition: fe-exec.c:721
int PQsendClosePrepared(PGconn *conn, const char *stmt)
Definition: fe-exec.c:2556
char * PQcmdTuples(PGresult *res)
Definition: fe-exec.c:3822
int PQsendPipelineSync(PGconn *conn)
Definition: fe-exec.c:3282
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3481
PGresult * PQprepare(PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes)
Definition: fe-exec.c:2306
char * PQresultErrorMessage(const PGresult *res)
Definition: fe-exec.c:3427
char * PQfname(const PGresult *res, int field_num)
Definition: fe-exec.c:3567
int PQconsumeInput(PGconn *conn)
Definition: fe-exec.c:1984
char * PQescapeLiteral(PGconn *conn, const char *str, size_t len)
Definition: fe-exec.c:4363
int PQsendPrepare(PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes)
Definition: fe-exec.c:1536
int PQfmod(const PGresult *res, int field_num)
Definition: fe-exec.c:3741
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3901
int PQsetChunkedRowsMode(PGconn *conn, int chunkSize)
Definition: fe-exec.c:1965
char * PQresultErrorField(const PGresult *res, int fieldcode)
Definition: fe-exec.c:3466
int PQsendQuery(PGconn *conn, const char *query)
Definition: fe-exec.c:1416
char * PQcmdStatus(PGresult *res)
Definition: fe-exec.c:3752
int PQpipelineSync(PGconn *conn)
Definition: fe-exec.c:3272
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2262
int PQsendQueryPrepared(PGconn *conn, const char *stmtName, int nParams, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
Definition: fe-exec.c:1633
char * PQescapeIdentifier(PGconn *conn, const char *str, size_t len)
Definition: fe-exec.c:4369
int PQsendFlushRequest(PGconn *conn)
Definition: fe-exec.c:3371
Oid PQoidValue(const PGresult *res)
Definition: fe-exec.c:3793
int PQnfields(const PGresult *res)
Definition: fe-exec.c:3489
PGnotify * PQnotifies(PGconn *conn)
Definition: fe-exec.c:2667
int PQmblenBounded(const char *s, int encoding)
Definition: fe-misc.c:1243
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void pg_free(void *ptr)
Definition: fe_memutils.c:105
void restore_sigpipe_trap(void)
Definition: print.c:3062
void printQuery(const PGresult *result, const printQueryOpt *opt, FILE *fout, bool is_pager, FILE *flog)
Definition: print.c:3549
FILE * PageOutput(int lines, const printTableOpt *topt)
Definition: print.c:3089
void ClosePager(FILE *pagerpipe)
Definition: print.c:3141
void disable_sigpipe_trap(void)
Definition: print.c:3039
void html_escaped_print(const char *in, FILE *fout)
Definition: print.c:1952
void set_sigpipe_trap_state(bool ignore)
Definition: print.c:3075
volatile sig_atomic_t cancel_pressed
Definition: print.c:43
@ PRINT_HTML
Definition: print.h:34
Assert(PointerIsAligned(start, uint64))
#define free(a)
Definition: header.h:65
long val
Definition: informix.c:689
static struct @165 value
static bool success
Definition: initdb.c:187
#define INSTR_TIME_SET_CURRENT(t)
Definition: instr_time.h:122
#define INSTR_TIME_SUBTRACT(x, y)
Definition: instr_time.h:181
#define INSTR_TIME_GET_MILLISEC(t)
Definition: instr_time.h:191
#define INSTR_TIME_SET_ZERO(t)
Definition: instr_time.h:172
int i
Definition: isn.c:77
@ CONNECTION_BAD
Definition: libpq-fe.h:85
ExecStatusType
Definition: libpq-fe.h:123
@ PGRES_COPY_IN
Definition: libpq-fe.h:132
@ PGRES_COPY_BOTH
Definition: libpq-fe.h:137
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:125
@ PGRES_TUPLES_CHUNK
Definition: libpq-fe.h:142
@ PGRES_FATAL_ERROR
Definition: libpq-fe.h:136
@ PGRES_COPY_OUT
Definition: libpq-fe.h:131
@ PGRES_EMPTY_QUERY
Definition: libpq-fe.h:124
@ PGRES_PIPELINE_SYNC
Definition: libpq-fe.h:139
@ PGRES_BAD_RESPONSE
Definition: libpq-fe.h:133
@ PGRES_PIPELINE_ABORTED
Definition: libpq-fe.h:140
@ PGRES_NONFATAL_ERROR
Definition: libpq-fe.h:135
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:128
PGTransactionStatusType
Definition: libpq-fe.h:146
@ PQTRANS_INTRANS
Definition: libpq-fe.h:149
@ PQTRANS_IDLE
Definition: libpq-fe.h:147
@ PQTRANS_ACTIVE
Definition: libpq-fe.h:148
@ PQTRANS_UNKNOWN
Definition: libpq-fe.h:151
@ PQTRANS_INERROR
Definition: libpq-fe.h:150
@ PQ_PIPELINE_OFF
Definition: libpq-fe.h:187
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_info(...)
Definition: logging.h:124
void * arg
#define MAXPGPATH
static const char * connstr
Definition: pg_dumpall.c:84
static char * filename
Definition: pg_dumpall.c:123
static char * buf
Definition: pg_test_fsync.c:72
#define pg_encoding_to_char
Definition: pg_wchar.h:630
#define pg_log_warning(...)
Definition: pgfnames.c:24
bool get_home_path(char *ret_path)
Definition: path.c:1005
#define snprintf
Definition: port.h:239
#define printf(...)
Definition: port.h:245
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
int pg_strncasecmp(const char *s1, const char *s2, size_t n)
Definition: pgstrcasecmp.c:69
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:52
#define PG_DIAG_MESSAGE_PRIMARY
Definition: postgres_ext.h:53
void printfPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:235
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:129
char * c
char * psprintf(const char *fmt,...)
Definition: psprintf.c:43
PsqlScanQuoteType
Definition: psqlscan.h:53
@ PQUOTE_SQL_LITERAL
Definition: psqlscan.h:55
@ PQUOTE_PLAIN
Definition: psqlscan.h:54
@ PQUOTE_SHELL_ARG
Definition: psqlscan.h:57
@ PQUOTE_SQL_IDENT
Definition: psqlscan.h:56
static int before(chr x, chr y)
Definition: regc_locale.c:488
@ PSQL_ERROR_ROLLBACK_ON
Definition: settings.h:60
@ PSQL_ERROR_ROLLBACK_OFF
Definition: settings.h:58
@ PSQL_ECHO_ALL
Definition: settings.h:46
@ PSQL_ECHO_ERRORS
Definition: settings.h:45
@ PSQL_ECHO_QUERIES
Definition: settings.h:44
@ PSQL_ECHO_HIDDEN_NOEXEC
Definition: settings.h:53
@ PSQL_ECHO_HIDDEN_OFF
Definition: settings.h:51
PsqlSettings pset
Definition: startup.c:32
#define EXIT_BADCONN
Definition: settings.h:200
@ PSQL_SEND_PIPELINE_SYNC
Definition: settings.h:78
@ PSQL_SEND_FLUSH
Definition: settings.h:81
@ PSQL_SEND_FLUSH_REQUEST
Definition: settings.h:82
@ PSQL_SEND_START_PIPELINE_MODE
Definition: settings.h:79
@ PSQL_SEND_QUERY
Definition: settings.h:73
@ PSQL_SEND_EXTENDED_QUERY_PARAMS
Definition: settings.h:76
@ PSQL_SEND_EXTENDED_PARSE
Definition: settings.h:75
@ PSQL_SEND_END_PIPELINE_MODE
Definition: settings.h:80
@ PSQL_SEND_GET_RESULTS
Definition: settings.h:83
@ PSQL_SEND_EXTENDED_CLOSE
Definition: settings.h:74
@ PSQL_SEND_EXTENDED_QUERY_PREPARED
Definition: settings.h:77
static void error(void)
Definition: sql-dyntest.c:147
bool appendShellStringNoError(PQExpBuffer buf, const char *str)
Definition: string_utils.c:594
printQueryOpt popt
Definition: settings.h:112
char * gset_prefix
Definition: settings.h:117
PSQL_ERROR_ROLLBACK on_error_rollback
Definition: settings.h:178
VariableSpace vars
Definition: settings.h:151
FILE * logfile
Definition: settings.h:149
char * stmtName
Definition: settings.h:124
bool on_error_stop
Definition: settings.h:166
PGconn * dead_conn
Definition: settings.h:158
bool autocommit
Definition: settings.h:165
char * ctv_args[4]
Definition: settings.h:133
int available_results
Definition: settings.h:128
PGresult * last_error_result
Definition: settings.h:110
int piped_syncs
Definition: settings.h:127
bool show_all_results
Definition: settings.h:185
FILE * copyStream
Definition: settings.h:108
int piped_commands
Definition: settings.h:126
char ** bind_params
Definition: settings.h:123
PGconn * db
Definition: settings.h:103
FILE * queryFout
Definition: settings.h:105
PSQL_SEND_MODE send_mode
Definition: settings.h:120
bool queryFoutPipe
Definition: settings.h:106
PSQL_ECHO echo
Definition: settings.h:176
bool singlestep
Definition: settings.h:169
int requested_results
Definition: settings.h:129
PSQL_ECHO_HIDDEN echo_hidden
Definition: settings.h:177
printQueryOpt * gsavepopt
Definition: settings.h:115
char * gfname
Definition: settings.h:114
int fetch_count
Definition: settings.h:172
bool cur_cmd_interactive
Definition: settings.h:140
bool gexec_flag
Definition: settings.h:119
bool crosstab_flag
Definition: settings.h:132
FILE * cur_cmd_source
Definition: settings.h:138
bool gdesc_flag
Definition: settings.h:118
int bind_nparams
Definition: settings.h:122
int be_pid
Definition: libpq-fe.h:231
char * relname
Definition: libpq-fe.h:230
char * extra
Definition: libpq-fe.h:232
printTableOpt topt
Definition: print.h:185
bool start_table
Definition: print.h:127
unsigned long prior_records
Definition: print.h:130
enum printFormat format
Definition: print.h:113
int encoding
Definition: print.h:138
bool stop_table
Definition: print.h:128
static void * fn(void *arg)
Definition: thread-alloc.c:119
bool VariableHasHook(VariableSpace space, const char *name)
Definition: variables.c:437
bool SetVariable(VariableSpace space, const char *name, const char *value)
Definition: variables.c:281
const char * GetVariable(VariableSpace space, const char *name)
Definition: variables.c:73
int wait_result_to_exit_code(int exit_status)
Definition: wait_error.c:138
const char * name