1 /*-------------------------------------------------------------------------
4 * an interactive front-end to postgres95
6 * Copyright (c) 1996, Regents of the University of California
10 * $Header: /cvsroot/pgsql/src/bin/psql/Attic/psql.c,v 1.29 1996/11/14 16:08:03 momjian Exp $
12 *-------------------------------------------------------------------------
18 #include <sys/types.h>
24 #include "stringutils.h"
31 /* from the GNU readline library */
36 #include <readline/readline.h>
37 #include <readline/history.h>
41 #define MAX_QUERY_BUFFER 20000
43 #define COPYBUFSIZ 8192
45 #define DEFAULT_FIELD_SEP "|"
46 #define DEFAULT_EDITOR "vi"
47 #define DEFAULT_SHELL "/bin/sh"
49 typedef struct _psqlSettings {
50 PGconn *db; /* connection to backend */
51 FILE *queryFout; /* where to send the query results */
52 PQprintOpt opt; /* options to be passed to PQprint */
53 char *prompt; /* prompt to display */
54 char *gfname; /* one-shot file output argument for \g */
55 bool notty; /* input or output is not a tty */
56 bool pipe; /* queryFout is from a popen() */
57 bool echoQuery; /* echo the query before sending it */
58 bool quiet; /* run quietly, no messages, no promt */
59 bool singleStep; /* prompt before for each query */
60 bool singleLineMode; /* query terminated by newline */
61 bool useReadline;/* use libreadline routines */
64 /* declarations for functions in this file */
65 static void usage(char *progname);
66 static void slashUsage();
67 static void handleCopyOut(PGresult * res, bool quiet, FILE * copystream);
69 handleCopyIn(PGresult * res, const bool mustprompt,
71 static int tableList(PsqlSettings * ps, bool deep_tablelist);
72 static int tableDesc(PsqlSettings * ps, char *table);
74 char *gets_noreadline(char *prompt, FILE * source);
75 char *gets_readline(char *prompt, FILE * source);
76 char *gets_fromFile(char *prompt, FILE * source);
77 int listAllDbs(PsqlSettings * settings);
79 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
80 const bool copy_in, const bool copy_out, FILE * copystream);
82 HandleSlashCmds(PsqlSettings * settings,
85 int MainLoop(PsqlSettings * settings, FILE * source);
86 /* probably should move this into libpq */
93 FILE *setFout(PsqlSettings * ps, char *fname);
96 * usage print out usage for command line arguments
100 usage(char *progname)
102 fprintf(stderr, "Usage: %s [options] [dbname]\n", progname);
103 fprintf(stderr, "\t -a authsvc set authentication service\n");
104 fprintf(stderr, "\t -A turn off alignment when printing out attributes\n");
105 fprintf(stderr, "\t -c query run single query (slash commands too)\n");
106 fprintf(stderr, "\t -d dbName specify database name\n");
107 fprintf(stderr, "\t -e echo the query sent to the backend\n");
108 fprintf(stderr, "\t -f filename use file as a source of queries\n");
109 fprintf(stderr, "\t -F sep set the field separator (default is " ")\n");
110 fprintf(stderr, "\t -h host set database server host\n");
111 fprintf(stderr, "\t -H turn on html3.0 table output\n");
112 fprintf(stderr, "\t -l list available databases\n");
113 fprintf(stderr, "\t -n don't use readline library\n");
114 fprintf(stderr, "\t -o filename send output to filename or (|pipe)\n");
115 fprintf(stderr, "\t -p port set port number\n");
116 fprintf(stderr, "\t -q run quietly (no messages, no prompts)\n");
117 fprintf(stderr, "\t -s single step mode (prompts for each query)\n");
118 fprintf(stderr, "\t -S single line mode (i.e. query terminated by newline)\n");
119 fprintf(stderr, "\t -t turn off printing of headings and row count\n");
120 fprintf(stderr, "\t -T html set html3.0 table command options (cf. -H)\n");
121 fprintf(stderr, "\t -x turn on expanded output (field names on left)\n");
126 * slashUsage print out usage for the backslash commands
132 return f ? "on" : "off";
136 slashUsage(PsqlSettings * ps)
138 fprintf(stderr, " \\? -- help\n");
139 fprintf(stderr, " \\a -- toggle field-alignment (currenty %s)\n", on(ps->opt.align));
140 fprintf(stderr, " \\C [<captn>] -- set html3 caption (currently '%s')\n", ps->opt.caption ? ps->opt.caption : "");
141 fprintf(stderr, " \\connect <dbname> -- connect to new database (currently '%s')\n", PQdb(ps->db));
142 fprintf(stderr, " \\copy <dbname> -- copy table to/from a file\n");
143 fprintf(stderr, " \\d [<table>] -- list tables in database or columns in <table>, * for all\n");
144 fprintf(stderr, " \\e [<fname>] -- edit the current query buffer or <fname>, \\E execute too\n");
145 fprintf(stderr, " \\f [<sep>] -- change field separater (currently '%s')\n", ps->opt.fieldSep);
146 fprintf(stderr, " \\g [<fname>] [|<cmd>] -- send query to backend [and results in <fname> or pipe]\n");
147 fprintf(stderr, " \\h [<cmd>] -- help on syntax of sql commands, * for all commands\n");
148 fprintf(stderr, " \\H -- toggle html3 output (currently %s)\n", on(ps->opt.html3));
149 fprintf(stderr, " \\i <fname> -- read and execute queries from filename\n");
150 fprintf(stderr, " \\l -- list all databases\n");
151 fprintf(stderr, " \\m -- toggle monitor-like table display (currently %s)\n", on(ps->opt.standard));
152 fprintf(stderr, " \\o [<fname>] [|<cmd>] -- send all query results to stdout, <fname>, or pipe\n");
153 fprintf(stderr, " \\p -- print the current query buffer\n");
154 fprintf(stderr, " \\q -- quit\n");
155 fprintf(stderr, " \\r -- reset(clear) the query buffer\n");
156 fprintf(stderr, " \\s [<fname>] -- print history or save it in <fname>\n");
157 fprintf(stderr, " \\t -- toggle table headings and row count (currently %s)\n", on(ps->opt.header));
158 fprintf(stderr, " \\T [<html>] -- set html3.0 <table ...> options (currently '%s')\n", ps->opt.tableOpt ? ps->opt.tableOpt : "");
159 fprintf(stderr, " \\x -- toggle expanded output (currently %s)\n", on(ps->opt.expanded));
160 fprintf(stderr, " \\! [<cmd>] -- shell escape or command\n");
164 PSQLexec(PsqlSettings * ps, char *query)
166 PGresult *res = PQexec(ps->db, query);
168 fputs(PQerrorMessage(ps->db), stderr);
170 if (PQresultStatus(res) == PGRES_COMMAND_OK ||
171 PQresultStatus(res) == PGRES_TUPLES_OK)
174 fputs(PQerrorMessage(ps->db), stderr);
182 * list all the databases in the system returns 0 if all went well
188 listAllDbs(PsqlSettings * ps)
191 char *query = "select * from pg_database;";
193 if (!(results = PSQLexec(ps, query)))
196 PQprint(ps->queryFout,
205 * List The Database Tables returns 0 if all went well
209 tableList(PsqlSettings * ps, bool deep_tablelist)
220 strcat(listbuf, "SELECT usename, relname, relkind, relhasrules");
221 strcat(listbuf, " FROM pg_class, pg_user ");
222 strcat(listbuf, "WHERE ( relkind = 'r' OR relkind = 'i') ");
223 strcat(listbuf, " and relname !~ '^pg_'");
224 strcat(listbuf, " and relname !~ '^Inv[0-9]+'");
226 * the usesysid = relowner won't work on stock 1.0 dbs, need to add in
227 * the int4oideq function
229 strcat(listbuf, " and usesysid = relowner");
230 strcat(listbuf, " ORDER BY relname ");
231 if (!(res = PSQLexec(ps, listbuf)))
234 /* first, print out the attribute names */
235 nColumns = PQntuples(res);
237 if (deep_tablelist) {
238 /* describe everything here */
240 table = (char **) malloc(nColumns * sizeof(char *));
244 /* load table table */
245 for (i = 0; i < nColumns; i++) {
246 table[i] = (char *) malloc(PQgetlength(res, i, 1) * sizeof(char) + 1);
247 if (table[i] == NULL)
249 strcpy(table[i], PQgetvalue(res, i, 1));
253 for (i = 0; i < nColumns; i++) {
254 tableDesc(ps, table[i]);
258 /* Display the information */
260 printf("\nDatabase = %s\n", PQdb(ps->db));
261 printf(" +------------------+----------------------------------+----------+\n");
262 printf(" | Owner | Relation | Type |\n");
263 printf(" +------------------+----------------------------------+----------+\n");
265 /* next, print out the instances */
266 for (i = 0; i < PQntuples(res); i++) {
267 printf(" | %-16.16s", PQgetvalue(res, i, 0));
268 printf(" | %-32.32s | ", PQgetvalue(res, i, 1));
269 rk = PQgetvalue(res, i, 2);
270 rr = PQgetvalue(res, i, 3);
271 if (strcmp(rk, "r") == 0)
272 printf("%-8.8s |", (rr[0] == 't') ? "view?" : "table");
274 printf("%-8.8s |", "index");
277 printf(" +------------------+----------------------------------+----------+\n");
283 fprintf(stderr, "Couldn't find any tables!\n");
291 * Describe the columns in a database table. returns 0 if all went well
296 tableDesc(PsqlSettings * ps, char *table)
306 /* Build the query */
309 strcat(descbuf, "SELECT a.attnum, a.attname, t.typname, a.attlen");
310 strcat(descbuf, " FROM pg_class c, pg_attribute a, pg_type t ");
311 strcat(descbuf, " WHERE c.relname = '");
312 strcat(descbuf, table);
313 strcat(descbuf, "'");
314 strcat(descbuf, " and a.attnum > 0 ");
315 strcat(descbuf, " and a.attrelid = c.oid ");
316 strcat(descbuf, " and a.atttypid = t.oid ");
317 strcat(descbuf, " ORDER BY attnum ");
318 if (!(res = PSQLexec(ps, descbuf)))
320 /* first, print out the attribute names */
321 nColumns = PQntuples(res);
324 * * Display the information
327 printf("\nTable = %s\n", table);
328 printf("+----------------------------------+----------------------------------+-------+\n");
329 printf("| Field | Type | Length|\n");
330 printf("+----------------------------------+----------------------------------+-------+\n");
332 /* next, print out the instances */
333 for (i = 0; i < PQntuples(res); i++) {
334 printf("| %-32.32s | ", PQgetvalue(res, i, 1));
335 rtype = PQgetvalue(res, i, 2);
336 rsize = atoi(PQgetvalue(res, i, 3));
337 if (strcmp(rtype, "text") == 0) {
338 printf("%-32.32s |", rtype);
339 printf("%6s |", "var");
340 } else if (strcmp(rtype, "bpchar") == 0) {
341 printf("%-32.32s |", "(bp)char");
342 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
343 } else if (strcmp(rtype, "varchar") == 0) {
344 printf("%-32.32s |", rtype);
345 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
347 /* array types start with an underscore */
349 printf("%-32.32s |", rtype);
352 newname = malloc(strlen(rtype) + 2);
353 strcpy(newname, rtype + 1);
354 strcat(newname, "[]");
355 printf("%-32.32s |", newname);
359 printf("%6i |", rsize);
361 printf("%6s |", "var");
365 printf("+----------------------------------+----------------------------------+-------+\n");
371 fprintf(stderr, "Couldn't find table %s!\n", table);
376 typedef char *(*READ_ROUTINE) (char *prompt, FILE * source);
379 * gets_noreadline prompt source gets a line of input without calling
380 * readline, the source is ignored
383 gets_noreadline(char *prompt, FILE * source)
385 fputs(prompt, stdout);
387 return (gets_fromFile(prompt, stdin));
391 * gets_readline prompt source the routine to get input from GNU readline(),
392 * the source is ignored the prompt argument is used as the prompting string
395 gets_readline(char *prompt, FILE * source)
397 return (readline(prompt));
401 * gets_fromFile prompt source
403 * the routine to read from a file, the prompt argument is ignored the source
404 * argument is a FILE *
407 gets_fromFile(char *prompt, FILE * source)
412 line = malloc(MAX_QUERY_BUFFER + 1);
414 /* read up to MAX_QUERY_BUFFER characters */
415 if (fgets(line, MAX_QUERY_BUFFER, source) == NULL)
418 line[MAX_QUERY_BUFFER - 1] = '\0';
420 if (len == MAX_QUERY_BUFFER) {
421 fprintf(stderr, "line read exceeds maximum length. Truncating at %d\n",
428 * SendQuery: send the query string to the backend return *success_p = 1 if
429 * the query executed successfully returns *success_p = 0 otherwise
432 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
433 const bool copy_in, const bool copy_out, FILE * copystream)
439 if (settings->singleStep)
440 fprintf(stdout, "\n**************************************"
441 "*****************************************\n");
443 if (settings->echoQuery || settings->singleStep) {
444 fprintf(stderr, "QUERY: %s\n", query);
447 if (settings->singleStep) {
448 fprintf(stdout, "\n**************************************"
449 "*****************************************\n");
451 printf("\npress return to continue ..\n");
452 gets_fromFile("", stdin);
454 results = PQexec(settings->db, query);
455 if (results == NULL) {
456 fprintf(stderr, "%s", PQerrorMessage(settings->db));
459 switch (PQresultStatus(results)) {
460 case PGRES_TUPLES_OK:
461 if (settings->gfname) {
462 PsqlSettings ps = *settings;
464 ps.queryFout = stdout;
465 fp = setFout(&ps, settings->gfname);
466 if (!fp || fp == stdout) {
478 settings->gfname = NULL;
482 PQprint(settings->queryFout,
485 fflush(settings->queryFout);
489 case PGRES_EMPTY_QUERY:
492 case PGRES_COMMAND_OK:
494 if (!settings->quiet)
495 fprintf(stdout, "%s\n", PQcmdStatus(results));
500 handleCopyOut(results, settings->quiet, copystream);
502 if (!settings->quiet)
503 fprintf(stdout, "Copy command returns...\n");
505 handleCopyOut(results, settings->quiet, stdout);
511 handleCopyIn(results, false, copystream);
515 * eat extra newline still in input buffer
519 if ((c = getc(stdin)) != '\n' && c != EOF)
520 (void) ungetc(c, stdin);
521 handleCopyIn(results, !settings->quiet, stdin);
524 case PGRES_NONFATAL_ERROR:
525 case PGRES_FATAL_ERROR:
526 case PGRES_BAD_RESPONSE:
528 fprintf(stderr, "%s", PQerrorMessage(settings->db));
532 if (PQstatus(settings->db) == CONNECTION_BAD) {
534 "We have lost the connection to the backend, so "
535 "further processing is impossible. "
537 exit(2); /* we are out'ta here */
539 /* check for asynchronous returns */
540 notify = PQnotifies(settings->db);
543 "ASYNC NOTIFY of '%s' from backend pid '%d' received\n",
544 notify->relname, notify->be_pid);
553 editFile(char *fname)
557 editorName = getenv("EDITOR");
559 editorName = DEFAULT_EDITOR;
560 sys = malloc(strlen(editorName) + strlen(fname) + 32 + 1);
565 sprintf(sys, "exec '%s' '%s'", editorName, fname);
571 toggle(PsqlSettings * settings, bool * sw, char *msg)
574 if (!settings->quiet)
575 fprintf(stderr, "turned %s %s\n", on(*sw), msg);
582 unescape(char *dest, const char *source)
584 /*-----------------------------------------------------------------------------
585 Return as the string <dest> the value of string <source> with escape
586 sequences turned into the bytes they represent.
587 -----------------------------------------------------------------------------*/
589 bool esc; /* Last character we saw was the escape
592 esc = false; /* Haven't seen escape character yet */
593 for (p = (char *) source; *p; p++) {
594 char c; /* Our output character */
617 } else if (*p == '\\') {
619 c = ' '; /* meaningless, but compiler doesn't know
628 *dest = '\0'; /* Terminating null character */
634 parse_slash_copy(const char *args, char *table, const int table_len,
635 char *file, const int file_len,
636 bool * from_p, bool * error_p)
641 * A copy of the \copy command arguments, except that we modify it as we
642 * parse to suit our parsing needs.
644 char *table_tok, *fromto_tok;
646 strncpy(work_args, args, sizeof(work_args));
647 work_args[sizeof(work_args) - 1] = '\0';
649 *error_p = false; /* initial assumption */
651 table_tok = strtok(work_args, " ");
652 if (table_tok == NULL) {
653 fprintf(stderr, "\\copy needs arguments.\n");
656 strncpy(table, table_tok, table_len);
657 file[table_len - 1] = '\0';
659 fromto_tok = strtok(NULL, " ");
660 if (fromto_tok == NULL) {
661 fprintf(stderr, "'FROM' or 'TO' must follow table name.\n");
664 if (strcasecmp(fromto_tok, "from") == 0)
666 else if (strcasecmp(fromto_tok, "to") == 0)
670 "Unrecognized token found where "
671 "'FROM' or 'TO' expected: '%s'.\n",
678 file_tok = strtok(NULL, " ");
679 if (file_tok == NULL) {
680 fprintf(stderr, "A file pathname must follow '%s'.\n",
684 strncpy(file, file_tok, file_len);
685 file[file_len - 1] = '\0';
686 if (strtok(NULL, " ") != NULL) {
688 "You have extra tokens after the filename.\n");
700 do_copy(const char *args, PsqlSettings * settings)
702 /*---------------------------------------------------------------------------
703 Execute a \copy command (frontend copy). We have to open a file, then
704 submit a COPY query to the backend and either feed it data from the
705 file or route its response into the file.
707 We do a text copy with default (tab) column delimiters. Some day, we
708 should do all the things a backend copy can do.
710 ----------------------------------------------------------------------------*/
712 /* The COPY command we send to the back end */
714 /* The direction of the copy is from a file to a table. */
715 char file[MAXPATHLEN + 1];
716 /* The pathname of the file from/to which we copy */
717 char table[NAMEDATALEN + 1];
718 /* The name of the table from/to which we copy */
720 /* The \c command has invalid syntax */
723 parse_slash_copy(args, table, sizeof(table), file, sizeof(file),
724 &from, &syntax_error);
727 strcpy(query, "COPY ");
728 strcat(query, table);
731 strcat(query, " FROM stdin");
733 strcat(query, " TO stdout");
736 copystream = fopen(file, "r");
738 copystream = fopen(file, "w");
742 "Unable to open file %s which to copy, errno = %s (%d).",
743 from ? "from" : "to", strerror(errno), errno);
745 bool success; /* The query succeeded at the backend */
747 SendQuery(&success, settings, query, from, !from, copystream);
749 if (!settings->quiet) {
751 fprintf(stdout, "Successfully copied.\n");
753 fprintf(stdout, "Copy failed.\n");
761 do_connect(const char *new_dbname, PsqlSettings * settings)
764 char *dbname = PQdb(settings->db);
766 fprintf(stderr, "\\connect must be followed by a database name\n");
768 PGconn *olddb = settings->db;
770 printf("closing connection to database: %s\n", dbname);
771 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
772 NULL, NULL, new_dbname);
773 printf("connecting to new database: %s\n", new_dbname);
774 if (PQstatus(settings->db) == CONNECTION_BAD) {
775 fprintf(stderr, "%s\n", PQerrorMessage(settings->db));
776 printf("reconnecting to %s\n", dbname);
777 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
779 if (PQstatus(settings->db) == CONNECTION_BAD) {
781 "could not reconnect to %s. exiting\n", dbname);
786 free(settings->prompt);
787 settings->prompt = malloc(strlen(PQdb(settings->db)) + 10);
788 sprintf(settings->prompt, "%s=> ", PQdb(settings->db));
795 do_edit(const char *filename_arg, char *query, int *status_p)
802 const int ql = strlen(query);
806 fname = (char *) filename_arg;
809 sprintf(tmp, "/tmp/psql.%ld.%ld", (long) geteuid(), (long) getpid());
813 if ((fd = open(tmp, O_EXCL | O_CREAT | O_WRONLY, 0600)) == -1) {
817 if (query[ql - 1] != '\n')
819 if (write(fd, query, ql) != ql) {
836 if ((fd = open(fname, O_RDONLY)) == -1) {
842 if ((cc = read(fd, query, MAX_QUERY_BUFFER)) == -1) {
863 do_help(const char *topic)
867 char left_center_right; /* Which column we're
869 int i; /* Index into QL_HELP[] */
871 printf("type \\h <cmd> where <cmd> is one of the following:\n");
873 left_center_right = 'L';/* Start with left column */
875 while (QL_HELP[i].cmd != NULL) {
876 switch (left_center_right) {
878 printf(" %-25s", QL_HELP[i].cmd);
879 left_center_right = 'C';
882 printf("%-25s", QL_HELP[i].cmd);
883 left_center_right = 'R';
886 printf("%-25s\n", QL_HELP[i].cmd);
887 left_center_right = 'L';
892 if (left_center_right != 'L')
894 printf("type \\h * for a complete description of all commands\n");
896 int i; /* Index into QL_HELP[] */
897 bool help_found; /* We found the help he asked for */
899 help_found = false; /* Haven't found it yet */
900 for (i = 0; QL_HELP[i].cmd; i++) {
901 if (strcmp(QL_HELP[i].cmd, topic) == 0 ||
902 strcmp(topic, "*") == 0) {
904 printf("Command: %s\n", QL_HELP[i].cmd);
905 printf("Description: %s\n", QL_HELP[i].help);
907 printf("%s\n", QL_HELP[i].syntax);
912 printf("command not found, "
913 "try \\h with no arguments to see available help\n");
920 do_shell(const char *command)
927 shellName = getenv("SHELL");
928 if (shellName == NULL)
929 shellName = DEFAULT_SHELL;
930 sys = malloc(strlen(shellName) + 16);
935 sprintf(sys, "exec %s", shellName);
947 * Handles all the different commands that start with \ db_ptr is a pointer to
948 * the TgDb* structure line is the current input line prompt_ptr is a pointer
949 * to the prompt string, a pointer is used because the prompt can be used
950 * with a connection to a new database returns a status: 0 - send currently
951 * constructed query to backend (i.e. we got a \g) 1 - skip processing of
952 * this line, continue building up query 2 - terminate processing of this
953 * query entirely, 3 - new query supplied by edit
956 HandleSlashCmds(PsqlSettings * settings,
963 * Pointer inside the <cmd> string to the argument of the slash command,
964 * assuming it is a one-character slash command. If it's not a
965 * one-character command, this is meaningless.
969 * Pointer inside the <cmd> string to the argument of the slash command
970 * assuming it's not a one-character command. If it's a one-character
971 * command, this is meaningless.
975 * String: value of the slash command, less the slash and with escape
979 /* Offset within <cmd> of first blank */
981 cmd = malloc(strlen(line)); /* unescaping better not make string grow. */
983 unescape(cmd, line + 1); /* sets cmd string */
986 * Originally, there were just single character commands. Now, we define
987 * some longer, friendly commands, but we have to keep the old single
988 * character commands too. \c used to be what \connect is now.
989 * Complicating matters is the fact that with the single-character
990 * commands, you can start the argument right after the single character,
991 * so "\copy" would mean "connect to database named 'opy'".
995 optarg = cmd + 1 + strspn(cmd + 1, " \t");
999 blank_loc = strcspn(cmd, " \t");
1003 optarg2 = cmd + blank_loc + strspn(cmd + blank_loc, " \t");
1007 case 'a': /* toggles to align fields on output */
1008 toggle(settings, &settings->opt.align, "field alignment");
1010 case 'C': /* define new caption */
1011 if (settings->opt.caption)
1012 free(settings->opt.caption);
1014 settings->opt.caption = NULL;
1015 else if (!(settings->opt.caption = strdup(optarg))) {
1021 if (strncmp(cmd, "copy ", strlen("copy ")) == 0)
1022 do_copy(optarg2, settings);
1023 else if (strncmp(cmd, "connect ", strlen("connect ")) == 0)
1024 do_connect(optarg2, settings);
1026 do_connect(optarg, settings);
1029 case 'd': /* \d describe tables or columns in a table */
1031 tableList(settings, 0);
1034 if (strcmp(optarg, "*") == 0) {
1035 tableList(settings, 0);
1036 tableList(settings, 1);
1038 tableDesc(settings, optarg);
1041 case 'e': /* edit */
1043 do_edit(optarg, query, &status);
1049 static char *lastfile;
1050 struct stat st, st2;
1054 lastfile = malloc(strlen(optarg + 1));
1059 strcpy(lastfile, optarg);
1060 } else if (!lastfile) {
1061 fprintf(stderr, "\\r must be followed by a file name initially\n");
1064 stat(lastfile, &st);
1066 if ((stat(lastfile, &st2) == -1) || ((fd = fopen(lastfile, "r")) == NULL)) {
1070 if (st2.st_mtime == st.st_mtime) {
1071 if (!settings->quiet)
1072 fprintf(stderr, "warning: %s not modified. query not executed\n", lastfile);
1076 MainLoop(settings, fd);
1082 char *fs = DEFAULT_FIELD_SEP;
1085 if (settings->opt.fieldSep);
1086 free(settings->opt.fieldSep);
1087 if (!(settings->opt.fieldSep = strdup(fs))) {
1091 if (!settings->quiet)
1092 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1095 case 'g': /* \g means send query */
1096 settings->gfname = optarg;
1099 case 'h': /* help */
1104 case 'i': /* \i is include file */
1109 fprintf(stderr, "\\i must be followed by a file name\n");
1112 if ((fd = fopen(optarg, "r")) == NULL) {
1113 fprintf(stderr, "file named %s could not be opened\n", optarg);
1116 MainLoop(settings, fd);
1120 case 'l': /* \l is list database */
1121 listAllDbs(settings);
1124 if (toggle(settings, &settings->opt.html3, "HTML3.0 tabular output"))
1125 settings->opt.standard = 0;
1128 setFout(settings, optarg);
1132 fputs(query, stdout);
1133 fputc('\n', stdout);
1136 case 'q': /* \q is quit */
1139 case 'r': /* reset(clear) the buffer */
1141 if (!settings->quiet)
1142 fprintf(stderr, "buffer reset(cleared)\n");
1144 case 's': /* \s is save history to a file */
1146 optarg = "/dev/tty";
1147 if (write_history(optarg) != 0)
1148 fprintf(stderr, "cannot write history to %s\n", optarg);
1150 case 'm': /* monitor like type-setting */
1151 if (toggle(settings, &settings->opt.standard, "standard SQL separaters and padding")) {
1152 settings->opt.html3 = settings->opt.expanded = 0;
1153 settings->opt.align = settings->opt.header = 1;
1154 free(settings->opt.fieldSep);
1155 settings->opt.fieldSep = strdup("|");
1156 if (!settings->quiet)
1157 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1159 free(settings->opt.fieldSep);
1160 settings->opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1161 if (!settings->quiet)
1162 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1165 case 't': /* toggle headers */
1166 toggle(settings, &settings->opt.header, "output headings and row count");
1168 case 'T': /* define html <table ...> option */
1169 if (settings->opt.tableOpt)
1170 free(settings->opt.tableOpt);
1172 settings->opt.tableOpt = NULL;
1173 else if (!(settings->opt.tableOpt = strdup(optarg))) {
1179 toggle(settings, &settings->opt.expanded, "expanded table representation");
1185 case '?': /* \? is help */
1186 slashUsage(settings);
1194 * MainLoop: main processing loop for reading lines of input and sending them
1197 * this loop is re-entrant. May be called by \i command which reads input from
1200 * db_ptr must be initialized and set
1204 MainLoop(PsqlSettings * settings, FILE * source)
1206 char *line; /* line of input */
1207 int len; /* length of the line */
1208 char query[MAX_QUERY_BUFFER]; /* multi-line query storage */
1209 int successResult = 1;
1210 int slashCmdStatus = 0;
1212 * slashCmdStatus can be: 0 - send currently constructed query to backend
1213 * (i.e. we got a \g) 1 - skip processing of this line, continue building
1214 * up query 2 - terminate processing of this query entirely 3 - new query
1218 bool querySent = false;
1220 READ_ROUTINE GetNextLine;
1222 /* We've reached the end of our command input. */
1225 bool was_bslash; /* backslash */
1230 interactive = ((source == stdin) && !settings->notty);
1231 #define PROMPT "=> "
1233 if (settings->prompt)
1234 free(settings->prompt);
1236 malloc(strlen(PQdb(settings->db)) + strlen(PROMPT) + 1);
1237 if (settings->quiet)
1238 settings->prompt[0] = '\0';
1240 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
1241 if (settings->useReadline) {
1243 GetNextLine = gets_readline;
1245 GetNextLine = gets_noreadline;
1247 GetNextLine = gets_fromFile;
1252 slashCmdStatus = -1; /* set default */
1254 /* main loop for getting queries and executing them */
1256 if (slashCmdStatus == 3) {
1257 line = strdup(query);
1260 line = GetNextLine(settings->prompt, source);
1261 if (interactive && settings->useReadline && line != NULL)
1262 add_history(line); /* save non-empty lines in history */
1267 if (line == NULL) { /* No more input. Time to quit */
1268 printf("EOF\n"); /* Goes on prompt line */
1271 if (!interactive && !settings->singleStep && !settings->quiet)
1272 fprintf(stderr, "%s\n", line);
1274 /* remove whitespaces on the right, incl. \n's */
1275 line = rightTrim(line);
1277 if (line[0] == '\0') {
1284 if (settings->singleLineMode) {
1285 SendQuery(&success, settings, line, false, false, 0);
1286 successResult &= success;
1293 for (i = 0; i < len; i++) {
1294 if (!in_quote && line[i] == '\\') {
1295 char hold_char = line[i];
1298 if (query_start[0] != '\0') {
1299 if (query[0] != '\0') {
1300 strcat(query, "\n");
1301 strcat(query, query_start);
1303 strcpy(query, query_start);
1305 line[i] = hold_char;
1306 query_start = line + i;
1307 break; /* handle command */
1309 if (querySent && !isspace(line[i])) {
1313 if (!in_quote && was_dash && line[i] == '-') {
1314 /* print comment at top of query */
1315 if (settings->singleStep)
1316 fprintf(stdout, "%s\n", line + i - 1);
1317 line[i - 1] = '\0'; /* remove comment */
1322 if (!in_quote && !paren_level &&
1324 char hold_char = line[i + 1];
1327 if (query_start[0] != '\0') {
1328 if (query[0] != '\0') {
1329 strcat(query, "\n");
1330 strcat(query, query_start);
1332 strcpy(query, query_start);
1334 SendQuery(&success, settings, query, false, false, 0);
1335 successResult &= success;
1336 line[i + 1] = hold_char;
1337 query_start = line + i + 1;
1342 else if (line[i] == '\\')
1344 else if (line[i] == '\'')
1346 else if (!in_quote && line[i] == '(')
1348 else if (!in_quote && paren_level && line[i] == ')')
1350 else if (!in_quote && line[i] == '-')
1355 slashCmdStatus = -1;
1356 /* slash commands have to be on their own line */
1357 if (!in_quote && query_start[0] == '\\') {
1358 slashCmdStatus = HandleSlashCmds(settings,
1361 if (slashCmdStatus == 1) {
1365 if (slashCmdStatus == 2) {
1369 } else if (strlen(query) + strlen(query_start) > MAX_QUERY_BUFFER) {
1370 fprintf(stderr, "query buffer max length of %d exceeded\n",
1372 fprintf(stderr, "query line ignored\n");
1374 if (query_start[0] != '\0') {
1376 if (query[0] != '\0') {
1377 strcat(query, "\n");
1378 strcat(query, query_start);
1380 strcpy(query, query_start);
1384 if (slashCmdStatus == 0) {
1385 SendQuery(&success, settings, query, false, false, 0);
1386 successResult &= success;
1389 free(line); /* free storage malloc'd by GetNextLine */
1392 return successResult;
1396 main(int argc, char **argv)
1398 extern char *optarg;
1401 char *dbname = NULL;
1404 char *qfilename = NULL;
1405 char errbuf[ERROR_MSG_LENGTH];
1407 PsqlSettings settings;
1409 char *singleQuery = NULL;
1411 bool listDatabases = 0;
1412 int successResult = 1;
1413 bool singleSlashCmd = 0;
1416 memset(&settings, 0, sizeof settings);
1417 settings.opt.align = 1;
1418 settings.opt.header = 1;
1419 settings.queryFout = stdout;
1420 settings.opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1421 settings.opt.pager = 1;
1422 if (!isatty(0) || !isatty(1))
1423 settings.quiet = settings.notty = 1;
1426 settings.useReadline = 1;
1429 while ((c = getopt(argc, argv, "Aa:c:d:ef:F:lh:Hnso:p:qStT:x")) != EOF) {
1432 settings.opt.align = 0;
1435 fe_setauthsvc(optarg, errbuf);
1438 singleQuery = optarg;
1439 if (singleQuery[0] == '\\') {
1447 settings.echoQuery = 1;
1453 settings.opt.fieldSep = optarg;
1462 settings.opt.html3 = 1;
1465 settings.useReadline = 0;
1468 setFout(&settings, optarg);
1477 settings.singleStep = 1;
1480 settings.singleLineMode = 1;
1483 settings.opt.header = 0;
1486 settings.opt.tableOpt = optarg;
1489 settings.opt.expanded = 1;
1496 /* if we still have an argument, use it as the database name */
1497 if (argc - optind == 1)
1498 dbname = argv[optind];
1501 dbname = "template1";
1503 settings.db = PQsetdb(host, port, NULL, NULL, dbname);
1504 dbname = PQdb(settings.db);
1506 if (PQstatus(settings.db) == CONNECTION_BAD) {
1507 fprintf(stderr, "Connection to database '%s' failed.\n", dbname);
1508 fprintf(stderr, "%s", PQerrorMessage(settings.db));
1511 if (listDatabases) {
1512 exit(listAllDbs(&settings));
1514 if (!settings.quiet && !singleQuery && !qfilename) {
1515 printf("Welcome to the POSTGRES95 interactive sql monitor:\n");
1516 printf(" Please read the file COPYRIGHT for copyright terms "
1517 "of POSTGRES95\n\n");
1518 printf(" type \\? for help on slash commands\n");
1519 printf(" type \\q to quit\n");
1520 printf(" type \\g or terminate with semicolon to execute query\n");
1521 printf(" You are currently connected to the database: %s\n\n", dbname);
1523 if (qfilename || singleSlashCmd) {
1525 * read in a file full of queries instead of reading in queries
1530 if (singleSlashCmd) {
1531 /* Not really a query, but "Do what I mean, not what I say." */
1534 line = malloc(strlen(qfilename) + 5);
1535 sprintf(line, "\\i %s", qfilename);
1537 HandleSlashCmds(&settings, line, "");
1540 bool success; /* The query succeeded at the backend */
1541 SendQuery(&success, &settings, singleQuery, false, false, 0);
1542 successResult = success;
1544 successResult = MainLoop(&settings, stdin);
1547 PQfinish(settings.db);
1549 return !successResult;
1552 #define COPYBUFSIZ 8192
1555 handleCopyOut(PGresult * res, bool quiet, FILE * copystream)
1558 char copybuf[COPYBUFSIZ];
1561 copydone = false; /* Can't be done; haven't started. */
1564 ret = PQgetline(res->conn, copybuf, COPYBUFSIZ);
1566 if (copybuf[0] == '\\' &&
1567 copybuf[1] == '.' &&
1568 copybuf[2] == '\0') {
1569 copydone = true; /* don't print this... */
1571 fputs(copybuf, copystream);
1577 fputc('\n', copystream);
1585 PQendcopy(res->conn);
1591 handleCopyIn(PGresult * res, const bool mustprompt, FILE * copystream)
1593 bool copydone = false;
1596 char copybuf[COPYBUFSIZ];
1602 fputs("Enter info followed by a newline\n", stdout);
1603 fputs("End with a backslash and a "
1604 "period on a line by itself.\n", stdout);
1606 while (!copydone) { /* for each input line ... */
1608 fputs(">> ", stdout);
1613 while (!linedone) { /* for each buffer ... */
1615 buflen = COPYBUFSIZ;
1616 for (; buflen > 1 &&
1617 !(linedone = (c = getc(copystream)) == '\n' || c == EOF);
1622 PQputline(res->conn, "\\.");
1627 PQputline(res->conn, copybuf);
1629 if (!strcmp(copybuf, "\\.")) {
1635 PQputline(res->conn, "\n");
1637 PQendcopy(res->conn);
1643 * try to open fname and return a FILE *, if it fails, use stdout, instead
1647 setFout(PsqlSettings * ps, char *fname)
1649 if (ps->queryFout && ps->queryFout != stdout) {
1651 pclose(ps->queryFout);
1653 fclose(ps->queryFout);
1656 ps->queryFout = stdout;
1658 if (*fname == '|') {
1659 signal(SIGPIPE, SIG_IGN);
1660 ps->queryFout = popen(fname + 1, "w");
1663 ps->queryFout = fopen(fname, "w");
1666 if (!ps->queryFout) {
1668 ps->queryFout = stdout;
1671 return ps->queryFout;