我们支持乌克兰

乌克兰人民正在为他们的国家而战。许多平民、妇女和儿童正在遭受苦难。数百人被杀害和受伤,数千人流离失所。

这是我家乡哈尔科夫的一张图片。这个地方就在老城中心。

.. image:: screenshots/kharkiv-destroyed.jpg

照片由@fomenko_ph (Telegram)提供。

请考虑捐款或志愿服务。

Postgres的REPL

这是一个具有自动完成和语法高亮功能的postgres客户端。

主页: http://pgcli.com

MySQL等效工具: http://mycli.net

.. image:: screenshots/pgcli.gif .. image:: screenshots/image01.png

快速开始

如果你已经知道如何安装Python包,那么你可以简单地执行:

$ pip install -U pgcli

或

$ sudo apt-get install pgcli # 仅适用于基于Debian的Linux(如Ubuntu、Mint等)
$ brew install pgcli  # 仅适用于macOS

如果你不知道如何安装Python包,请查看详细说明_。

.. _详细说明: https://github.com/dbcli/pgcli#detailed-installation-instructions

用法

$ pgcli [数据库名称]

或

$ pgcli postgresql://[用户名[:密码]@][主机][:端口][/数据库名][?额外参数=值[&其他参数=其他值]]

示例:

$ pgcli local_database

$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db?sslmode=verify-ca&sslrootcert=/myrootcert

更多详情:

$ pgcli --help

用法: pgcli [选项] [数据库名称] [用户名]

选项:
  -h, --host TEXT            postgres数据库的主机地址。
  -p, --port INTEGER         postgres实例监听的端口号。
  -U, --username TEXT        连接postgres数据库的用户名。
  -u, --user TEXT            连接postgres数据库的用户名。
  -W, --password             强制密码提示。
  -w, --no-password          永不提示密码。
  --single-connection        不为补全使用单独的连接。
  -v, --version              pgcli的版本。
  -d, --dbname TEXT          要连接的数据库名称。
  --pgclirc FILE             pgclirc文件的位置。
  -D, --dsn TEXT             使用pgclirc文件[alias_dsn]部分中配置的DSN。
  --list-dsn                 列出pgclirc文件[alias_dsn]部分中配置的DSN。
  --row-limit INTEGER        设置行数限制提示的阈值。使用0禁用提示。
  --less-chatty              启动时跳过介绍,退出时跳过再见。
  --prompt TEXT              提示格式(默认: "\u@\h:\d> ")。
  --prompt-dsn TEXT          使用DSN别名连接时的提示格式(默认: "\u@\h:\d> ")。
  -l, --list                 列出可用的数据库,然后退出。
  --auto-vertical-output     如果结果宽度超过终端宽度,自动切换到垂直输出模式。
  --warn [all|moderate|off]  在运行破坏性查询之前发出警告。
  --help                     显示此消息并退出。

pgcli还支持许多与psql相同的环境变量_用于登录选项(例如PGHOST、PGPORT、PGUSER、PGPASSWORD、PGDATABASE)。

也支持SSL相关的环境变量,因此如果你需要通过SSL连接连接postgres数据库,你可以这样设置环境:

export PGSSLMODE="verify-full"
export PGSSLCERT="/your-path-to-certs/client.crt"
export PGSSLKEY="/your-path-to-keys/client.key"
export PGSSLROOTCERT="/your-path-to-ca/ca.crt"
pgcli -h localhost -p 5432 -U username postgres

.. _环境变量: https://www.postgresql.org/docs/current/libpq-envars.html

特性

pgcli使用prompt_toolkit_编写。

在你输入SQL关键字以及数据库中的表和列时自动完成。
使用Pygments进行语法高亮。
智能补全(默认启用)将提供上下文相关的补全。
- SELECT * FROM <tab>将只显示表名。
- SELECT * FROM users WHERE <tab>将只显示列名。
对psql反斜杠命令的基本支持。
美化表格数据输出。

.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit .. _tabulate: https://pypi.python.org/pypi/tabulate

配置

首次启动时,会在~/.config/pgcli/config自动创建一个配置文件。查看文件本身以了解所有可用选项的说明。

贡献:

如果你有兴趣为这个项目做出贡献,首先我想表达我衷心的感谢。我写了一个小文档来描述如何在开发设置中运行它。

https://github.com/dbcli/pgcli/blob/master/DEVELOP.rst

如果你需要帮助,请随时联系我们。

Amjith, pgcli作者: amjith.r@gmail.com, Twitter: @amjithr <http://twitter.com/amjithr>_
Irina, pgcli维护者: i.chernyavska@gmail.com, Twitter: @irinatruong <http://twitter.com/irinatruong>_

详细安装说明:

macOS:

安装pgcli最简单的方法是使用Homebrew。

$ brew install pgcli

完成!

或者,你可以使用名为pip的包管理器将pgcli作为Python包安装。为此,你需要在系统上安装postgres。

pip的深入入门指南 - https://pip.pypa.io/en/latest/installation/

$ which pip

如果已安装,你可以执行:

$ pip install pgcli

如果由于权限问题而失败,你可能需要以sudo权限运行命令。

$ sudo pip install pgcli

如果未安装pip,请检查系统上是否有easy_install。

$ which easy_install

$ sudo easy_install pgcli

Linux:

pip的深入入门指南 - https://pip.pypa.io/en/latest/installation/

检查系统中是否已有pip。

$ which pip

