如何设置 Databend 开发环境
工欲善其事,必先利其器。在开启 Databend 贡献之旅前,一起来配置适合自己的开发环境吧。快速安装
快速安装
为方便开发者快速建立开发环境,Databend 维护了一个复杂的 shell 脚本,位于 scripts/setup/dev_setup.sh
。只需执行一条指令即可完成开发环境配置:
注意:此过程会辅助安装部分 python 环境,可能会对本地原开发环境造成影响,建议预先执行以下命令以创建并启用专属虚拟环境。
如果遇到依赖缺失问题,可以参考「分步安装 - 测试必备」这一部分的内容安装。分步安装
分步安装
这里以 Fedora 36 为例,考虑到不同系统和发行版之间的差异,你可能需要自行安装 gcc,python 和 openssl。
1.安装 Rust toolchain:
推荐使用 rustup 来管理 Rust toolchain ,参考 https://rustup.rs/ 进行安装。对于 MacOS 和 Linux 用户,执行:
Databend 通常使用最新发布的 nightly 工具链进行开发,相关信息记录在 rust-toolchain.toml
中。Rustup 会在使用时对工具链进行自动重载,安装时只需默认配置。
2.安装必备依赖:
以下列出了一些安装构建和测试必备依赖的关键步骤,说明及报错信息以注释形式呈现。
构建必备:
测试必备:
Lint 必备:
编辑器 - Visual Studio Code
访问 https://code.visualstudio.com ,安装 Visual Studio Code 。
1.插件推荐
rust-analyzer
作者:The Rust Programming Language
为 Visual Studio Code 提供 Rust 语言支持。
crates
作者:Seray Uzgur
帮助 Rust 开发者管理 Cargo.toml 中的依赖。仅支持来源为 crates.io 的依赖。
CodeLLDB
作者:Vadim Chugunov
由 LLDB 驱动的原生调试工具。支持调试 C++ 、Rust 和其他编译语言。
Remote - Containers
作者:Microsoft
在 Docker 容器内打开任何文件夹或 Repo ,并利用 Visual Studio Code 的全部功能。
2. 利用 Dev Containers 开发(For Linux)
安装「Remote - Containers」插件,打开 Databend 后会看到右下角弹出窗口并提示「Reopen in Container」。
安装 Docker
根据 Docker Docs - Install 安装并启动对应你发行版的 docker 。以 Fedora 36
为例,步骤如下:
将当前 User 添加到 docker group 中参考 Docker Docs - PostInstall(https://docs.docker.com/engine/install/linux-postinstall)中 Manage Docker as a non-root user 一节配置,可能需要重启。
步骤如下
其他步骤
启用 Docker :
点击左下角「打开远程窗口」选中「Reopen in Container」即可体验。
其他实用工具推荐
这里列出一些可能有助于 Databend 开发的实用工具,根据实际情况按需选用。
1.starship
轻量级、反应迅速、可无限定制的高颜值终端!
https://github.com/starship/starship
参考 starship - installation 进行安装。
2.hyperfine
命令行基准测试工具。
https://github.com/sharkdp/hyperfine

参考 hyperfine - installation(https://github.com/starship/starship#-installation)进行安装。
关于 Databend
Databend 是一款开源、弹性、低成本,基于对象存储也可以做实时分析的新式数仓。期待您的关注,一起探索云原生数仓解决方案,打造新一代开源 Data Cloud。
Databend 文档:https://databend.rs/
Twitter:https://twitter.com/Datafuse_Labs
Slack:https://datafusecloud.slack.com/
Wechat:Databend
GitHub :https://github.com/datafuselabs/databend
