materialize/mzcli

mzcli Docker镜像文档

镜像概述和主要用途

mzcli是Materialize Streaming Database Engine的交互式命令行客户端（REPL），基于pgcli的软分叉开发。它提供自动补全、语法高亮等功能，专为Materialize数据库设计，便于用户与Materialize数据库进行交互、执行查询和管理操作。

核心功能和特性

• 自动补全：输入时自动补全SQL关键字、数据库表和列名
• 语法高亮：使用Pygments实现SQL语法高亮显示
• 智能补全：根据上下文提供敏感建议（如SELECT * FROM <tab>仅显示表名，WHERE <tab>仅显示列名）
• 支持psql命令：基本支持psql的反斜杠命令
• 格式化输出：表格数据的美观打印
• 环境变量支持：兼容psql的登录环境变量（如PGHOST、PGPORT、PGUSER等）及SSL相关环境变量

使用场景和适用范围

• Materialize数据库的日常管理和查询操作
• SQL查询编写和调试
• 开发环境中与Materialize数据库的交互
• 需要命令行工具进行数据库操作的场景

使用方法和配置说明

快速开始

通过Docker运行mzcli的最简单方式：

bash
docker run -it materialize/mzcli mzcli --help

基本使用

连接数据库

bash
# 基本连接方式
docker run -it materialize/mzcli mzcli [数据库名称]

# 使用URL连接
docker run -it materialize/mzcli mzcli postgresql://[用户[:密码]@][主机][:端口][/数据库名][?参数=值[&其他参数=其他值]]

示例

bash
# 连接本地数据库
docker run -it materialize/mzcli mzcli local_database

# 使用完整URL连接
docker run -it materialize/mzcli mzcli postgres://amjith:pa$w0rd@example.com:5432/app_db?sslmode=verify-ca&sslrootcert=/myrootcert

命令行选项

bash
mzcli [OPTIONS] [DBNAME] [USERNAME]

选项:
  -h, --host TEXT            数据库主机地址
  -p, --port INTEGER         数据库端口号
  -U, --username TEXT        连接数据库的用户名
  -u, --user TEXT            连接数据库的用户名（同--username）
  -W, --password             强制提示输入密码
  -w, --no-password          从不提示输入密码
  --single-connection        不为补全使用单独连接
  -v, --version              显示mzcli版本
  -d, --dbname TEXT          要连接的数据库名称
  --mzclirc FILE             mzclirc配置文件位置
  -D, --dsn TEXT             使用mzclirc文件[alias_dsn]部分配置的DSN
  --list-dsn                 列出mzclirc文件[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                     显示帮助信息

环境变量支持

mzcli支持与psql相同的登录环境变量：

• PGHOST: 数据库主机地址
• PGPORT: 数据库端口号
• PGUSER: 用户名
• PGPASSWORD: 密码
• PGDATABASE: 数据库名称

SSL连接配置

如需通过SSL连接数据库，可设置以下环境变量：

bash
export PGSSLMODE="verify-full"
export PGSSLCERT="/路径/client.crt"
export PGSSLKEY="/路径/client.key"
export PGSSLROOTCERT="/路径/ca.crt"

配置文件

首次启动时，配置文件会自动创建于 ~/.config/mzcli/config。配置文件中包含所有可用选项的说明。

获取最新版本

mzcli的新版本会从main分支自动构建并发布到https://hub.docker.com/repository/docker/materialize/mzcli%E3%80%82