如果不存在,使用你的Linux包管理器安装pip。这可能看起来像:

$ sudo apt-get install python-pip   # Debian, Ubuntu, Mint等

或

$ sudo yum install python-pip  # RHEL, Centos, Fedora等

pgcli需要python-dev、libpq-dev和libevent-dev包。你可以通过操作系统的包管理器安装这些包。

$ sudo apt-get install python-dev libpq-dev libevent-dev

或

$ sudo yum install python-devel postgresql-devel

然后你可以安装pgcli:

$ sudo pip install pgcli

Docker

可以在Docker中运行Pgcli。这对于尝试pgcli而无需在系统范围内安装它或任何依赖项很有用。

要构建镜像:

$ docker build -t pgcli .

要从镜像创建容器:

$ docker run --rm -ti pgcli pgcli <参数>

要访问监听localhost的postgresql数据库,请确保在"主机网络模式"下运行docker。例如,要访问在localhost:5432(标准端口)上运行的postgresql服务器上名为"foo"的数据库:

$ docker run --rm -ti --net host pgcli pgcli -h localhost foo

要连接到本地运行的实例通过unix套接字,将套接字绑定到docker容器:

$ docker run --rm -ti -v /var/run/postgres:/var/run/postgres pgcli pgcli foo

IPython

可以从IPython <https://ipython.org>_控制台运行Pgcli。在处理查询时,可能有用的是在不离开IPython控制台的情况下进入pgcli会话,迭代查询,然后退出pgcli以在IPython工作空间中找到查询结果。

假设你已安装IPython:

$ pip install ipython-sql

之后，运行 ipython 并加载 pgcli.magic 扩展：

$ ipython

In [1]: %load_ext pgcli.magic

连接到数据库并构建查询：

In [2]: %pgcli postgres://someone@localhost:5432/world
已连接：someone@world
someone@localhost:world> select * from city c where countrycode = 'USA' and population > 1000000;
+------+--------------+---------------+--------------+--------------+
| id   | name         | countrycode   | district     | population   |
|------+--------------+---------------+--------------+--------------|
| 3793 | New York     | USA           | New York     | 8008278      |
| 3794 | Los Angeles  | USA           | California   | 3694820      |
| 3795 | Chicago      | USA           | Illinois     | 2896016      |
| 3796 | Houston      | USA           | Texas        | 1953631      |
| 3797 | Philadelphia | USA           | Pennsylvania | 1517550      |
| 3798 | Phoenix      | USA           | Arizona      | 1321045      |
| 3799 | San Diego    | USA           | California   | 1223400      |
| 3800 | Dallas       | USA           | Texas        | 1188580      |
| 3801 | San Antonio  | USA           | Texas        | 1144646      |
+------+--------------+---------------+--------------+--------------+
选中 9 行
用时：0.003秒

使用 Ctrl + D 退出 pgcli 会话并查看查询结果：

someone@localhost:world>
再见！
影响了 9 行。
Out[2]:
[(3793, u'New York', u'USA', u'New York', 8008278),
 (3794, u'Los Angeles', u'USA', u'California', 3694820),
 (3795, u'Chicago', u'USA', u'Illinois', 2896016),
 (3796, u'Houston', u'USA', u'Texas', 1953631),
 (3797, u'Philadelphia', u'USA', u'Pennsylvania', 1517550),
 (3798, u'Phoenix', u'USA', u'Arizona', 1321045),
 (3799, u'San Diego', u'USA', u'California', 1223400),
 (3800, u'Dallas', u'USA', u'Texas', 1188580),
 (3801, u'San Antonio', u'USA', u'Texas', 1144646)]

结果可在特殊的本地变量 _ 中获取，并可以赋值给你选择的变量：

In [3]: my_result = _

从 4.0.0 版本开始，Pgcli 不再支持 Python<3.8。如果你需要，请安装 pgcli <= 4.0.0。

致谢：

特别感谢 Jonathan Slenders <https://twitter.com/jonathan_s>_ 创建了 Python Prompt Toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>_，这个库是使本应用成为可能的核心支柱。Jonathan 在本应用开发过程中还提供了宝贵的反馈和支持。

Click <http://click.pocoo.org/>_ 用于命令行选项解析和打印错误消息。

感谢 psycopg <https://www.psycopg.org/>_ 提供了与 Postgres 数据库的稳固接口。

感谢所有 beta 测试者和贡献者的时间和耐心。:)

.. |Build Status| image:: https://github.com/dbcli/pgcli/actions/workflows/ci.yml/badge.svg?branch=main :target: https://github.com/dbcli/pgcli/actions/workflows/ci.yml

.. |CodeCov| image:: https://codecov.io/gh/dbcli/pgcli/branch/master/graph/badge.svg :target: https://codecov.io/gh/dbcli/pgcli :alt: 代码覆盖率报告

.. |Landscape| image:: https://landscape.io/github/dbcli/pgcli/master/landscape.svg?style=flat :target: https://landscape.io/github/dbcli/pgcli/master :alt: 代码健康度

.. |PyPI| image:: https://img.shields.io/pypi/v/pgcli.svg :target: https://pypi.python.org/pypi/pgcli/ :alt: 最新版本

.. |netlify| image:: https://api.netlify.com/api/v1/badges/3a0a14dd-776d-445d-804c-3dd74fe31c4e/deploy-status :target: https://app.netlify.com/sites/pgcli/deploys :alt: Netlify