1 /*-------------------------------------------------------------------------
4 * an interactive front-end to postgreSQL
6 * Copyright (c) 1996, Regents of the University of California
10 * $Header: /cvsroot/pgsql/src/bin/psql/Attic/psql.c,v 1.40 1996/12/26 17:52:46 momjian Exp $
12 *-------------------------------------------------------------------------
18 #include <sys/types.h>
25 #include "stringutils.h"
34 /* from the GNU readline library */
39 #include <readline/readline.h>
40 #include <readline/history.h>
46 #define MAX_QUERY_BUFFER 20000
48 #define COPYBUFSIZ 8192
50 #define DEFAULT_FIELD_SEP "|"
51 #define DEFAULT_EDITOR "vi"
52 #define DEFAULT_SHELL "/bin/sh"
54 typedef struct _psqlSettings {
55 PGconn *db; /* connection to backend */
56 FILE *queryFout; /* where to send the query results */
57 PQprintOpt opt; /* options to be passed to PQprint */
58 char *prompt; /* prompt to display */
59 char *gfname; /* one-shot file output argument for \g */
60 bool notty; /* input or output is not a tty */
61 bool pipe; /* queryFout is from a popen() */
62 bool echoQuery; /* echo the query before sending it */
63 bool quiet; /* run quietly, no messages, no promt */
64 bool singleStep; /* prompt before for each query */
65 bool singleLineMode; /* query terminated by newline */
66 bool useReadline;/* use libreadline routines */
69 /* declarations for functions in this file */
70 static void usage(char *progname);
71 static void slashUsage();
72 static void handleCopyOut(PGresult * res, bool quiet, FILE * copystream);
74 handleCopyIn(PGresult * res, const bool mustprompt,
76 static int tableList(PsqlSettings * ps, bool deep_tablelist);
77 static int tableDesc(PsqlSettings * ps, char *table);
79 char *gets_noreadline(char *prompt, FILE * source);
80 char *gets_readline(char *prompt, FILE * source);
81 char *gets_fromFile(char *prompt, FILE * source);
82 int listAllDbs(PsqlSettings * settings);
84 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
85 const bool copy_in, const bool copy_out, FILE * copystream);
87 HandleSlashCmds(PsqlSettings * settings,
90 int MainLoop(PsqlSettings * settings, FILE * source);
91 /* probably should move this into libpq */
98 FILE *setFout(PsqlSettings * ps, char *fname);
101 * usage print out usage for command line arguments
105 usage(char *progname)
107 fprintf(stderr, "Usage: %s [options] [dbname]\n", progname);
108 fprintf(stderr, "\t -a authsvc set authentication service\n");
109 fprintf(stderr, "\t -A turn off alignment when printing out attributes\n");
110 fprintf(stderr, "\t -c query run single query (slash commands too)\n");
111 fprintf(stderr, "\t -d dbName specify database name\n");
112 fprintf(stderr, "\t -e echo the query sent to the backend\n");
113 fprintf(stderr, "\t -f filename use file as a source of queries\n");
114 fprintf(stderr, "\t -F sep set the field separator (default is " ")\n");
115 fprintf(stderr, "\t -h host set database server host\n");
116 fprintf(stderr, "\t -H turn on html3.0 table output\n");
117 fprintf(stderr, "\t -l list available databases\n");
118 fprintf(stderr, "\t -n don't use readline library\n");
119 fprintf(stderr, "\t -o filename send output to filename or (|pipe)\n");
120 fprintf(stderr, "\t -p port set port number\n");
121 fprintf(stderr, "\t -q run quietly (no messages, no prompts)\n");
122 fprintf(stderr, "\t -s single step mode (prompts for each query)\n");
123 fprintf(stderr, "\t -S single line mode (i.e. query terminated by newline)\n");
124 fprintf(stderr, "\t -t turn off printing of headings and row count\n");
125 fprintf(stderr, "\t -T html set html3.0 table command options (cf. -H)\n");
126 fprintf(stderr, "\t -x turn on expanded output (field names on left)\n");
131 * slashUsage print out usage for the backslash commands
137 return f ? "on" : "off";
141 slashUsage(PsqlSettings * ps)
143 fprintf(stderr, " \\? -- help\n");
144 fprintf(stderr, " \\a -- toggle field-alignment (currenty %s)\n", on(ps->opt.align));
145 fprintf(stderr, " \\C [<captn>] -- set html3 caption (currently '%s')\n", ps->opt.caption ? ps->opt.caption : "");
146 fprintf(stderr, " \\connect <dbname> -- connect to new database (currently '%s')\n", PQdb(ps->db));
147 fprintf(stderr, " \\copy <dbname> -- copy table to/from a file\n");
148 fprintf(stderr, " \\d [<table>] -- list tables in database or columns in <table>, * for all\n");
149 fprintf(stderr, " \\e [<fname>] -- edit the current query buffer or <fname>, \\E execute too\n");
150 fprintf(stderr, " \\f [<sep>] -- change field separater (currently '%s')\n", ps->opt.fieldSep);
151 fprintf(stderr, " \\g [<fname>] [|<cmd>] -- send query to backend [and results in <fname> or pipe]\n");
152 fprintf(stderr, " \\h [<cmd>] -- help on syntax of sql commands, * for all commands\n");
153 fprintf(stderr, " \\H -- toggle html3 output (currently %s)\n", on(ps->opt.html3));
154 fprintf(stderr, " \\i <fname> -- read and execute queries from filename\n");
155 fprintf(stderr, " \\l -- list all databases\n");
156 fprintf(stderr, " \\m -- toggle monitor-like table display (currently %s)\n", on(ps->opt.standard));
157 fprintf(stderr, " \\o [<fname>] [|<cmd>] -- send all query results to stdout, <fname>, or pipe\n");
158 fprintf(stderr, " \\p -- print the current query buffer\n");
159 fprintf(stderr, " \\q -- quit\n");
160 fprintf(stderr, " \\r -- reset(clear) the query buffer\n");
161 fprintf(stderr, " \\s [<fname>] -- print history or save it in <fname>\n");
162 fprintf(stderr, " \\t -- toggle table headings and row count (currently %s)\n", on(ps->opt.header));
163 fprintf(stderr, " \\T [<html>] -- set html3.0 <table ...> options (currently '%s')\n", ps->opt.tableOpt ? ps->opt.tableOpt : "");
164 fprintf(stderr, " \\x -- toggle expanded output (currently %s)\n", on(ps->opt.expanded));
165 fprintf(stderr, " \\! [<cmd>] -- shell escape or command\n");
169 PSQLexec(PsqlSettings * ps, char *query)
171 PGresult *res = PQexec(ps->db, query);
173 fputs(PQerrorMessage(ps->db), stderr);
175 if (PQresultStatus(res) == PGRES_COMMAND_OK ||
176 PQresultStatus(res) == PGRES_TUPLES_OK)
179 fputs(PQerrorMessage(ps->db), stderr);
187 * list all the databases in the system returns 0 if all went well
193 listAllDbs(PsqlSettings * ps)
196 char *query = "select * from pg_database;";
198 if (!(results = PSQLexec(ps, query)))
201 PQprint(ps->queryFout,
210 * List The Database Tables returns 0 if all went well
214 tableList(PsqlSettings * ps, bool deep_tablelist)
225 strcat(listbuf, "SELECT usename, relname, relkind, relhasrules");
226 strcat(listbuf, " FROM pg_class, pg_user ");
227 strcat(listbuf, "WHERE ( relkind = 'r' OR relkind = 'i') ");
228 strcat(listbuf, " and relname !~ '^pg_'");
229 strcat(listbuf, " and relname !~ '^Inv[0-9]+'");
231 * the usesysid = relowner won't work on stock 1.0 dbs, need to add in
232 * the int4oideq function
234 strcat(listbuf, " and usesysid = relowner");
235 strcat(listbuf, " ORDER BY relname ");
236 if (!(res = PSQLexec(ps, listbuf)))
239 /* first, print out the attribute names */
240 nColumns = PQntuples(res);
242 if (deep_tablelist) {
243 /* describe everything here */
245 table = (char **) malloc(nColumns * sizeof(char *));
249 /* load table table */
250 for (i = 0; i < nColumns; i++) {
251 table[i] = (char *) malloc(PQgetlength(res, i, 1) * sizeof(char) + 1);
252 if (table[i] == NULL)
254 strcpy(table[i], PQgetvalue(res, i, 1));
258 for (i = 0; i < nColumns; i++) {
259 tableDesc(ps, table[i]);
263 /* Display the information */
265 printf("\nDatabase = %s\n", PQdb(ps->db));
266 printf(" +------------------+----------------------------------+----------+\n");
267 printf(" | Owner | Relation | Type |\n");
268 printf(" +------------------+----------------------------------+----------+\n");
270 /* next, print out the instances */
271 for (i = 0; i < PQntuples(res); i++) {
272 printf(" | %-16.16s", PQgetvalue(res, i, 0));
273 printf(" | %-32.32s | ", PQgetvalue(res, i, 1));
274 rk = PQgetvalue(res, i, 2);
275 rr = PQgetvalue(res, i, 3);
276 if (strcmp(rk, "r") == 0)
277 printf("%-8.8s |", (rr[0] == 't') ? "view?" : "table");
279 printf("%-8.8s |", "index");
282 printf(" +------------------+----------------------------------+----------+\n");
288 fprintf(stderr, "Couldn't find any tables!\n");
296 * Describe the columns in a database table. returns 0 if all went well
301 tableDesc(PsqlSettings * ps, char *table)
311 /* Build the query */
314 strcat(descbuf, "SELECT a.attnum, a.attname, t.typname, a.attlen");
315 strcat(descbuf, " FROM pg_class c, pg_attribute a, pg_type t ");
316 strcat(descbuf, " WHERE c.relname = '");
317 strcat(descbuf, table);
318 strcat(descbuf, "'");
319 strcat(descbuf, " and a.attnum > 0 ");
320 strcat(descbuf, " and a.attrelid = c.oid ");
321 strcat(descbuf, " and a.atttypid = t.oid ");
322 strcat(descbuf, " ORDER BY attnum ");
323 if (!(res = PSQLexec(ps, descbuf)))
325 /* first, print out the attribute names */
326 nColumns = PQntuples(res);
329 * * Display the information
332 printf("\nTable = %s\n", table);
333 printf("+----------------------------------+----------------------------------+-------+\n");
334 printf("| Field | Type | Length|\n");
335 printf("+----------------------------------+----------------------------------+-------+\n");
337 /* next, print out the instances */
338 for (i = 0; i < PQntuples(res); i++) {
339 printf("| %-32.32s | ", PQgetvalue(res, i, 1));
340 rtype = PQgetvalue(res, i, 2);
341 rsize = atoi(PQgetvalue(res, i, 3));
342 if (strcmp(rtype, "text") == 0) {
343 printf("%-32.32s |", rtype);
344 printf("%6s |", "var");
345 } else if (strcmp(rtype, "bpchar") == 0) {
346 printf("%-32.32s |", "(bp)char");
347 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
348 } else if (strcmp(rtype, "varchar") == 0) {
349 printf("%-32.32s |", rtype);
350 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
352 /* array types start with an underscore */
354 printf("%-32.32s |", rtype);
357 newname = malloc(strlen(rtype) + 2);
358 strcpy(newname, rtype + 1);
359 strcat(newname, "[]");
360 printf("%-32.32s |", newname);
364 printf("%6i |", rsize);
366 printf("%6s |", "var");
370 printf("+----------------------------------+----------------------------------+-------+\n");
376 fprintf(stderr, "Couldn't find table %s!\n", table);
381 typedef char *(*READ_ROUTINE) (char *prompt, FILE * source);
384 * gets_noreadline prompt source gets a line of input without calling
385 * readline, the source is ignored
388 gets_noreadline(char *prompt, FILE * source)
390 fputs(prompt, stdout);
392 return (gets_fromFile(prompt, stdin));
396 * gets_readline prompt source the routine to get input from GNU readline(),
397 * the source is ignored the prompt argument is used as the prompting string
400 gets_readline(char *prompt, FILE * source)
402 return (readline(prompt));
406 * gets_fromFile prompt source
408 * the routine to read from a file, the prompt argument is ignored the source
409 * argument is a FILE *
412 gets_fromFile(char *prompt, FILE * source)
417 line = malloc(MAX_QUERY_BUFFER + 1);
419 /* read up to MAX_QUERY_BUFFER characters */
420 if (fgets(line, MAX_QUERY_BUFFER, source) == NULL)
423 line[MAX_QUERY_BUFFER - 1] = '\0';
425 if (len == MAX_QUERY_BUFFER) {
426 fprintf(stderr, "line read exceeds maximum length. Truncating at %d\n",
433 * SendQuery: send the query string to the backend return *success_p = 1 if
434 * the query executed successfully returns *success_p = 0 otherwise
437 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
438 const bool copy_in, const bool copy_out, FILE * copystream)
444 if (settings->singleStep)
445 fprintf(stdout, "\n**************************************"
446 "*****************************************\n");
448 if (settings->echoQuery || settings->singleStep) {
449 fprintf(stderr, "QUERY: %s\n", query);
452 if (settings->singleStep) {
453 fprintf(stdout, "\n**************************************"
454 "*****************************************\n");
456 printf("\npress return to continue ..\n");
457 gets_fromFile("", stdin);
459 results = PQexec(settings->db, query);
460 if (results == NULL) {
461 fprintf(stderr, "%s", PQerrorMessage(settings->db));
464 switch (PQresultStatus(results)) {
465 case PGRES_TUPLES_OK:
466 if (settings->gfname) {
467 PsqlSettings ps = *settings;
469 ps.queryFout = stdout;
470 fp = setFout(&ps, settings->gfname);
471 if (!fp || fp == stdout) {
483 free(settings->gfname);
484 settings->gfname = NULL;
488 PQprint(settings->queryFout,
491 fflush(settings->queryFout);
495 case PGRES_EMPTY_QUERY:
498 case PGRES_COMMAND_OK:
500 if (!settings->quiet)
501 fprintf(stdout, "%s\n", PQcmdStatus(results));
506 handleCopyOut(results, settings->quiet, copystream);
508 if (!settings->quiet)
509 fprintf(stdout, "Copy command returns...\n");
511 handleCopyOut(results, settings->quiet, stdout);
517 handleCopyIn(results, false, copystream);
521 * eat extra newline still in input buffer
525 if ((c = getc(stdin)) != '\n' && c != EOF)
526 (void) ungetc(c, stdin);
527 handleCopyIn(results, !settings->quiet, stdin);
530 case PGRES_NONFATAL_ERROR:
531 case PGRES_FATAL_ERROR:
532 case PGRES_BAD_RESPONSE:
534 fprintf(stderr, "%s", PQerrorMessage(settings->db));
538 if (PQstatus(settings->db) == CONNECTION_BAD) {
540 "We have lost the connection to the backend, so "
541 "further processing is impossible. "
543 exit(2); /* we are out'ta here */
545 /* check for asynchronous returns */
546 notify = PQnotifies(settings->db);
549 "ASYNC NOTIFY of '%s' from backend pid '%d' received\n",
550 notify->relname, notify->be_pid);
559 editFile(char *fname)
563 editorName = getenv("EDITOR");
565 editorName = DEFAULT_EDITOR;
566 sys = malloc(strlen(editorName) + strlen(fname) + 32 + 1);
571 sprintf(sys, "exec '%s' '%s'", editorName, fname);
577 toggle(PsqlSettings * settings, bool * sw, char *msg)
580 if (!settings->quiet)
581 fprintf(stderr, "turned %s %s\n", on(*sw), msg);
588 unescape(char *dest, const char *source)
590 /*-----------------------------------------------------------------------------
591 Return as the string <dest> the value of string <source> with escape
592 sequences turned into the bytes they represent.
593 -----------------------------------------------------------------------------*/
595 bool esc; /* Last character we saw was the escape
598 esc = false; /* Haven't seen escape character yet */
599 for (p = (char *) source; *p; p++) {
600 char c; /* Our output character */
623 } else if (*p == '\\') {
625 c = ' '; /* meaningless, but compiler doesn't know
634 *dest = '\0'; /* Terminating null character */
640 parse_slash_copy(const char *args, char *table, const int table_len,
641 char *file, const int file_len,
642 bool * from_p, bool * error_p)
647 * A copy of the \copy command arguments, except that we modify it as we
648 * parse to suit our parsing needs.
650 char *table_tok, *fromto_tok;
652 strncpy(work_args, args, sizeof(work_args));
653 work_args[sizeof(work_args) - 1] = '\0';
655 *error_p = false; /* initial assumption */
657 table_tok = strtok(work_args, " ");
658 if (table_tok == NULL) {
659 fprintf(stderr, "\\copy needs arguments.\n");
662 strncpy(table, table_tok, table_len);
663 file[table_len - 1] = '\0';
665 fromto_tok = strtok(NULL, " ");
666 if (fromto_tok == NULL) {
667 fprintf(stderr, "'FROM' or 'TO' must follow table name.\n");
670 if (strcasecmp(fromto_tok, "from") == 0)
672 else if (strcasecmp(fromto_tok, "to") == 0)
676 "Unrecognized token found where "
677 "'FROM' or 'TO' expected: '%s'.\n",
684 file_tok = strtok(NULL, " ");
685 if (file_tok == NULL) {
686 fprintf(stderr, "A file pathname must follow '%s'.\n",
690 strncpy(file, file_tok, file_len);
691 file[file_len - 1] = '\0';
692 if (strtok(NULL, " ") != NULL) {
694 "You have extra tokens after the filename.\n");
706 do_copy(const char *args, PsqlSettings * settings)
708 /*---------------------------------------------------------------------------
709 Execute a \copy command (frontend copy). We have to open a file, then
710 submit a COPY query to the backend and either feed it data from the
711 file or route its response into the file.
713 We do a text copy with default (tab) column delimiters. Some day, we
714 should do all the things a backend copy can do.
716 ----------------------------------------------------------------------------*/
718 /* The COPY command we send to the back end */
720 /* The direction of the copy is from a file to a table. */
721 char file[MAXPATHLEN + 1];
722 /* The pathname of the file from/to which we copy */
723 char table[NAMEDATALEN + 1];
724 /* The name of the table from/to which we copy */
726 /* The \c command has invalid syntax */
729 parse_slash_copy(args, table, sizeof(table), file, sizeof(file),
730 &from, &syntax_error);
733 strcpy(query, "COPY ");
734 strcat(query, table);
737 strcat(query, " FROM stdin");
739 strcat(query, " TO stdout");
742 copystream = fopen(file, "r");
744 copystream = fopen(file, "w");
746 if (copystream == NULL)
748 "Unable to open file %s which to copy, errno = %s (%d).",
749 from ? "from" : "to", strerror(errno), errno);
751 bool success; /* The query succeeded at the backend */
753 SendQuery(&success, settings, query, from, !from, copystream);
755 if (!settings->quiet) {
757 fprintf(stdout, "Successfully copied.\n");
759 fprintf(stdout, "Copy failed.\n");
767 do_connect(const char *new_dbname, PsqlSettings * settings)
770 char *dbname = PQdb(settings->db);
772 fprintf(stderr, "\\connect must be followed by a database name\n");
774 PGconn *olddb = settings->db;
776 printf("closing connection to database: %s\n", dbname);
777 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
778 NULL, NULL, new_dbname);
779 printf("connecting to new database: %s\n", new_dbname);
780 if (PQstatus(settings->db) == CONNECTION_BAD) {
781 fprintf(stderr, "%s\n", PQerrorMessage(settings->db));
782 printf("reconnecting to %s\n", dbname);
783 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
785 if (PQstatus(settings->db) == CONNECTION_BAD) {
787 "could not reconnect to %s. exiting\n", dbname);
792 free(settings->prompt);
793 settings->prompt = malloc(strlen(PQdb(settings->db)) + 10);
794 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
801 do_edit(const char *filename_arg, char *query, int *status_p)
808 const int ql = strlen(query);
812 fname = (char *) filename_arg;
815 sprintf(tmp, "/tmp/psql.%ld.%ld", (long) geteuid(), (long) getpid());
819 if ((fd = open(tmp, O_EXCL | O_CREAT | O_WRONLY, 0600)) == -1) {
823 if (query[ql - 1] != '\n')
825 if (write(fd, query, ql) != ql) {
842 if ((fd = open(fname, O_RDONLY)) == -1) {
848 if ((cc = read(fd, query, MAX_QUERY_BUFFER)) == -1) {
869 do_help(const char *topic)
873 char left_center_right; /* Which column we're
875 int i; /* Index into QL_HELP[] */
877 printf("type \\h <cmd> where <cmd> is one of the following:\n");
879 left_center_right = 'L';/* Start with left column */
881 while (QL_HELP[i].cmd != NULL) {
882 switch (left_center_right) {
884 printf(" %-25s", QL_HELP[i].cmd);
885 left_center_right = 'C';
888 printf("%-25s", QL_HELP[i].cmd);
889 left_center_right = 'R';
892 printf("%-25s\n", QL_HELP[i].cmd);
893 left_center_right = 'L';
898 if (left_center_right != 'L')
900 printf("type \\h * for a complete description of all commands\n");
902 int i; /* Index into QL_HELP[] */
903 bool help_found; /* We found the help he asked for */
905 help_found = false; /* Haven't found it yet */
906 for (i = 0; QL_HELP[i].cmd; i++) {
907 if (strcmp(QL_HELP[i].cmd, topic) == 0 ||
908 strcmp(topic, "*") == 0) {
910 printf("Command: %s\n", QL_HELP[i].cmd);
911 printf("Description: %s\n", QL_HELP[i].help);
913 printf("%s\n", QL_HELP[i].syntax);
918 printf("command not found, "
919 "try \\h with no arguments to see available help\n");
926 do_shell(const char *command)
933 shellName = getenv("SHELL");
934 if (shellName == NULL)
935 shellName = DEFAULT_SHELL;
936 sys = malloc(strlen(shellName) + 16);
941 sprintf(sys, "exec %s", shellName);
953 * Handles all the different commands that start with \ db_ptr is a pointer to
954 * the TgDb* structure line is the current input line prompt_ptr is a pointer
955 * to the prompt string, a pointer is used because the prompt can be used
956 * with a connection to a new database returns a status: 0 - send currently
957 * constructed query to backend (i.e. we got a \g) 1 - skip processing of
958 * this line, continue building up query 2 - terminate processing of this
959 * query entirely, 3 - new query supplied by edit
962 HandleSlashCmds(PsqlSettings * settings,
969 * Pointer inside the <cmd> string to the argument of the slash command,
970 * assuming it is a one-character slash command. If it's not a
971 * one-character command, this is meaningless.
975 * Pointer inside the <cmd> string to the argument of the slash command
976 * assuming it's not a one-character command. If it's a one-character
977 * command, this is meaningless.
981 * String: value of the slash command, less the slash and with escape
985 /* Offset within <cmd> of first blank */
987 cmd = malloc(strlen(line)); /* unescaping better not make string grow. */
989 unescape(cmd, line + 1); /* sets cmd string */
992 * Originally, there were just single character commands. Now, we define
993 * some longer, friendly commands, but we have to keep the old single
994 * character commands too. \c used to be what \connect is now.
995 * Complicating matters is the fact that with the single-character
996 * commands, you can start the argument right after the single character,
997 * so "\copy" would mean "connect to database named 'opy'".
1000 if (strlen(cmd) > 1)
1001 optarg = cmd + 1 + strspn(cmd + 1, " \t");
1005 blank_loc = strcspn(cmd, " \t");
1009 optarg2 = cmd + blank_loc + strspn(cmd + blank_loc, " \t");
1013 case 'a': /* toggles to align fields on output */
1014 toggle(settings, &settings->opt.align, "field alignment");
1016 case 'C': /* define new caption */
1017 if (settings->opt.caption)
1018 free(settings->opt.caption);
1021 if (settings->opt.caption)
1022 free(settings->opt.caption);
1023 settings->opt.caption = NULL;
1025 else if (!(settings->opt.caption = strdup(optarg))) {
1031 if (strncmp(cmd, "copy ", strlen("copy ")) == 0)
1032 do_copy(optarg2, settings);
1033 else if (strncmp(cmd, "connect ", strlen("connect ")) == 0)
1034 do_connect(optarg2, settings);
1036 do_connect(optarg, settings);
1039 case 'd': /* \d describe tables or columns in a table */
1041 tableList(settings, 0);
1044 if (strcmp(optarg, "*") == 0) {
1045 tableList(settings, 0);
1046 tableList(settings, 1);
1048 tableDesc(settings, optarg);
1051 case 'e': /* edit */
1053 do_edit(optarg, query, &status);
1059 static char *lastfile;
1060 struct stat st, st2;
1064 lastfile = malloc(strlen(optarg + 1));
1069 strcpy(lastfile, optarg);
1070 } else if (!lastfile) {
1071 fprintf(stderr, "\\r must be followed by a file name initially\n");
1074 stat(lastfile, &st);
1076 if ((stat(lastfile, &st2) == -1) || ((fd = fopen(lastfile, "r")) == NULL)) {
1080 if (st2.st_mtime == st.st_mtime) {
1081 if (!settings->quiet)
1082 fprintf(stderr, "warning: %s not modified. query not executed\n", lastfile);
1086 MainLoop(settings, fd);
1092 char *fs = DEFAULT_FIELD_SEP;
1095 if (settings->opt.fieldSep)
1096 free(settings->opt.fieldSep);
1097 if (!(settings->opt.fieldSep = strdup(fs))) {
1101 if (!settings->quiet)
1102 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1105 case 'g': /* \g means send query */
1107 settings->gfname = NULL;
1108 else if (!(settings->gfname = strdup(optarg))) {
1114 case 'h': /* help */
1119 case 'i': /* \i is include file */
1124 fprintf(stderr, "\\i must be followed by a file name\n");
1127 if ((fd = fopen(optarg, "r")) == NULL) {
1128 fprintf(stderr, "file named %s could not be opened\n", optarg);
1131 MainLoop(settings, fd);
1135 case 'l': /* \l is list database */
1136 listAllDbs(settings);
1139 if (toggle(settings, &settings->opt.html3, "HTML3.0 tabular output"))
1140 settings->opt.standard = 0;
1143 setFout(settings, optarg);
1147 fputs(query, stdout);
1148 fputc('\n', stdout);
1151 case 'q': /* \q is quit */
1154 case 'r': /* reset(clear) the buffer */
1156 if (!settings->quiet)
1157 fprintf(stderr, "buffer reset(cleared)\n");
1159 case 's': /* \s is save history to a file */
1161 optarg = "/dev/tty";
1162 if (write_history(optarg) != 0)
1163 fprintf(stderr, "cannot write history to %s\n", optarg);
1165 case 'm': /* monitor like type-setting */
1166 if (toggle(settings, &settings->opt.standard, "standard SQL separaters and padding")) {
1167 settings->opt.html3 = settings->opt.expanded = 0;
1168 settings->opt.align = settings->opt.header = 1;
1169 if (settings->opt.fieldSep)
1170 free(settings->opt.fieldSep);
1171 settings->opt.fieldSep = strdup("|");
1172 if (!settings->quiet)
1173 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1175 if (settings->opt.fieldSep)
1176 free(settings->opt.fieldSep);
1177 settings->opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1178 if (!settings->quiet)
1179 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1182 case 't': /* toggle headers */
1183 toggle(settings, &settings->opt.header, "output headings and row count");
1185 case 'T': /* define html <table ...> option */
1186 if (settings->opt.tableOpt)
1187 free(settings->opt.tableOpt);
1189 settings->opt.tableOpt = NULL;
1190 else if (!(settings->opt.tableOpt = strdup(optarg))) {
1196 toggle(settings, &settings->opt.expanded, "expanded table representation");
1202 case '?': /* \? is help */
1203 slashUsage(settings);
1211 * MainLoop: main processing loop for reading lines of input and sending them
1214 * this loop is re-entrant. May be called by \i command which reads input from
1217 * db_ptr must be initialized and set
1221 MainLoop(PsqlSettings * settings, FILE * source)
1223 char *line; /* line of input */
1224 int len; /* length of the line */
1225 char query[MAX_QUERY_BUFFER]; /* multi-line query storage */
1226 int successResult = 1;
1227 int slashCmdStatus = 0;
1229 * slashCmdStatus can be: 0 - send currently constructed query to backend
1230 * (i.e. we got a \g) 1 - skip processing of this line, continue building
1231 * up query 2 - terminate processing of this query entirely 3 - new query
1235 bool querySent = false;
1237 READ_ROUTINE GetNextLine;
1239 /* We've reached the end of our command input. */
1242 bool was_bslash; /* backslash */
1247 interactive = ((source == stdin) && !settings->notty);
1249 if (settings->prompt)
1250 free(settings->prompt);
1252 malloc(strlen(PQdb(settings->db)) + strlen(PROMPT) + 1);
1253 if (settings->quiet)
1254 settings->prompt[0] = '\0';
1256 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
1257 if (settings->useReadline) {
1259 GetNextLine = gets_readline;
1261 GetNextLine = gets_noreadline;
1263 GetNextLine = gets_fromFile;
1268 slashCmdStatus = -1; /* set default */
1270 /* main loop for getting queries and executing them */
1272 if (slashCmdStatus == 3) {
1273 line = strdup(query);
1276 if (interactive && !settings->quiet) {
1278 settings->prompt[strlen(settings->prompt)-3] = '\'';
1279 else if (query[0] != '\0' && !querySent)
1280 settings->prompt[strlen(settings->prompt)-3] = '-';
1282 settings->prompt[strlen(settings->prompt)-3] = '=';
1284 line = GetNextLine(settings->prompt, source);
1285 if (interactive && settings->useReadline && line != NULL)
1286 add_history(line); /* save non-empty lines in history */
1291 if (line == NULL) { /* No more input. Time to quit */
1292 printf("EOF\n"); /* Goes on prompt line */
1295 if (!interactive && !settings->singleStep && !settings->quiet)
1296 fprintf(stderr, "%s\n", line);
1298 /* remove whitespaces on the right, incl. \n's */
1299 line = rightTrim(line);
1301 if (line[0] == '\0') {
1308 if (settings->singleLineMode) {
1309 SendQuery(&success, settings, line, false, false, 0);
1310 successResult &= success;
1317 for (i = 0; i < len; i++) {
1318 if (!in_quote && line[i] == '\\') {
1319 char hold_char = line[i];
1322 if (query_start[0] != '\0') {
1323 if (query[0] != '\0') {
1324 strcat(query, "\n");
1325 strcat(query, query_start);
1327 strcpy(query, query_start);
1329 line[i] = hold_char;
1330 query_start = line + i;
1331 break; /* handle command */
1333 if (querySent && !isspace(line[i])) {
1337 if (!in_quote && was_dash && line[i] == '-') {
1338 /* print comment at top of query */
1339 if (settings->singleStep)
1340 fprintf(stdout, "%s\n", line + i - 1);
1341 line[i - 1] = '\0'; /* remove comment */
1346 if (!in_quote && !paren_level &&
1348 char hold_char = line[i + 1];
1351 if (query_start[0] != '\0') {
1352 if (query[0] != '\0') {
1353 strcat(query, "\n");
1354 strcat(query, query_start);
1356 strcpy(query, query_start);
1358 SendQuery(&success, settings, query, false, false, 0);
1359 successResult &= success;
1360 line[i + 1] = hold_char;
1361 query_start = line + i + 1;
1366 else if (line[i] == '\\')
1368 else if (line[i] == '\'')
1370 else if (!in_quote && line[i] == '(')
1372 else if (!in_quote && paren_level && line[i] == ')')
1374 else if (!in_quote && line[i] == '-')
1379 slashCmdStatus = -1;
1380 /* slash commands have to be on their own line */
1381 if (!in_quote && query_start[0] == '\\') {
1382 slashCmdStatus = HandleSlashCmds(settings,
1385 if (slashCmdStatus == 1) {
1389 if (slashCmdStatus == 2) {
1393 } else if (strlen(query) + strlen(query_start) > MAX_QUERY_BUFFER) {
1394 fprintf(stderr, "query buffer max length of %d exceeded\n",
1396 fprintf(stderr, "query line ignored\n");
1398 if (query_start[0] != '\0') {
1400 if (query[0] != '\0') {
1401 strcat(query, "\n");
1402 strcat(query, query_start);
1404 strcpy(query, query_start);
1408 if (slashCmdStatus == 0) {
1409 SendQuery(&success, settings, query, false, false, 0);
1410 successResult &= success;
1413 free(line); /* free storage malloc'd by GetNextLine */
1416 return successResult;
1420 main(int argc, char **argv)
1422 extern char *optarg;
1425 char *dbname = NULL;
1428 char *qfilename = NULL;
1429 char errbuf[ERROR_MSG_LENGTH];
1431 PsqlSettings settings;
1433 char *singleQuery = NULL;
1435 bool listDatabases = 0;
1436 int successResult = 1;
1437 bool singleSlashCmd = 0;
1440 memset(&settings, 0, sizeof settings);
1441 settings.opt.align = 1;
1442 settings.opt.header = 1;
1443 settings.queryFout = stdout;
1444 settings.opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1445 settings.opt.pager = 1;
1446 if (!isatty(0) || !isatty(1))
1447 settings.quiet = settings.notty = 1;
1450 settings.useReadline = 1;
1453 while ((c = getopt(argc, argv, "Aa:c:d:ef:F:lh:Hnso:p:qStT:x")) != EOF) {
1456 settings.opt.align = 0;
1459 fe_setauthsvc(optarg, errbuf);
1462 singleQuery = optarg;
1463 if (singleQuery[0] == '\\') {
1471 settings.echoQuery = 1;
1477 settings.opt.fieldSep = optarg;
1486 settings.opt.html3 = 1;
1489 settings.useReadline = 0;
1492 setFout(&settings, optarg);
1501 settings.singleStep = 1;
1504 settings.singleLineMode = 1;
1507 settings.opt.header = 0;
1510 settings.opt.tableOpt = optarg;
1513 settings.opt.expanded = 1;
1520 /* if we still have an argument, use it as the database name */
1521 if (argc - optind == 1)
1522 dbname = argv[optind];
1525 dbname = "template1";
1527 settings.db = PQsetdb(host, port, NULL, NULL, dbname);
1528 dbname = PQdb(settings.db);
1530 if (PQstatus(settings.db) == CONNECTION_BAD) {
1531 fprintf(stderr, "Connection to database '%s' failed.\n", dbname);
1532 fprintf(stderr, "%s", PQerrorMessage(settings.db));
1535 if (listDatabases) {
1536 exit(listAllDbs(&settings));
1538 if (!settings.quiet && !singleQuery && !qfilename) {
1539 printf("Welcome to the POSTGRESQL interactive sql monitor:\n");
1540 printf(" Please read the file COPYRIGHT for copyright terms "
1541 "of POSTGRESQL\n\n");
1542 printf(" type \\? for help on slash commands\n");
1543 printf(" type \\q to quit\n");
1544 printf(" type \\g or terminate with semicolon to execute query\n");
1545 printf(" You are currently connected to the database: %s\n\n", dbname);
1547 if (qfilename || singleSlashCmd) {
1549 * read in a file full of queries instead of reading in queries
1554 if (singleSlashCmd) {
1555 /* Not really a query, but "Do what I mean, not what I say." */
1558 line = malloc(strlen(qfilename) + 5);
1559 sprintf(line, "\\i %s", qfilename);
1561 HandleSlashCmds(&settings, line, "");
1564 bool success; /* The query succeeded at the backend */
1565 SendQuery(&success, &settings, singleQuery, false, false, 0);
1566 successResult = success;
1568 successResult = MainLoop(&settings, stdin);
1571 PQfinish(settings.db);
1573 return !successResult;
1576 #define COPYBUFSIZ 8192
1579 handleCopyOut(PGresult * res, bool quiet, FILE * copystream)
1582 char copybuf[COPYBUFSIZ];
1585 copydone = false; /* Can't be done; haven't started. */
1588 ret = PQgetline(res->conn, copybuf, COPYBUFSIZ);
1590 if (copybuf[0] == '\\' &&
1591 copybuf[1] == '.' &&
1592 copybuf[2] == '\0') {
1593 copydone = true; /* don't print this... */
1595 fputs(copybuf, copystream);
1601 fputc('\n', copystream);
1609 PQendcopy(res->conn);
1615 handleCopyIn(PGresult * res, const bool mustprompt, FILE * copystream)
1617 bool copydone = false;
1620 char copybuf[COPYBUFSIZ];
1626 fputs("Enter info followed by a newline\n", stdout);
1627 fputs("End with a backslash and a "
1628 "period on a line by itself.\n", stdout);
1630 while (!copydone) { /* for each input line ... */
1632 fputs(">> ", stdout);
1637 while (!linedone) { /* for each buffer ... */
1639 buflen = COPYBUFSIZ;
1640 for (; buflen > 1 &&
1641 !(linedone = (c = getc(copystream)) == '\n' || c == EOF);
1646 PQputline(res->conn, "\\.");
1651 PQputline(res->conn, copybuf);
1653 if (!strcmp(copybuf, "\\.")) {
1659 PQputline(res->conn, "\n");
1661 PQendcopy(res->conn);
1667 * try to open fname and return a FILE *, if it fails, use stdout, instead
1671 setFout(PsqlSettings * ps, char *fname)
1673 if (ps->queryFout && ps->queryFout != stdout) {
1675 pclose(ps->queryFout);
1677 fclose(ps->queryFout);
1680 ps->queryFout = stdout;
1682 if (*fname == '|') {
1683 signal(SIGPIPE, SIG_IGN);
1684 ps->queryFout = popen(fname + 1, "w");
1687 ps->queryFout = fopen(fname, "w");
1690 if (!ps->queryFout) {
1692 ps->queryFout = stdout;
1695 return ps->queryFout;