materialize/cli

镜像概述

该Docker镜像预打包了与materialized交互所需的常用工具，旨在简化环境配置流程，提供开箱即用的交互体验，帮助用户快速接入materialized服务。

主要用途

用于与materialized进行便捷交互，支持演示、开发调试、日常管理等场景，无需手动安装和配置相关工具。

核心功能与特性

核心功能

• 集成mzcli：materialized专用命令行客户端，支持与materialized的直接交互操作
• 集成psql：PostgreSQL官方命令行客户端，因materialized兼容PostgreSQL协议，可通过psql实现连接与操作

主要特性

• 即开即用：拉取镜像后无需额外安装工具，直接启动即可使用
• 环境统一：避免因本地工具版本差异导致的兼容性问题，确保交互环境一致性
• 轻量化配置：简化与materialized的对接流程，降低使用门槛

使用场景与适用范围

使用场景

• 技术演示：在产品展示、培训或会议中快速启动工具，演示materialized功能
• 开发调试：开发过程中连接materialized进行查询测试、数据验证等日常操作
• 学习实践：作为学习materialized的配套工具，快速体验其交互方式

适用范围

• 开发人员：需与materialized交互的后端开发、数据开发人员
• 测试人员：验证materialized功能和性能的测试工程师
• 培训人员：开展materialized技术培训或演示的教育工作者

使用方法与配置说明

拉取镜像

（注：实际使用时需替换为具体镜像仓库地址）

bash
docker pull [镜像仓库地址]/materialized-tools:latest

基本使用示例

使用mzcli连接materialized

bash
docker run -it --rm [镜像仓库地址]/materialized-tools mzcli -h <materialized主机> -p <端口> -U <用户名> -d <数据库名>

参数说明：

• -h：materialized服务主机地址
• -p：materialized服务端口（默认通常为6875）
• -U：连接用户名
• -d：目标数据库名称

使用psql连接materialized

bash
docker run -it --rm [镜像仓库地址]/materialized-tools psql -h <materialized主机> -p <端口> -U <用户名> -d <数据库名>

（参数与mzcli一致，遵循psql标准连接格式）

高级配置

如需持久化工具配置（如保存连接历史），可挂载本地目录至容器内配置路径：

bash
docker run -it --rm -v ~/.mzcli:/root/.config/mzcli [镜像仓库地址]/materialized-tools mzcli -h <materialized主机>

通过挂载本地~/.mzcli目录，可保留mzcli的配置和历史记录。