ClickHouse CLI 项目使用教程

最新推荐文章于 2025-01-24 09:31:08 发布

梅昆焕Talia

最新推荐文章于 2025-01-24 09:31:08 发布

阅读量406

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00200/article/details/142774485

ClickHouse CLI 项目使用教程

clickhouse-cli A third-party client for the Clickhouse DBMS server. 项目地址: https://gitcode.com/gh_mirrors/cl/clickhouse-cli

1. 项目目录结构及介绍

clickhouse-cli/
├── github/workflows/
│   ├── clickhouse_cli.yml
│   └── tests.yml
├── tests/
├── .gitignore
├── LICENSE.txt
├── Makefile
├── README.md
├── pyproject.toml
├── requirements.txt
├── setup.cfg
├── setup.py
├── tox.ini
└── clickhouse_cli/
    ├── __init__.py
    ├── cli.py
    └── ...

目录结构说明

github/workflows/: 包含GitHub Actions的工作流配置文件，用于CI/CD和测试。
tests/: 包含项目的测试文件。
.gitignore: Git忽略文件配置。
LICENSE.txt: 项目的开源许可证文件。
Makefile: 项目的Makefile，用于自动化构建和测试。
README.md: 项目的README文件，包含项目的基本介绍和使用说明。
pyproject.toml: 项目的配置文件，用于定义项目的依赖和构建工具。
requirements.txt: 项目的依赖文件，列出了项目运行所需的Python包。
setup.cfg: 项目的配置文件，用于定义Python包的元数据。
setup.py: 项目的安装脚本。
tox.ini: 项目的Tox配置文件，用于自动化测试。
clickhouse_cli/: 项目的主要代码目录，包含CLI工具的核心实现。

2. 项目启动文件介绍

项目的启动文件是 clickhouse_cli/cli.py。这个文件包含了ClickHouse CLI工具的主要逻辑和命令行接口。通过运行这个文件，用户可以启动ClickHouse CLI工具并执行SQL查询。

启动命令

python clickhouse_cli/cli.py

主要功能

命令行参数解析: 支持多种命令行参数，如服务器地址、端口、用户名、密码等。
SQL查询执行: 支持在命令行中直接执行SQL查询。
自动补全和语法高亮: 提供SQL语句的自动补全和语法高亮功能。

3. 项目的配置文件介绍

项目的配置文件是 ~/.clickhouse-cli.rc。这个文件包含了ClickHouse CLI工具的配置选项，用户可以根据需要自定义配置。

配置文件示例

[defaults]
# 默认连接选项
host = 127.0.0.1
port = 8123
db = default
user = default
password =
cookie =

[main]
# 允许不安全的SSL连接
insecure = False
# 默认启用多行模式
multiline = False
# 显示SQL语句的执行时间
timing = True
# 交互模式下的数据格式
format = PrettyCompact
# 非交互模式下的数据格式
format_stdin = TabSeparated
# 显示格式化后的查询
show_formatted_query = True
# 语法高亮
highlight = True
# 高亮输出
highlight_output = True
# 使用TrueColor高亮
highlight_truecolor = True
# Pygments高亮主题
highlight_theme = default
# 使用分页器
pager = False

[settings]
# 服务器端设置
max_memory_usage = 20000000000