summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorIrina Truong <i.chernyavska@gmail.com>2021-02-12 21:09:38 -0800
committerGitHub <noreply@github.com>2021-02-12 21:09:38 -0800
commita3287c4ab2cea5ba5bef495e1174b12c3b2ae084 (patch)
tree2f9ebfe6f6312ad6c7b37ee8b17233ff72d1ed2f /README.rst
parent762fb4b8da98fdf6792e6c5586060ed37224f894 (diff)
Finer control over destructive warning. (#1242)
* Finer control over destructive warning. * Review feedback. * Changelog. * Run integration tests with --warn=moderate. * Fix typo. * Black.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst52
1 files changed, 26 insertions, 26 deletions
diff --git a/README.rst b/README.rst
index d5934274..1fa4e7f5 100644
--- a/README.rst
+++ b/README.rst
@@ -62,32 +62,32 @@ For more details:
Usage: pgcli [OPTIONS] [DBNAME] [USERNAME]
Options:
- -h, --host TEXT Host address of the postgres database.
- -p, --port INTEGER Port number at which the postgres instance is
- listening.
- -U, --username TEXT Username to connect to the postgres database.
- -u, --user TEXT Username to connect to the postgres database.
- -W, --password Force password prompt.
- -w, --no-password Never prompt for password.
- --single-connection Do not use a separate connection for completions.
- -v, --version Version of pgcli.
- -d, --dbname TEXT database name to connect to.
- --pgclirc PATH Location of pgclirc file.
- -D, --dsn TEXT Use DSN configured into the [alias_dsn] section of
- pgclirc file.
- --list-dsn list of DSN configured into the [alias_dsn] section
- of pgclirc file.
- --row-limit INTEGER Set threshold for row limit prompt. Use 0 to disable
- prompt.
- --less-chatty Skip intro on startup and goodbye on exit.
- --prompt TEXT Prompt format (Default: "\u@\h:\d> ").
- --prompt-dsn TEXT Prompt format for connections using DSN aliases
- (Default: "\u@\h:\d> ").
- -l, --list list available databases, then exit.
- --auto-vertical-output Automatically switch to vertical output mode if the
- result is wider than the terminal width.
- --warn / --no-warn Warn before running a destructive query.
- --help Show this message and exit.
+ -h, --host TEXT Host address of the postgres database.
+ -p, --port INTEGER Port number at which the postgres instance is
+ listening.
+ -U, --username TEXT Username to connect to the postgres database.
+ -u, --user TEXT Username to connect to the postgres database.
+ -W, --password Force password prompt.
+ -w, --no-password Never prompt for password.
+ --single-connection Do not use a separate connection for completions.
+ -v, --version Version of pgcli.
+ -d, --dbname TEXT database name to connect to.
+ --pgclirc FILE Location of pgclirc file.
+ -D, --dsn TEXT Use DSN configured into the [alias_dsn] section
+ of pgclirc file.
+ --list-dsn list of DSN configured into the [alias_dsn]
+ section of pgclirc file.
+ --row-limit INTEGER Set threshold for row limit prompt. Use 0 to
+ disable prompt.
+ --less-chatty Skip intro on startup and goodbye on exit.
+ --prompt TEXT Prompt format (Default: "\u@\h:\d> ").
+ --prompt-dsn TEXT Prompt format for connections using DSN aliases
+ (Default: "\u@\h:\d> ").
+ -l, --list list available databases, then exit.
+ --auto-vertical-output Automatically switch to vertical output mode if
+ the result is wider than the terminal width.
+ --warn [all|moderate|off] Warn before running a destructive query.
+ --help Show this message and exit.
``pgcli`` also supports many of the same `environment variables`_ as ``psql`` for login options (e.g. ``PGHOST``, ``PGPORT``, ``PGUSER``, ``PGPASSWORD``, ``PGDATABASE``).