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.50 1997/01/25 03:51:59 scrappy Exp $
12 *-------------------------------------------------------------------------
18 #include <sys/types.h>
19 #include <sys/param.h> /* for MAXPATHLEN */
27 #include "stringutils.h"
33 #ifndef HAVE_LIBREADLINE
36 # ifdef HAVE_READLINE_H
37 # include <readline.h>
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 char *s = readline(prompt);
410 * gets_fromFile prompt source
412 * the routine to read from a file, the prompt argument is ignored the source
413 * argument is a FILE *
416 gets_fromFile(char *prompt, FILE * source)
421 line = malloc(MAX_QUERY_BUFFER + 1);
423 /* read up to MAX_QUERY_BUFFER characters */
424 if (fgets(line, MAX_QUERY_BUFFER, source) == NULL)
427 line[MAX_QUERY_BUFFER - 1] = '\0';
429 if (len == MAX_QUERY_BUFFER) {
430 fprintf(stderr, "line read exceeds maximum length. Truncating at %d\n",
437 * SendQuery: send the query string to the backend return *success_p = 1 if
438 * the query executed successfully returns *success_p = 0 otherwise
441 SendQuery(bool * success_p, PsqlSettings * settings, const char *query,
442 const bool copy_in, const bool copy_out, FILE * copystream)
448 if (settings->singleStep)
449 fprintf(stdout, "\n**************************************"
450 "*****************************************\n");
452 if (settings->echoQuery || settings->singleStep) {
453 fprintf(stderr, "QUERY: %s\n", query);
456 if (settings->singleStep) {
457 fprintf(stdout, "\n**************************************"
458 "*****************************************\n");
460 printf("\npress return to continue ..\n");
461 gets_fromFile("", stdin);
463 results = PQexec(settings->db, query);
464 if (results == NULL) {
465 fprintf(stderr, "%s", PQerrorMessage(settings->db));
468 switch (PQresultStatus(results)) {
469 case PGRES_TUPLES_OK:
470 if (settings->gfname) {
471 PsqlSettings ps = *settings;
473 ps.queryFout = stdout;
474 fp = setFout(&ps, settings->gfname);
475 if (!fp || fp == stdout) {
487 free(settings->gfname);
488 settings->gfname = NULL;
492 PQprint(settings->queryFout,
495 fflush(settings->queryFout);
499 case PGRES_EMPTY_QUERY:
502 case PGRES_COMMAND_OK:
504 if (!settings->quiet)
505 fprintf(stdout, "%s\n", PQcmdStatus(results));
510 handleCopyOut(results, settings->quiet, copystream);
512 if (!settings->quiet)
513 fprintf(stdout, "Copy command returns...\n");
515 handleCopyOut(results, settings->quiet, stdout);
521 handleCopyIn(results, false, copystream);
523 handleCopyIn(results, !settings->quiet, stdin);
525 case PGRES_NONFATAL_ERROR:
526 case PGRES_FATAL_ERROR:
527 case PGRES_BAD_RESPONSE:
529 fprintf(stderr, "%s", PQerrorMessage(settings->db));
533 if (PQstatus(settings->db) == CONNECTION_BAD) {
535 "We have lost the connection to the backend, so "
536 "further processing is impossible. "
538 exit(2); /* we are out'ta here */
540 /* check for asynchronous returns */
541 notify = PQnotifies(settings->db);
544 "ASYNC NOTIFY of '%s' from backend pid '%d' received\n",
545 notify->relname, notify->be_pid);
554 editFile(char *fname)
558 editorName = getenv("EDITOR");
560 editorName = DEFAULT_EDITOR;
561 sys = malloc(strlen(editorName) + strlen(fname) + 32 + 1);
566 sprintf(sys, "exec '%s' '%s'", editorName, fname);
572 toggle(PsqlSettings * settings, bool * sw, char *msg)
575 if (!settings->quiet)
576 fprintf(stderr, "turned %s %s\n", on(*sw), msg);
583 unescape(char *dest, const char *source)
585 /*-----------------------------------------------------------------------------
586 Return as the string <dest> the value of string <source> with escape
587 sequences turned into the bytes they represent.
588 -----------------------------------------------------------------------------*/
590 bool esc; /* Last character we saw was the escape
593 esc = false; /* Haven't seen escape character yet */
594 for (p = (char *) source; *p; p++) {
595 char c; /* Our output character */
618 } else if (*p == '\\') {
620 c = ' '; /* meaningless, but compiler doesn't know
629 *dest = '\0'; /* Terminating null character */
635 parse_slash_copy(const char *args, char *table, const int table_len,
636 char *file, const int file_len,
637 bool * from_p, bool * error_p)
642 * A copy of the \copy command arguments, except that we modify it as we
643 * parse to suit our parsing needs.
645 char *table_tok, *fromto_tok;
647 strncpy(work_args, args, sizeof(work_args));
648 work_args[sizeof(work_args) - 1] = '\0';
650 *error_p = false; /* initial assumption */
652 table_tok = strtok(work_args, " ");
653 if (table_tok == NULL) {
654 fprintf(stderr, "\\copy needs arguments.\n");
657 strncpy(table, table_tok, table_len);
658 file[table_len - 1] = '\0';
660 fromto_tok = strtok(NULL, " ");
661 if (fromto_tok == NULL) {
662 fprintf(stderr, "'FROM' or 'TO' must follow table name.\n");
665 if (strcasecmp(fromto_tok, "from") == 0)
667 else if (strcasecmp(fromto_tok, "to") == 0)
671 "Unrecognized token found where "
672 "'FROM' or 'TO' expected: '%s'.\n",
679 file_tok = strtok(NULL, " ");
680 if (file_tok == NULL) {
681 fprintf(stderr, "A file pathname must follow '%s'.\n",
685 strncpy(file, file_tok, file_len);
686 file[file_len - 1] = '\0';
687 if (strtok(NULL, " ") != NULL) {
689 "You have extra tokens after the filename.\n");
701 do_copy(const char *args, PsqlSettings * settings)
703 /*---------------------------------------------------------------------------
704 Execute a \copy command (frontend copy). We have to open a file, then
705 submit a COPY query to the backend and either feed it data from the
706 file or route its response into the file.
708 We do a text copy with default (tab) column delimiters. Some day, we
709 should do all the things a backend copy can do.
711 ----------------------------------------------------------------------------*/
713 /* The COPY command we send to the back end */
715 /* The direction of the copy is from a file to a table. */
716 char file[MAXPATHLEN + 1];
717 /* The pathname of the file from/to which we copy */
718 char table[NAMEDATALEN + 1];
719 /* The name of the table from/to which we copy */
721 /* The \c command has invalid syntax */
724 parse_slash_copy(args, table, sizeof(table), file, sizeof(file),
725 &from, &syntax_error);
728 strcpy(query, "COPY ");
729 strcat(query, table);
732 strcat(query, " FROM stdin");
734 strcat(query, " TO stdout");
737 copystream = fopen(file, "r");
739 copystream = fopen(file, "w");
741 if (copystream == NULL)
743 "Unable to open file %s which to copy, errno = %s (%d).",
744 from ? "from" : "to", strerror(errno), errno);
746 bool success; /* The query succeeded at the backend */
748 SendQuery(&success, settings, query, from, !from, copystream);
750 if (!settings->quiet) {
752 fprintf(stdout, "Successfully copied.\n");
754 fprintf(stdout, "Copy failed.\n");
762 do_connect(const char *new_dbname, PsqlSettings * settings)
765 char *dbname = PQdb(settings->db);
767 fprintf(stderr, "\\connect must be followed by a database name\n");
769 PGconn *olddb = settings->db;
771 printf("closing connection to database: %s\n", dbname);
772 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
773 NULL, NULL, new_dbname);
774 printf("connecting to new database: %s\n", new_dbname);
775 if (PQstatus(settings->db) == CONNECTION_BAD) {
776 fprintf(stderr, "%s\n", PQerrorMessage(settings->db));
777 printf("reconnecting to %s\n", dbname);
778 settings->db = PQsetdb(PQhost(olddb), PQport(olddb),
780 if (PQstatus(settings->db) == CONNECTION_BAD) {
782 "could not reconnect to %s. exiting\n", dbname);
787 free(settings->prompt);
788 settings->prompt = malloc(strlen(PQdb(settings->db)) + 10);
789 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
796 do_edit(const char *filename_arg, char *query, int *status_p)
803 const int ql = strlen(query);
807 fname = (char *) filename_arg;
810 sprintf(tmp, "/tmp/psql.%ld.%ld", (long) geteuid(), (long) getpid());
814 if ((fd = open(tmp, O_EXCL | O_CREAT | O_WRONLY, 0600)) == -1) {
818 if (query[ql - 1] != '\n')
820 if (write(fd, query, ql) != ql) {
837 if ((fd = open(fname, O_RDONLY)) == -1) {
843 if ((cc = read(fd, query, MAX_QUERY_BUFFER)) == -1) {
864 do_help(const char *topic)
868 char left_center_right; /* Which column we're
870 int i; /* Index into QL_HELP[] */
872 printf("type \\h <cmd> where <cmd> is one of the following:\n");
874 left_center_right = 'L';/* Start with left column */
876 while (QL_HELP[i].cmd != NULL) {
877 switch (left_center_right) {
879 printf(" %-25s", QL_HELP[i].cmd);
880 left_center_right = 'C';
883 printf("%-25s", QL_HELP[i].cmd);
884 left_center_right = 'R';
887 printf("%-25s\n", QL_HELP[i].cmd);
888 left_center_right = 'L';
893 if (left_center_right != 'L')
895 printf("type \\h * for a complete description of all commands\n");
897 int i; /* Index into QL_HELP[] */
898 bool help_found; /* We found the help he asked for */
900 help_found = false; /* Haven't found it yet */
901 for (i = 0; QL_HELP[i].cmd; i++) {
902 if (strcmp(QL_HELP[i].cmd, topic) == 0 ||
903 strcmp(topic, "*") == 0) {
905 printf("Command: %s\n", QL_HELP[i].cmd);
906 printf("Description: %s\n", QL_HELP[i].help);
908 printf("%s\n", QL_HELP[i].syntax);
913 printf("command not found, "
914 "try \\h with no arguments to see available help\n");
921 do_shell(const char *command)
928 shellName = getenv("SHELL");
929 if (shellName == NULL)
930 shellName = DEFAULT_SHELL;
931 sys = malloc(strlen(shellName) + 16);
936 sprintf(sys, "exec %s", shellName);
948 * Handles all the different commands that start with \ db_ptr is a pointer to
949 * the TgDb* structure line is the current input line prompt_ptr is a pointer
950 * to the prompt string, a pointer is used because the prompt can be used
951 * with a connection to a new database returns a status: 0 - send currently
952 * constructed query to backend (i.e. we got a \g) 1 - skip processing of
953 * this line, continue building up query 2 - terminate processing of this
954 * query entirely, 3 - new query supplied by edit
957 HandleSlashCmds(PsqlSettings * settings,
964 * Pointer inside the <cmd> string to the argument of the slash command,
965 * assuming it is a one-character slash command. If it's not a
966 * one-character command, this is meaningless.
970 * Pointer inside the <cmd> string to the argument of the slash command
971 * assuming it's not a one-character command. If it's a one-character
972 * command, this is meaningless.
976 * String: value of the slash command, less the slash and with escape
980 /* Offset within <cmd> of first blank */
982 cmd = malloc(strlen(line)); /* unescaping better not make string grow. */
984 unescape(cmd, line + 1); /* sets cmd string */
987 * Originally, there were just single character commands. Now, we define
988 * some longer, friendly commands, but we have to keep the old single
989 * character commands too. \c used to be what \connect is now.
990 * Complicating matters is the fact that with the single-character
991 * commands, you can start the argument right after the single character,
992 * so "\copy" would mean "connect to database named 'opy'".
996 optarg = cmd + 1 + strspn(cmd + 1, " \t");
1000 blank_loc = strcspn(cmd, " \t");
1004 optarg2 = cmd + blank_loc + strspn(cmd + blank_loc, " \t");
1008 case 'a': /* toggles to align fields on output */
1009 toggle(settings, &settings->opt.align, "field alignment");
1011 case 'C': /* define new caption */
1012 if (settings->opt.caption)
1013 free(settings->opt.caption);
1016 if (settings->opt.caption)
1017 free(settings->opt.caption);
1018 settings->opt.caption = NULL;
1020 else if (!(settings->opt.caption = strdup(optarg))) {
1026 if (strncmp(cmd, "copy ", strlen("copy ")) == 0)
1027 do_copy(optarg2, settings);
1028 else if (strncmp(cmd, "connect ", strlen("connect ")) == 0)
1029 do_connect(optarg2, settings);
1031 do_connect(optarg, settings);
1034 case 'd': /* \d describe tables or columns in a table */
1036 tableList(settings, 0);
1039 if (strcmp(optarg, "*") == 0) {
1040 tableList(settings, 0);
1041 tableList(settings, 1);
1043 tableDesc(settings, optarg);
1046 case 'e': /* edit */
1048 do_edit(optarg, query, &status);
1054 static char *lastfile;
1055 struct stat st, st2;
1059 lastfile = malloc(strlen(optarg + 1));
1064 strcpy(lastfile, optarg);
1065 } else if (!lastfile) {
1066 fprintf(stderr, "\\r must be followed by a file name initially\n");
1069 stat(lastfile, &st);
1071 if ((stat(lastfile, &st2) == -1) || ((fd = fopen(lastfile, "r")) == NULL)) {
1075 if (st2.st_mtime == st.st_mtime) {
1076 if (!settings->quiet)
1077 fprintf(stderr, "warning: %s not modified. query not executed\n", lastfile);
1081 MainLoop(settings, fd);
1087 char *fs = DEFAULT_FIELD_SEP;
1090 if (settings->opt.fieldSep)
1091 free(settings->opt.fieldSep);
1092 if (!(settings->opt.fieldSep = strdup(fs))) {
1096 if (!settings->quiet)
1097 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1100 case 'g': /* \g means send query */
1102 settings->gfname = NULL;
1103 else if (!(settings->gfname = strdup(optarg))) {
1109 case 'h': /* help */
1114 case 'i': /* \i is include file */
1119 fprintf(stderr, "\\i must be followed by a file name\n");
1122 if ((fd = fopen(optarg, "r")) == NULL) {
1123 fprintf(stderr, "file named %s could not be opened\n", optarg);
1126 MainLoop(settings, fd);
1130 case 'l': /* \l is list database */
1131 listAllDbs(settings);
1134 if (toggle(settings, &settings->opt.html3, "HTML3.0 tabular output"))
1135 settings->opt.standard = 0;
1138 setFout(settings, optarg);
1142 fputs(query, stdout);
1143 fputc('\n', stdout);
1146 case 'q': /* \q is quit */
1149 case 'r': /* reset(clear) the buffer */
1151 if (!settings->quiet)
1152 fprintf(stderr, "buffer reset(cleared)\n");
1154 case 's': /* \s is save history to a file */
1156 optarg = "/dev/tty";
1157 if (write_history(optarg) != 0)
1158 fprintf(stderr, "cannot write history to %s\n", optarg);
1160 case 'm': /* monitor like type-setting */
1161 if (toggle(settings, &settings->opt.standard, "standard SQL separaters and padding")) {
1162 settings->opt.html3 = settings->opt.expanded = 0;
1163 settings->opt.align = settings->opt.header = 1;
1164 if (settings->opt.fieldSep)
1165 free(settings->opt.fieldSep);
1166 settings->opt.fieldSep = strdup("|");
1167 if (!settings->quiet)
1168 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1170 if (settings->opt.fieldSep)
1171 free(settings->opt.fieldSep);
1172 settings->opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1173 if (!settings->quiet)
1174 fprintf(stderr, "field separater changed to '%s'\n", settings->opt.fieldSep);
1177 case 't': /* toggle headers */
1178 toggle(settings, &settings->opt.header, "output headings and row count");
1180 case 'T': /* define html <table ...> option */
1181 if (settings->opt.tableOpt)
1182 free(settings->opt.tableOpt);
1184 settings->opt.tableOpt = NULL;
1185 else if (!(settings->opt.tableOpt = strdup(optarg))) {
1191 toggle(settings, &settings->opt.expanded, "expanded table representation");
1197 case '?': /* \? is help */
1198 slashUsage(settings);
1206 * MainLoop: main processing loop for reading lines of input and sending them
1209 * this loop is re-entrant. May be called by \i command which reads input from
1212 * db_ptr must be initialized and set
1216 MainLoop(PsqlSettings * settings, FILE * source)
1218 char *line; /* line of input */
1219 int len; /* length of the line */
1220 char query[MAX_QUERY_BUFFER]; /* multi-line query storage */
1221 int successResult = 1;
1222 int slashCmdStatus = 0;
1224 * slashCmdStatus can be: 0 - send currently constructed query to backend
1225 * (i.e. we got a \g) 1 - skip processing of this line, continue building
1226 * up query 2 - terminate processing of this query entirely 3 - new query
1230 bool querySent = false;
1232 READ_ROUTINE GetNextLine;
1234 /* We've reached the end of our command input. */
1237 bool was_bslash; /* backslash */
1242 interactive = ((source == stdin) && !settings->notty);
1244 if (settings->prompt)
1245 free(settings->prompt);
1247 malloc(strlen(PQdb(settings->db)) + strlen(PROMPT) + 1);
1248 if (settings->quiet)
1249 settings->prompt[0] = '\0';
1251 sprintf(settings->prompt, "%s%s", PQdb(settings->db), PROMPT);
1252 if (settings->useReadline) {
1254 GetNextLine = gets_readline;
1256 GetNextLine = gets_noreadline;
1258 GetNextLine = gets_fromFile;
1263 slashCmdStatus = -1; /* set default */
1265 /* main loop for getting queries and executing them */
1267 if (slashCmdStatus == 3) {
1269 line = strdup(query);
1272 if (interactive && !settings->quiet) {
1274 settings->prompt[strlen(settings->prompt)-3] = '\'';
1275 else if (query[0] != '\0' && !querySent)
1276 settings->prompt[strlen(settings->prompt)-3] = '-';
1278 settings->prompt[strlen(settings->prompt)-3] = '=';
1280 line = GetNextLine(settings->prompt, source);
1281 if (interactive && settings->useReadline && line != NULL)
1282 add_history(line); /* save non-empty lines in history */
1287 if (line == NULL) { /* No more input. Time to quit */
1288 if (!settings->quiet)
1289 printf("EOF\n"); /* Goes on prompt line */
1292 /* remove whitespaces on the right, incl. \n's */
1293 line = rightTrim(line);
1295 if (!interactive && !settings->singleStep && !settings->quiet)
1296 fprintf(stderr, "%s\n", line);
1298 if (line[0] == '\0') {
1305 if (settings->singleLineMode) {
1306 SendQuery(&success, settings, line, false, false, 0);
1307 successResult &= success;
1314 for (i = 0; i < len; i++) {
1315 if (!in_quote && line[i] == '\\') {
1316 char hold_char = line[i];
1319 if (query_start[0] != '\0') {
1320 if (query[0] != '\0') {
1321 strcat(query, "\n");
1322 strcat(query, query_start);
1324 strcpy(query, query_start);
1326 line[i] = hold_char;
1327 query_start = line + i;
1328 break; /* handle command */
1330 if (querySent && !isspace(line[i])) {
1334 if (!in_quote && was_dash && line[i] == '-') {
1335 /* print comment at top of query */
1336 if (settings->singleStep)
1337 fprintf(stdout, "%s\n", line + i - 1);
1338 line[i - 1] = '\0'; /* remove comment */
1343 if (!in_quote && !paren_level &&
1345 char hold_char = line[i + 1];
1348 if (query_start[0] != '\0') {
1349 if (query[0] != '\0') {
1350 strcat(query, "\n");
1351 strcat(query, query_start);
1353 strcpy(query, query_start);
1355 SendQuery(&success, settings, query, false, false, 0);
1356 successResult &= success;
1357 line[i + 1] = hold_char;
1358 query_start = line + i + 1;
1363 else if (line[i] == '\\')
1365 else if (line[i] == '\'')
1367 else if (!in_quote && line[i] == '(')
1369 else if (!in_quote && paren_level && line[i] == ')')
1371 else if (!in_quote && line[i] == '-')
1376 slashCmdStatus = -1;
1377 /* slash commands have to be on their own line */
1378 if (!in_quote && query_start[0] == '\\') {
1379 slashCmdStatus = HandleSlashCmds(settings,
1382 if (slashCmdStatus == 1) {
1383 if (query[0] == '\0')
1388 if (slashCmdStatus == 2) {
1392 } else if (strlen(query) + strlen(query_start) > MAX_QUERY_BUFFER) {
1393 fprintf(stderr, "query buffer max length of %d exceeded\n",
1395 fprintf(stderr, "query line ignored\n");
1397 if (query_start[0] != '\0') {
1399 if (query[0] != '\0') {
1400 strcat(query, "\n");
1401 strcat(query, query_start);
1403 strcpy(query, query_start);
1407 if (slashCmdStatus == 0) {
1408 SendQuery(&success, settings, query, false, false, 0);
1409 successResult &= success;
1412 free(line); /* free storage malloc'd by GetNextLine */
1415 return successResult;
1419 main(int argc, char **argv)
1421 extern char *optarg;
1424 char *dbname = NULL;
1427 char *qfilename = NULL;
1428 char errbuf[ERROR_MSG_LENGTH];
1430 PsqlSettings settings;
1432 char *singleQuery = NULL;
1434 bool listDatabases = 0;
1435 int successResult = 1;
1436 bool singleSlashCmd = 0;
1439 memset(&settings, 0, sizeof settings);
1440 settings.opt.align = 1;
1441 settings.opt.header = 1;
1442 settings.queryFout = stdout;
1443 settings.opt.fieldSep = strdup(DEFAULT_FIELD_SEP);
1444 settings.opt.pager = 1;
1445 if (!isatty(0) || !isatty(1))
1446 settings.quiet = settings.notty = 1;
1449 settings.useReadline = 1;
1452 while ((c = getopt(argc, argv, "Aa:c:d:ef:F:lh:Hnso:p:qStT:x")) != EOF) {
1455 settings.opt.align = 0;
1458 fe_setauthsvc(optarg, errbuf);
1461 singleQuery = optarg;
1462 if (singleQuery[0] == '\\') {
1470 settings.echoQuery = 1;
1476 settings.opt.fieldSep = optarg;
1485 settings.opt.html3 = 1;
1488 settings.useReadline = 0;
1491 setFout(&settings, optarg);
1500 settings.singleStep = 1;
1503 settings.singleLineMode = 1;
1506 settings.opt.header = 0;
1509 settings.opt.tableOpt = optarg;
1512 settings.opt.expanded = 1;
1519 /* if we still have an argument, use it as the database name */
1520 if (argc - optind == 1)
1521 dbname = argv[optind];
1524 dbname = "template1";
1526 settings.db = PQsetdb(host, port, NULL, NULL, dbname);
1527 dbname = PQdb(settings.db);
1529 if (PQstatus(settings.db) == CONNECTION_BAD) {
1530 fprintf(stderr, "Connection to database '%s' failed.\n", dbname);
1531 fprintf(stderr, "%s", PQerrorMessage(settings.db));
1534 if (listDatabases) {
1535 exit(listAllDbs(&settings));
1537 if (!settings.quiet && !singleQuery && !qfilename) {
1538 printf("Welcome to the POSTGRESQL interactive sql monitor:\n");
1539 printf(" Please read the file COPYRIGHT for copyright terms "
1540 "of POSTGRESQL\n\n");
1541 printf(" type \\? for help on slash commands\n");
1542 printf(" type \\q to quit\n");
1543 printf(" type \\g or terminate with semicolon to execute query\n");
1544 printf(" You are currently connected to the database: %s\n\n", dbname);
1546 if (qfilename || singleSlashCmd) {
1548 * read in a file full of queries instead of reading in queries
1553 if (singleSlashCmd) {
1554 /* Not really a query, but "Do what I mean, not what I say." */
1557 line = malloc(strlen(qfilename) + 5);
1558 sprintf(line, "\\i %s", qfilename);
1560 HandleSlashCmds(&settings, line, "");
1563 bool success; /* The query succeeded at the backend */
1564 SendQuery(&success, &settings, singleQuery, false, false, 0);
1565 successResult = success;
1567 successResult = MainLoop(&settings, stdin);
1570 PQfinish(settings.db);
1572 return !successResult;
1575 #define COPYBUFSIZ 8192
1578 handleCopyOut(PGresult * res, bool quiet, FILE * copystream)
1581 char copybuf[COPYBUFSIZ];
1584 copydone = false; /* Can't be done; haven't started. */
1587 ret = PQgetline(res->conn, copybuf, COPYBUFSIZ);
1589 if (copybuf[0] == '\\' &&
1590 copybuf[1] == '.' &&
1591 copybuf[2] == '\0') {
1592 copydone = true; /* don't print this... */
1594 fputs(copybuf, copystream);
1600 fputc('\n', copystream);
1608 PQendcopy(res->conn);
1614 handleCopyIn(PGresult * res, const bool mustprompt, FILE * copystream)
1616 bool copydone = false;
1619 char copybuf[COPYBUFSIZ];
1625 fputs("Enter info followed by a newline\n", stdout);
1626 fputs("End with a backslash and a "
1627 "period on a line by itself.\n", stdout);
1629 while (!copydone) { /* for each input line ... */
1631 fputs(">> ", stdout);
1636 while (!linedone) { /* for each buffer ... */
1638 buflen = COPYBUFSIZ;
1639 for (; buflen > 1 &&
1640 !(linedone = (c = getc(copystream)) == '\n' || c == EOF);
1645 PQputline(res->conn, "\\.");
1650 PQputline(res->conn, copybuf);
1652 if (!strcmp(copybuf, "\\.")) {
1658 PQputline(res->conn, "\n");
1660 PQendcopy(res->conn);
1666 * try to open fname and return a FILE *, if it fails, use stdout, instead
1670 setFout(PsqlSettings * ps, char *fname)
1672 if (ps->queryFout && ps->queryFout != stdout) {
1674 pclose(ps->queryFout);
1676 fclose(ps->queryFout);
1679 ps->queryFout = stdout;
1680 pqsignal(SIGPIPE, SIG_DFL);
1683 if (*fname == '|') {
1684 pqsignal(SIGPIPE, SIG_IGN);
1685 ps->queryFout = popen(fname + 1, "w");
1688 ps->queryFout = fopen(fname, "w");
1689 pqsignal(SIGPIPE, SIG_DFL);
1692 if (!ps->queryFout) {
1694 ps->queryFout = stdout;
1697 return ps->queryFout;