/* * psql - the PostgreSQL interactive terminal * * Copyright ( c ) 2000 - 2025 , PostgreSQL Global Development Group * * src / bin / psql / command . c
#include "postgres_fe.h"
#include <ctype.h>
#include <time.h>
#include <pwd.h>
#include <utime.h>
#ifndef WIN32
#include <sys/stat.h>
/* for stat() */
#include <sys/time.h>
/* for setitimer() */
#include <fcntl.h>
/* open() flags */
#include <unistd.h>
/* for geteuid(), getpid(), stat() */
#else
#include <win32.h>
#include <io.h>
#include <fcntl.h>
#include <direct.h>
#include <sys/stat.h>
/* for stat() */
#endif
#include "catalog/pg_class_d.h"
#include "command.h"
#include "common.h"
#include "common/logging.h"
#include "common/string.h"
#include "copy.h"
#include "describe.h"
#include "fe_utils/cancel.h"
#include "fe_utils/print.h"
#include "fe_utils/string_utils.h"
#include "help.h"
#include "input.h"
#include "large_obj.h"
#include "libpq/pqcomm.h"
#include "mainloop.h"
#include "pqexpbuffer.h"
#include "psqlscanslash.h"
#include "settings.h"
#include "variables.h"
/* * Editable database object types .
typedef enum EditableObjectType
{
EditableFunction,
EditableView,
} EditableObjectType;
/* local function declarations */
static backslashResult exec_command(
const char *cmd,
PsqlScanState scan_state,
ConditionalStack cstack,
PQExpBuffer query_buf,
PQExpBuffer previous_buf);
static backslashResult exec_command_a(PsqlScanState scan_state,
bool active_branch);
static backslashResult exec_command_bind(PsqlScanState scan_state,
bool active_branch
);static backslashResult exec_command_bind_named(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_C(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_connect(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_cd(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_close_prepared(PsqlScanState scan_state,bool active_branch, const char *cmd);static backslashResult exec_command_conninfo(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_copy(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_copyright(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_crosstabview(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_d(PsqlScanState scan_state, bool active_branch,const char *cmd);static bool exec_command_dfo(PsqlScanState scan_state, const char *cmd,const char *pattern,bool show_verbose, bool show_system);static backslashResult exec_command_edit(PsqlScanState scan_state, bool active_branch,static backslashResult exec_command_ef_ev(PsqlScanState scan_state, bool active_branch,bool is_func);static backslashResult exec_command_echo(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_elif(PsqlScanState scan_state, ConditionalStack cstack,static backslashResult exec_command_else(PsqlScanState scan_state, ConditionalStack cstack,static backslashResult exec_command_endif(PsqlScanState scan_state, ConditionalStack cstack,static backslashResult exec_command_endpipeline(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_encoding(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_errverbose(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_f(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_flush(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_flushrequest(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_g(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult process_command_g_options(char *first_option,bool active_branch,const char *cmd);static backslashResult exec_command_gdesc(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_getenv(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_gexec(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_getresults(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_gset(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_help(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_html(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_include(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_if(PsqlScanState scan_state, ConditionalStack cstack,static backslashResult exec_command_list(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_lo(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_out(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_print(PsqlScanState scan_state, bool active_branch,static backslashResult exec_command_parse(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_password(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_prompt(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_pset(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_quit(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_reset(PsqlScanState scan_state, bool active_branch,static backslashResult exec_command_restrict(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_s(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_sendpipeline(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_set(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_setenv(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_sf_sv(PsqlScanState scan_state, bool active_branch,const char *cmd, bool is_func);static backslashResult exec_command_startpipeline(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_syncpipeline(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_t(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_T(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_timing(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_unrestrict(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_unset(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_write(PsqlScanState scan_state, bool active_branch,const char *cmd,static backslashResult exec_command_watch(PsqlScanState scan_state, bool active_branch,static backslashResult exec_command_x(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_z(PsqlScanState scan_state, bool active_branch,const char *cmd);static backslashResult exec_command_shell_escape(PsqlScanState scan_state, bool active_branch);static backslashResult exec_command_slash_command_help(PsqlScanState scan_state, bool active_branch);static char *read_connect_arg(PsqlScanState scan_state);static PQExpBuffer gather_boolean_expression(PsqlScanState scan_state);static bool is_true_boolean_expression(PsqlScanState scan_state, const char *name);static void ignore_boolean_expression(PsqlScanState scan_state);static void ignore_slash_options(PsqlScanState scan_state);static void ignore_slash_filepipe(PsqlScanState scan_state);static void ignore_slash_whole_line(PsqlScanState scan_state);static bool is_branching_command(const char *cmd);static void save_query_text_state(PsqlScanState scan_state, ConditionalStack cstack,static void discard_query_text(PsqlScanState scan_state, ConditionalStack cstack,static bool copy_previous_query(PQExpBuffer query_buf, PQExpBuffer previous_buf);static bool do_connect(enum trivalue reuse_previous_specification,char *dbname, char *user, char *host, char *port);static void wait_until_connected(PGconn *conn);static bool do_edit(const char *filename_arg, PQExpBuffer query_buf,int lineno, bool discard_on_quit, bool *edited);static bool do_shell(const char *command);static bool do_watch(PQExpBuffer query_buf, double sleep, int iter, int min_rows);static bool lookup_object_oid(EditableObjectType obj_type, const char *desc,static bool get_create_object_cmd(EditableObjectType obj_type, Oid oid,static int strip_lineno_from_objdesc(char *obj);static int count_lines_in_buf(PQExpBuffer buf);static void print_with_linenumbers(FILE *output, char *lines, bool is_func);static void minimal_error_message(PGresult *res);static void printSSLInfo(void );static void printGSSInfo(void );static bool printPsetInfo(const char *param, printQueryOpt *popt);static char *pset_value_string(const char *param, printQueryOpt *popt);#ifdef WIN32static void checkWin32Codepage(void );#endif static bool restricted;static char *restrict_key;/*---------- * HandleSlashCmds : * * Handles all the different commands that start with ' \ ' . * Ordinarily called by MainLoop ( ) . * * scan_state is a lexer working state that is set to continue scanning * just after the ' \ ' . The lexer is advanced past the command and all * arguments on return . * * cstack is the current \ if stack state . This will be examined , and * possibly modified by conditional commands . * * query_buf contains the query - so - far , which may be modified by * execution of the backslash command ( for example , \ r clears it ) . * * previous_buf contains the query most recently sent to the server * ( empty if none yet ) . This should not be modified here , but some * commands copy its content into query_buf . * * query_buf and previous_buf will be NULL when executing a " - c " * command - line option . * * Returns a status code indicating what action is desired , see command . h . * - - - - - - - - - - char *cmd;char *arg;/* Parse off the command name */ /* * And try to execute it . * * If we are in " restricted " mode , the only allowable backslash command is * \ unrestrict ( to exit restricted mode ) . if (restricted && strcmp(cmd, "unrestrict" ) != 0 )"backslash commands are restricted; only \\unrestrict is allowed" );else if (status == PSQL_CMD_UNKNOWN)"invalid command \\%s" , cmd);if (pset.cur_cmd_interactive)"Try \\? for help." );if (status != PSQL_CMD_ERROR)/* * Eat any remaining arguments after a valid command . We want to * suppress evaluation of backticks in this situation , so transiently * push an inactive conditional - stack entry . bool active_branch = conditional_active(cstack);while ((arg = psql_scan_slash_option(scan_state,false )))if (active_branch)"\\%s: extra argument \" %s\" ignored" , cmd, arg);else /* silently throw away rest of line after an erroneous command */ while ((arg = psql_scan_slash_option(scan_state,false )))/* if there is a trailing \\, swallow it */ /* some commands write to queryFout, so make sure output is sent */ return status;/* * Subroutine to actually try to execute a backslash command . * * The typical " success " result code is PSQL_CMD_SKIP_LINE , although some * commands return something else . Failure result code is PSQL_CMD_ERROR , * unless PSQL_CMD_UNKNOWN is more appropriate . static backslashResultconst char *cmd,bool active_branch = conditional_active(cstack);/* * In interactive mode , warn when we ' re ignoring a command within a false * \ if - branch . But we continue on , so as to parse and discard the right * amount of parameter text . Each individual backslash command subroutine * is responsible for doing nothing after discarding appropriate * arguments , if ! active_branch . if (pset.cur_cmd_interactive && !active_branch &&"\\%s command ignored; use \\endif or Ctrl-C to exit current \\if block" ,if (strcmp(cmd, "a" ) == 0 )else if (strcmp(cmd, "bind" ) == 0 )else if (strcmp(cmd, "bind_named" ) == 0 )else if (strcmp(cmd, "C" ) == 0 )else if (strcmp(cmd, "c" ) == 0 || strcmp(cmd, "connect" ) == 0 )else if (strcmp(cmd, "cd" ) == 0 )else if (strcmp(cmd, "close_prepared" ) == 0 )else if (strcmp(cmd, "conninfo" ) == 0 )else if (pg_strcasecmp(cmd, "copy" ) == 0 )else if (strcmp(cmd, "copyright" ) == 0 )else if (strcmp(cmd, "crosstabview" ) == 0 )else if (cmd[0 ] == 'd' )else if (strcmp(cmd, "e" ) == 0 || strcmp(cmd, "edit" ) == 0 )else if (strcmp(cmd, "ef" ) == 0 )true );else if (strcmp(cmd, "ev" ) == 0 )false );else if (strcmp(cmd, "echo" ) == 0 || strcmp(cmd, "qecho" ) == 0 ||"warn" ) == 0 )else if (strcmp(cmd, "elif" ) == 0 )else if (strcmp(cmd, "else" ) == 0 )else if (strcmp(cmd, "endif" ) == 0 )else if (strcmp(cmd, "endpipeline" ) == 0 )else if (strcmp(cmd, "encoding" ) == 0 )else if (strcmp(cmd, "errverbose" ) == 0 )else if (strcmp(cmd, "f" ) == 0 )else if (strcmp(cmd, "flush" ) == 0 )else if (strcmp(cmd, "flushrequest" ) == 0 )else if (strcmp(cmd, "g" ) == 0 || strcmp(cmd, "gx" ) == 0 )else if (strcmp(cmd, "gdesc" ) == 0 )else if (strcmp(cmd, "getenv" ) == 0 )else if (strcmp(cmd, "getresults" ) == 0 )else if (strcmp(cmd, "gexec" ) == 0 )else if (strcmp(cmd, "gset" ) == 0 )else if (strcmp(cmd, "h" ) == 0 || strcmp(cmd, "help" ) == 0 )else if (strcmp(cmd, "H" ) == 0 || strcmp(cmd, "html" ) == 0 )else if (strcmp(cmd, "i" ) == 0 || strcmp(cmd, "include" ) == 0 ||"ir" ) == 0 || strcmp(cmd, "include_relative" ) == 0 )else if (strcmp(cmd, "if" ) == 0 )else if (strcmp(cmd, "l" ) == 0 || strcmp(cmd, "list" ) == 0 ||"lx" ) == 0 || strcmp(cmd, "listx" ) == 0 ||"l+" ) == 0 || strcmp(cmd, "list+" ) == 0 ||"lx+" ) == 0 || strcmp(cmd, "listx+" ) == 0 ||"l+x" ) == 0 || strcmp(cmd, "list+x" ) == 0 )else if (strncmp(cmd, "lo_" , 3 ) == 0 )else if (strcmp(cmd, "o" ) == 0 || strcmp(cmd, "out" ) == 0 )else if (strcmp(cmd, "p" ) == 0 || strcmp(cmd, "print" ) == 0 )else if (strcmp(cmd, "parse" ) == 0 )else if (strcmp(cmd, "password" ) == 0 )else if (strcmp(cmd, "prompt" ) == 0 )else if (strcmp(cmd, "pset" ) == 0 )else if (strcmp(cmd, "q" ) == 0 || strcmp(cmd, "quit" ) == 0 )else if (strcmp(cmd, "r" ) == 0 || strcmp(cmd, "reset" ) == 0 )else if (strcmp(cmd, "restrict" ) == 0 )else if (strcmp(cmd, "s" ) == 0 )else if (strcmp(cmd, "sendpipeline" ) == 0 )else if (strcmp(cmd, "set" ) == 0 )else if (strcmp(cmd, "setenv" ) == 0 )else if (strcmp(cmd, "sf" ) == 0 || strcmp(cmd, "sf+" ) == 0 )true );else if (strcmp(cmd, "sv" ) == 0 || strcmp(cmd, "sv+" ) == 0 )false );else if (strcmp(cmd, "startpipeline" ) == 0 )else if (strcmp(cmd, "syncpipeline" ) == 0 )else if (strcmp(cmd, "t" ) == 0 )else if (strcmp(cmd, "T" ) == 0 )else if (strcmp(cmd, "timing" ) == 0 )else if (strcmp(cmd, "unrestrict" ) == 0 )else if (strcmp(cmd, "unset" ) == 0 )else if (strcmp(cmd, "w" ) == 0 || strcmp(cmd, "write" ) == 0 )else if (strcmp(cmd, "watch" ) == 0 )else if (strcmp(cmd, "x" ) == 0 )else if (strcmp(cmd, "z" ) == 0 ||"zS" ) == 0 || strcmp(cmd, "zx" ) == 0 ||"zSx" ) == 0 || strcmp(cmd, "zxS" ) == 0 )else if (strcmp(cmd, "!" ) == 0 )else if (strcmp(cmd, "?" ) == 0 )else /* * All the commands that return PSQL_CMD_SEND want to execute previous_buf * if query_buf is empty . For convenience we implement that here , not in * the individual command subroutines . if (status == PSQL_CMD_SEND)void ) copy_previous_query(query_buf, previous_buf);return status;/* * \ a - - toggle field alignment * * This makes little sense but we keep it around . static backslashResultbool active_branch)bool success = true ;if (active_branch)if (pset.popt.topt.format != PRINT_ALIGNED)"format" , "aligned" , &pset.popt, pset.quiet);else "format" , "unaligned" , &pset.popt, pset.quiet);return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ bind - - set query parameters static backslashResultbool active_branch)if (active_branch)char *opt;int nparams = 0 ;int nalloc = 0 ;while ((opt = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false )))if (nparams > nalloc)2 : 1 ;char *, nalloc);1 ] = opt;else return status;/* * \ bind_named - - set query parameters for an existing prepared statement static backslashResultbool active_branch,const char *cmd)if (active_branch)char *opt;int nparams = 0 ;int nalloc = 0 ;/* get the mandatory prepared statement name */ false );if (!opt)"\\%s: missing required argument" , cmd);else /* set of parameters */ while ((opt = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false )))if (nparams > nalloc)2 : 1 ;char *, nalloc);1 ] = opt;else return status;/* * \ C - - override table title ( formerly change HTML caption ) static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,true );"title" , opt, &pset.popt, pset.quiet);else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ c or \ connect - - connect to database using the specified parameters . * * \ c [ - reuse - previous = BOOL ] dbname user host port * * Specifying a parameter as ' - ' is equivalent to omitting it . Examples : * * \ c - - hst Connect to current database on current port of * host " hst " as current user . * \ c - usr - prt Connect to current database on port " prt " of current host * as user " usr " . * \ c dbs Connect to database " dbs " on current port of current host * as current user . static backslashResultbool active_branch)bool success = true ;if (active_branch)static const char prefix[] = "-reuse-previous=" ;char *opt1,enum trivalue reuse_previous = TRI_DEFAULT;if (opt1 != NULL && strncmp(opt1, prefix, sizeof (prefix) - 1 ) == 0 )bool on_off;sizeof (prefix) - 1 ,"-reuse-previous" ,if (success)if (success) /* give up if reuse_previous was invalid */ else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ cd - - change directory static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,true );char *dir;if (opt)else #ifndef WIN32/* This should match get_home_path() */ "HOME" );if (dir == NULL || dir[0 ] == '\0' )struct passwd *pw;0 ; /* clear errno before call */ if (pw)else "could not get home directory for user ID %ld: %s" ,long ) user_id,"user does not exist" ));false ;#else /* WIN32 */ /* * On Windows , ' cd ' without arguments prints the current * directory , so if someone wants to code this here instead . . . "/" ;#endif /* WIN32 */ if (success &&0 )"\\%s: could not change directory to \" %s\": %m" ,false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ close_prepared - - close a previously prepared statement static backslashResultbool active_branch, const char *cmd)if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );if (!opt)"\\%s: missing required argument" , cmd);else else return status;/* * \ conninfo - - display information about the current connection static backslashResultbool active_branch)int rows,char *db;char *host;bool print_hostaddr;char *hostaddr;char *protocol_version,int ssl_in_use,int version_num;char *paramval;if (!active_branch)return PSQL_CMD_SKIP_LINE;if (db == NULL)"You are currently not connected to a database.\n" ));return PSQL_CMD_SKIP_LINE;/* Get values for the parameters */ "%d.%d" , version_num / 10000 ,10000 );"%d" , PQbackendPID(pset.db));/* Only print hostaddr if it differs from host, and not if unixsock */ 0 );/* Determine the exact number of rows to print */ 12 ;2 ;if (ssl_in_use)6 ;if (print_hostaddr)/* Set it all up */ "Connection Information" ), cols, rows);"Parameter" ), true , 'l' );"Value" ), true , 'l' );/* Database */ "Database" ), false , false );false , false );/* Client User */ "Client User" ), false , false );false , false );/* Host/hostaddr/socket */ if (is_unixsock_path(host))/* hostaddr if specified overrides socket, so suppress the latter */ if (hostaddr && *hostaddr)"Host Address" ), false , false );false , false );else "Socket Directory" ), false , false );false , false );else "Host" ), false , false );false , false );if (print_hostaddr)"Host Address" ), false , false );false , false );/* Server Port */ "Server Port" ), false , false );false , false );/* Options */ "Options" ), false , false );false , false );/* Protocol Version */ "Protocol Version" ), false , false );false , false );/* Password Used */ "Password Used" ), false , false );"true" ) : _("false" ), false , false );/* GSSAPI Authenticated */ "GSSAPI Authenticated" ), false , false );"true" ) : _("false" ), false , false );/* Backend PID */ "Backend PID" ), false , false );false , false );/* SSL Connection */ "SSL Connection" ), false , false );"true" ) : _("false" ), false , false );/* SSL Information */ if (ssl_in_use)char *library,char *) PQsslAttribute(pset.db, "library" );char *) PQsslAttribute(pset.db, "protocol" );char *) PQsslAttribute(pset.db, "key_bits" );char *) PQsslAttribute(pset.db, "cipher" );char *) PQsslAttribute(pset.db, "compression" );char *) PQsslAttribute(pset.db, "alpn" );"SSL Library" ), false , false );"unknown" ), false , false );"SSL Protocol" ), false , false );"unknown" ), false , false );"SSL Key Bits" ), false , false );"unknown" ), false , false );"SSL Cipher" ), false , false );"unknown" ), false , false );"SSL Compression" ), false , false );"off" ) != 0 ) ?"true" ) : _("false" ), false , false );"ALPN" ), false , false );0 ] != '\0' ) ? alpn : _("none" ), false , false );char *) PQparameterStatus(pset.db, "is_superuser" );"Superuser" , false , false );"unknown" ), false , false );char *) PQparameterStatus(pset.db, "in_hot_standby" );"Hot Standby" , false , false );"unknown" ), false , false );false , pset.logfile);return PSQL_CMD_SKIP_LINE;/* * \ copy - - run a COPY command static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ copyright - - print copyright notice static backslashResultbool active_branch)if (active_branch)return PSQL_CMD_SKIP_LINE;/* * \ crosstabview - - execute a query and display result in crosstab static backslashResultbool active_branch)if (active_branch)int i;for (i = 0 ; i < lengthof(pset.ctv_args); i++)true );true ;else return status;/* * \ d * commands static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *pattern;bool show_verbose,unsigned short int save_expanded;/* We don't do SQLID reduction on the pattern yet */ true );'+' ) ? true : false ;'S' ) ? true : false ;/* * The ' x ' option turns expanded mode on for this command only . This * is allowed in all \ d * commands , except \ d by itself , since \ dx is a * separate command . So the ' x ' option cannot appear immediately after * \ d , but it can appear after \ d followed by other options . if (cmd[1 ] != '\0' && strchr(&cmd[2 ], 'x' ))1 ;switch (cmd[1 ])case '\0' :case '+' :case 'S' :if (pattern)else /* standard listing of interesting things */ "tvmsE" , NULL, show_verbose, show_system);break ;case 'A' :char *pattern2 = NULL;if (pattern && cmd[2 ] != '\0' && cmd[2 ] != '+' && cmd[2 ] != 'x' )true );switch (cmd[2 ])case '\0' :case '+' :case 'x' :break ;case 'c' :break ;case 'f' :break ;case 'o' :break ;case 'p' :break ;default :break ;break ;case 'a' :break ;case 'b' :break ;case 'c' :if (strncmp(cmd, "dconfig" , 7 ) == 0 )else break ;case 'C' :break ;case 'd' :if (strncmp(cmd, "ddp" , 3 ) == 0 )else break ;case 'D' :break ;case 'f' : /* function subsystem */ switch (cmd[2 ])case '\0' :case '+' :case 'S' :case 'a' :case 'n' :case 'p' :case 't' :case 'w' :case 'x' :break ;default :break ;break ;case 'g' :/* no longer distinct from \du */ break ;case 'l' :break ;case 'L' :break ;case 'n' :break ;case 'o' :break ;case 'O' :break ;case 'p' :break ;case 'P' :switch (cmd[2 ])case '\0' :case '+' :case 't' :case 'i' :case 'n' :case 'x' :2 ], pattern, show_verbose);break ;default :break ;break ;case 'T' :break ;case 't' :case 'v' :case 'm' :case 'i' :case 's' :case 'E' :1 ], pattern, show_verbose, show_system);break ;case 'r' :if (cmd[2 ] == 'd' && cmd[3 ] == 's' )char *pattern2 = NULL;if (pattern)true );else if (cmd[2 ] == 'g' )else break ;case 'R' :switch (cmd[2 ])case 'p' :if (show_verbose)else break ;case 's' :break ;default :break ;case 'u' :break ;case 'F' : /* text search subsystem */ switch (cmd[2 ])case '\0' :case '+' :case 'x' :break ;case 'p' :break ;case 'd' :break ;case 't' :break ;default :break ;break ;case 'e' : /* SQL/MED subsystem */ switch (cmd[2 ])case 's' :break ;case 'u' :break ;case 'w' :break ;case 't' :break ;default :break ;break ;case 'x' : /* Extensions */ if (show_verbose)else break ;case 'X' : /* Extended Statistics */ break ;case 'y' : /* Event Triggers */ break ;default :/* Restore original expanded mode */ else if (!success)return status;/* \df and \do; messy enough to split out of exec_command_d */ static bool const char *cmd,const char *pattern,bool show_verbose, bool show_system)bool success;char *arg_patterns[FUNC_MAX_ARGS];int num_arg_patterns = 0 ;/* Collect argument-type patterns too */ if (pattern) /* otherwise it was just \df or \do */ char *ap;while ((ap = psql_scan_slash_option(scan_state,true )) != NULL)if (num_arg_patterns >= FUNC_MAX_ARGS)break ; /* protect limited-size array */ if (cmd[1 ] == 'f' )2 ], pattern,else while (--num_arg_patterns >= 0 )return success;/* * \ e or \ edit - - edit the current query buffer , or edit a file and * make it the query buffer static backslashResultbool active_branch,if (active_branch)if (!query_buf)"no query buffer" );else char *fname;char *ln = NULL;int lineno = -1 ;true );if (fname)/* try to get separate lineno arg */ true );if (ln == NULL)/* only one arg; maybe it is lineno not fname */ if (fname[0 ] &&"0123456789" ) == strlen(fname))/* all digits, so assume it is lineno */ if (ln)if (lineno < 1 )"invalid line number: %s" , ln);if (status != PSQL_CMD_ERROR)bool discard_on_quit;if (fname)/* Always clear buffer if the file isn't modified */ true ;else /* * If query_buf is empty , recall previous query for * editing . But in that case , the query buffer should be * emptied if editing doesn ' t modify the file . if (do_edit(fname, query_buf, lineno, discard_on_quit, NULL))else /* * On error while editing or if specifying an incorrect line * number , reset the query buffer . if (status == PSQL_CMD_ERROR)else return status;/* * \ ef / \ ev - - edit the named function / view , or * present a blank CREATE FUNCTION / VIEW template if no argument is given static backslashResultbool active_branch,bool is_func)if (active_branch)char *obj_desc = psql_scan_slash_option(scan_state,true );int lineno = -1 ;if (!query_buf)"no query buffer" );else if (lineno == 0 )/* error already reported */ else if (!obj_desc)/* set up an empty command to fill in */ if (is_func)"CREATE FUNCTION ( )\n" " RETURNS \n" " LANGUAGE \n" " -- common options: IMMUTABLE STABLE STRICT SECURITY DEFINER\n" "AS $function$\n" "\n$function$\n" );else "CREATE VIEW AS\n" " SELECT \n" " -- something...\n" );else if (!lookup_object_oid(eot, obj_desc, &obj_oid))/* error already reported */ else if (!get_create_object_cmd(eot, obj_oid, query_buf))/* error already reported */ else if (is_func && lineno > 0 )/* * lineno " 1 " should correspond to the first line of the * function body . We expect that pg_get_functiondef ( ) will * emit that on a line beginning with " AS " , " BEGIN " , or * " RETURN " , and that there can be no such line before the * real start of the function body . Increment lineno by the * number of lines before that line , so that it becomes * relative to the first line of the function definition . const char *lines = query_buf->data;while (*lines != '\0' )if (strncmp(lines, "AS " , 3 ) == 0 ||"BEGIN " , 6 ) == 0 ||"RETURN " , 7 ) == 0 )break ;/* find start of next line */ '\n' );if (!lines)break ;if (status != PSQL_CMD_ERROR)bool edited = false ;if (!do_edit(NULL, query_buf, lineno, true , &edited))else if (!edited)"No changes" ));else /* * On error while doing object lookup or while editing , or if * specifying an incorrect line number , reset the query buffer . if (status == PSQL_CMD_ERROR)else return status;/* * \ echo , \ qecho , and \ warn - - echo arguments to stdout , query output , or stderr static backslashResultbool active_branch, const char *cmd)if (active_branch)char *value;char quoted;bool no_newline = false ;bool first = true ;if (strcmp(cmd, "qecho" ) == 0 )else if (strcmp(cmd, "warn" ) == 0 )else while ((value = psql_scan_slash_option(scan_state,false )))if (first && !no_newline && !quoted && strcmp(value, "-n" ) == 0 )true ;else if (first)false ;else ' ' , fout);if (!no_newline)"\n" , fout);else return PSQL_CMD_SKIP_LINE;/* * \ encoding - - set / show client side encoding static backslashResultbool active_branch)if (active_branch)char *encoding = psql_scan_slash_option(scan_state,false );if (!encoding)/* show encoding */ else /* set encoding */ if (PQsetClientEncoding(pset.db, encoding) == -1 )"%s: invalid encoding name or conversion procedure not found" , encoding);else /* save encoding info into psql internal data */ "ENCODING" ,else return PSQL_CMD_SKIP_LINE;/* * \ errverbose - - display verbose message from last failed query static backslashResultbool active_branch)if (active_branch)if (pset.last_error_result)char *msg;if (msg)"%s" , msg);else "out of memory" ));else "There is no previous error." ));return PSQL_CMD_SKIP_LINE;/* * \ f - - change field separator static backslashResultbool active_branch)bool success = true ;if (active_branch)char *fname = psql_scan_slash_option(scan_state,false );"fieldsep" , fname, &pset.popt, pset.quiet);else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ flush - - call PQflush ( ) on the connection static backslashResultbool active_branch)if (active_branch)else return status;/* * \ flushrequest - - call PQsendFlushRequest ( ) on the connection static backslashResultbool active_branch)if (active_branch)else return status;/* * \ g [ ( pset - option [ = pset - value ] . . . ) ] [ filename / shell - command ] * \ gx [ ( pset - option [ = pset - value ] . . . ) ] [ filename / shell - command ] * * Send the current query . If pset options are specified , they are made * active just for this query . If a filename or pipe command is given , * the query output goes there . \ gx implicitly sets " expanded = on " along * with any other pset options that are specified . static backslashResultbool active_branch, const char *cmd)char *fname;/* * Because the option processing for this is fairly complicated , we do it * and then decide whether the branch is active . false );if (fname && fname[0 ] == '(' )/* Consume pset options through trailing ')' ... */ 1 , scan_state,/* ... and again attempt to scan the filename. */ false );if (status == PSQL_CMD_SKIP_LINE && active_branch)if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)"\\%s not allowed in pipeline mode" , cmd);return PSQL_CMD_ERROR;if (!fname)else if (strcmp(cmd, "gx" ) == 0 )/* save settings if not done already, then force expanded=on */ if (pset.gsavepopt == NULL)1 ;return status;/* * Process parenthesized pset options for \ g * * Note : okay to modify first_option , but not to free it ; caller does that static backslashResultchar *first_option, PsqlScanState scan_state,bool active_branch, const char *cmd)bool success = true ;bool found_r_paren = false ;do char *option;/* If not first time through, collect a new option */ if (first_option)else false );if (!option)if (active_branch)"\\%s: missing right parenthesis" , cmd);false ;break ;/* Check for terminating right paren, and remove it from string */ if (optlen > 0 && option[optlen - 1 ] == ')' )'\0' ;true ;/* If there was anything besides parentheses, parse/execute it */ if (optlen > 0 )/* We can have either "name" or "name=value" */ char *valptr = strchr(option, '=' );if (valptr)'\0' ;if (active_branch)/* save settings if not done already, then apply option */ if (pset.gsavepopt == NULL)true );/* Clean up after this option. We should not free first_option. */ if (first_option)else while (!found_r_paren);/* If we failed after already changing some options, undo side-effects */ if (!success && active_branch && pset.gsavepopt)return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ gdesc - - describe query result static backslashResultbool active_branch)if (active_branch)true ;return status;/* * \ getenv - - set variable from environment variable static backslashResultbool active_branch,const char *cmd)bool success = true ;if (active_branch)char *myvar = psql_scan_slash_option(scan_state,false );char *envvar = psql_scan_slash_option(scan_state,false );if (!myvar || !envvar)"\\%s: missing required argument" , cmd);false ;else char *envval = getenv(envvar);if (envval && !SetVariable(pset.vars, myvar, envval))false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ getresults - - read results static backslashResultbool active_branch)if (active_branch)char *opt;int num_results;false );0 ;if (opt != NULL)if (num_results < 0 )"\\getresults: invalid number of requested results" );return PSQL_CMD_ERROR;else return status;/* * \ gexec - - send query and execute each field of result static backslashResultbool active_branch)if (active_branch)if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)"\\%s not allowed in pipeline mode" , "gexec" );return PSQL_CMD_ERROR;true ;return status;/* * \ gset [ prefix ] - - send query and store result into variables static backslashResultbool active_branch)if (active_branch)char *prefix = psql_scan_slash_option(scan_state,false );if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)"\\%s not allowed in pipeline mode" , "gset" );return PSQL_CMD_ERROR;if (prefix)else /* we must set a non-NULL prefix to trigger storing */ "" );/* gset_prefix is freed later */ else return status;/* * \ help [ topic ] - - print help about SQL commands static backslashResultbool active_branch)if (active_branch)char *opt = psql_scan_slash_option(scan_state,true );else return PSQL_CMD_SKIP_LINE;/* * \ H and \ html - - toggle HTML formatting static backslashResultbool active_branch)bool success = true ;if (active_branch)if (pset.popt.topt.format != PRINT_HTML)"format" , "html" , &pset.popt, pset.quiet);else "format" , "aligned" , &pset.popt, pset.quiet);return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ i and \ ir - - include a file static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *fname = psql_scan_slash_option(scan_state,true );if (!fname)"\\%s: missing required argument" , cmd);false ;else bool include_relative;"ir" ) == 0 "include_relative" ) == 0 );else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ if < expr > - - beginning of an \ if . . \ endif block * * < expr > is parsed as a boolean expression . Invalid expressions will emit a * warning and be treated as false . Statements that follow a false expression * will be parsed but ignored . Note that in the case where an \ if statement * is itself within an inactive section of a block , then the entire inner * \ if . . \ endif block will be parsed but ignored . static backslashResultif (conditional_active(cstack))/* * First , push a new active stack entry ; this ensures that the lexer * will perform variable substitution and backtick evaluation while * scanning the expression . ( That should happen anyway , since we know * we ' re in an active outer branch , but let ' s be sure . ) /* Remember current query state in case we need to restore later */ /* * Evaluate the expression ; if it ' s false , change to inactive state . if (!is_true_boolean_expression(scan_state, "\\if expression" ))else /* * We ' re within an inactive outer branch , so this entire \ if block * will be ignored . We don ' t want to evaluate the expression , so push * the " ignored " stack state before scanning it . /* Remember current query state in case we need to restore later */ return PSQL_CMD_SKIP_LINE;/* * \ elif < expr > - - alternative branch in an \ if . . \ endif block * * < expr > is evaluated the same as in \ if < expr > . static backslashResultbool success = true ;switch (conditional_stack_peek(cstack))case IFSTATE_TRUE:/* * Just finished active branch of this \ if block . Update saved * state so we will keep whatever data was put in query_buf by the * active branch . /* * Discard \ elif expression and ignore the rest until \ endif . * Switch state before reading expression to ensure proper lexer * behavior . break ;case IFSTATE_FALSE:/* * Discard any query text added by the just - skipped branch . /* * Have not yet found a true expression in this \ if block , so this * might be the first . We have to change state before examining * the expression , or the lexer won ' t do the right thing . if (!is_true_boolean_expression(scan_state, "\\elif expression" ))break ;case IFSTATE_IGNORED:/* * Discard any query text added by the just - skipped branch . /* * Skip expression and move on . Either the \ if block already had * an active section , or whole block is being skipped . break ;case IFSTATE_ELSE_TRUE:case IFSTATE_ELSE_FALSE:"\\elif: cannot occur after \\else" );false ;break ;case IFSTATE_NONE:/* no \if to elif from */ "\\elif: no matching \\if" );false ;break ;return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ else - - final alternative in an \ if . . \ endif block * * Statements within an \ else branch will only be executed if * all previous \ if and \ elif expressions evaluated to false * and the block was not itself being ignored . static backslashResultbool success = true ;switch (conditional_stack_peek(cstack))case IFSTATE_TRUE:/* * Just finished active branch of this \ if block . Update saved * state so we will keep whatever data was put in query_buf by the * active branch . /* Now skip the \else branch */ break ;case IFSTATE_FALSE:/* * Discard any query text added by the just - skipped branch . /* * We ' ve not found any true \ if or \ elif expression , so execute * the \ else branch . break ;case IFSTATE_IGNORED:/* * Discard any query text added by the just - skipped branch . /* * Either we previously processed the active branch of this \ if , * or the whole \ if block is being skipped . Either way , skip the * \ else branch . break ;case IFSTATE_ELSE_TRUE:case IFSTATE_ELSE_FALSE:"\\else: cannot occur after \\else" );false ;break ;case IFSTATE_NONE:/* no \if to else from */ "\\else: no matching \\if" );false ;break ;return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ endif - - ends an \ if . . . \ endif block static backslashResultbool success = true ;switch (conditional_stack_peek(cstack))case IFSTATE_TRUE:case IFSTATE_ELSE_TRUE:/* Close the \if block, keeping the query text */ break ;case IFSTATE_FALSE:case IFSTATE_IGNORED:case IFSTATE_ELSE_FALSE:/* * Discard any query text added by the just - skipped branch . /* Close the \if block */ break ;case IFSTATE_NONE:/* no \if to end */ "\\endif: no matching \\if" );false ;break ;return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ l - - list databases static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *pattern;bool show_verbose;unsigned short int save_expanded;true );'+' ) ? true : false ;/* if 'x' option specified, force expanded mode */ if (strchr(cmd, 'x' ))1 ;/* restore original expanded mode */ else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ lo_ * - - large object operations static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *opt1,true );true );if (strcmp(cmd + 3 , "export" ) == 0 )if (!opt2)"\\%s: missing required argument" , cmd);false ;else else if (strcmp(cmd + 3 , "import" ) == 0 )if (!opt1)"\\%s: missing required argument" , cmd);false ;else else if (strncmp(cmd + 3 , "list" , 4 ) == 0 )bool show_verbose;unsigned short int save_expanded;'+' ) ? true : false ;/* if 'x' option specified, force expanded mode */ if (strchr(cmd, 'x' ))1 ;/* restore original expanded mode */ else if (strcmp(cmd + 3 , "unlink" ) == 0 )if (!opt1)"\\%s: missing required argument" , cmd);false ;else else else if (!success)return status;/* * \ o - - set query output static backslashResultbool active_branch)bool success = true ;if (active_branch)char *fname = psql_scan_slash_option(scan_state,true );else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ p - - print the current query buffer static backslashResultbool active_branch,if (active_branch)/* * We want to print the same thing \ g would execute , but not to change * the query buffer state ; so we can ' t use copy_previous_query ( ) . * Also , beware of possibility that buffer pointers are NULL . if (query_buf && query_buf->len > 0 )else if (previous_buf && previous_buf->len > 0 )else if (!pset.quiet)"Query buffer is empty." ));return PSQL_CMD_SKIP_LINE;/* * \ parse - - parse query static backslashResultbool active_branch,const char *cmd)if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );if (!opt)"\\%s: missing required argument" , cmd);else else return status;/* * \ password - - set user password static backslashResultbool active_branch)bool success = true ;if (active_branch)char *user = psql_scan_slash_option(scan_state,true );char *pw1 = NULL;char *pw2 = NULL;if (user == NULL)/* By default, the command applies to CURRENT_USER */ "SELECT CURRENT_USER" );if (!res)return PSQL_CMD_ERROR;0 , 0 ));/* Set up to let SIGINT cancel simple_prompt_extended() */ false ;"Enter new password for user \" %s\": " ), user);false , &prompt_ctx);if (!prompt_ctx.canceled)"Enter it again: " , false , &prompt_ctx);if (prompt_ctx.canceled)/* fail silently */ false ;else if (strcmp(pw1, pw2) != 0 )"Passwords didn't match." );false ;else if (PQresultStatus(res) != PGRES_COMMAND_OK)"%s" , PQerrorMessage(pset.db));false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ prompt - - prompt and set variable static backslashResultbool active_branch,const char *cmd)bool success = true ;if (active_branch)char *opt,char *arg1,false );false );if (!arg1)"\\%s: missing required argument" , cmd);false ;else char *result;/* Set up to let SIGINT cancel simple_prompt_extended() */ false ;if (arg2)else if (!pset.inputfile)true , &prompt_ctx);else if (prompt_text)if (!result)"\\%s: could not read value for variable" ,false ;if (prompt_ctx.canceled ||false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ pset - - set printing parameters static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt0 = psql_scan_slash_option(scan_state,false );char *opt1 = psql_scan_slash_option(scan_state,false );if (!opt0)/* list all variables */ int i;static const char *const my_list[] = {"border" , "columns" , "csv_fieldsep" , "expanded" , "fieldsep" ,"fieldsep_zero" , "footer" , "format" , "linestyle" , "null" ,"numericlocale" , "pager" , "pager_min_lines" ,"recordsep" , "recordsep_zero" ,"tableattr" , "title" , "tuples_only" ,"unicode_border_linestyle" ,"unicode_column_linestyle" ,"unicode_header_linestyle" ,"xheader_width" ,for (i = 0 ; my_list[i] != NULL; i++)char *val = pset_value_string(my_list[i], &pset.popt);"%-24s %s\n" , my_list[i], val);true ;else else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ q or \ quit - - exit psql static backslashResultbool active_branch)if (active_branch)return status;/* * \ r - - reset ( clear ) the query buffer static backslashResultbool active_branch,if (active_branch)if (!pset.quiet)"Query buffer reset (cleared)." ));return PSQL_CMD_SKIP_LINE;/* * \ restrict - - enter " restricted mode " with the provided key static backslashResultbool active_branch,const char *cmd)if (active_branch)char *opt;true );if (opt == NULL || opt[0 ] == '\0' )"\\%s: missing required argument" , cmd);return PSQL_CMD_ERROR;true ;else return PSQL_CMD_SKIP_LINE;/* * \ s - - save history in a file or show it on the screen static backslashResultbool active_branch)bool success = true ;if (active_branch)char *fname = psql_scan_slash_option(scan_state,true );if (success && !pset.quiet && fname)"Wrote history to file \" %s\".\n" ), fname);if (!fname)'\n' );else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ sendpipeline - - send an extended query to an ongoing pipeline static backslashResultbool active_branch)if (active_branch)if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)if (pset.send_mode == PSQL_SEND_EXTENDED_QUERY_PREPARED ||else "\\sendpipeline must be used after \\bind or \\bind_named" );return PSQL_CMD_ERROR;else "\\sendpipeline not allowed outside of pipeline mode" );return PSQL_CMD_ERROR;else return status;/* * \ set - - set variable static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt0 = psql_scan_slash_option(scan_state,false );if (!opt0)/* list all variables */ true ;else /* * Set variable to the concatenation of the arguments . char *newval;char *opt;false );"" );while ((opt = psql_scan_slash_option(scan_state,false )))1 );if (!SetVariable(pset.vars, opt0, newval))false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ setenv - - set environment variable static backslashResultbool active_branch,const char *cmd)bool success = true ;if (active_branch)char *envvar = psql_scan_slash_option(scan_state,false );char *envval = psql_scan_slash_option(scan_state,false );if (!envvar)"\\%s: missing required argument" , cmd);false ;else if (strchr(envvar, '=' ) != NULL)"\\%s: environment variable name must not contain \" =\"" ,false ;else if (!envval)/* No argument - unset the environment variable */ true ;else /* Set variable to the value of the next argument */ 1 );true ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ sf / \ sv - - show a function / view ' s source code static backslashResultbool active_branch,const char *cmd, bool is_func)if (active_branch)bool show_linenumbers = (strchr(cmd, '+' ) != NULL);char *obj_desc;true );if (!obj_desc)if (is_func)"function name is required" );else "view name is required" );else if (!lookup_object_oid(eot, obj_desc, &obj_oid))/* error already reported */ else if (!get_create_object_cmd(eot, obj_oid, buf))/* error already reported */ else bool is_pager;/* Select output stream: stdout, pager, or file */ if (pset.queryFout == stdout)/* count lines in function to see if pager is needed */ int lineno = count_lines_in_buf(buf);true ;else /* use previously set output file, without pager */ false ;if (show_linenumbers)/* add line numbers */ else /* just send the definition to output */ if (is_pager)else return status;/* * \ startpipeline - - enter pipeline mode static backslashResultbool active_branch)if (active_branch)else return status;/* * \ syncpipeline - - send a sync message to an active pipeline static backslashResultbool active_branch)if (active_branch)else return status;/* * \ endpipeline - - end pipeline mode static backslashResultbool active_branch)if (active_branch)else return status;/* * \ t - - turn off table headers and row count static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,true );"tuples_only" , opt, &pset.popt, pset.quiet);else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ T - - define html < table . . . > attributes static backslashResultbool active_branch)bool success = true ;if (active_branch)char *value = psql_scan_slash_option(scan_state,false );"tableattr" , value, &pset.popt, pset.quiet);else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ timing - - enable / disable timing of queries static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );if (opt)"\\timing" , &pset.timing);else if (!pset.quiet)if (pset.timing)"Timing is on." ));else "Timing is off." ));else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ unrestrict - - exit " restricted mode " if provided key matches static backslashResultbool active_branch,const char *cmd)if (active_branch)char *opt;true );if (opt == NULL || opt[0 ] == '\0' )"\\%s: missing required argument" , cmd);return PSQL_CMD_ERROR;if (!restricted)"\\%s: not currently in restricted mode" , cmd);return PSQL_CMD_ERROR;else if (strcmp(opt, restrict_key) == 0 )false ;else "\\%s: wrong key" , cmd);return PSQL_CMD_ERROR;else return PSQL_CMD_SKIP_LINE;/* * \ unset - - unset variable static backslashResultbool active_branch,const char *cmd)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );if (!opt)"\\%s: missing required argument" , cmd);false ;else if (!SetVariable(pset.vars, opt, NULL))false ;else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ w - - write query buffer to file static backslashResultbool active_branch,const char *cmd,if (active_branch)char *fname = psql_scan_slash_option(scan_state,true );bool is_pipe = false ;if (!query_buf)"no query buffer" );else if (!fname)"\\%s: missing required argument" , cmd);else if (fname[0 ] == '|' )true ;1 ], "w" );else "w" );if (!fd)"%s: %m" , fname);if (fd)int result;/* * We want to print the same thing \ g would execute , but not to * change the query buffer state ; so we can ' t use * copy_previous_query ( ) . Also , beware of possibility that buffer * pointers are NULL . if (query_buf && query_buf->len > 0 )"%s\n" , query_buf->data);else if (previous_buf && previous_buf->len > 0 )"%s\n" , previous_buf->data);if (is_pipe)if (result != 0 )"%s: %s" , fname, wait_result_to_str(result));else if (result == EOF)"%s: %m" , fname);if (is_pipe)else return status;/* * \ watch - - execute a query every N seconds . * Optionally , stop after M iterations . static backslashResultbool active_branch,bool success = true ;if (active_branch)bool have_sleep = false ;bool have_iter = false ;bool have_min_rows = false ;double sleep = pset.watch_interval;int iter = 0 ;int min_rows = 0 ;if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)"\\%s not allowed in pipeline mode" , "watch" );false ;/* * Parse arguments . We allow either an unlabeled interval or * " name = value " , where name is from the set ( ' i ' , ' interval ' , ' c ' , * ' count ' , ' m ' , ' min_rows ' ) . The parsing of interval value should be * kept in sync with ParseVariableDouble which is used for setting the * default interval value . while (success)char *opt = psql_scan_slash_option(scan_state,true );char *valptr;char *opt_end;if (!opt)break ; /* no more arguments */ '=' );if (valptr)/* Labeled argument */ if (strncmp("i=" , opt, strlen("i=" )) == 0 ||"interval=" , opt, strlen("interval=" )) == 0 )if (have_sleep)"\\watch: interval value is specified more than once" );false ;else true ;0 ;if (sleep < 0 || *opt_end || errno == ERANGE)"\\watch: incorrect interval value \" %s\"" , valptr);false ;else if (strncmp("c=" , opt, strlen("c=" )) == 0 ||"count=" , opt, strlen("count=" )) == 0 )if (have_iter)"\\watch: iteration count is specified more than once" );false ;else true ;0 ;10 );if (iter <= 0 || *opt_end || errno == ERANGE)"\\watch: incorrect iteration count \" %s\"" , valptr);false ;else if (strncmp("m=" , opt, strlen("m=" )) == 0 ||"min_rows=" , opt, strlen("min_rows=" )) == 0 )if (have_min_rows)"\\watch: minimum row count specified more than once" );false ;else true ;0 ;10 );if (min_rows <= 0 || *opt_end || errno == ERANGE)"\\watch: incorrect minimum row count \" %s\"" , valptr);false ;else "\\watch: unrecognized parameter \" %s\"" , opt);false ;else /* Unlabeled argument: take it as interval */ if (have_sleep)"\\watch: interval value is specified more than once" );false ;else true ;0 ;if (sleep < 0 || *opt_end || errno == ERANGE)"\\watch: incorrect interval value \" %s\"" , opt);false ;/* If we parsed arguments successfully, do the command */ if (success)/* If query_buf is empty, recall and execute previous query */ void ) copy_previous_query(query_buf, previous_buf);/* Reset the query buffer as though for \r */ else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ x - - set or toggle expanded table representation static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,true );"expanded" , opt, &pset.popt, pset.quiet);else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ z - - list table privileges ( equivalent to \ dp ) static backslashResultbool active_branch, const char *cmd)bool success = true ;if (active_branch)char *pattern;bool show_system;unsigned short int save_expanded;true );'S' ) ? true : false ;/* if 'x' option specified, force expanded mode */ if (strchr(cmd, 'x' ))1 ;/* restore original expanded mode */ else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ ! - - execute shell command static backslashResultbool active_branch)bool success = true ;if (active_branch)char *opt = psql_scan_slash_option(scan_state,false );else return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;/* * \ ? - - print help about backslash commands static backslashResultbool active_branch)if (active_branch)char *opt0 = psql_scan_slash_option(scan_state,false );if (!opt0 || strcmp(opt0, "commands" ) == 0 )else if (strcmp(opt0, "options" ) == 0 )else if (strcmp(opt0, "variables" ) == 0 )else else return PSQL_CMD_SKIP_LINE;/* * Read and interpret an argument to the \ connect slash command . * * Returns a malloc ' d string , or NULL if no / empty argument . static char *char *result;char quote;/* * Ideally we should treat the arguments as SQL identifiers . But for * backwards compatibility with 7 . 2 and older pg_dump files , we have to * take unquoted arguments verbatim ( don ' t downcase them ) . For now , * double - quoted arguments may be stripped of double quotes ( as if SQL * identifiers ) . By 7 . 4 or so , pg_dump files can be expected to * double - quote all mixed - case \ connect arguments , and then we can get rid * of OT_SQLIDHACK . true );if (!result)return NULL;if (quote)return result;if (*result == '\0' || strcmp(result, "-" ) == 0 )return NULL;return result;/* * Read a boolean expression , return it as a PQExpBuffer string . * * Note : anything more or less than one token will certainly fail to be * parsed by ParseVariableBool , so we don ' t worry about complaining here . * This routine ' s return data structure will need to be rethought anyway * to support likely future extensions such as " \ if defined VARNAME " . static PQExpBufferint num_options = 0 ;char *value;/* collect all arguments for the conditional command into exp_buf */ while ((value = psql_scan_slash_option(scan_state,false )) != NULL)/* add spaces between tokens */ if (num_options > 0 )' ' );return exp_buf;/* * Read a boolean expression , return true if the expression * was a valid boolean expression that evaluated to true . * Otherwise return false . * * Note : conditional stack ' s top state must be active , else lexer will * fail to expand variables and backticks . static bool const char *name)bool value = false ;bool success = ParseVariableBool(buf->data, name, &value);return success && value;/* * Read a boolean expression , but do nothing with it . * * Note : conditional stack ' s top state must be INACTIVE , else lexer will * expand variables and backticks , which we do not want here . static void /* * Read and discard " normal " slash command options . * * This should be used for inactive - branch processing of any slash command * that eats one or more OT_NORMAL , OT_SQLID , or OT_SQLIDHACK parameters . * We don ' t need to worry about exactly how many it would eat , since the * cleanup logic in HandleSlashCmds would silently discard any extras anyway . static void char *arg;while ((arg = psql_scan_slash_option(scan_state,false )) != NULL)/* * Read and discard FILEPIPE slash command argument . * * This * MUST * be used for inactive - branch processing of any slash command * that takes an OT_FILEPIPE option . Otherwise we might consume a different * amount of option text in active and inactive cases . static void char *arg = psql_scan_slash_option(scan_state,false );/* * Read and discard whole - line slash command argument . * * This * MUST * be used for inactive - branch processing of any slash command * that takes an OT_WHOLE_LINE option . Otherwise we might consume a different * amount of option text in active and inactive cases . * * Note : although callers might pass " semicolon " as either true or false , * we need not duplicate that here , since it doesn ' t affect the amount of * input text consumed . static void char *arg = psql_scan_slash_option(scan_state,false );/* * Return true if the command given is a branching command . static bool const char *cmd)return (strcmp(cmd, "if" ) == 0 ||"elif" ) == 0 ||"else" ) == 0 ||"endif" ) == 0 );/* * Prepare to possibly restore query buffer to its current state * ( cf . discard_query_text ) . * * We need to remember the length of the query buffer , and the lexer ' s * notion of the parenthesis nesting depth . static void if (query_buf)/* * Discard any query text absorbed during an inactive conditional branch . * * We must discard data that was appended to query_buf during an inactive * \ if branch . We don ' t have to do anything there if there ' s no query_buf . * * Also , reset the lexer state to the same paren depth there was before . * ( The rest of its state doesn ' t need attention , since we could not be * inside a comment or literal or partial token . ) static void if (query_buf)int new_len = conditional_stack_get_query_len(cstack);0 && new_len <= query_buf->len);'\0' ;/* * If query_buf is empty , copy previous_buf into it . * * This is used by various slash commands for which re - execution of a * previous query is a common usage . For convenience , we allow the * case of query_buf = = NULL ( and do nothing ) . * * Returns " true " if the previous query was copied into the query * buffer , else " false " . static bool if (query_buf && query_buf->len == 0 )return true ;return false ;/* * Ask the user for a password ; ' username ' is the username the * password is for , if one has been explicitly specified . * Returns a malloc ' d string . * If ' canceled ' is provided , * canceled will be set to true if the prompt * is canceled via SIGINT , and to false otherwise . static char *const char *username, bool *canceled)char *result;/* Set up to let SIGINT cancel simple_prompt_extended() */ false ;if (username == NULL || username[0 ] == '\0' )"Password: " , false , &prompt_ctx);else char *prompt_text;"Password for user %s: " ), username);false , &prompt_ctx);if (canceled)return result;static bool const char *old_val, const char *new_val)if (new_val == NULL)return false ;if (old_val == NULL || strcmp(old_val, new_val) != 0 )return true ;return false ;/* * do_connect - - handler for \ connect * * Connects to a database with given parameters . If we are told to re - use * parameters , parameters from the previous connection are used where the * command ' s own options do not supply a value . Otherwise , libpq defaults * are used . * * In interactive mode , if connection fails with the given parameters , * the old connection will be kept . static bool enum trivalue reuse_previous_specification,char *dbname, char *user, char *host, char *port)int nconnopts = 0 ;bool same_host = false ;char *password = NULL;char *client_encoding;bool success = true ;bool keep_password = true ;bool has_connection_string;bool reuse_previous;false ;/* Complain if we have additional arguments after a connection string. */ if (has_connection_string && (user || host || port))"Do not give user, host, or port separately when using a connection string" );return false ;switch (reuse_previous_specification)case TRI_YES:true ;break ;case TRI_NO:false ;break ;default :break ;/* * If we intend to re - use connection parameters , collect them out of the * old connection , then replace individual values as necessary . ( We may * need to resort to looking at pset . dead_conn , if the connection died * previously . ) Otherwise , obtain a PQconninfoOption array containing * libpq ' s defaults , and modify that . Note this function assumes that * PQconninfo , PQconndefaults , and PQconninfoParse will all produce arrays * containing the same options in the same order . if (reuse_previous)if (o_conn)else if (pset.dead_conn)else /* This is reachable after a non-interactive \connect failure */ "No database connection exists to re-use parameters from" );return false ;else if (cinfo)if (has_connection_string)/* Parse the connstring and insert values into cinfo */ char *errmsg;if (replcinfo)bool have_password = false ;for (ci = cinfo, replci = replcinfo;0 );/* Insert value from connstring if one was provided */ if (replci->val)/* * We know that both val strings were allocated by * libpq , so the least messy way to avoid memory leaks * is to swap them . char *swap = replci->val;/* * Check whether connstring provides options affecting * password re - use . While any change in user , host , * hostaddr , or port causes us to ignore the old * connection ' s password , we don ' t force that for * dbname , since passwords aren ' t database - specific . if (replci->val == NULL ||0 )if (strcmp(replci->keyword, "user" ) == 0 ||"host" ) == 0 ||"hostaddr" ) == 0 ||"port" ) == 0 )false ;/* Also note whether connstring contains a password. */ if (strcmp(replci->keyword, "password" ) == 0 )true ;else if (!reuse_previous)/* * When we have a connstring and are not re - using * parameters , swap * all * entries , even those not set * by the connstring . This avoids absorbing * environment - dependent defaults from the result of * PQconndefaults ( ) . We don ' t want to do that because * they ' d override service - file entries if the * connstring specifies a service parameter , whereas * the priority should be the other way around . libpq * can certainly recompute any defaults we don ' t pass * here . ( In this situation , it ' s a bit wasteful to * have called PQconndefaults ( ) at all , but not doing * so would require yet another major code path here . ) /* While here, determine how many option slots there are */ /* * If the connstring contains a password , tell the loop below * that we may use it , regardless of other settings ( i . e . , * cinfo ' s password is no longer an " old " password ) . if (have_password)true ;/* Don't let code below try to inject dbname into params. */ else /* PQconninfoParse failed */ if (errmsg)"%s" , errmsg);else "out of memory" );false ;else /* * If dbname isn ' t a connection string , then we ' ll inject it and * the other parameters into the keyword array below . ( We can ' t * easily insert them into the cinfo array because of memory * management issues : PQconninfoFree would misbehave on Windows . ) * However , to avoid dependencies on the order in which parameters * appear in the array , make a preliminary scan to set * keep_password and same_host correctly . * * While any change in user , host , or port causes us to ignore the * old connection ' s password , we don ' t force that for dbname , * since passwords aren ' t database - specific . for (ci = cinfo; ci->keyword; ci++)if (user && strcmp(ci->keyword, "user" ) == 0 )if (!(ci->val && strcmp(user, ci->val) == 0 ))false ;else if (host && strcmp(ci->keyword, "host" ) == 0 )if (ci->val && strcmp(host, ci->val) == 0 )true ;else false ;else if (port && strcmp(ci->keyword, "port" ) == 0 )if (!(ci->val && strcmp(port, ci->val) == 0 ))false ;/* While here, determine how many option slots there are */ else /* We failed to create the cinfo structure */ "out of memory" );false ;/* * If the user asked to be prompted for a password , ask for one now . If * not , use the password from the old connection , provided the username * etc have not changed . Otherwise , try to connect without a password * first , and then ask for a password if needed . * * XXX : this behavior leads to spurious connection attempts recorded in * the postmaster ' s log . But libpq offers no API that would let us obtain * a password and then continue with the first connection attempt . if (pset.getPassword == TRI_YES && success)bool canceled = false ;/* * If a connstring or URI is provided , we don ' t know which username * will be used , since we haven ' t dug that out of the connstring . * Don ' t risk issuing a misleading prompt . As in startup . c , it does * not seem worth working harder , since this getPassword setting is * normally only used in noninteractive cases . /* * Consider whether to force client_encoding to " auto " ( overriding * anything in the connection string ) . We do so if we have a terminal * connection and there is no PGCLIENTENCODING environment setting . if (pset.notty || getenv("PGCLIENTENCODING" ))else "auto" ;/* Loop till we have a connection or fail, which we might've already */ while (success)const char **keywords = pg_malloc((nconnopts + 1 ) * sizeof (*keywords));const char **values = pg_malloc((nconnopts + 1 ) * sizeof (*values));int paramnum = 0 ;/* * Copy non - default settings into the PQconnectdbParams parameter * arrays ; but inject any values specified old - style , as well as any * interactively - obtained password , and a couple of fields we want to * set forcibly . * * If you change this code , see also the initial - connection code in * main ( ) . for (ci = cinfo; ci->keyword; ci++)if (dbname && strcmp(ci->keyword, "dbname" ) == 0 )else if (user && strcmp(ci->keyword, "user" ) == 0 )else if (host && strcmp(ci->keyword, "host" ) == 0 )else if (host && !same_host && strcmp(ci->keyword, "hostaddr" ) == 0 )/* If we're changing the host value, drop any old hostaddr */ else if (port && strcmp(ci->keyword, "port" ) == 0 )/* If !keep_password, we unconditionally drop old password */ else if ((password || !keep_password) &&"password" ) == 0 )else if (strcmp(ci->keyword, "fallback_application_name" ) == 0 )else if (client_encoding &&"client_encoding" ) == 0 )else if (ci->val)/* else, don't bother making libpq parse this keyword */ /* add array terminator */ /* Note we do not want libpq to re-expand the dbname parameter */ false );if (PQstatus(n_conn) == CONNECTION_OK)break ;/* * Connection attempt failed ; either retry the connection attempt with * a new password , or give up . if (!password && PQconnectionNeedsPassword(n_conn) && pset.getPassword != TRI_NO)bool canceled = false ;/* * Prompt for password using the username we actually connected * with - - - it might ' ve come out of " dbname " rather than " user " . continue ;/* * We ' ll report the error below . . . unless n_conn is NULL , indicating * that libpq didn ' t have enough memory to make a PGconn . if (n_conn == NULL)"out of memory" );false ;/* end retry loop */ /* Release locally allocated data, whether we succeeded or not */ if (!success)/* * Failed to connect to the database . In interactive mode , keep the * previous connection to the DB ; in scripting mode , close our * previous connection as well . if (pset.cur_cmd_interactive)if (n_conn)"%s" , PQerrorMessage(n_conn));/* pset.db is left unmodified */ if (o_conn)"Previous connection kept" );else if (n_conn)"\\connect: %s" , PQerrorMessage(n_conn));if (o_conn)/* * Transition to having no connection . * * Unlike CheckConnection ( ) , we close the old connection * immediately to prevent its parameters from being re - used . * This is so that a script cannot accidentally reuse * parameters it did not expect to . Otherwise , the state * cleanup should be the same as in CheckConnection ( ) . /* On the same reasoning, release any dead_conn to prevent reuse */ if (pset.dead_conn)return false ;/* * Replace the old connection with the new one , and update * connection - dependent variables . Keep the resynchronization logic in * sync with CheckConnection ( ) . false ); /* Must be after SyncVariables */ /* Tell the user about the new connection */ if (!pset.quiet)if (!o_conn ||char *connhost = PQhost(pset.db);char *hostaddr = PQhostaddr(pset.db);if (is_unixsock_path(connhost))/* hostaddr overrides connhost */ if (hostaddr && *hostaddr)"You are now connected to database \" %s\" as user \" %s\" on address \" %s\" at port \" %s\".\n" ),else "You are now connected to database \" %s\" as user \" %s\" via socket in \" %s\" at port \" %s\".\n" ),else if (hostaddr && *hostaddr && strcmp(connhost, hostaddr) != 0 )"You are now connected to database \" %s\" as user \" %s\" on host \" %s\" (address \" %s\") at port \" %s\".\n" ),else "You are now connected to database \" %s\" as user \" %s\" on host \" %s\" at port \" %s\".\n" ),else "You are now connected to database \" %s\" as user \" %s\".\n" ),/* Drop no-longer-needed connection(s) */ if (o_conn)if (pset.dead_conn)return true ;/* * Processes the connection sequence described by PQconnectStartParams ( ) . Don ' t * worry about reporting errors in this function . Our caller will check the * connection ' s status , and report appropriately . static void bool forRead = false ;while (true )int rc;int sock;/* * On every iteration of the connection sequence , let ' s check if the * user has requested a cancellation . if (cancel_pressed)break ;/* * Do not assume that the socket remains the same across * PQconnectPoll ( ) calls . if (sock == -1 )break ;/* * If the user sends SIGINT between the cancel_pressed check , and * polling of the socket , it will not be recognized . Instead , we will * just wait until the next step in the connection sequence or * forever , which might require users to send SIGTERM or SIGQUIT . * * Some solutions would include the " self - pipe trick , " using * pselect ( 2 ) and ppoll ( 2 ) , or using a timeout . * * The self - pipe trick requires a bit of code to setup . pselect ( 2 ) and * ppoll ( 2 ) are not on all the platforms we support . The simplest * solution happens to just be adding a timeout , so let ' s wait for 1 * second and check cancel_pressed again . 1000000 ;if (rc == -1 )return ;switch (PQconnectPoll(conn))case PGRES_POLLING_OK:case PGRES_POLLING_FAILED:return ;case PGRES_POLLING_READING:true ;continue ;case PGRES_POLLING_WRITING:false ;continue ;case PGRES_POLLING_ACTIVE:void bool in_startup)if (!pset.quiet && !pset.notty)int client_ver = PG_VERSION_NUM;char cverbuf[32 ];char sverbuf[32 ];if (pset.sversion != client_ver)const char *server_version;/* Try to get full text form, might include "devel" etc */ "server_version" );/* Otherwise fall back on pset.sversion */ if (!server_version)true ,sizeof (sverbuf));"%s (%s, server %s)\n" ),/* For version match, only print psql banner on startup. */ else if (in_startup)"%s (%s)\n" , pset.progname, PG_VERSION);/* * Warn if server ' s major version is newer than ours , or if server * predates our support cutoff ( currently 9 . 2 ) . if (pset.sversion / 100 > client_ver / 100 ||90200 )"WARNING: %s major version %s, server major version %s.\n" " Some psql features might not work.\n" ),false ,sizeof (cverbuf)),false ,sizeof (sverbuf)));#ifdef WIN32if (in_startup)#endif /* * printSSLInfo * * Prints information about the current SSL connection , if SSL is in use static void void )const char *protocol;const char *cipher;const char *compression;const char *alpn;if (!PQsslInUse(pset.db))return ; /* no SSL */ "protocol" );"cipher" );"compression" );"alpn" );"SSL connection (protocol: %s, cipher: %s, compression: %s, ALPN: %s)\n" ),"unknown" ),"unknown" ),"off" ) != 0 ) ? _("on" ) : _("off" ),0 ] != '\0' ) ? alpn : _("none" ));/* * printGSSInfo * * Prints information about the current GSSAPI connection , if GSSAPI encryption is in use static void void )if (!PQgssEncInUse(pset.db))return ; /* no GSSAPI encryption in use */ "GSSAPI-encrypted connection\n" ));/* * checkWin32Codepage * * Prints a warning when win32 console codepage differs from Windows codepage #ifdef WIN32static void void )unsigned int wincp,if (wincp != concp)"WARNING: Console code page (%u) differs from Windows code page (%u)\n" " 8-bit characters might not work correctly. See psql reference\n" " page \" Notes for Windows users\" for details.\n" ),#endif /* * SyncVariables * * Make psql ' s internal variables agree with connection state upon * establishing a new connection . void void )char vbuf[32 ];const char *server_version;char *service_name;/* get stuff from connection */ "DBNAME" , PQdb(pset.db));"USER" , PQuser(pset.db));"HOST" , PQhost(pset.db));"PORT" , PQport(pset.db));"ENCODING" , pg_encoding_to_char(pset.encoding));"service" );"SERVICE" , service_name);if (service_name)/* this bit should match connection_warnings(): */ /* Try to get full text form of version, might include "devel" etc */ "server_version" );/* Otherwise fall back on pset.sversion */ if (!server_version)true , vbuf, sizeof (vbuf));"SERVER_VERSION_NAME" , server_version);sizeof (vbuf), "%d" , pset.sversion);"SERVER_VERSION_NUM" , vbuf);/* send stuff to it, too */ /* * UnsyncVariables * * Clear variables that should be not be set when there is no connection . void void )"DBNAME" , NULL);"SERVICE" , NULL);"USER" , NULL);"HOST" , NULL);"PORT" , NULL);"ENCODING" , NULL);"SERVER_VERSION_NAME" , NULL);"SERVER_VERSION_NUM" , NULL);/* * helper for do_edit ( ) : actually invoke the editor * * Returns true on success , false if we failed to invoke the editor or * it returned nonzero status . ( An error message is printed for failed - * to - invoke cases , but not if the editor returns nonzero status . ) static bool const char *fname, int lineno)const char *editorName;const char *editor_lineno_arg = NULL;char *sys;int result;/* Find an editor to use */ "PSQL_EDITOR" );if (!editorName)"EDITOR" );if (!editorName)"VISUAL" );if (!editorName)/* Get line number argument, if we need it. */ if (lineno > 0 )"PSQL_EDITOR_LINENUMBER_ARG" );#ifdef DEFAULT_EDITOR_LINENUMBER_ARGif (!editor_lineno_arg)#endif if (!editor_lineno_arg)"environment variable PSQL_EDITOR_LINENUMBER_ARG must be set to specify a line number" );return false ;/* * On Unix the EDITOR value should * not * be quoted , since it might include * switches , eg , EDITOR = " pico - t " ; it ' s up to the user to put quotes in it * if necessary . But this policy is not very workable on Windows , due to * severe brain damage in their command shell plus the fact that standard * program paths include spaces . #ifndef WIN32if (lineno > 0 )"exec %s %s%d '%s'" ,else "exec %s '%s'" ,#else if (lineno > 0 )"\" %s\" %s%d \" %s\"" ,else "\" %s\" \" %s\"" ,#endif if (result == -1 )"could not start editor \" %s\"" , editorName);else if (result == 127 )"could not start /bin/sh" );return result == 0 ;/* * do_edit - - handler for \ e * * If you do not specify a filename , the current query buffer will be copied * into a temporary file . * * After this function is done , the resulting file will be copied back into the * query buffer . As an exception to this , the query buffer will be emptied * if the file was not modified ( or the editor failed ) and the caller passes * " discard_on_quit " = true . * * If " edited " isn ' t NULL , * edited will be set to true if the query buffer * is successfully replaced . static bool const char *filename_arg, PQExpBuffer query_buf,int lineno, bool discard_on_quit, bool *edited)char fnametmp[MAXPGPATH];const char *fname;bool error = false ;int fd;struct stat before,if (filename_arg)else /* make a temp file to edit */ #ifndef WIN32const char *tmpdir = getenv("TMPDIR" );if (!tmpdir)"/tmp" ;#else char tmpdir[MAXPGPATH];int ret;if (ret == 0 || ret > MAXPGPATH)"could not locate temporary directory: %s" ,"" );return false ;#endif /* * No canonicalize_path ( ) here . EDIT . EXE run from CMD . EXE prepends the * current directory to the supplied path unless we use only * backslashes , so we do that . #ifndef WIN32sizeof (fnametmp), "%s%spsql.edit.%d.sql" , tmpdir,"/" , (int ) getpid());#else sizeof (fnametmp), "%s%spsql.edit.%d.sql" , tmpdir,"" /* trailing separator already present */ , (int) getpid()); #endif const char *) fnametmp;0600 );if (fd != -1 )"w" );if (fd == -1 || !stream)"could not open temporary file \" %s\": %m" , fname);true ;else unsigned int ql = query_buf->len;/* force newline-termination of what we send to editor */ if (ql > 0 && query_buf->data[ql - 1 ] != '\n' )'\n' );if (fwrite(query_buf->data, 1 , ql, stream) != ql)"%s: %m" , fname);if (fclose(stream) != 0 )"%s: %m" , fname);if (remove(fname) != 0 )"%s: %m" , fname);true ;else if (fclose(stream) != 0 )"%s: %m" , fname);if (remove(fname) != 0 )"%s: %m" , fname);true ;else struct utimbuf ut;/* * Try to set the file modification time of the temporary file * a few seconds in the past . Otherwise , the low granularity * ( one second , or even worse on some filesystems ) that we can * portably measure with stat ( 2 ) could lead us to not * recognize a modification , if the user typed very quickly . * * This is a rather unlikely race condition , so don ' t error * out if the utime ( 2 ) call fails - - - that would make the cure * worse than the disease . 2 ;void ) utime(fname, &ut);if (!error && stat(fname, &before) != 0 )"%s: %m" , fname);true ;/* call editor */ if (!error)if (!error && stat(fname, &after) != 0 )"%s: %m" , fname);true ;/* file was edited if the size or modification time has changed */ if (!error &&if (!stream)"%s: %m" , fname);true ;else /* read file back into query_buf */ char line[1024 ];while (fgets(line, sizeof (line), stream) != NULL)if (ferror(stream))"%s: %m" , fname);true ;else if (edited)true ;else /* * If the file was not modified , and the caller requested it , discard * the query buffer . if (discard_on_quit)/* remove temp file */ if (!filename_arg)if (remove(fname) == -1 )"%s: %m" , fname);true ;return !error;/* * process_file * * Reads commands from filename and passes them to the main processing loop . * Handler for \ i and \ ir , but can be used for other things as well . Returns * MainLoop ( ) error code . * * If use_relative_path is true and filename is not an absolute path , then open * the file from where the currently processed file ( if any ) is located . int char *filename, bool use_relative_path)int result;char *oldfilename;char relpath[MAXPGPATH];if (!filename)else if (strcmp(filename, "-" ) != 0 )/* * If we were asked to resolve the pathname relative to the location * of the currently executing script , and there is one , and this is a * relative pathname , then prepend all but the last pathname component * of the current script to this pathname . if (use_relative_path && pset.inputfile &&sizeof (relpath));if (!fd)"%s: %m" , filename);return EXIT_FAILURE;else "<stdin>" ; /* for future error messages */ 0 : PG_LOG_FLAG_TERSE);if (fd != stdin)0 : PG_LOG_FLAG_TERSE);return result;static const char *enum printFormat in)switch (in)case PRINT_NOTHING:return "nothing" ;break ;case PRINT_ALIGNED:return "aligned" ;break ;case PRINT_ASCIIDOC:return "asciidoc" ;break ;case PRINT_CSV:return "csv" ;break ;case PRINT_HTML:return "html" ;break ;case PRINT_LATEX:return "latex" ;break ;case PRINT_LATEX_LONGTABLE:return "latex-longtable" ;break ;case PRINT_TROFF_MS:return "troff-ms" ;break ;case PRINT_UNALIGNED:return "unaligned" ;break ;case PRINT_WRAPPED:return "wrapped" ;break ;return "unknown" ;/* * Parse entered Unicode linestyle . If ok , update * linestyle and return * true , else return false . static bool const char *value, size_t vallen,if (pg_strncasecmp("single" , value, vallen) == 0 )else if (pg_strncasecmp("double" , value, vallen) == 0 )else return false ;return true ;static const char *int linestyle)switch (linestyle)case UNICODE_LINESTYLE_SINGLE:return "single" ;break ;case UNICODE_LINESTYLE_DOUBLE:return "double" ;break ;return "unknown" ;/* * do_pset * * Performs the assignment " param = value " , where value could be NULL ; * for some params that has an effect such as inversion , for others * it does nothing . * * Adjusts the state of the formatting options at * popt . ( In practice that * is always pset . popt , but maybe someday it could be different . ) * * If successful and quiet is false , then invokes printPsetInfo ( ) to report * the change . * * Returns true if successful , else false ( eg for invalid param or value ) . bool const char *param, const char *value, printQueryOpt *popt, bool quiet)0 ;if (value)/* set format */ if (strcmp(param, "format" ) == 0 )static const struct fmtconst char *name;enum printFormat number;/* remember to update error message below when adding more */ "aligned" , PRINT_ALIGNED},"asciidoc" , PRINT_ASCIIDOC},"csv" , PRINT_CSV},"html" , PRINT_HTML},"latex" , PRINT_LATEX},"troff-ms" , PRINT_TROFF_MS},"unaligned" , PRINT_UNALIGNED},"wrapped" , PRINT_WRAPPED}if (!value)else int match_pos = -1 ;for (int i = 0 ; i < lengthof(formats); i++)if (pg_strncasecmp(formats[i].name, value, vallen) == 0 )if (match_pos < 0 )else "\\pset: ambiguous abbreviation \" %s\" matches both \" %s\" and \" %s\"" ,return false ;if (match_pos >= 0 )else if (pg_strncasecmp("latex-longtable" , value, vallen) == 0 )/* * We must treat latex - longtable specially because latex is a * prefix of it ; if both were in the table above , we ' d think * " latex " is ambiguous . else "\\pset: allowed formats are aligned, asciidoc, csv, html, latex, latex-longtable, troff-ms, unaligned, wrapped" );return false ;/* set table line style */ else if (strcmp(param, "linestyle" ) == 0 )if (!value)else if (pg_strncasecmp("ascii" , value, vallen) == 0 )else if (pg_strncasecmp("old-ascii" , value, vallen) == 0 )else if (pg_strncasecmp("unicode" , value, vallen) == 0 )else "\\pset: allowed line styles are ascii, old-ascii, unicode" );return false ;/* set unicode border line style */ else if (strcmp(param, "unicode_border_linestyle" ) == 0 )if (!value)else if (set_unicode_line_style(value, vallen,else "\\pset: allowed Unicode border line styles are single, double" );return false ;/* set unicode column line style */ else if (strcmp(param, "unicode_column_linestyle" ) == 0 )if (!value)else if (set_unicode_line_style(value, vallen,else "\\pset: allowed Unicode column line styles are single, double" );return false ;/* set unicode header line style */ else if (strcmp(param, "unicode_header_linestyle" ) == 0 )if (!value)else if (set_unicode_line_style(value, vallen,else "\\pset: allowed Unicode header line styles are single, double" );return false ;/* set border style/width */ else if (strcmp(param, "border" ) == 0 )if (value)/* set expanded/vertical mode */ else if (strcmp(param, "x" ) == 0 ||"expanded" ) == 0 ||"vertical" ) == 0 )if (value && pg_strcasecmp(value, "auto" ) == 0 )2 ;else if (value)bool on_off;if (ParseVariableBool(value, NULL, &on_off))1 : 0 ;else "on, off, auto" );return false ;else /* header line width in expanded mode */ else if (strcmp(param, "xheader_width" ) == 0 )if (!value)else if (pg_strcasecmp(value, "full" ) == 0 )else if (pg_strcasecmp(value, "column" ) == 0 )else if (pg_strcasecmp(value, "page" ) == 0 )else int intval = atoi(value);if (intval == 0 )"\\pset: allowed xheader_width values are \" %s\" (default), \" %s\", \" %s\", or a number specifying the exact width" , "full" , "column" , "page" );return false ;/* field separator for CSV format */ else if (strcmp(param, "csv_fieldsep" ) == 0 )if (value)/* CSV separator has to be a one-byte character */ if (strlen(value) != 1 )"\\pset: csv_fieldsep must be a single one-byte character" );return false ;if (value[0 ] == '"' || value[0 ] == '\n' || value[0 ] == '\r' )"\\pset: csv_fieldsep cannot be a double quote, a newline, or a carriage return" );return false ;0 ] = value[0 ];/* locale-aware numeric output */ else if (strcmp(param, "numericlocale" ) == 0 )if (value)return ParseVariableBool(value, param, &popt->topt.numericLocale);else /* null display */ else if (strcmp(param, "null" ) == 0 )if (value)/* field separator for unaligned text */ else if (strcmp(param, "fieldsep" ) == 0 )if (value)false ;else if (strcmp(param, "fieldsep_zero" ) == 0 )true ;/* record separator for unaligned text */ else if (strcmp(param, "recordsep" ) == 0 )if (value)false ;else if (strcmp(param, "recordsep_zero" ) == 0 )true ;/* toggle between full and tuples-only format */ else if (strcmp(param, "t" ) == 0 || strcmp(param, "tuples_only" ) == 0 )if (value)return ParseVariableBool(value, param, &popt->topt.tuples_only);else /* set title override */ else if (strcmp(param, "C" ) == 0 || strcmp(param, "title" ) == 0 )if (!value)else /* set HTML table tag options */ else if (strcmp(param, "T" ) == 0 || strcmp(param, "tableattr" ) == 0 )if (!value)else /* toggle use of pager */ else if (strcmp(param, "pager" ) == 0 )if (value && pg_strcasecmp(value, "always" ) == 0 )2 ;else if (value)bool on_off;if (!ParseVariableBool(value, NULL, &on_off))"on, off, always" );return false ;1 : 0 ;else if (popt->topt.pager == 1 )0 ;else 1 ;/* set minimum lines for pager use */ else if (strcmp(param, "pager_min_lines" ) == 0 )if (value &&"pager_min_lines" , &popt->topt.pager_min_lines))return false ;/* disable "(x rows)" footer */ else if (strcmp(param, "footer" ) == 0 )if (value)return ParseVariableBool(value, param, &popt->topt.default_footer);else /* set border style/width */ else if (strcmp(param, "columns" ) == 0 )if (value)else "\\pset: unknown option: %s" , param);return false ;if (!quiet)return true ;/* * printPsetInfo : print the state of the " param " formatting parameter in popt . static bool const char *param, printQueryOpt *popt)/* show border style/width */ if (strcmp(param, "border" ) == 0 )"Border style is %d.\n" ), popt->topt.border);/* show the target width for the wrapped format */ else if (strcmp(param, "columns" ) == 0 )if (!popt->topt.columns)"Target width is unset.\n" ));else "Target width is %d.\n" ), popt->topt.columns);/* show expanded/vertical mode */ else if (strcmp(param, "x" ) == 0 || strcmp(param, "expanded" ) == 0 || strcmp(param, "vertical" ) == 0 )if (popt->topt.expanded == 1 )"Expanded display is on.\n" ));else if (popt->topt.expanded == 2 )"Expanded display is used automatically.\n" ));else "Expanded display is off.\n" ));/* show xheader width value */ else if (strcmp(param, "xheader_width" ) == 0 )if (popt->topt.expanded_header_width_type == PRINT_XHEADER_FULL)"Expanded header width is \" %s\".\n" ), "full" );else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_COLUMN)"Expanded header width is \" %s\".\n" ), "column" );else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_PAGE)"Expanded header width is \" %s\".\n" ), "page" );else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_EXACT_WIDTH)"Expanded header width is %d.\n" ), popt->topt.expanded_header_exact_width);/* show field separator for CSV format */ else if (strcmp(param, "csv_fieldsep" ) == 0 )"Field separator for CSV is \" %s\".\n" ),/* show field separator for unaligned text */ else if (strcmp(param, "fieldsep" ) == 0 )if (popt->topt.fieldSep.separator_zero)"Field separator is zero byte.\n" ));else "Field separator is \" %s\".\n" ),else if (strcmp(param, "fieldsep_zero" ) == 0 )"Field separator is zero byte.\n" ));/* show disable "(x rows)" footer */ else if (strcmp(param, "footer" ) == 0 )if (popt->topt.default_footer)"Default footer is on.\n" ));else "Default footer is off.\n" ));/* show format */ else if (strcmp(param, "format" ) == 0 )"Output format is %s.\n" ), _align2string(popt->topt.format));/* show table line style */ else if (strcmp(param, "linestyle" ) == 0 )"Line style is %s.\n" ),/* show null display */ else if (strcmp(param, "null" ) == 0 )"Null display is \" %s\".\n" ),"" );/* show locale-aware numeric output */ else if (strcmp(param, "numericlocale" ) == 0 )if (popt->topt.numericLocale)"Locale-adjusted numeric output is on.\n" ));else "Locale-adjusted numeric output is off.\n" ));/* show toggle use of pager */ else if (strcmp(param, "pager" ) == 0 )if (popt->topt.pager == 1 )"Pager is used for long output.\n" ));else if (popt->topt.pager == 2 )"Pager is always used.\n" ));else "Pager usage is off.\n" ));/* show minimum lines for pager use */ else if (strcmp(param, "pager_min_lines" ) == 0 )"Pager won't be used for less than %d line.\n" ,"Pager won't be used for less than %d lines.\n" ,/* show record separator for unaligned text */ else if (strcmp(param, "recordsep" ) == 0 )if (popt->topt.recordSep.separator_zero)"Record separator is zero byte.\n" ));else if (strcmp(popt->topt.recordSep.separator, "\n" ) == 0 )"Record separator is <newline>.\n" ));else "Record separator is \" %s\".\n" ),else if (strcmp(param, "recordsep_zero" ) == 0 )"Record separator is zero byte.\n" ));/* show HTML table tag options */ else if (strcmp(param, "T" ) == 0 || strcmp(param, "tableattr" ) == 0 )if (popt->topt.tableAttr)"Table attributes are \" %s\".\n" ),else "Table attributes unset.\n" ));/* show title override */ else if (strcmp(param, "C" ) == 0 || strcmp(param, "title" ) == 0 )if (popt->title)"Title is \" %s\".\n" ), popt->title);else "Title is unset.\n" ));/* show toggle between full and tuples-only format */ else if (strcmp(param, "t" ) == 0 || strcmp(param, "tuples_only" ) == 0 )if (popt->topt.tuples_only)"Tuples only is on.\n" ));else "Tuples only is off.\n" ));/* Unicode style formatting */ else if (strcmp(param, "unicode_border_linestyle" ) == 0 )"Unicode border line style is \" %s\".\n" ),else if (strcmp(param, "unicode_column_linestyle" ) == 0 )"Unicode column line style is \" %s\".\n" ),else if (strcmp(param, "unicode_header_linestyle" ) == 0 )"Unicode header line style is \" %s\".\n" ),else "\\pset: unknown option: %s" , param);return false ;return true ;/* * savePsetInfo : make a malloc ' d copy of the data in * popt . * * Possibly this should be somewhere else , but it ' s a bit specific to psql . const printQueryOpt *popt)sizeof (printQueryOpt));/* Flat-copy all the scalar fields, then duplicate sub-structures. */ sizeof (printQueryOpt));/* topt.line_style points to const data that need not be duplicated */ if (popt->topt.fieldSep.separator)if (popt->topt.recordSep.separator)if (popt->topt.tableAttr)if (popt->nullPrint)if (popt->title)/* * footers and translate_columns are never set in psql ' s print settings , * so we needn ' t write code to duplicate them . return save;/* * restorePsetInfo : restore * popt from the previously - saved copy * save , * then free * save . void /* Free all the old data we're about to overwrite the pointers to. */ /* topt.line_style points to const data that need not be duplicated */ /* * footers and translate_columns are never set in psql ' s print settings , * so we needn ' t write code to duplicate them . /* Now we may flat-copy all the fields, including pointers. */ sizeof (printQueryOpt));/* Lastly, free "save" ... but its sub-structures now belong to popt. */ static const char *bool val)return val ? "on" : "off" ;static char *const char *str)char *ret = pg_malloc(strlen(str) * 2 + 3 );char *r = ret;'\' '; for (; *str; str++)if (*str == '\n' )'\\' ;'n' ;else if (*str == '\' ') '\\' ;'\' '; else '\' '; '\0' ;return ret;/* * Return a malloc ' ed string for the \ pset value . * * Note that for some string parameters , print . c distinguishes between unset * and empty string , but for others it doesn ' t . This function should produce * output that produces the correct setting when fed back into \ pset . static char *const char *param, printQueryOpt *popt)if (strcmp(param, "border" ) == 0 )return psprintf("%d" , popt->topt.border);else if (strcmp(param, "columns" ) == 0 )return psprintf("%d" , popt->topt.columns);else if (strcmp(param, "csv_fieldsep" ) == 0 )return pset_quoted_string(popt->topt.csvFieldSep);else if (strcmp(param, "expanded" ) == 0 )return pstrdup(popt->topt.expanded == 2 "auto" else if (strcmp(param, "fieldsep" ) == 0 )return pset_quoted_string(popt->topt.fieldSep.separator"" );else if (strcmp(param, "fieldsep_zero" ) == 0 )return pstrdup(pset_bool_string(popt->topt.fieldSep.separator_zero));else if (strcmp(param, "footer" ) == 0 )return pstrdup(pset_bool_string(popt->topt.default_footer));else if (strcmp(param, "format" ) == 0 )return pstrdup(_align2string(popt->topt.format));else if (strcmp(param, "linestyle" ) == 0 )return pstrdup(get_line_style(&popt->topt)->name);else if (strcmp(param, "null" ) == 0 )return pset_quoted_string(popt->nullPrint"" );else if (strcmp(param, "numericlocale" ) == 0 )return pstrdup(pset_bool_string(popt->topt.numericLocale));else if (strcmp(param, "pager" ) == 0 )return psprintf("%d" , popt->topt.pager);else if (strcmp(param, "pager_min_lines" ) == 0 )return psprintf("%d" , popt->topt.pager_min_lines);else if (strcmp(param, "recordsep" ) == 0 )return pset_quoted_string(popt->topt.recordSep.separator"" );else if (strcmp(param, "recordsep_zero" ) == 0 )return pstrdup(pset_bool_string(popt->topt.recordSep.separator_zero));else if (strcmp(param, "tableattr" ) == 0 )return popt->topt.tableAttr ? pset_quoted_string(popt->topt.tableAttr) : pstrdup("" );else if (strcmp(param, "title" ) == 0 )return popt->title ? pset_quoted_string(popt->title) : pstrdup("" );else if (strcmp(param, "tuples_only" ) == 0 )return pstrdup(pset_bool_string(popt->topt.tuples_only));else if (strcmp(param, "unicode_border_linestyle" ) == 0 )return pstrdup(_unicode_linestyle2string(popt->topt.unicode_border_linestyle));else if (strcmp(param, "unicode_column_linestyle" ) == 0 )return pstrdup(_unicode_linestyle2string(popt->topt.unicode_column_linestyle));else if (strcmp(param, "unicode_header_linestyle" ) == 0 )return pstrdup(_unicode_linestyle2string(popt->topt.unicode_header_linestyle));else if (strcmp(param, "xheader_width" ) == 0 )if (popt->topt.expanded_header_width_type == PRINT_XHEADER_FULL)return pstrdup("full" );else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_COLUMN)return pstrdup("column" );else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_PAGE)return pstrdup("page" );else /* must be PRINT_XHEADER_EXACT_WIDTH */ char wbuff[32 ];sizeof (wbuff), "%d" ,return pstrdup(wbuff);else return pstrdup("ERROR" );#ifndef WIN32#define DEFAULT_SHELL "/bin/sh" #else /* * CMD . EXE is in different places in different Win32 releases so we * have to rely on the path to find it . #define DEFAULT_SHELL "cmd.exe" #endif static bool const char *command)int result;if (!command)char *sys;const char *shellName;"SHELL" );#ifdef WIN32if (shellName == NULL)"COMSPEC" );#endif if (shellName == NULL)/* See EDITOR handling comment for an explanation */ #ifndef WIN32"exec %s" , shellName);#else "\" %s\"" , shellName);#endif else if (result == 127 || result == -1 )"\\!: failed" );return false ;return true ;/* * do_watch - - handler for \ watch * * We break this out of exec_command to avoid having to plaster " volatile " * onto a bunch of exec_command ' s variables to silence stupider compilers . * * " sleep " is the amount of time to sleep during each loop , measured in * seconds . The internals of this function should use " sleep_ms " for * precise sleep time calculations . static bool double sleep, int iter, int min_rows)long sleep_ms = (long ) (sleep * 1000 );const char *strftime_fmt;const char *user_title;char *title;const char *pagerprog = NULL;int title_len;int res = 0 ;bool done = false ;#ifndef WIN32struct itimerval interval;#endif if (!query_buf || query_buf->len <= 0 )"\\watch cannot be used with an empty query" );return false ;#ifndef WIN32/* * Block SIGALRM and SIGCHLD before we start the timer and the pager ( if * configured ) , to avoid races . sigwait ( ) will receive them . /* * Set a timer to interrupt sigwait ( ) so we can run the query at the * requested intervals . 1000 ;1000 ) * 1000 ;if (setitimer(ITIMER_REAL, &interval, NULL) < 0 )"could not set timer: %m" );true ;#endif /* * For \ watch , we ignore the size of the result and always use the pager * as long as we ' re talking to a terminal and " \ pset pager " is enabled . * However , we ' ll only use the pager identified by PSQL_WATCH_PAGER . We * ignore the regular PSQL_PAGER or PAGER environment variables , because * traditional pagers probably won ' t be very useful for showing a stream * of results . #ifndef WIN32"PSQL_WATCH_PAGER" );/* if variable is empty or all-white-space, don't use pager */ if (pagerprog && strspn(pagerprog, " \t\r\n" ) == strlen(pagerprog))#endif if (pagerprog && myopt.topt.pager &&"w" );if (!pagerpipe)/* silently proceed without pager */ /* * Choose format for timestamps . We might eventually make this a \ pset * option . In the meantime , using a variable for the format suppresses * overly - anal - retentive gcc warnings about % c being Y2K sensitive . "%c" ;/* * Set up rendering options , in particular , disable the pager unless * PSQL_WATCH_PAGER was successfully launched . if (!pagerpipe)0 ;/* * If there ' s a title in the user configuration , make sure we have room * for it in the title buffer . Allow 128 bytes for the timestamp plus 128 * bytes for the rest . 0 ) + 256 ;/* Loop to run query and then sleep awhile */ while (!done)char timebuf[128 ];/* * Prepare title for output . Note that we intentionally include a * newline at the end of the title ; this is somewhat historical but it * makes for reasonably nicely formatted output in simple cases . sizeof (timebuf), strftime_fmt, localtime(&timer));if (user_title)"%s\t%s (every %gs)\n" ),1000 .0 );else "%s (every %gs)\n" ),1000 .0 );/* Run the query and print out the result */ /* * PSQLexecWatch handles the case where we can no longer repeat the * query , and returns 0 or - 1 . if (res <= 0 )break ;/* If we have iteration count, check that it's not exceeded yet */ if (iter && (--iter <= 0 ))break ;/* Quit if error on pager pipe (probably pager has quit) */ if (pagerpipe && ferror(pagerpipe))break ;/* Tight loop, no wait needed */ if (sleep_ms == 0 )continue ;#ifdef WIN32/* * Wait a while before running the query again . Break the sleep into * short intervals ( at most 1 s ) ; that ' s probably unnecessary since * pg_usleep is interruptible on Windows , but it ' s cheap insurance . for (long i = sleep_ms; i > 0 ;)long s = Min(i, 1000 L);1000 L);if (cancel_pressed)true ;break ;#else /* sigwait() will handle SIGINT. */ if (cancel_pressed)true ;/* Wait for SIGINT, SIGCHLD or SIGALRM. */ while (!done)int signal_received;if (errno != 0 )/* Some other signal arrived? */ if (errno == EINTR)continue ;else "could not wait for signals: %m" );true ;break ;/* On ^C or pager exit, it's time to stop running the query. */ if (signal_received == SIGINT || signal_received == SIGCHLD)true ;/* Otherwise, we must have SIGALRM. Time to run the query again. */ break ;/* Unblock SIGINT so that slow queries can be interrupted. */ #endif if (pagerpipe)else /* * If the terminal driver echoed " ^ C " , libedit / libreadline might be * confused about the cursor position . Therefore , inject a newline * before the next prompt is displayed . We only do this when not * using a pager , because pagers are expected to restore the screen to * a sane state on exit . "\n" );#ifndef WIN32/* Disable the interval timer. */ 0 , sizeof (interval));/* Unblock SIGINT, SIGCHLD and SIGALRM. */ #endif return (res >= 0 );/* * a little code borrowed from PSQLexec ( ) to manage ECHO_HIDDEN output . * returns true unless we have ECHO_HIDDEN_NOEXEC . static bool const char *query)if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)"/******** QUERY *********/\n" "%s\n" "/************************/\n\n"), query); if (pset.logfile)"/******** QUERY *********/\n" "%s\n" "/************************/\n\n"), query); if (pset.echo_hidden == PSQL_ECHO_HIDDEN_NOEXEC)return false ;return true ;/* * Look up the object identified by obj_type and desc . If successful , * store its OID in * obj_oid and return true , else return false . * * Note that we ' ll fail if the object doesn ' t exist OR if there are multiple * matching candidates OR if there ' s something syntactically wrong with the * object description ; unfortunately it can be hard to tell the difference . static bool const char *desc,bool result = true ;switch (obj_type)case EditableFunction:/* * We have a function description , e . g . " x " or " x ( int ) " . Issue a * query to retrieve the function ' s OID using a cast to regproc or * regprocedure ( as appropriate ) . "SELECT " );"::pg_catalog.%s::pg_catalog.oid" ,'(' ) ? "regprocedure" : "regproc" );break ;case EditableView:/* * Convert view name ( possibly schema - qualified ) to OID . Note : * this code doesn ' t check if the relation is actually a view . * We ' ll detect that in get_create_object_cmd ( ) . "SELECT " );"::pg_catalog.regclass::pg_catalog.oid" );break ;if (!echo_hidden_command(query->data))return false ;if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1 )0 , 0 ));else false ;return result;/* * Construct a " CREATE OR REPLACE . . . " command that describes the specified * database object . If successful , the result is stored in buf . static bool bool result = true ;switch (obj_type)case EditableFunction:"SELECT pg_catalog.pg_get_functiondef(%u)" ,break ;case EditableView:/* * pg_get_viewdef ( ) just prints the query , so we must prepend * CREATE for ourselves . We must fully qualify the view name to * ensure the right view gets replaced . Also , check relation kind * to be sure it ' s a view . * * Starting with PG 9 . 4 , views may have WITH [ LOCAL | CASCADED ] * CHECK OPTION . These are not part of the view definition * returned by pg_get_viewdef ( ) and so need to be retrieved * separately . Materialized views ( introduced in 9 . 3 ) may have * arbitrary storage parameter reloptions . if (pset.sversion >= 90400 )"SELECT nspname, relname, relkind, " "pg_catalog.pg_get_viewdef(c.oid, true), " "pg_catalog.array_remove(pg_catalog.array_remove(c.reloptions,'check_option=local'),'check_option=cascaded') AS reloptions, " "CASE WHEN 'check_option=local' = ANY (c.reloptions) THEN 'LOCAL'::text " "WHEN 'check_option=cascaded' = ANY (c.reloptions) THEN 'CASCADED'::text ELSE NULL END AS checkoption " "FROM pg_catalog.pg_class c " "LEFT JOIN pg_catalog.pg_namespace n " "ON c.relnamespace = n.oid WHERE c.oid = %u" ,else "SELECT nspname, relname, relkind, " "pg_catalog.pg_get_viewdef(c.oid, true), " "c.reloptions AS reloptions, " "NULL AS checkoption " "FROM pg_catalog.pg_class c " "LEFT JOIN pg_catalog.pg_namespace n " "ON c.relnamespace = n.oid WHERE c.oid = %u" ,break ;if (!echo_hidden_command(query->data))return false ;if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1 )switch (obj_type)case EditableFunction:0 , 0 ));break ;case EditableView:char *nspname = PQgetvalue(res, 0 , 0 );char *relname = PQgetvalue(res, 0 , 1 );char *relkind = PQgetvalue(res, 0 , 2 );char *viewdef = PQgetvalue(res, 0 , 3 );char *reloptions = PQgetvalue(res, 0 , 4 );char *checkoption = PQgetvalue(res, 0 , 5 );/* * If the backend ever supports CREATE OR REPLACE * MATERIALIZED VIEW , allow that here ; but as of today it * does not , so editing a matview definition in this way * is impossible . switch (relkind[0 ])#ifdef NOT_USEDcase RELKIND_MATVIEW:"CREATE OR REPLACE MATERIALIZED VIEW " );break ;#endif case RELKIND_VIEW:"CREATE OR REPLACE VIEW " );break ;default :"\" %s.%s\" is not a view" ,false ;break ;"%s." , fmtId(nspname));/* reloptions, if not an empty array "{}" */ if (reloptions != NULL && strlen(reloptions) > 2 )"\n WITH (" );if (!appendReloptionsArray(buf, reloptions, "" ,"could not parse reloptions array" );false ;')' );/* View definition from pg_get_viewdef (a SELECT query) */ " AS\n%s" , viewdef);/* Get rid of the semicolon that pg_get_viewdef appends */ if (buf->len > 0 && buf->data[buf->len - 1 ] == ';' )'\0' ;/* WITH [LOCAL|CASCADED] CHECK OPTION */ if (checkoption && checkoption[0 ] != '\0' )"\n WITH %s CHECK OPTION" ,break ;/* Make sure result ends with a newline */ if (buf->len > 0 && buf->data[buf->len - 1 ] != '\n' )'\n' );else false ;return result;/* * If the given argument of \ ef or \ ev ends with a line number , delete the line * number from the argument string and return it as an integer . ( We need * this kluge because we ' re too lazy to parse \ ef ' s function or \ ev ' s view * argument carefully - - - we just slop it up in OT_WHOLE_LINE mode . ) * * Returns - 1 if no line number is present , 0 on error , or a positive value * on success . static int char *obj)char *c;int lineno;if (!obj || obj[0 ] == '\0' )return -1 ;1 ;/* * This business of parsing backwards is dangerous as can be in a * multibyte environment : there is no reason to believe that we are * looking at the first byte of a character , nor are we necessarily * working in a " safe " encoding . Fortunately the bitpatterns we are * looking for are unlikely to occur as non - first bytes , but beware of * trying to expand the set of cases that can be recognized . We must * guard the < ctype . h > macros by using isascii ( ) first , too . /* skip trailing whitespace */ while (c > obj && isascii((unsigned char ) *c) && isspace((unsigned char ) *c))/* must have a digit as last non-space char */ if (c == obj || !isascii((unsigned char ) *c) || !isdigit((unsigned char ) *c))return -1 ;/* find start of digit string */ while (c > obj && isascii((unsigned char ) *c) && isdigit((unsigned char ) *c))/* digits must be separated from object name by space or closing paren */ /* notice also that we are not allowing an empty object name ... */ if (c == obj || !isascii((unsigned char ) *c) ||unsigned char ) *c) || *c == ')' ))return -1 ;/* parse digit string */ if (lineno < 1 )"invalid line number: %s" , c);return 0 ;/* strip digit string from object name */ '\0' ;return lineno;/* * Count number of lines in the buffer . * This is used to test if pager is needed or not . static int int lineno = 0 ;const char *lines = buf->data;while (*lines != '\0' )/* find start of next line */ '\n' );if (!lines)break ;return lineno;/* * Write text at * lines to output with line numbers . * * For functions , lineno " 1 " should correspond to the first line of the * function body ; lines before that are unnumbered . We expect that * pg_get_functiondef ( ) will emit that on a line beginning with " AS " , * " BEGIN " , or " RETURN " , and that there can be no such line before * the real start of the function body . * * Caution : this scribbles on * lines . static void char *lines, bool is_func)bool in_header = is_func;int lineno = 0 ;while (*lines != '\0' )char *eol;if (in_header &&"AS " , 3 ) == 0 ||"BEGIN " , 6 ) == 0 ||"RETURN " , 7 ) == 0 ))false ;/* increment lineno only for body's lines */ if (!in_header)/* find and mark end of current line */ '\n' );if (eol != NULL)'\0' ;/* show current line as appropriate */ if (in_header)" %s\n" , lines);else "%-7d %s\n" , lineno, lines);/* advance to next line, if any */ if (eol == NULL)break ;/* * Report just the primary error ; this is to avoid cluttering the output * with , for instance , a redisplay of the internally generated query static void const char *fld;if (fld)"%s: " , fld);else "ERROR: " );if (fld)else "(not available)" );'\n' );"%s" , msg->data); Messung V0.5 in Prozent C=94 H=98 G=95
¤ Dauer der Verarbeitung: 0.212 Sekunden
(vorverarbeitet am 2026-08-07)
¤ *© Formatika GbR, Deutschland
