summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-09-06 04:17:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-09-06 04:17:24 +0000
commit9b77fda0d4171f68760c070895dc5700cb6d1e0f (patch)
tree37912945e9d35ef62e5a4a1eb07ac224307e5db6 /README.rst
parentReleasing debian version 3.1.0-3. (diff)
downloadpgcli-9b77fda0d4171f68760c070895dc5700cb6d1e0f.tar.xz
pgcli-9b77fda0d4171f68760c070895dc5700cb6d1e0f.zip
Merging upstream version 3.2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--README.rst62
1 files changed, 29 insertions, 33 deletions
diff --git a/README.rst b/README.rst
index d593427..95137f7 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
A REPL for Postgres
-------------------
-|Build Status| |CodeCov| |PyPI| |Landscape| |Gitter|
+|Build Status| |CodeCov| |PyPI| |Landscape|
This is a postgres client that does auto-completion and syntax highlighting.
@@ -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``).
@@ -352,8 +352,8 @@ interface to Postgres database.
Thanks to all the beta testers and contributors for your time and patience. :)
-.. |Build Status| image:: https://api.travis-ci.org/dbcli/pgcli.svg?branch=master
- :target: https://travis-ci.org/dbcli/pgcli
+.. |Build Status| image:: https://github.com/dbcli/pgcli/workflows/pgcli/badge.svg
+ :target: https://github.com/dbcli/pgcli/actions?query=workflow%3Apgcli
.. |CodeCov| image:: https://codecov.io/gh/dbcli/pgcli/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dbcli/pgcli
@@ -366,7 +366,3 @@ Thanks to all the beta testers and contributors for your time and patience. :)
.. |PyPI| image:: https://img.shields.io/pypi/v/pgcli.svg
:target: https://pypi.python.org/pypi/pgcli/
:alt: Latest Version
-
-.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
- :target: https://gitter.im/dbcli/pgcli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
- :alt: Gitter Chat