2 * psql - the PostgreSQL interactive terminal
4 * Copyright (c) 2000-2011, PostgreSQL Global Development Group
6 * src/bin/psql/command.c
8 #include "postgres_fe.h"
11 #ifdef __BORLANDC__ /* needed for BCC */
20 #include <sys/types.h> /* for umask() */
21 #include <sys/stat.h> /* for stat() */
22 #include <fcntl.h> /* open() flags */
23 #include <unistd.h> /* for geteuid(), getpid(), stat() */
29 #include <sys/types.h> /* for umask() */
30 #include <sys/stat.h> /* for stat() */
33 #include <openssl/ssl.h>
36 #include "portability/instr_time.h"
39 #include "pqexpbuffer.h"
40 #include "dumputils.h"
47 #include "large_obj.h"
52 #include "variables.h"
55 /* functions for use in this file */
56 static backslashResult exec_command(const char *cmd,
57 PsqlScanState scan_state,
58 PQExpBuffer query_buf);
59 static bool do_edit(const char *filename_arg, PQExpBuffer query_buf,
60 int lineno, bool *edited);
61 static bool do_connect(char *dbname, char *user, char *host, char *port);
62 static bool do_shell(const char *command);
63 static bool lookup_function_oid(PGconn *conn, const char *desc, Oid *foid);
64 static bool get_create_function_cmd(PGconn *conn, Oid oid, PQExpBuffer buf);
65 static int strip_lineno_from_funcdesc(char *func);
66 static void minimal_error_message(PGresult *res);
68 static void printSSLInfo(void);
71 static void checkWin32Codepage(void);
79 * Handles all the different commands that start with '\'.
80 * Ordinarily called by MainLoop().
82 * scan_state is a lexer working state that is set to continue scanning
83 * just after the '\'. The lexer is advanced past the command and all
84 * arguments on return.
86 * 'query_buf' contains the query-so-far, which may be modified by
87 * execution of the backslash command (for example, \r clears it).
88 * query_buf can be NULL if there is no query so far.
90 * Returns a status code indicating what action is desired, see command.h.
95 HandleSlashCmds(PsqlScanState scan_state,
96 PQExpBuffer query_buf)
98 backslashResult status = PSQL_CMD_SKIP_LINE;
102 psql_assert(scan_state);
104 /* Parse off the command name */
105 cmd = psql_scan_slash_command(scan_state);
107 /* And try to execute it */
108 status = exec_command(cmd, scan_state, query_buf);
110 if (status == PSQL_CMD_UNKNOWN)
112 if (pset.cur_cmd_interactive)
113 fprintf(stderr, _("Invalid command \\%s. Try \\? for help.\n"), cmd);
115 psql_error("invalid command \\%s\n", cmd);
116 status = PSQL_CMD_ERROR;
119 if (status != PSQL_CMD_ERROR)
121 /* eat any remaining arguments after a valid command */
122 /* note we suppress evaluation of backticks here */
123 while ((arg = psql_scan_slash_option(scan_state,
124 OT_VERBATIM, NULL, false)))
126 psql_error("\\%s: extra argument \"%s\" ignored\n", cmd, arg);
132 /* silently throw away rest of line after an erroneous command */
133 while ((arg = psql_scan_slash_option(scan_state,
134 OT_WHOLE_LINE, NULL, false)))
138 /* if there is a trailing \\, swallow it */
139 psql_scan_slash_command_end(scan_state);
143 /* some commands write to queryFout, so make sure output is sent */
144 fflush(pset.queryFout);
150 * Read and interpret an argument to the \connect slash command.
153 read_connect_arg(PsqlScanState scan_state)
159 * Ideally we should treat the arguments as SQL identifiers. But for
160 * backwards compatibility with 7.2 and older pg_dump files, we have to
161 * take unquoted arguments verbatim (don't downcase them). For now,
162 * double-quoted arguments may be stripped of double quotes (as if SQL
163 * identifiers). By 7.4 or so, pg_dump files can be expected to
164 * double-quote all mixed-case \connect arguments, and then we can get rid
167 result = psql_scan_slash_option(scan_state, OT_SQLIDHACK, "e, true);
175 if (*result == '\0' || strcmp(result, "-") == 0)
183 * Subroutine to actually try to execute a backslash command.
185 static backslashResult
186 exec_command(const char *cmd,
187 PsqlScanState scan_state,
188 PQExpBuffer query_buf)
190 bool success = true; /* indicate here if the command ran ok or
192 backslashResult status = PSQL_CMD_SKIP_LINE;
195 * \a -- toggle field alignment This makes little sense but we keep it
198 if (strcmp(cmd, "a") == 0)
200 if (pset.popt.topt.format != PRINT_ALIGNED)
201 success = do_pset("format", "aligned", &pset.popt, pset.quiet);
203 success = do_pset("format", "unaligned", &pset.popt, pset.quiet);
206 /* \C -- override table title (formerly change HTML caption) */
207 else if (strcmp(cmd, "C") == 0)
209 char *opt = psql_scan_slash_option(scan_state,
210 OT_NORMAL, NULL, true);
212 success = do_pset("title", opt, &pset.popt, pset.quiet);
217 * \c or \connect -- connect to database using the specified parameters.
219 * \c dbname user host port
221 * If any of these parameters are omitted or specified as '-', the current
222 * value of the parameter will be used instead. If the parameter has no
223 * current value, the default value for that parameter will be used. Some
226 * \c - - hst Connect to current database on current port of host
227 * "hst" as current user. \c - usr - prt Connect to current database on
228 * "prt" port of current host as user "usr". \c dbs Connect to
229 * "dbs" database on current port of current host as current user.
231 else if (strcmp(cmd, "c") == 0 || strcmp(cmd, "connect") == 0)
238 opt1 = read_connect_arg(scan_state);
239 opt2 = read_connect_arg(scan_state);
240 opt3 = read_connect_arg(scan_state);
241 opt4 = read_connect_arg(scan_state);
243 success = do_connect(opt1, opt2, opt3, opt4);
252 else if (strcmp(cmd, "cd") == 0)
254 char *opt = psql_scan_slash_option(scan_state,
255 OT_NORMAL, NULL, true);
265 pw = getpwuid(geteuid());
268 psql_error("could not get home directory: %s\n", strerror(errno));
275 * On Windows, 'cd' without arguments prints the current
276 * directory, so if someone wants to code this here instead...
282 if (chdir(dir) == -1)
284 psql_error("\\%s: could not change directory to \"%s\": %s\n",
285 cmd, dir, strerror(errno));
291 pset.dirname = pg_strdup(dir);
292 canonicalize_path(pset.dirname);
298 /* \conninfo -- display information about the current connection */
299 else if (strcmp(cmd, "conninfo") == 0)
301 char *db = PQdb(pset.db);
302 char *host = PQhost(pset.db);
305 printf(_("You are currently not connected to a database.\n"));
309 host = DEFAULT_PGSOCKET_DIR;
310 /* If the host is an absolute path, the connection is via socket */
311 if (is_absolute_path(host))
312 printf(_("You are connected to database \"%s\" as user \"%s\" via socket in \"%s\" at port \"%s\".\n"),
313 db, PQuser(pset.db), host, PQport(pset.db));
315 printf(_("You are connected to database \"%s\" as user \"%s\" on host \"%s\" at port \"%s\".\n"),
316 db, PQuser(pset.db), host, PQport(pset.db));
321 else if (pg_strcasecmp(cmd, "copy") == 0)
323 /* Default fetch-it-all-and-print mode */
327 char *opt = psql_scan_slash_option(scan_state,
328 OT_WHOLE_LINE, NULL, false);
331 INSTR_TIME_SET_CURRENT(before);
333 success = do_copy(opt);
335 if (pset.timing && success)
337 INSTR_TIME_SET_CURRENT(after);
338 INSTR_TIME_SUBTRACT(after, before);
339 printf(_("Time: %.3f ms\n"), INSTR_TIME_GET_MILLISEC(after));
346 else if (strcmp(cmd, "copyright") == 0)
350 else if (cmd[0] == 'd')
356 /* We don't do SQLID reduction on the pattern yet */
357 pattern = psql_scan_slash_option(scan_state,
358 OT_NORMAL, NULL, true);
360 show_verbose = strchr(cmd, '+') ? true : false;
361 show_system = strchr(cmd, 'S') ? true : false;
369 success = describeTableDetails(pattern, show_verbose, show_system);
371 /* standard listing of interesting things */
372 success = listTables("tvsE", NULL, show_verbose, show_system);
375 success = describeAggregates(pattern, show_verbose, show_system);
378 success = describeTablespaces(pattern, show_verbose);
381 success = listConversions(pattern, show_verbose, show_system);
384 success = listCasts(pattern, show_verbose);
387 if (strncmp(cmd, "ddp", 3) == 0)
388 success = listDefaultACLs(pattern);
390 success = objectDescription(pattern, show_system);
393 success = listDomains(pattern, show_verbose, show_system);
395 case 'f': /* function subsystem */
405 success = describeFunctions(&cmd[2], pattern, show_verbose, show_system);
408 status = PSQL_CMD_UNKNOWN;
413 /* no longer distinct from \du */
414 success = describeRoles(pattern, show_verbose);
417 success = do_lo_list();
420 success = listLanguages(pattern, show_verbose, show_system);
423 success = listSchemas(pattern, show_verbose, show_system);
426 success = describeOperators(pattern, show_system);
429 success = listCollations(pattern, show_verbose, show_system);
432 success = permissionsList(pattern);
435 success = describeTypes(pattern, show_verbose, show_system);
442 success = listTables(&cmd[1], pattern, show_verbose, show_system);
445 if (cmd[2] == 'd' && cmd[3] == 's')
447 char *pattern2 = NULL;
450 pattern2 = psql_scan_slash_option(scan_state,
451 OT_NORMAL, NULL, true);
452 success = listDbRoleSettings(pattern, pattern2);
455 success = PSQL_CMD_UNKNOWN;
458 success = describeRoles(pattern, show_verbose);
460 case 'F': /* text search subsystem */
465 success = listTSConfigs(pattern, show_verbose);
468 success = listTSParsers(pattern, show_verbose);
471 success = listTSDictionaries(pattern, show_verbose);
474 success = listTSTemplates(pattern, show_verbose);
477 status = PSQL_CMD_UNKNOWN;
481 case 'e': /* SQL/MED subsystem */
485 success = listForeignServers(pattern, show_verbose);
488 success = listUserMappings(pattern, show_verbose);
491 success = listForeignDataWrappers(pattern, show_verbose);
494 success = listForeignTables(pattern, show_verbose);
497 status = PSQL_CMD_UNKNOWN;
501 case 'x': /* Extensions */
503 success = listExtensionContents(pattern);
505 success = listExtensions(pattern);
508 status = PSQL_CMD_UNKNOWN;
517 * \e or \edit -- edit the current query buffer, or edit a file and make
518 * it the query buffer
520 else if (strcmp(cmd, "e") == 0 || strcmp(cmd, "edit") == 0)
524 psql_error("no query buffer\n");
525 status = PSQL_CMD_ERROR;
533 fname = psql_scan_slash_option(scan_state,
534 OT_NORMAL, NULL, true);
537 /* try to get separate lineno arg */
538 ln = psql_scan_slash_option(scan_state,
539 OT_NORMAL, NULL, true);
542 /* only one arg; maybe it is lineno not fname */
544 strspn(fname, "0123456789") == strlen(fname))
546 /* all digits, so assume it is lineno */
557 psql_error("invalid line number: %s\n", ln);
558 status = PSQL_CMD_ERROR;
561 if (status != PSQL_CMD_ERROR)
563 expand_tilde(&fname);
565 canonicalize_path(fname);
566 if (do_edit(fname, query_buf, lineno, NULL))
567 status = PSQL_CMD_NEWEDIT;
569 status = PSQL_CMD_ERROR;
579 * \ef -- edit the named function, or present a blank CREATE FUNCTION
580 * template if no argument is given
582 else if (strcmp(cmd, "ef") == 0)
588 psql_error("no query buffer\n");
589 status = PSQL_CMD_ERROR;
594 Oid foid = InvalidOid;
596 func = psql_scan_slash_option(scan_state,
597 OT_WHOLE_LINE, NULL, true);
598 lineno = strip_lineno_from_funcdesc(func);
601 /* error already reported */
602 status = PSQL_CMD_ERROR;
606 /* set up an empty command to fill in */
607 printfPQExpBuffer(query_buf,
608 "CREATE FUNCTION ( )\n"
611 " -- common options: IMMUTABLE STABLE STRICT SECURITY DEFINER\n"
615 else if (!lookup_function_oid(pset.db, func, &foid))
617 /* error already reported */
618 status = PSQL_CMD_ERROR;
620 else if (!get_create_function_cmd(pset.db, foid, query_buf))
622 /* error already reported */
623 status = PSQL_CMD_ERROR;
628 * lineno "1" should correspond to the first line of the
629 * function body. We expect that pg_get_functiondef() will
630 * emit that on a line beginning with "AS ", and that there
631 * can be no such line before the real start of the function
632 * body. Increment lineno by the number of lines before that
633 * line, so that it becomes relative to the first line of the
634 * function definition.
636 const char *lines = query_buf->data;
638 while (*lines != '\0')
640 if (strncmp(lines, "AS ", 3) == 0)
643 /* find start of next line */
644 lines = strchr(lines, '\n');
655 if (status != PSQL_CMD_ERROR)
659 if (!do_edit(NULL, query_buf, lineno, &edited))
660 status = PSQL_CMD_ERROR;
662 puts(_("No changes"));
664 status = PSQL_CMD_NEWEDIT;
668 /* \echo and \qecho */
669 else if (strcmp(cmd, "echo") == 0 || strcmp(cmd, "qecho") == 0)
673 bool no_newline = false;
677 if (strcmp(cmd, "qecho") == 0)
678 fout = pset.queryFout;
682 while ((value = psql_scan_slash_option(scan_state,
683 OT_NORMAL, "ed, false)))
685 if (!quoted && strcmp(value, "-n") == 0)
701 /* \encoding -- set/show client side encoding */
702 else if (strcmp(cmd, "encoding") == 0)
704 char *encoding = psql_scan_slash_option(scan_state,
705 OT_NORMAL, NULL, false);
710 puts(pg_encoding_to_char(pset.encoding));
715 if (PQsetClientEncoding(pset.db, encoding) == -1)
716 psql_error("%s: invalid encoding name or conversion procedure not found\n", encoding);
719 /* save encoding info into psql internal data */
720 pset.encoding = PQclientEncoding(pset.db);
721 pset.popt.topt.encoding = pset.encoding;
722 SetVariable(pset.vars, "ENCODING",
723 pg_encoding_to_char(pset.encoding));
729 /* \f -- change field separator */
730 else if (strcmp(cmd, "f") == 0)
732 char *fname = psql_scan_slash_option(scan_state,
733 OT_NORMAL, NULL, false);
735 success = do_pset("fieldsep", fname, &pset.popt, pset.quiet);
739 /* \g means send query */
740 else if (strcmp(cmd, "g") == 0)
742 char *fname = psql_scan_slash_option(scan_state,
743 OT_FILEPIPE, NULL, false);
749 expand_tilde(&fname);
750 pset.gfname = pg_strdup(fname);
753 status = PSQL_CMD_SEND;
757 else if (strcmp(cmd, "h") == 0 || strcmp(cmd, "help") == 0)
759 char *opt = psql_scan_slash_option(scan_state,
760 OT_WHOLE_LINE, NULL, false);
763 /* strip any trailing spaces and semicolons */
768 (isspace((unsigned char) opt[len - 1])
769 || opt[len - 1] == ';'))
773 helpSQL(opt, pset.popt.topt.pager);
778 else if (strcmp(cmd, "H") == 0 || strcmp(cmd, "html") == 0)
780 if (pset.popt.topt.format != PRINT_HTML)
781 success = do_pset("format", "html", &pset.popt, pset.quiet);
783 success = do_pset("format", "aligned", &pset.popt, pset.quiet);
787 /* \i and \ir include files */
788 else if (strcmp(cmd, "i") == 0 || strcmp(cmd, "include") == 0
789 || strcmp(cmd, "ir") == 0 || strcmp(cmd, "include_relative") == 0)
791 char *fname = psql_scan_slash_option(scan_state,
792 OT_NORMAL, NULL, true);
796 psql_error("\\%s: missing required argument\n", cmd);
801 bool include_relative;
803 include_relative = (strcmp(cmd, "ir") == 0
804 || strcmp(cmd, "include_relative") == 0);
805 expand_tilde(&fname);
806 success = (process_file(fname, false, include_relative) == EXIT_SUCCESS);
811 /* \l is list databases */
812 else if (strcmp(cmd, "l") == 0 || strcmp(cmd, "list") == 0)
813 success = listAllDbs(false);
814 else if (strcmp(cmd, "l+") == 0 || strcmp(cmd, "list+") == 0)
815 success = listAllDbs(true);
818 * large object things
820 else if (strncmp(cmd, "lo_", 3) == 0)
825 opt1 = psql_scan_slash_option(scan_state,
826 OT_NORMAL, NULL, true);
827 opt2 = psql_scan_slash_option(scan_state,
828 OT_NORMAL, NULL, true);
830 if (strcmp(cmd + 3, "export") == 0)
834 psql_error("\\%s: missing required argument\n", cmd);
840 success = do_lo_export(opt1, opt2);
844 else if (strcmp(cmd + 3, "import") == 0)
848 psql_error("\\%s: missing required argument\n", cmd);
854 success = do_lo_import(opt1, opt2);
858 else if (strcmp(cmd + 3, "list") == 0)
859 success = do_lo_list();
861 else if (strcmp(cmd + 3, "unlink") == 0)
865 psql_error("\\%s: missing required argument\n", cmd);
869 success = do_lo_unlink(opt1);
873 status = PSQL_CMD_UNKNOWN;
880 /* \o -- set query output */
881 else if (strcmp(cmd, "o") == 0 || strcmp(cmd, "out") == 0)
883 char *fname = psql_scan_slash_option(scan_state,
884 OT_FILEPIPE, NULL, true);
886 expand_tilde(&fname);
887 success = setQFout(fname);
891 /* \p prints the current query buffer */
892 else if (strcmp(cmd, "p") == 0 || strcmp(cmd, "print") == 0)
894 if (query_buf && query_buf->len > 0)
895 puts(query_buf->data);
896 else if (!pset.quiet)
897 puts(_("Query buffer is empty."));
901 /* \password -- set user password */
902 else if (strcmp(cmd, "password") == 0)
907 pw1 = simple_prompt("Enter new password: ", 100, false);
908 pw2 = simple_prompt("Enter it again: ", 100, false);
910 if (strcmp(pw1, pw2) != 0)
912 fprintf(stderr, _("Passwords didn't match.\n"));
917 char *opt0 = psql_scan_slash_option(scan_state, OT_SQLID, NULL, true);
919 char *encrypted_password;
924 user = PQuser(pset.db);
926 encrypted_password = PQencryptPassword(pw1, user);
928 if (!encrypted_password)
930 fprintf(stderr, _("Password encryption failed.\n"));
938 initPQExpBuffer(&buf);
939 printfPQExpBuffer(&buf, "ALTER USER %s PASSWORD ",
941 appendStringLiteralConn(&buf, encrypted_password, pset.db);
942 res = PSQLexec(buf.data, false);
943 termPQExpBuffer(&buf);
948 PQfreemem(encrypted_password);
956 /* \prompt -- prompt and set variable */
957 else if (strcmp(cmd, "prompt") == 0)
964 arg1 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false);
965 arg2 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false);
969 psql_error("\\%s: missing required argument\n", cmd);
985 result = simple_prompt(prompt_text, 4096, true);
990 fputs(prompt_text, stdout);
993 result = gets_fromFile(stdin);
996 if (!SetVariable(pset.vars, opt, result))
998 psql_error("\\%s: error\n", cmd);
1009 /* \pset -- set printing parameters */
1010 else if (strcmp(cmd, "pset") == 0)
1012 char *opt0 = psql_scan_slash_option(scan_state,
1013 OT_NORMAL, NULL, false);
1014 char *opt1 = psql_scan_slash_option(scan_state,
1015 OT_NORMAL, NULL, false);
1019 psql_error("\\%s: missing required argument\n", cmd);
1023 success = do_pset(opt0, opt1, &pset.popt, pset.quiet);
1030 else if (strcmp(cmd, "q") == 0 || strcmp(cmd, "quit") == 0)
1031 status = PSQL_CMD_TERMINATE;
1033 /* reset(clear) the buffer */
1034 else if (strcmp(cmd, "r") == 0 || strcmp(cmd, "reset") == 0)
1036 resetPQExpBuffer(query_buf);
1037 psql_scan_reset(scan_state);
1039 puts(_("Query buffer reset (cleared)."));
1042 /* \s save history in a file or show it on the screen */
1043 else if (strcmp(cmd, "s") == 0)
1045 char *fname = psql_scan_slash_option(scan_state,
1046 OT_NORMAL, NULL, true);
1048 expand_tilde(&fname);
1049 /* This scrolls off the screen when using /dev/tty */
1050 success = saveHistory(fname ? fname : DEVTTY, -1, false, false);
1051 if (success && !pset.quiet && fname)
1052 printf(gettext("Wrote history to file \"%s/%s\".\n"),
1053 pset.dirname ? pset.dirname : ".", fname);
1059 /* \set -- generalized set variable/option command */
1060 else if (strcmp(cmd, "set") == 0)
1062 char *opt0 = psql_scan_slash_option(scan_state,
1063 OT_NORMAL, NULL, false);
1067 /* list all variables */
1068 PrintVariables(pset.vars);
1074 * Set variable to the concatenation of the arguments.
1079 opt = psql_scan_slash_option(scan_state,
1080 OT_NORMAL, NULL, false);
1081 newval = pg_strdup(opt ? opt : "");
1084 while ((opt = psql_scan_slash_option(scan_state,
1085 OT_NORMAL, NULL, false)))
1087 newval = realloc(newval, strlen(newval) + strlen(opt) + 1);
1090 psql_error("out of memory\n");
1093 strcat(newval, opt);
1097 if (!SetVariable(pset.vars, opt0, newval))
1099 psql_error("\\%s: error\n", cmd);
1107 /* \sf -- show a function's source code */
1108 else if (strcmp(cmd, "sf") == 0 || strcmp(cmd, "sf+") == 0)
1110 bool show_linenumbers = (strcmp(cmd, "sf+") == 0);
1111 PQExpBuffer func_buf;
1113 Oid foid = InvalidOid;
1115 func_buf = createPQExpBuffer();
1116 func = psql_scan_slash_option(scan_state,
1117 OT_WHOLE_LINE, NULL, true);
1120 psql_error("function name is required\n");
1121 status = PSQL_CMD_ERROR;
1123 else if (!lookup_function_oid(pset.db, func, &foid))
1125 /* error already reported */
1126 status = PSQL_CMD_ERROR;
1128 else if (!get_create_function_cmd(pset.db, foid, func_buf))
1130 /* error already reported */
1131 status = PSQL_CMD_ERROR;
1138 /* Select output stream: stdout, pager, or file */
1139 if (pset.queryFout == stdout)
1141 /* count lines in function to see if pager is needed */
1143 const char *lines = func_buf->data;
1145 while (*lines != '\0')
1148 /* find start of next line */
1149 lines = strchr(lines, '\n');
1155 output = PageOutput(lineno, pset.popt.topt.pager);
1160 /* use previously set output file, without pager */
1161 output = pset.queryFout;
1165 if (show_linenumbers)
1167 bool in_header = true;
1169 char *lines = func_buf->data;
1172 * lineno "1" should correspond to the first line of the
1173 * function body. We expect that pg_get_functiondef() will
1174 * emit that on a line beginning with "AS ", and that there
1175 * can be no such line before the real start of the function
1178 * Note that this loop scribbles on func_buf.
1180 while (*lines != '\0')
1184 if (in_header && strncmp(lines, "AS ", 3) == 0)
1186 /* increment lineno only for body's lines */
1190 /* find and mark end of current line */
1191 eol = strchr(lines, '\n');
1195 /* show current line as appropriate */
1197 fprintf(output, " %s\n", lines);
1199 fprintf(output, "%-7d %s\n", lineno, lines);
1201 /* advance to next line, if any */
1209 /* just send the function definition to output */
1210 fputs(func_buf->data, output);
1219 destroyPQExpBuffer(func_buf);
1222 /* \t -- turn off headers and row count */
1223 else if (strcmp(cmd, "t") == 0)
1225 char *opt = psql_scan_slash_option(scan_state,
1226 OT_NORMAL, NULL, true);
1228 success = do_pset("tuples_only", opt, &pset.popt, pset.quiet);
1232 /* \T -- define html <table ...> attributes */
1233 else if (strcmp(cmd, "T") == 0)
1235 char *value = psql_scan_slash_option(scan_state,
1236 OT_NORMAL, NULL, false);
1238 success = do_pset("tableattr", value, &pset.popt, pset.quiet);
1242 /* \timing -- toggle timing of queries */
1243 else if (strcmp(cmd, "timing") == 0)
1245 char *opt = psql_scan_slash_option(scan_state,
1246 OT_NORMAL, NULL, false);
1249 pset.timing = ParseVariableBool(opt);
1251 pset.timing = !pset.timing;
1255 puts(_("Timing is on."));
1257 puts(_("Timing is off."));
1263 else if (strcmp(cmd, "unset") == 0)
1265 char *opt = psql_scan_slash_option(scan_state,
1266 OT_NORMAL, NULL, false);
1270 psql_error("\\%s: missing required argument\n", cmd);
1273 else if (!SetVariable(pset.vars, opt, NULL))
1275 psql_error("\\%s: error\n", cmd);
1281 /* \w -- write query buffer to file */
1282 else if (strcmp(cmd, "w") == 0 || strcmp(cmd, "write") == 0)
1285 bool is_pipe = false;
1290 psql_error("no query buffer\n");
1291 status = PSQL_CMD_ERROR;
1295 fname = psql_scan_slash_option(scan_state,
1296 OT_FILEPIPE, NULL, true);
1297 expand_tilde(&fname);
1301 psql_error("\\%s: missing required argument\n", cmd);
1306 if (fname[0] == '|')
1309 fd = popen(&fname[1], "w");
1313 canonicalize_path(fname);
1314 fd = fopen(fname, "w");
1318 psql_error("%s: %s\n", fname, strerror(errno));
1328 if (query_buf && query_buf->len > 0)
1329 fprintf(fd, "%s\n", query_buf->data);
1332 result = pclose(fd);
1334 result = fclose(fd);
1338 psql_error("%s: %s\n", fname, strerror(errno));
1346 /* \x -- toggle expanded table representation */
1347 else if (strcmp(cmd, "x") == 0)
1349 char *opt = psql_scan_slash_option(scan_state,
1350 OT_NORMAL, NULL, true);
1352 success = do_pset("expanded", opt, &pset.popt, pset.quiet);
1356 /* \z -- list table rights (equivalent to \dp) */
1357 else if (strcmp(cmd, "z") == 0)
1359 char *pattern = psql_scan_slash_option(scan_state,
1360 OT_NORMAL, NULL, true);
1362 success = permissionsList(pattern);
1367 /* \! -- shell escape */
1368 else if (strcmp(cmd, "!") == 0)
1370 char *opt = psql_scan_slash_option(scan_state,
1371 OT_WHOLE_LINE, NULL, false);
1373 success = do_shell(opt);
1377 /* \? -- slash command help */
1378 else if (strcmp(cmd, "?") == 0)
1379 slashUsage(pset.popt.topt.pager);
1384 * These commands don't do anything. I just use them to test the parser.
1386 else if (strcmp(cmd, "void") == 0 || strcmp(cmd, "#") == 0)
1391 while ((value = psql_scan_slash_option(scan_state,
1392 OT_NORMAL, NULL, true)))
1394 fprintf(stderr, "+ opt(%d) = |%s|\n", i++, value);
1401 status = PSQL_CMD_UNKNOWN;
1404 status = PSQL_CMD_ERROR;
1410 * Ask the user for a password; 'username' is the username the
1411 * password is for, if one has been explicitly specified. Returns a
1415 prompt_for_password(const char *username)
1419 if (username == NULL)
1420 result = simple_prompt("Password: ", 100, false);
1425 prompt_text = malloc(strlen(username) + 100);
1426 snprintf(prompt_text, strlen(username) + 100,
1427 _("Password for user %s: "), username);
1428 result = simple_prompt(prompt_text, 100, false);
1436 param_is_newly_set(const char *old_val, const char *new_val)
1438 if (new_val == NULL)
1441 if (old_val == NULL || strcmp(old_val, new_val) != 0)
1448 * do_connect -- handler for \connect
1450 * Connects to a database with given parameters. If there exists an
1451 * established connection, NULL values will be replaced with the ones
1452 * in the current connection. Otherwise NULL will be passed for that
1453 * parameter to PQconnectdbParams(), so the libpq defaults will be used.
1455 * In interactive mode, if connection fails with the given parameters,
1456 * the old connection will be kept.
1459 do_connect(char *dbname, char *user, char *host, char *port)
1461 PGconn *o_conn = pset.db,
1463 char *password = NULL;
1466 dbname = PQdb(o_conn);
1468 user = PQuser(o_conn);
1470 host = PQhost(o_conn);
1472 port = PQport(o_conn);
1475 * If the user asked to be prompted for a password, ask for one now. If
1476 * not, use the password from the old connection, provided the username
1477 * has not changed. Otherwise, try to connect without a password first,
1478 * and then ask for a password if needed.
1480 * XXX: this behavior leads to spurious connection attempts recorded in
1481 * the postmaster's log. But libpq offers no API that would let us obtain
1482 * a password and then continue with the first connection attempt.
1484 if (pset.getPassword == TRI_YES)
1486 password = prompt_for_password(user);
1488 else if (o_conn && user && strcmp(PQuser(o_conn), user) == 0)
1490 password = strdup(PQpass(o_conn));
1495 #define PARAMS_ARRAY_SIZE 8
1496 const char **keywords = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*keywords));
1497 const char **values = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*values));
1499 keywords[0] = "host";
1501 keywords[1] = "port";
1503 keywords[2] = "user";
1505 keywords[3] = "password";
1506 values[3] = password;
1507 keywords[4] = "dbname";
1509 keywords[5] = "fallback_application_name";
1510 values[5] = pset.progname;
1511 keywords[6] = "client_encoding";
1512 values[6] = (pset.notty || getenv("PGCLIENTENCODING")) ? NULL : "auto";
1516 n_conn = PQconnectdbParams(keywords, values, true);
1521 /* We can immediately discard the password -- no longer needed */
1525 if (PQstatus(n_conn) == CONNECTION_OK)
1529 * Connection attempt failed; either retry the connection attempt with
1530 * a new password, or give up.
1532 if (!password && PQconnectionNeedsPassword(n_conn) && pset.getPassword != TRI_NO)
1535 password = prompt_for_password(user);
1540 * Failed to connect to the database. In interactive mode, keep the
1541 * previous connection to the DB; in scripting mode, close our
1542 * previous connection as well.
1544 if (pset.cur_cmd_interactive)
1546 psql_error("%s", PQerrorMessage(n_conn));
1548 /* pset.db is left unmodified */
1550 fputs(_("Previous connection kept\n"), stderr);
1554 psql_error("\\connect: %s", PQerrorMessage(n_conn));
1567 * Replace the old connection with the new one, and update
1568 * connection-dependent variables.
1570 PQsetNoticeProcessor(n_conn, NoticeProcessor, NULL);
1573 connection_warnings(false); /* Must be after SyncVariables */
1575 /* Tell the user about the new connection */
1578 if (param_is_newly_set(PQhost(o_conn), PQhost(pset.db)) ||
1579 param_is_newly_set(PQport(o_conn), PQport(pset.db)))
1581 char *host = PQhost(pset.db);
1584 host = DEFAULT_PGSOCKET_DIR;
1585 /* If the host is an absolute path, the connection is via socket */
1586 if (is_absolute_path(host))
1587 printf(_("You are now connected to database \"%s\" as user \"%s\" via socket in \"%s\" at port \"%s\".\n"),
1588 PQdb(pset.db), PQuser(pset.db), host, PQport(pset.db));
1590 printf(_("You are now connected to database \"%s\" as user \"%s\" on host \"%s\" at port \"%s\".\n"),
1591 PQdb(pset.db), PQuser(pset.db), host, PQport(pset.db));
1594 printf(_("You are now connected to database \"%s\" as user \"%s\".\n"),
1595 PQdb(pset.db), PQuser(pset.db));
1605 connection_warnings(bool in_startup)
1607 if (!pset.quiet && !pset.notty)
1609 int client_ver = parse_version(PG_VERSION);
1611 if (pset.sversion != client_ver)
1613 const char *server_version;
1614 char server_ver_str[16];
1616 /* Try to get full text form, might include "devel" etc */
1617 server_version = PQparameterStatus(pset.db, "server_version");
1618 if (!server_version)
1620 snprintf(server_ver_str, sizeof(server_ver_str),
1622 pset.sversion / 10000,
1623 (pset.sversion / 100) % 100,
1624 pset.sversion % 100);
1625 server_version = server_ver_str;
1628 printf(_("%s (%s, server %s)\n"),
1629 pset.progname, PG_VERSION, server_version);
1631 /* For version match, only print psql banner on startup. */
1632 else if (in_startup)
1633 printf("%s (%s)\n", pset.progname, PG_VERSION);
1635 if (pset.sversion / 100 != client_ver / 100)
1636 printf(_("WARNING: %s version %d.%d, server version %d.%d.\n"
1637 " Some psql features might not work.\n"),
1638 pset.progname, client_ver / 10000, (client_ver / 100) % 100,
1639 pset.sversion / 10000, (pset.sversion / 100) % 100);
1642 checkWin32Codepage();
1652 * Prints information about the current SSL connection, if SSL is in use
1661 ssl = PQgetssl(pset.db);
1663 return; /* no SSL */
1665 SSL_get_cipher_bits(ssl, &sslbits);
1666 printf(_("SSL connection (cipher: %s, bits: %d)\n"),
1667 SSL_get_cipher(ssl), sslbits);
1671 * If psql is compiled without SSL but is using a libpq with SSL, we
1672 * cannot figure out the specifics about the connection. But we know it's
1675 if (PQgetssl(pset.db))
1676 printf(_("SSL connection (unknown cipher)\n"));
1682 * checkWin32Codepage
1684 * Prints a warning when win32 console codepage differs from Windows codepage
1688 checkWin32Codepage(void)
1694 concp = GetConsoleCP();
1697 printf(_("WARNING: Console code page (%u) differs from Windows code page (%u)\n"
1698 " 8-bit characters might not work correctly. See psql reference\n"
1699 " page \"Notes for Windows users\" for details.\n"),
1709 * Make psql's internal variables agree with connection state upon
1710 * establishing a new connection.
1715 /* get stuff from connection */
1716 pset.encoding = PQclientEncoding(pset.db);
1717 pset.popt.topt.encoding = pset.encoding;
1718 pset.sversion = PQserverVersion(pset.db);
1720 SetVariable(pset.vars, "DBNAME", PQdb(pset.db));
1721 SetVariable(pset.vars, "USER", PQuser(pset.db));
1722 SetVariable(pset.vars, "HOST", PQhost(pset.db));
1723 SetVariable(pset.vars, "PORT", PQport(pset.db));
1724 SetVariable(pset.vars, "ENCODING", pg_encoding_to_char(pset.encoding));
1726 /* send stuff to it, too */
1727 PQsetErrorVerbosity(pset.db, pset.verbosity);
1733 * Clear variables that should be not be set when there is no connection.
1736 UnsyncVariables(void)
1738 SetVariable(pset.vars, "DBNAME", NULL);
1739 SetVariable(pset.vars, "USER", NULL);
1740 SetVariable(pset.vars, "HOST", NULL);
1741 SetVariable(pset.vars, "PORT", NULL);
1742 SetVariable(pset.vars, "ENCODING", NULL);
1747 * do_edit -- handler for \e
1749 * If you do not specify a filename, the current query buffer will be copied
1750 * into a temporary one.
1753 editFile(const char *fname, int lineno)
1755 const char *editorName;
1756 const char *editor_lineno_arg = NULL;
1762 /* Find an editor to use */
1763 editorName = getenv("PSQL_EDITOR");
1765 editorName = getenv("EDITOR");
1767 editorName = getenv("VISUAL");
1769 editorName = DEFAULT_EDITOR;
1771 /* Get line number argument, if we need it. */
1774 editor_lineno_arg = getenv("PSQL_EDITOR_LINENUMBER_ARG");
1775 #ifdef DEFAULT_EDITOR_LINENUMBER_ARG
1776 if (!editor_lineno_arg)
1777 editor_lineno_arg = DEFAULT_EDITOR_LINENUMBER_ARG;
1779 if (!editor_lineno_arg)
1781 psql_error("environment variable PSQL_EDITOR_LINENUMBER_ARG must be set to specify a line number\n");
1786 /* Allocate sufficient memory for command line. */
1788 sys = pg_malloc(strlen(editorName)
1789 + strlen(editor_lineno_arg) + 10 /* for integer */
1790 + 1 + strlen(fname) + 10 + 1);
1792 sys = pg_malloc(strlen(editorName) + strlen(fname) + 10 + 1);
1795 * On Unix the EDITOR value should *not* be quoted, since it might include
1796 * switches, eg, EDITOR="pico -t"; it's up to the user to put quotes in it
1797 * if necessary. But this policy is not very workable on Windows, due to
1798 * severe brain damage in their command shell plus the fact that standard
1799 * program paths include spaces.
1803 sprintf(sys, "exec %s %s%d '%s'",
1804 editorName, editor_lineno_arg, lineno, fname);
1806 sprintf(sys, "exec %s '%s'",
1810 sprintf(sys, SYSTEMQUOTE "\"%s\" %s%d \"%s\"" SYSTEMQUOTE,
1811 editorName, editor_lineno_arg, lineno, fname);
1813 sprintf(sys, SYSTEMQUOTE "\"%s\" \"%s\"" SYSTEMQUOTE,
1816 result = system(sys);
1818 psql_error("could not start editor \"%s\"\n", editorName);
1819 else if (result == 127)
1820 psql_error("could not start /bin/sh\n");
1829 do_edit(const char *filename_arg, PQExpBuffer query_buf,
1830 int lineno, bool *edited)
1832 char fnametmp[MAXPGPATH];
1833 FILE *stream = NULL;
1842 fname = filename_arg;
1845 /* make a temp file to edit */
1847 const char *tmpdir = getenv("TMPDIR");
1852 char tmpdir[MAXPGPATH];
1855 ret = GetTempPath(MAXPGPATH, tmpdir);
1856 if (ret == 0 || ret > MAXPGPATH)
1858 psql_error("could not locate temporary directory: %s\n",
1859 !ret ? strerror(errno) : "");
1864 * No canonicalize_path() here. EDIT.EXE run from CMD.EXE prepends the
1865 * current directory to the supplied path unless we use only
1866 * backslashes, so we do that.
1870 snprintf(fnametmp, sizeof(fnametmp), "%s%spsql.edit.%d", tmpdir,
1871 "/", (int) getpid());
1873 snprintf(fnametmp, sizeof(fnametmp), "%s%spsql.edit.%d", tmpdir,
1874 "" /* trailing separator already present */ , (int) getpid());
1877 fname = (const char *) fnametmp;
1879 fd = open(fname, O_WRONLY | O_CREAT | O_EXCL, 0600);
1881 stream = fdopen(fd, "w");
1883 if (fd == -1 || !stream)
1885 psql_error("could not open temporary file \"%s\": %s\n", fname, strerror(errno));
1890 unsigned int ql = query_buf->len;
1892 if (ql == 0 || query_buf->data[ql - 1] != '\n')
1894 appendPQExpBufferChar(query_buf, '\n');
1898 if (fwrite(query_buf->data, 1, ql, stream) != ql)
1900 psql_error("%s: %s\n", fname, strerror(errno));
1905 else if (fclose(stream) != 0)
1907 psql_error("%s: %s\n", fname, strerror(errno));
1914 if (!error && stat(fname, &before) != 0)
1916 psql_error("%s: %s\n", fname, strerror(errno));
1922 error = !editFile(fname, lineno);
1924 if (!error && stat(fname, &after) != 0)
1926 psql_error("%s: %s\n", fname, strerror(errno));
1930 if (!error && before.st_mtime != after.st_mtime)
1932 stream = fopen(fname, PG_BINARY_R);
1935 psql_error("%s: %s\n", fname, strerror(errno));
1940 /* read file back into query_buf */
1943 resetPQExpBuffer(query_buf);
1944 while (fgets(line, sizeof(line), stream) != NULL)
1945 appendPQExpBufferStr(query_buf, line);
1949 psql_error("%s: %s\n", fname, strerror(errno));
1961 /* remove temp file */
1964 if (remove(fname) == -1)
1966 psql_error("%s: %s\n", fname, strerror(errno));
1979 * Read commands from filename and then them to the main processing loop
1980 * Handler for \i and \ir, but can be used for other things as well. Returns
1981 * MainLoop() error code.
1983 * If use_relative_path is true and filename is not an absolute path, then open
1984 * the file from where the currently processed file (if any) is located.
1987 process_file(char *filename, bool single_txn, bool use_relative_path)
1992 char relpath[MAXPGPATH];
1996 return EXIT_FAILURE;
1998 if (strcmp(filename, "-") != 0)
2000 canonicalize_path(filename);
2003 * If we were asked to resolve the pathname relative to the location
2004 * of the currently executing script, and there is one, and this is
2005 * a relative pathname, then prepend all but the last pathname
2006 * component of the current script to this pathname.
2008 if (use_relative_path && pset.inputfile && !is_absolute_path(filename)
2009 && !has_drive_prefix(filename))
2011 snprintf(relpath, MAXPGPATH, "%s", pset.inputfile);
2012 get_parent_directory(relpath);
2013 join_path_components(relpath, relpath, filename);
2014 canonicalize_path(relpath);
2019 fd = fopen(filename, PG_BINARY_R);
2026 psql_error("%s: %s\n", filename, strerror(errno));
2027 return EXIT_FAILURE;
2030 oldfilename = pset.inputfile;
2031 pset.inputfile = filename;
2035 if ((res = PSQLexec("BEGIN", false)) == NULL)
2037 if (pset.on_error_stop)
2047 result = MainLoop(fd);
2051 if ((res = PSQLexec("COMMIT", false)) == NULL)
2053 if (pset.on_error_stop)
2067 pset.inputfile = oldfilename;
2078 _align2string(enum printFormat in)
2085 case PRINT_UNALIGNED:
2100 case PRINT_TROFF_MS:
2109 do_pset(const char *param, const char *value, printQueryOpt *popt, bool quiet)
2116 vallen = strlen(value);
2119 if (strcmp(param, "format") == 0)
2123 else if (pg_strncasecmp("unaligned", value, vallen) == 0)
2124 popt->topt.format = PRINT_UNALIGNED;
2125 else if (pg_strncasecmp("aligned", value, vallen) == 0)
2126 popt->topt.format = PRINT_ALIGNED;
2127 else if (pg_strncasecmp("wrapped", value, vallen) == 0)
2128 popt->topt.format = PRINT_WRAPPED;
2129 else if (pg_strncasecmp("html", value, vallen) == 0)
2130 popt->topt.format = PRINT_HTML;
2131 else if (pg_strncasecmp("latex", value, vallen) == 0)
2132 popt->topt.format = PRINT_LATEX;
2133 else if (pg_strncasecmp("troff-ms", value, vallen) == 0)
2134 popt->topt.format = PRINT_TROFF_MS;
2137 psql_error("\\pset: allowed formats are unaligned, aligned, wrapped, html, latex, troff-ms\n");
2142 printf(_("Output format is %s.\n"), _align2string(popt->topt.format));
2145 /* set table line style */
2146 else if (strcmp(param, "linestyle") == 0)
2150 else if (pg_strncasecmp("ascii", value, vallen) == 0)
2151 popt->topt.line_style = &pg_asciiformat;
2152 else if (pg_strncasecmp("old-ascii", value, vallen) == 0)
2153 popt->topt.line_style = &pg_asciiformat_old;
2154 else if (pg_strncasecmp("unicode", value, vallen) == 0)
2155 popt->topt.line_style = &pg_utf8format;
2158 psql_error("\\pset: allowed line styles are ascii, old-ascii, unicode\n");
2163 printf(_("Line style is %s.\n"),
2164 get_line_style(&popt->topt)->name);
2167 /* set border style/width */
2168 else if (strcmp(param, "border") == 0)
2171 popt->topt.border = atoi(value);
2174 printf(_("Border style is %d.\n"), popt->topt.border);
2177 /* set expanded/vertical mode */
2178 else if (strcmp(param, "x") == 0 || strcmp(param, "expanded") == 0 || strcmp(param, "vertical") == 0)
2181 popt->topt.expanded = ParseVariableBool(value);
2183 popt->topt.expanded = !popt->topt.expanded;
2185 printf(popt->topt.expanded
2186 ? _("Expanded display is on.\n")
2187 : _("Expanded display is off.\n"));
2190 /* locale-aware numeric output */
2191 else if (strcmp(param, "numericlocale") == 0)
2194 popt->topt.numericLocale = ParseVariableBool(value);
2196 popt->topt.numericLocale = !popt->topt.numericLocale;
2199 if (popt->topt.numericLocale)
2200 puts(_("Showing locale-adjusted numeric output."));
2202 puts(_("Locale-adjusted numeric output is off."));
2207 else if (strcmp(param, "null") == 0)
2211 free(popt->nullPrint);
2212 popt->nullPrint = pg_strdup(value);
2215 printf(_("Null display is \"%s\".\n"), popt->nullPrint ? popt->nullPrint : "");
2218 /* field separator for unaligned text */
2219 else if (strcmp(param, "fieldsep") == 0)
2223 free(popt->topt.fieldSep);
2224 popt->topt.fieldSep = pg_strdup(value);
2227 printf(_("Field separator is \"%s\".\n"), popt->topt.fieldSep);
2230 /* record separator for unaligned text */
2231 else if (strcmp(param, "recordsep") == 0)
2235 free(popt->topt.recordSep);
2236 popt->topt.recordSep = pg_strdup(value);
2240 if (strcmp(popt->topt.recordSep, "\n") == 0)
2241 printf(_("Record separator is <newline>."));
2243 printf(_("Record separator is \"%s\".\n"), popt->topt.recordSep);
2247 /* toggle between full and tuples-only format */
2248 else if (strcmp(param, "t") == 0 || strcmp(param, "tuples_only") == 0)
2251 popt->topt.tuples_only = ParseVariableBool(value);
2253 popt->topt.tuples_only = !popt->topt.tuples_only;
2256 if (popt->topt.tuples_only)
2257 puts(_("Showing only tuples."));
2259 puts(_("Tuples only is off."));
2263 /* set title override */
2264 else if (strcmp(param, "title") == 0)
2270 popt->title = pg_strdup(value);
2275 printf(_("Title is \"%s\".\n"), popt->title);
2277 printf(_("Title is unset.\n"));
2281 /* set HTML table tag options */
2282 else if (strcmp(param, "T") == 0 || strcmp(param, "tableattr") == 0)
2284 free(popt->topt.tableAttr);
2286 popt->topt.tableAttr = NULL;
2288 popt->topt.tableAttr = pg_strdup(value);
2292 if (popt->topt.tableAttr)
2293 printf(_("Table attribute is \"%s\".\n"), popt->topt.tableAttr);
2295 printf(_("Table attributes unset.\n"));
2299 /* toggle use of pager */
2300 else if (strcmp(param, "pager") == 0)
2302 if (value && pg_strcasecmp(value, "always") == 0)
2303 popt->topt.pager = 2;
2305 if (ParseVariableBool(value))
2306 popt->topt.pager = 1;
2308 popt->topt.pager = 0;
2309 else if (popt->topt.pager == 1)
2310 popt->topt.pager = 0;
2312 popt->topt.pager = 1;
2315 if (popt->topt.pager == 1)
2316 puts(_("Pager is used for long output."));
2317 else if (popt->topt.pager == 2)
2318 puts(_("Pager is always used."));
2320 puts(_("Pager usage is off."));
2324 /* disable "(x rows)" footer */
2325 else if (strcmp(param, "footer") == 0)
2328 popt->default_footer = ParseVariableBool(value);
2330 popt->default_footer = !popt->default_footer;
2333 if (popt->default_footer)
2334 puts(_("Default footer is on."));
2336 puts(_("Default footer is off."));
2340 /* set border style/width */
2341 else if (strcmp(param, "columns") == 0)
2344 popt->topt.columns = atoi(value);
2347 printf(_("Target width for \"wrapped\" format is %d.\n"), popt->topt.columns);
2352 psql_error("\\pset: unknown option: %s\n", param);
2362 #define DEFAULT_SHELL "/bin/sh"
2365 * CMD.EXE is in different places in different Win32 releases so we
2366 * have to rely on the path to find it.
2368 #define DEFAULT_SHELL "cmd.exe"
2372 do_shell(const char *command)
2379 const char *shellName;
2381 shellName = getenv("SHELL");
2383 if (shellName == NULL)
2384 shellName = getenv("COMSPEC");
2386 if (shellName == NULL)
2387 shellName = DEFAULT_SHELL;
2389 sys = pg_malloc(strlen(shellName) + 16);
2392 /* See EDITOR handling comment for an explaination */
2393 "exec %s", shellName);
2395 /* See EDITOR handling comment for an explaination */
2396 sprintf(sys, SYSTEMQUOTE "\"%s\"" SYSTEMQUOTE, shellName);
2398 result = system(sys);
2402 result = system(command);
2404 if (result == 127 || result == -1)
2406 psql_error("\\!: failed\n");
2413 * This function takes a function description, e.g. "x" or "x(int)", and
2414 * issues a query on the given connection to retrieve the function's OID
2415 * using a cast to regproc or regprocedure (as appropriate). The result,
2416 * if there is one, is returned at *foid. Note that we'll fail if the
2417 * function doesn't exist OR if there are multiple matching candidates
2418 * OR if there's something syntactically wrong with the function description;
2419 * unfortunately it can be hard to tell the difference.
2422 lookup_function_oid(PGconn *conn, const char *desc, Oid *foid)
2428 query = createPQExpBuffer();
2429 printfPQExpBuffer(query, "SELECT ");
2430 appendStringLiteralConn(query, desc, conn);
2431 appendPQExpBuffer(query, "::pg_catalog.%s::pg_catalog.oid",
2432 strchr(desc, '(') ? "regprocedure" : "regproc");
2434 res = PQexec(conn, query->data);
2435 if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1)
2436 *foid = atooid(PQgetvalue(res, 0, 0));
2439 minimal_error_message(res);
2444 destroyPQExpBuffer(query);
2450 * Fetches the "CREATE OR REPLACE FUNCTION ..." command that describes the
2451 * function with the given OID. If successful, the result is stored in buf.
2454 get_create_function_cmd(PGconn *conn, Oid oid, PQExpBuffer buf)
2460 query = createPQExpBuffer();
2461 printfPQExpBuffer(query, "SELECT pg_catalog.pg_get_functiondef(%u)", oid);
2463 res = PQexec(conn, query->data);
2464 if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1)
2466 resetPQExpBuffer(buf);
2467 appendPQExpBufferStr(buf, PQgetvalue(res, 0, 0));
2471 minimal_error_message(res);
2476 destroyPQExpBuffer(query);
2482 * If the given argument of \ef ends with a line number, delete the line
2483 * number from the argument string and return it as an integer. (We need
2484 * this kluge because we're too lazy to parse \ef's function name argument
2485 * carefully --- we just slop it up in OT_WHOLE_LINE mode.)
2487 * Returns -1 if no line number is present, 0 on error, or a positive value
2491 strip_lineno_from_funcdesc(char *func)
2496 if (!func || func[0] == '\0')
2499 c = func + strlen(func) - 1;
2502 * This business of parsing backwards is dangerous as can be in a
2503 * multibyte environment: there is no reason to believe that we are
2504 * looking at the first byte of a character, nor are we necessarily
2505 * working in a "safe" encoding. Fortunately the bitpatterns we are
2506 * looking for are unlikely to occur as non-first bytes, but beware of
2507 * trying to expand the set of cases that can be recognized. We must
2508 * guard the <ctype.h> macros by using isascii() first, too.
2511 /* skip trailing whitespace */
2512 while (c > func && isascii((unsigned char) *c) && isspace((unsigned char) *c))
2515 /* must have a digit as last non-space char */
2516 if (c == func || !isascii((unsigned char) *c) || !isdigit((unsigned char) *c))
2519 /* find start of digit string */
2520 while (c > func && isascii((unsigned char) *c) && isdigit((unsigned char) *c))
2523 /* digits must be separated from func name by space or closing paren */
2524 /* notice also that we are not allowing an empty func name ... */
2525 if (c == func || !isascii((unsigned char) *c) ||
2526 !(isspace((unsigned char) *c) || *c == ')'))
2529 /* parse digit string */
2534 psql_error("invalid line number: %s\n", c);
2538 /* strip digit string from func */
2545 * Report just the primary error; this is to avoid cluttering the output
2546 * with, for instance, a redisplay of the internally generated query
2549 minimal_error_message(PGresult *res)
2554 msg = createPQExpBuffer();
2556 fld = PQresultErrorField(res, PG_DIAG_SEVERITY);
2558 printfPQExpBuffer(msg, "%s: ", fld);
2560 printfPQExpBuffer(msg, "ERROR: ");
2561 fld = PQresultErrorField(res, PG_DIAG_MESSAGE_PRIMARY);
2563 appendPQExpBufferStr(msg, fld);
2565 appendPQExpBufferStr(msg, "(not available)");
2566 appendPQExpBufferStr(msg, "\n");
2568 psql_error("%s", msg->data);
2570 destroyPQExpBuffer(msg);