mycli

迈克利

MySQL 的命令行客户端，可以自动完成和语法突出显示。

主页：http://mycli.net 文档：http://mycli.net/docs

Postgres 等效项：http://pgcli.com

快速入门

如果你已经知道如何安装 python 包，那么你可以通过 pip 安装它：

您可能需要在 Linux 上使用 sudo。

 $ pip install -U mycli

或者

 $ brew update && brew install mycli  # Only on macOS

或者

 $ sudo apt-get install mycli # Only on debian or ubuntu

用法

 $ mycli --help
Usage: mycli [OPTIONS] [DATABASE]

  A MySQL terminal client with auto-completion and syntax highlighting.

  Examples:
    - mycli my_database
    - mycli -u my_user -h my_host.com my_database
    - mycli mysql://my_user@my_host.com:3306/my_database

Options:
  -h, --host TEXT               Host address of the database.
  -P, --port INTEGER            Port number to use for connection. Honors
                                $MYSQL_TCP_PORT.

  -u, --user TEXT               User name to connect to the database.
  -S, --socket TEXT             The socket file to use for connection.
  -p, --password TEXT           Password to connect to the database.
  --pass TEXT                   Password to connect to the database.
  --ssh-user TEXT               User name to connect to ssh server.
  --ssh-host TEXT               Host name to connect to ssh server.
  --ssh-port INTEGER            Port to connect to ssh server.
  --ssh-password TEXT           Password to connect to ssh server.
  --ssh-key-filename TEXT       Private key filename (identify file) for the
                                ssh connection.

  --ssh-config-path TEXT        Path to ssh configuration.
  --ssh-config-host TEXT        Host to connect to ssh server reading from ssh
                                configuration.

  --ssl                         Enable SSL for connection (automatically
                                enabled with other flags).
  --ssl-ca PATH                 CA file in PEM format.
  --ssl-capath TEXT             CA directory.
  --ssl-cert PATH               X509 cert in PEM format.
  --ssl-key PATH                X509 key in PEM format.
  --ssl-cipher TEXT             SSL cipher to use.
  --tls-version [TLSv1|TLSv1.1|TLSv1.2|TLSv1.3]
                                TLS protocol version for secure connection.

  --ssl-verify-server-cert      Verify server's "Common Name" in its cert
                                against hostname used when connecting. This
                                option is disabled by default.

  -V, --version                 Output mycli's version.
  -v, --verbose                 Verbose output.
  -D, --database TEXT           Database to use.
  -d, --dsn TEXT                Use DSN configured into the [alias_dsn]
                                section of myclirc file.

  --list-dsn                    list of DSN configured into the [alias_dsn]
                                section of myclirc file.

  --list-ssh-config             list ssh configurations in the ssh config
                                (requires paramiko).

  -R, --prompt TEXT             Prompt format (Default: "t u@h:d> ").
  -l, --logfile FILENAME        Log every query and its results to a file.
  --defaults-group-suffix TEXT  Read MySQL config groups with the specified
                                suffix.

  --defaults-file PATH          Only read MySQL options from the given file.
  --myclirc PATH                Location of myclirc file.
  --auto-vertical-output        Automatically switch to vertical output mode
                                if the result is wider than the terminal
                                width.

  -t, --table                   Display batch output in table format.
  --csv                         Display batch output in CSV format.
  --warn / --no-warn            Warn before running a destructive query.
  --local-infile BOOLEAN        Enable/disable LOAD DATA LOCAL INFILE.
  -g, --login-path TEXT         Read this path from the login file.
  -e, --execute TEXT            Execute command and quit.
  --init-command TEXT           SQL statement to execute after connecting.
  --charset TEXT                Character set for MySQL session.
  --password-file PATH          File or FIFO path containing the password
                                to connect to the db if not specified otherwise
  --help                        Show this message and exit.

特征

mycli是使用prompt_toolkit 编写的。

• 当您键入 SQL 关键字以及数据库中的表、视图和列时自动完成。
• 使用 Pygments 进行语法高亮显示。
• 智能完成（默认启用）将建议上下文相关的完成。
  • SELECT * FROM <tab>将仅显示表名称。
  • SELECT * FROM users WHERE <tab>将仅显示列名称。
• 支持多行查询。
• 带有可选位置参数的收藏夹查询。使用fs alias query保存查询，并在需要时使用f alias执行它。
• sql语句和表渲染的时序。
• 首次启动时，配置文件会在~/.myclirc中自动创建。
• 将每个查询及其结果记录到文件中（默认情况下禁用）。
• 漂亮地打印表格数据（带颜色！）
• 支持 SSL 连接
• 某些功能仅作为键绑定公开

贡献：

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

https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md

如果您需要帮助，请随时与我联系。

我的电子邮件：[email protected]

推特：@amjithr

详细安装说明：

拱门，曼扎罗

您可以安装 AUR 中提供的 mycli 软件包：

 $ yay -S mycli

Debian、Ubuntu

在 Debian、Ubuntu 发行版上，您可以使用 apt 轻松安装 mycli 软件包：

 $ sudo apt-get install mycli

软呢帽

Fedora 有一个可用于 mycli 的软件包，使用 dnf 安装它：

 $ sudo dnf install mycli

视窗

请按照此博文中的说明进行操作：http://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/

谢谢：

该项目是通过 kickstarter 资助的。我感谢支持该项目的支持者。

特别感谢 Jonathan Slenders 创建了 Python Prompt Toolkit，它实际上是骨干库，使这个应用程序成为可能。乔纳森还在该应用程序的开发过程中提供了宝贵的反馈和支持。

Click 用于命令行选项解析和打印错误消息。

感谢 PyMysql 为 MySQL 数据库提供了纯 Python 适配器。

兼容性

Mycli 在 macOS 和 Linux 上进行了测试，需要 Python 3.7 或更高版本。

Mycli 未在 Windows 上进行测试，但此应用程序中使用的库与 Windows 兼容。这意味着它应该无需任何修改即可工作。如果您无法在 Windows 上运行它，请提交错误。

配置与使用

有关使用和配置 mycli 的更多信息，请查看我们的文档。

常见主题包括：

• 配置 mycli
• 使用/禁用寻呼机
• 语法颜色