Vsql command line options in Vertica

We will see some options parameters that can be used with Vertica vsql client utility The basic syntax is :

vsql [OPTIONS]... [DBNAME [USERNAME]]
General options:
  • -d DBNAME specify database name to connect to (default: "dbadmin")
  • -c COMMAND run only single command (SQL or internal) and exit
  • -f FILENAME execute commands from file, then exit
  • -l list available databases, then exit
  • -v NAME=VALUE set vsql variable NAME to VALUE
  • -X do not read startup file (~/.vsqlrc)
  • --help show this help, then exit
  • --version output version information, then exit
Input and output options:
  • -a echo all input from script
  • -e echo commands sent to server
  • -E display queries that internal commands generate
  • -q run quietly (no messages, only query output)
  • -o FILENAME send query results to file (or |pipe)
  • -n disable enhanced command line editing (readline)
  • -s single-step mode (confirm each query)
  • -S single-line mode (end of line terminates SQL command)
Output format options:
  • -A unaligned table output mode (-P format=unaligned)
  • -b beep on command completion
  • -H HTML table output mode (-P format=html)
  • -t print rows only (-P tuples_only)
  • -T TEXT set HTML table tag attributes (width, border) (-P tableattr=)
  • -x turn on expanded table output (-P expanded)
  • -P VAR[=ARG] set printing option VAR to ARG (see pset command)
  • -F STRING set field separator for unaligned output (default: "|") (-P fieldsep=)
  • -R STRING set record separator (default: newline) (-P recordsep=)
Connection options:
  • -h HOSTNAME database server host or socket directory (default: "local socket")
  • -p PORT database server port (default: "5433")
  • -U NAME database user name (default: "dbadmin")
  • -W prompt for password (should happen automatically)
  • -w PASSWORD database user's password
For examples on how we can write scripts that can be used as the Vsql command line in the next tutorial.