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.42 1996/12/26 22:07:57 momjian Exp $
12 *-------------------------------------------------------------------------
18 #include <sys/types.h>
26 #include "stringutils.h"
35 /* from the GNU readline library */
40 #include <readline/readline.h>
41 #include <readline/history.h>
47 #define MAX_QUERY_BUFFER 20000
49 #define COPYBUFSIZ 8192
51 #define DEFAULT_FIELD_SEP "|"
52 #define DEFAULT_EDITOR "vi"
53 #define DEFAULT_SHELL "/bin/sh"
55 typedef struct _psqlSettings {
56 PGconn *db; /* connection to backend */
57 FILE *queryFout; /* where to send the query results */
58 PQprintOpt opt; /* options to be passed to PQprint */
59 char *prompt; /* prompt to display */
60 char *gfname; /* one-shot file output argument for \g */
61 bool notty; /* input or output is not a tty */
62 bool pipe; /* queryFout is from a popen() */
63 bool echoQuery; /* echo the query before sending it */
64 bool quiet; /* run quietly, no messages, no promt */
65 bool singleStep; /* prompt before for each query */
66 bool singleLineMode; /* query terminated by newline */
67 bool useReadline;/* use libreadline routines */
70 /* declarations for functions in this file */
71 static void usage(char *progname);
72 static void slashUsage();
73 static void handleCopyOut(PGresult * res, bool quiet, FILE * copystream);
75 handleCopyIn(PGresult * res, const bool mustprompt,
77 static int tableList(PsqlSettings * ps, bool deep_tablelist);
78 static int tableDesc(PsqlSettings * ps, char *table);
80 char *gets_noreadline(char *prompt, FILE * source);
81 char *gets_readline(char *prompt, FILE * source);
82 char *gets_fromFile(char *prompt, FILE * source);
83 int listAllDbs(PsqlSettings * settings);
85 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
86 const bool copy_in, const bool copy_out, FILE * copystream);
88 HandleSlashCmds(PsqlSettings * settings,
91 int MainLoop(PsqlSettings * settings, FILE * source);
92 /* probably should move this into libpq */
99 FILE *setFout(PsqlSettings * ps, char *fname);
102 * usage print out usage for command line arguments
106 usage(char *progname)
108 fprintf(stderr, "Usage: %s [options] [dbname]\n", progname);
109 fprintf(stderr, "\t -a authsvc set authentication service\n");
110 fprintf(stderr, "\t -A turn off alignment when printing out attributes\n");
111 fprintf(stderr, "\t -c query run single query (slash commands too)\n");
112 fprintf(stderr, "\t -d dbName specify database name\n");
113 fprintf(stderr, "\t -e echo the query sent to the backend\n");
114 fprintf(stderr, "\t -f filename use file as a source of queries\n");
115 fprintf(stderr, "\t -F sep set the field separator (default is " ")\n");
116 fprintf(stderr, "\t -h host set database server host\n");
117 fprintf(stderr, "\t -H turn on html3.0 table output\n");
118 fprintf(stderr, "\t -l list available databases\n");
119 fprintf(stderr, "\t -n don't use readline library\n");
120 fprintf(stderr, "\t -o filename send output to filename or (|pipe)\n");
121 fprintf(stderr, "\t -p port set port number\n");
122 fprintf(stderr, "\t -q run quietly (no messages, no prompts)\n");
123 fprintf(stderr, "\t -s single step mode (prompts for each query)\n");
124 fprintf(stderr, "\t -S single line mode (i.e. query terminated by newline)\n");
125 fprintf(stderr, "\t -t turn off printing of headings and row count\n");
126 fprintf(stderr, "\t -T html set html3.0 table command options (cf. -H)\n");
127 fprintf(stderr, "\t -x turn on expanded output (field names on left)\n");
132 * slashUsage print out usage for the backslash commands
138 return f ? "on" : "off";
142 slashUsage(PsqlSettings * ps)
144 fprintf(stderr, " \\? -- help\n");
145 fprintf(stderr, " \\a -- toggle field-alignment (currenty %s)\n", on(ps->opt.align));
146 fprintf(stderr, " \\C [<captn>] -- set html3 caption (currently '%s')\n", ps->opt.caption ? ps->opt.caption : "");
147 fprintf(stderr, " \\connect <dbname> -- connect to new database (currently '%s')\n", PQdb(ps->db));
148 fprintf(stderr, " \\copy {<table> to <file> | <file> from <table>}\n");
149 fprintf(stderr, " \\d [<table>] -- list tables in database or columns in <table>, * for all\n");
150 fprintf(stderr, " \\e [<fname>] -- edit the current query buffer or <fname>, \\E execute too\n");
151 fprintf(stderr, " \\f [<sep>] -- change field separater (currently '%s')\n", ps->opt.fieldSep);
152 fprintf(stderr, " \\g [<fname>] [|<cmd>] -- send query to backend [and results in <fname> or pipe]\n");
153 fprintf(stderr, " \\h [<cmd>] -- help on syntax of sql commands, * for all commands\n");
154 fprintf(stderr, " \\H -- toggle html3 output (currently %s)\n", on(ps->opt.html3));
155 fprintf(stderr, " \\i <fname> -- read and execute queries from filename\n");
156 fprintf(stderr, " \\l -- list all databases\n");
157 fprintf(stderr, " \\m -- toggle monitor-like table display (currently %s)\n", on(ps->opt.standard));
158 fprintf(stderr, " \\o [<fname>] [|<cmd>] -- send all query results to stdout, <fname>, or pipe\n");
159 fprintf(stderr, " \\p -- print the current query buffer\n");
160 fprintf(stderr, " \\q -- quit\n");
161 fprintf(stderr, " \\r -- reset(clear) the query buffer\n");
162 fprintf(stderr, " \\s [<fname>] -- print history or save it in <fname>\n");
163 fprintf(stderr, " \\t -- toggle table headings and row count (currently %s)\n", on(ps->opt.header));
164 fprintf(stderr, " \\T [<html>] -- set html3.0 <table ...> options (currently '%s')\n", ps->opt.tableOpt ? ps->opt.tableOpt : "");
165 fprintf(stderr, " \\x -- toggle expanded output (currently %s)\n", on(ps->opt.expanded));
166 fprintf(stderr, " \\! [<cmd>] -- shell escape or command\n");
170 PSQLexec(PsqlSettings * ps, char *query)
172 PGresult *res = PQexec(ps->db, query);
174 fputs(PQerrorMessage(ps->db), stderr);
176 if (PQresultStatus(res) == PGRES_COMMAND_OK ||
177 PQresultStatus(res) == PGRES_TUPLES_OK)
180 fputs(PQerrorMessage(ps->db), stderr);
188 * list all the databases in the system returns 0 if all went well
194 listAllDbs(PsqlSettings * ps)
197 char *query = "select * from pg_database;";
199 if (!(results = PSQLexec(ps, query)))
202 PQprint(ps->queryFout,
211 * List The Database Tables returns 0 if all went well
215 tableList(PsqlSettings * ps, bool deep_tablelist)
226 strcat(listbuf, "SELECT usename, relname, relkind, relhasrules");
227 strcat(listbuf, " FROM pg_class, pg_user ");
228 strcat(listbuf, "WHERE ( relkind = 'r' OR relkind = 'i') ");
229 strcat(listbuf, " and relname !~ '^pg_'");
230 strcat(listbuf, " and relname !~ '^Inv[0-9]+'");
232 * the usesysid = relowner won't work on stock 1.0 dbs, need to add in
233 * the int4oideq function
235 strcat(listbuf, " and usesysid = relowner");
236 strcat(listbuf, " ORDER BY relname ");
237 if (!(res = PSQLexec(ps, listbuf)))
240 /* first, print out the attribute names */
241 nColumns = PQntuples(res);
243 if (deep_tablelist) {
244 /* describe everything here */
246 table = (char **) malloc(nColumns * sizeof(char *));
250 /* load table table */
251 for (i = 0; i < nColumns; i++) {
252 table[i] = (char *) malloc(PQgetlength(res, i, 1) * sizeof(char) + 1);
253 if (table[i] == NULL)
255 strcpy(table[i], PQgetvalue(res, i, 1));
259 for (i = 0; i < nColumns; i++) {
260 tableDesc(ps, table[i]);
264 /* Display the information */
266 printf("\nDatabase = %s\n", PQdb(ps->db));
267 printf(" +------------------+----------------------------------+----------+\n");
268 printf(" | Owner | Relation | Type |\n");
269 printf(" +------------------+----------------------------------+----------+\n");
271 /* next, print out the instances */
272 for (i = 0; i < PQntuples(res); i++) {
273 printf(" | %-16.16s", PQgetvalue(res, i, 0));
274 printf(" | %-32.32s | ", PQgetvalue(res, i, 1));
275 rk = PQgetvalue(res, i, 2);
276 rr = PQgetvalue(res, i, 3);
277 if (strcmp(rk, "r") == 0)
278 printf("%-8.8s |", (rr[0] == 't') ? "view?" : "table");
280 printf("%-8.8s |", "index");
283 printf(" +------------------+----------------------------------+----------+\n");
289 fprintf(stderr, "Couldn't find any tables!\n");
297 * Describe the columns in a database table. returns 0 if all went well
302 tableDesc(PsqlSettings * ps, char *table)
312 /* Build the query */
315 strcat(descbuf, "SELECT a.attnum, a.attname, t.typname, a.attlen");
316 strcat(descbuf, " FROM pg_class c, pg_attribute a, pg_type t ");
317 strcat(descbuf, " WHERE c.relname = '");
318 strcat(descbuf, table);
319 strcat(descbuf, "'");
320 strcat(descbuf, " and a.attnum > 0 ");
321 strcat(descbuf, " and a.attrelid = c.oid ");
322 strcat(descbuf, " and a.atttypid = t.oid ");
323 strcat(descbuf, " ORDER BY attnum ");
324 if (!(res = PSQLexec(ps, descbuf)))
326 /* first, print out the attribute names */
327 nColumns = PQntuples(res);
330 * * Display the information
333 printf("\nTable = %s\n", table);
334 printf("+----------------------------------+----------------------------------+-------+\n");
335 printf("| Field | Type | Length|\n");
336 printf("+----------------------------------+----------------------------------+-------+\n");
338 /* next, print out the instances */
339 for (i = 0; i < PQntuples(res); i++) {
340 printf("| %-32.32s | ", PQgetvalue(res, i, 1));
341 rtype = PQgetvalue(res, i, 2);
342 rsize = atoi(PQgetvalue(res, i, 3));
343 if (strcmp(rtype, "text") == 0) {
344 printf("%-32.32s |", rtype);
345 printf("%6s |", "var");
346 } else if (strcmp(rtype, "bpchar") == 0) {
347 printf("%-32.32s |", "(bp)char");
348 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
349 } else if (strcmp(rtype, "varchar") == 0) {
350 printf("%-32.32s |", rtype);
351 printf("%6i |", rsize > 0 ? rsize - 4 : 0);
353 /* array types start with an underscore */
355 printf("%-32.32s |", rtype);
358 newname = malloc(strlen(rtype) + 2);
359 strcpy(newname, rtype + 1);
360 strcat(newname, "[]");
361 printf("%-32.32s |", newname);
365 printf("%6i |", rsize);
367 printf("%6s |", "var");
371 printf("+----------------------------------+----------------------------------+-------+\n");
377 fprintf(stderr, "Couldn't find table %s!\n", table);
382 typedef char *(*READ_ROUTINE) (char *prompt, FILE * source);
385 * gets_noreadline prompt source gets a line of input without calling
386 * readline, the source is ignored
389 gets_noreadline(char *prompt, FILE * source)
391 fputs(prompt, stdout);
393 return (gets_fromFile(prompt, stdin));
397 * gets_readline prompt source the routine to get input from GNU readline(),
398 * the source is ignored the prompt argument is used as the prompting string
401 gets_readline(char *prompt, FILE * source)
403 return (readline(prompt));
407 * gets_fromFile prompt source
409 * the routine to read from a file, the prompt argument is ignored the source
410 * argument is a FILE *
413 gets_fromFile(char *prompt, FILE * source)
418 line = malloc(MAX_QUERY_BUFFER + 1);
420 /* read up to MAX_QUERY_BUFFER characters */
421 if (fgets(line, MAX_QUERY_BUFFER, source) == NULL)
424 line[MAX_QUERY_BUFFER - 1] = '\0';
426 if (len == MAX_QUERY_BUFFER) {
427 fprintf(stderr, "line read exceeds maximum length. Truncating at %d\n",
434 * SendQuery: send the query string to the backend return *success_p = 1 if
435 * the query executed successfully returns *success_p = 0 otherwise
438 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
439 const bool copy_in, const bool copy_out, FILE * copystream)
445 if (settings->singleStep)
446 fprintf(stdout, "\n**************************************"
447 "*****************************************\n");
449 if (settings->echoQuery || settings->singleStep) {
450 fprintf(stderr, "QUERY: %s\n", query);
453 if (settings->singleStep) {
454 fprintf(stdout, "\n**************************************"
455 "*****************************************\n");
457 printf("\npress return to continue ..\n");
458 gets_fromFile("", stdin);
460 results = PQexec(settings->db, query);
461 if (results == NULL) {
462 fprintf(stderr, "%s", PQerrorMessage(settings->db));
465 switch (PQresultStatus(results)) {
466 case PGRES_TUPLES_OK:
467 if (settings->gfname) {
468 PsqlSettings ps = *settings;
470 ps.queryFout = stdout;
471 fp = setFout(&ps, settings->gfname);
472 if (!fp || fp == stdout) {
484 free(settings->gfname);
485 settings->gfname = NULL;
489 PQprint(settings->queryFout,
492 fflush(settings->queryFout);
496 case PGRES_EMPTY_QUERY:
499 case PGRES_COMMAND_OK:
501 if (!settings->quiet)
502 fprintf(stdout, "%s\n", PQcmdStatus(results));
507 handleCopyOut(results, settings->quiet, copystream);
509 if (!settings->quiet)
510 fprintf(stdout, "Copy command returns...\n");
512 handleCopyOut(results, settings->quiet, stdout);
518 handleCopyIn(results, false, copystream);
520 handleCopyIn(results, !settings->quiet, stdin);
522 case PGRES_NONFATAL_ERROR:
523 case PGRES_FATAL_ERROR:
524 case PGRES_BAD_RESPONSE:
526 fprintf(stderr, "%s", PQerrorMessage(settings->db));
530 if (PQstatus(settings->db) == CONNECTION_BAD) {
532 "We have lost the connection to the backend, so "
533 "further processing is impossible. "
535 exit(2); /* we are out'ta here */
537 /* check for asynchronous returns */
538 notify = PQnotifies(settings->db);
541 "ASYNC NOTIFY of '%s' from backend pid '%d' received\n",
542 notify->relname, notify->be_pid);
551 editFile(char *fname)
555 editorName = getenv("EDITOR");
557 editorName = DEFAULT_EDITOR;
558 sys = malloc(strlen(editorName) + strlen(fname) + 32 + 1);
563 sprintf(sys, "exec '%s' '%s'", editorName, fname);
569 toggle(PsqlSettings * settings, bool * sw, char *msg)
572 if (!settings->quiet)
573 fprintf(stderr, "turned %s %s\n", on(*sw), msg);
580 unescape(char *dest, const char *source)
582 /*-----------------------------------------------------------------------------
583 Return as the string <dest> the value of string <source> with escape
584 sequences turned into the bytes they represent.
585 -----------------------------------------------------------------------------*/
587 bool esc; /* Last character we saw was the escape
590 esc = false; /* Haven't seen escape character yet */
591 for (p = (char *) source; *p; p++) {
592 char c; /* Our output character */
615 } else if (*p == '\\') {
617 c = ' '; /* meaningless, but compiler doesn't know
626 *dest = '\0'; /* Terminating null character */
632 parse_slash_copy(const char *args, char *table, const int table_len,
633 char *file, const int file_len,
634 bool * from_p, bool * error_p)
639 * A copy of the \copy command arguments, except that we modify it as we
640 * parse to suit our parsing needs.
642 char *table_tok, *fromto_tok;
644 strncpy(work_args, args, sizeof(work_args));
645 work_args[sizeof(work_args) - 1] = '\0';
647 *error_p = false; /* initial assumption */
649 table_tok = strtok(work_args, " ");
650 if (table_tok == NULL) {
651 fprintf(stderr, "\\copy needs arguments.\n");
654 strncpy(table, table_tok, table_len);
655 file[table_len - 1] = '\0';
657 fromto_tok = strtok(NULL, " ");
658 if (fromto_tok == NULL) {
659 fprintf(stderr, "'FROM' or 'TO' must follow table name.\n");
662 if (strcasecmp(fromto_tok, "from") == 0)
664 else if (strcasecmp(fromto_tok, "to") == 0)
668 "Unrecognized token found where "
669 "'FROM' or 'TO' expected: '%s'.\n",
676 file_tok = strtok(NULL, " ");
677 if (file_tok == NULL) {
678 fprintf(stderr, "A file pathname must follow '%s'.\n",
682 strncpy(file, file_tok, file_len);
683 file[file_len - 1] = '\0';
684 if (strtok(NULL, " ") != NULL) {
686 "You have extra tokens after the filename.\n");
698 do_copy(const char *args, PsqlSettings * settings)
700 /*---------------------------------------------------------------------------
701 Execute a \copy command (frontend copy). We have to open a file, then
702 submit a COPY query to the backend and either feed it data from the
703 file or route its response into the file.
705 We do a text copy with default (tab) column delimiters. Some day, we
706 should do all the things a backend copy can do.
708 ----------------------------------------------------------------------------*/
710 /* The COPY command we send to the back end */
712 /* The direction of the copy is from a file to a table. */
713 char file[MAXPATHLEN + 1];
714 /* The pathname of the file from/to which we copy */
715 char table[NAMEDATALEN + 1];
716 /* The name of the table from/to which we copy */
718 /* The \c command has invalid syntax */
721 parse_slash_copy(args, table, sizeof(table), file, sizeof(file),
722 &from, &syntax_error);
725 strcpy(query, "COPY ");
726 strcat(query, table);
729 strcat(query, " FROM stdin");
731 strcat(query, " TO stdout");
734 copystream = fopen(file, "r");
736 copystream = fopen(file, "w");
738 if (copystream == NULL)
740 "Unable to open file %s which to copy, errno = %s (%d).",
741 from ? "from" : "to", strerror(errno), errno);
743 bool success; /* The query succeeded at the backend */
745 SendQuery(&success, settings, query, from, !from, copystream);
747 if (!settings->quiet) {
749 fprintf(stdout, "Successfully copied.\n");
751 fprintf(stdout, "Copy failed.\n");
759 do_connect(const char *new_dbname, PsqlSettings * settings)
762 char *dbname = PQdb(settings->db);
764 fprintf(stderr, "\\connect must be followed by a database name\n");
766 PGconn *olddb = settings->db;
768 printf("closing connection to database: %s\n", dbname);
769 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
770 NULL, NULL, new_dbname);
771 printf("connecting to new database: %s\n", new_dbname);
772 if (PQstatus(settings->db) == CONNECTION_BAD) {
773 fprintf(stderr, "%s\n", PQerrorMessage(settings->db));
774 printf("reconnecting to %s\n", dbname);
775 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
777 if (PQstatus(settings->db) == CONNECTION_BAD) {
779 "could not reconnect to %s. exiting\n", dbname);
784 free(settings->prompt);
785 settings->prompt = malloc(strlen(PQdb(settings->db)) + 10);
786 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
793 do_edit(const char *filename_arg, char *query, int *status_p)
800 const int ql = strlen(query);
804 fname = (char *) filename_arg;
807 sprintf(tmp, "/tmp/psql.%ld.%ld", (long) geteuid(), (long) getpid());
811 if ((fd = open(tmp, O_EXCL | O_CREAT | O_WRONLY, 0600)) == -1) {
815 if (query[ql - 1] != '\n')
817 if (write(fd, query, ql) != ql) {
834 if ((fd = open(fname, O_RDONLY)) == -1) {
840 if ((cc = read(fd, query, MAX_QUERY_BUFFER)) == -1) {
861 do_help(const char *topic)
865 char left_center_right; /* Which column we're
867 int i; /* Index into QL_HELP[] */
869 printf("type \\h <cmd> where <cmd> is one of the following:\n");
871 left_center_right = 'L';/* Start with left column */
873 while (QL_HELP[i].cmd != NULL) {
874 switch (left_center_right) {
876 printf(" %-25s", QL_HELP[i].cmd);
877 left_center_right = 'C';
880 printf("%-25s", QL_HELP[i].cmd);
881 left_center_right = 'R';
884 printf("%-25s\n", QL_HELP[i].cmd);
885 left_center_right = 'L';
890 if (left_center_right != 'L')
892 printf("type \\h * for a complete description of all commands\n");
894 int i; /* Index into QL_HELP[] */
895 bool help_found; /* We found the help he asked for */
897 help_found = false; /* Haven't found it yet */
898 for (i = 0; QL_HELP[i].cmd; i++) {
899 if (strcmp(QL_HELP[i].cmd, topic) == 0 ||
900 strcmp(topic, "*") == 0) {
902 printf("Command: %s\n", QL_HELP[i].cmd);
903 printf("Description: %s\n", QL_HELP[i].help);
905 printf("%s\n", QL_HELP[i].syntax);
910 printf("command not found, "
911 "try \\h with no arguments to see available help\n");
918 do_shell(const char *command)
925 shellName = getenv("SHELL");
926 if (shellName == NULL)
927 shellName = DEFAULT_SHELL;
928 sys = malloc(strlen(shellName) + 16);
933 sprintf(sys, "exec %s", shellName);
945 * Handles all the different commands that start with \ db_ptr is a pointer to
946 * the TgDb* structure line is the current input line prompt_ptr is a pointer
947 * to the prompt string, a pointer is used because the prompt can be used
948 * with a connection to a new database returns a status: 0 - send currently
949 * constructed query to backend (i.e. we got a \g) 1 - skip processing of
950 * this line, continue building up query 2 - terminate processing of this
951 * query entirely, 3 - new query supplied by edit
954 HandleSlashCmds(PsqlSettings * settings,
961 * Pointer inside the <cmd> string to the argument of the slash command,
962 * assuming it is a one-character slash command. If it's not a
963 * one-character command, this is meaningless.
967 * Pointer inside the <cmd> string to the argument of the slash command
968 * assuming it's not a one-character command. If it's a one-character
969 * command, this is meaningless.
973 * String: value of the slash command, less the slash and with escape
977 /* Offset within <cmd> of first blank */
979 cmd = malloc(strlen(line)); /* unescaping better not make string grow. */
981 unescape(cmd, line + 1); /* sets cmd string */
984 * Originally, there were just single character commands. Now, we define
985 * some longer, friendly commands, but we have to keep the old single
986 * character commands too. \c used to be what \connect is now.
987 * Complicating matters is the fact that with the single-character
988 * commands, you can start the argument right after the single character,
989 * so "\copy" would mean "connect to database named 'opy'".
993 optarg = cmd + 1 + strspn(cmd + 1, " \t");
997 blank_loc = strcspn(cmd, " \t");
1001 optarg2 = cmd + blank_loc + strspn(cmd + blank_loc, " \t");
1005 case 'a': /* toggles to align fields on output */
1006 toggle(settings, &settings->opt.align, "field alignment");
1008 case 'C': /* define new caption */
1009 if (settings->opt.caption)
1010 free(settings->opt.caption);
1013 if (settings->opt.caption)
1014 free(settings->opt.caption);
1015 settings->opt.caption = NULL;
1017 else if (!(settings->opt.caption = strdup(optarg))) {
1023 if (strncmp(cmd, "copy ", strlen("copy ")) == 0)
1024 do_copy(optarg2, settings);
1025 else if (strncmp(cmd, "connect ", strlen("connect ")) == 0)
1026 do_connect(optarg2, settings);
1028 do_connect(optarg, settings);
1031 case 'd': /* \d describe tables or columns in a table */
1033 tableList(settings, 0);
1036 if (strcmp(optarg, "*") == 0) {
1037 tableList(settings, 0);
1038 tableList(settings, 1);
1040 tableDesc(settings, optarg);
1043 case 'e': /* edit */
1045 do_edit(optarg, query, &status);
1051 static char *lastfile;
1052 struct stat st, st2;
1056 lastfile = malloc(strlen(optarg + 1));
1061 strcpy(lastfile, optarg);
1062 } else if (!lastfile) {
1063 fprintf(stderr, "\\r must be followed by a file name initially\n");
1066 stat(lastfile, &st);
1068 if ((stat(lastfile, &st2) == -1) || ((fd = fopen(lastfile, "r")) == NULL)) {
1072 if (st2.st_mtime == st.st_mtime) {
1073 if (!settings->quiet)
1074 fprintf(stderr, "warning: %s not modified. query not executed\n", lastfile);
1078 MainLoop(settings, fd);
1084 char *fs = DEFAULT_FIELD_SEP;
1087 if (settings->opt.fieldSep)
1088 free(settings->opt.fieldSep);
1089 if (!(settings->opt.fieldSep = strdup(fs))) {
1093 if (!settings->quiet)
1094 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1097 case 'g': /* \g means send query */
1099 settings->gfname = NULL;
1100 else if (!(settings->gfname = strdup(optarg))) {
1106 case 'h': /* help */
1111 case 'i': /* \i is include file */
1116 fprintf(stderr, "\\i must be followed by a file name\n");
1119 if ((fd = fopen(optarg, "r")) == NULL) {
1120 fprintf(stderr, "file named %s could not be opened\n", optarg);
1123 MainLoop(settings, fd);
1127 case 'l': /* \l is list database */
1128 listAllDbs(settings);
1131 if (toggle(settings, &settings->opt.html3, "HTML3.0 tabular output"))
1132 settings->opt.standard = 0;
1135 setFout(settings, optarg);
1139 fputs(query, stdout);
1140 fputc('\n', stdout);
1143 case 'q': /* \q is quit */
1146 case 'r': /* reset(clear) the buffer */
1148 if (!settings->quiet)
1149 fprintf(stderr, "buffer reset(cleared)\n");
1151 case 's': /* \s is save history to a file */
1153 optarg = "/dev/tty";
1154 if (write_history(optarg) != 0)
1155 fprintf(stderr, "cannot write history to %s\n", optarg);
1157 case 'm': /* monitor like type-setting */
1158 if (toggle(settings, &settings->opt.standard, "standard SQL separaters and padding")) {
1159 settings->opt.html3 = settings->opt.expanded = 0;
1160 settings->opt.align = settings->opt.header = 1;
1161 if (settings->opt.fieldSep)
1162 free(settings->opt.fieldSep);
1163 settings->opt.fieldSep = strdup("|");
1164 if (!settings->quiet)
1165 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1167 if (settings->opt.fieldSep)
1168 free(settings->opt.fieldSep);
1169 settings->opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1170 if (!settings->quiet)
1171 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1174 case 't': /* toggle headers */
1175 toggle(settings, &settings->opt.header, "output headings and row count");
1177 case 'T': /* define html <table ...> option */
1178 if (settings->opt.tableOpt)
1179 free(settings->opt.tableOpt);
1181 settings->opt.tableOpt = NULL;
1182 else if (!(settings->opt.tableOpt = strdup(optarg))) {
1188 toggle(settings, &settings->opt.expanded, "expanded table representation");
1194 case '?': /* \? is help */
1195 slashUsage(settings);
1203 * MainLoop: main processing loop for reading lines of input and sending them
1206 * this loop is re-entrant. May be called by \i command which reads input from
1209 * db_ptr must be initialized and set
1213 MainLoop(PsqlSettings * settings, FILE * source)
1215 char *line; /* line of input */
1216 int len; /* length of the line */
1217 char query[MAX_QUERY_BUFFER]; /* multi-line query storage */
1218 int successResult = 1;
1219 int slashCmdStatus = 0;
1221 * slashCmdStatus can be: 0 - send currently constructed query to backend
1222 * (i.e. we got a \g) 1 - skip processing of this line, continue building
1223 * up query 2 - terminate processing of this query entirely 3 - new query
1227 bool querySent = false;
1229 READ_ROUTINE GetNextLine;
1231 /* We've reached the end of our command input. */
1234 bool was_bslash; /* backslash */
1239 interactive = ((source == stdin) && !settings->notty);
1241 if (settings->prompt)
1242 free(settings->prompt);
1244 malloc(strlen(PQdb(settings->db)) + strlen(PROMPT) + 1);
1245 if (settings->quiet)
1246 settings->prompt[0] = '\0';
1248 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
1249 if (settings->useReadline) {
1251 GetNextLine = gets_readline;
1253 GetNextLine = gets_noreadline;
1255 GetNextLine = gets_fromFile;
1260 slashCmdStatus = -1; /* set default */
1262 /* main loop for getting queries and executing them */
1264 if (slashCmdStatus == 3) {
1265 line = strdup(query);
1268 if (interactive && !settings->quiet) {
1270 settings->prompt[strlen(settings->prompt)-3] = '\'';
1271 else if (query[0] != '\0' && !querySent)
1272 settings->prompt[strlen(settings->prompt)-3] = '-';
1274 settings->prompt[strlen(settings->prompt)-3] = '=';
1276 line = GetNextLine(settings->prompt, source);
1277 if (interactive && settings->useReadline && line != NULL)
1278 add_history(line); /* save non-empty lines in history */
1283 if (line == NULL) { /* No more input. Time to quit */
1284 printf("EOF\n"); /* Goes on prompt line */
1287 if (!interactive && !settings->singleStep && !settings->quiet)
1288 fprintf(stderr, "%s\n", line);
1290 /* remove whitespaces on the right, incl. \n's */
1291 line = rightTrim(line);
1293 if (line[0] == '\0') {
1300 if (settings->singleLineMode) {
1301 SendQuery(&success, settings, line, false, false, 0);
1302 successResult &= success;
1309 for (i = 0; i < len; i++) {
1310 if (!in_quote && line[i] == '\\') {
1311 char hold_char = line[i];
1314 if (query_start[0] != '\0') {
1315 if (query[0] != '\0') {
1316 strcat(query, "\n");
1317 strcat(query, query_start);
1319 strcpy(query, query_start);
1321 line[i] = hold_char;
1322 query_start = line + i;
1323 break; /* handle command */
1325 if (querySent && !isspace(line[i])) {
1329 if (!in_quote && was_dash && line[i] == '-') {
1330 /* print comment at top of query */
1331 if (settings->singleStep)
1332 fprintf(stdout, "%s\n", line + i - 1);
1333 line[i - 1] = '\0'; /* remove comment */
1338 if (!in_quote && !paren_level &&
1340 char hold_char = line[i + 1];
1343 if (query_start[0] != '\0') {
1344 if (query[0] != '\0') {
1345 strcat(query, "\n");
1346 strcat(query, query_start);
1348 strcpy(query, query_start);
1350 SendQuery(&success, settings, query, false, false, 0);
1351 successResult &= success;
1352 line[i + 1] = hold_char;
1353 query_start = line + i + 1;
1358 else if (line[i] == '\\')
1360 else if (line[i] == '\'')
1362 else if (!in_quote && line[i] == '(')
1364 else if (!in_quote && paren_level && line[i] == ')')
1366 else if (!in_quote && line[i] == '-')
1371 slashCmdStatus = -1;
1372 /* slash commands have to be on their own line */
1373 if (!in_quote && query_start[0] == '\\') {
1374 slashCmdStatus = HandleSlashCmds(settings,
1377 if (slashCmdStatus == 1) {
1381 if (slashCmdStatus == 2) {
1385 } else if (strlen(query) + strlen(query_start) > MAX_QUERY_BUFFER) {
1386 fprintf(stderr, "query buffer max length of %d exceeded\n",
1388 fprintf(stderr, "query line ignored\n");
1390 if (query_start[0] != '\0') {
1392 if (query[0] != '\0') {
1393 strcat(query, "\n");
1394 strcat(query, query_start);
1396 strcpy(query, query_start);
1400 if (slashCmdStatus == 0) {
1401 SendQuery(&success, settings, query, false, false, 0);
1402 successResult &= success;
1405 free(line); /* free storage malloc'd by GetNextLine */
1408 return successResult;
1412 main(int argc, char **argv)
1414 extern char *optarg;
1417 char *dbname = NULL;
1420 char *qfilename = NULL;
1421 char errbuf[ERROR_MSG_LENGTH];
1423 PsqlSettings settings;
1425 char *singleQuery = NULL;
1427 bool listDatabases = 0;
1428 int successResult = 1;
1429 bool singleSlashCmd = 0;
1432 memset(&settings, 0, sizeof settings);
1433 settings.opt.align = 1;
1434 settings.opt.header = 1;
1435 settings.queryFout = stdout;
1436 settings.opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1437 settings.opt.pager = 1;
1438 if (!isatty(0) || !isatty(1))
1439 settings.quiet = settings.notty = 1;
1442 settings.useReadline = 1;
1445 while ((c = getopt(argc, argv, "Aa:c:d:ef:F:lh:Hnso:p:qStT:x")) != EOF) {
1448 settings.opt.align = 0;
1451 fe_setauthsvc(optarg, errbuf);
1454 singleQuery = optarg;
1455 if (singleQuery[0] == '\\') {
1463 settings.echoQuery = 1;
1469 settings.opt.fieldSep = optarg;
1478 settings.opt.html3 = 1;
1481 settings.useReadline = 0;
1484 setFout(&settings, optarg);
1493 settings.singleStep = 1;
1496 settings.singleLineMode = 1;
1499 settings.opt.header = 0;
1502 settings.opt.tableOpt = optarg;
1505 settings.opt.expanded = 1;
1512 /* if we still have an argument, use it as the database name */
1513 if (argc - optind == 1)
1514 dbname = argv[optind];
1517 dbname = "template1";
1519 settings.db = PQsetdb(host, port, NULL, NULL, dbname);
1520 dbname = PQdb(settings.db);
1522 if (PQstatus(settings.db) == CONNECTION_BAD) {
1523 fprintf(stderr, "Connection to database '%s' failed.\n", dbname);
1524 fprintf(stderr, "%s", PQerrorMessage(settings.db));
1527 if (listDatabases) {
1528 exit(listAllDbs(&settings));
1530 if (!settings.quiet && !singleQuery && !qfilename) {
1531 printf("Welcome to the POSTGRESQL interactive sql monitor:\n");
1532 printf(" Please read the file COPYRIGHT for copyright terms "
1533 "of POSTGRESQL\n\n");
1534 printf(" type \\? for help on slash commands\n");
1535 printf(" type \\q to quit\n");
1536 printf(" type \\g or terminate with semicolon to execute query\n");
1537 printf(" You are currently connected to the database: %s\n\n", dbname);
1539 if (qfilename || singleSlashCmd) {
1541 * read in a file full of queries instead of reading in queries
1546 if (singleSlashCmd) {
1547 /* Not really a query, but "Do what I mean, not what I say." */
1550 line = malloc(strlen(qfilename) + 5);
1551 sprintf(line, "\\i %s", qfilename);
1553 HandleSlashCmds(&settings, line, "");
1556 bool success; /* The query succeeded at the backend */
1557 SendQuery(&success, &settings, singleQuery, false, false, 0);
1558 successResult = success;
1560 successResult = MainLoop(&settings, stdin);
1563 PQfinish(settings.db);
1565 return !successResult;
1568 #define COPYBUFSIZ 8192
1571 handleCopyOut(PGresult * res, bool quiet, FILE * copystream)
1574 char copybuf[COPYBUFSIZ];
1577 copydone = false; /* Can't be done; haven't started. */
1580 ret = PQgetline(res->conn, copybuf, COPYBUFSIZ);
1582 if (copybuf[0] == '\\' &&
1583 copybuf[1] == '.' &&
1584 copybuf[2] == '\0') {
1585 copydone = true; /* don't print this... */
1587 fputs(copybuf, copystream);
1593 fputc('\n', copystream);
1601 PQendcopy(res->conn);
1607 handleCopyIn(PGresult * res, const bool mustprompt, FILE * copystream)
1609 bool copydone = false;
1612 char copybuf[COPYBUFSIZ];
1618 fputs("Enter info followed by a newline\n", stdout);
1619 fputs("End with a backslash and a "
1620 "period on a line by itself.\n", stdout);
1622 while (!copydone) { /* for each input line ... */
1624 fputs(">> ", stdout);
1629 while (!linedone) { /* for each buffer ... */
1631 buflen = COPYBUFSIZ;
1632 for (; buflen > 1 &&
1633 !(linedone = (c = getc(copystream)) == '\n' || c == EOF);
1638 PQputline(res->conn, "\\.");
1643 PQputline(res->conn, copybuf);
1645 if (!strcmp(copybuf, "\\.")) {
1651 PQputline(res->conn, "\n");
1653 PQendcopy(res->conn);
1659 * try to open fname and return a FILE *, if it fails, use stdout, instead
1663 setFout(PsqlSettings * ps, char *fname)
1665 if (ps->queryFout && ps->queryFout != stdout) {
1667 pclose(ps->queryFout);
1669 fclose(ps->queryFout);
1672 ps->queryFout = stdout;
1673 pqsignal(SIGPIPE, SIG_DFL);
1676 if (*fname == '|') {
1677 pqsignal(SIGPIPE, SIG_IGN);
1678 ps->queryFout = popen(fname + 1, "w");
1681 ps->queryFout = fopen(fname, "w");
1682 pqsignal(SIGPIPE, SIG_DFL);
1685 if (!ps->queryFout) {
1687 ps->queryFout = stdout;
1690 return ps->queryFout;