README-CN.md

English

CeresDB 是一款高性能、分布式的云原生时序数据库。

RoadMap

项目 Roadmap。

快速开始

获取代码

通过 git 克隆代码仓库并进入代码目录：

git clone [email protected]:CeresDB/ceresdb.git
cd ceresdb

通过 Docker 运行

确保开发环境安装了 docker，通过仓库中的提供的 Dockerfile 进行镜像的构建：

docker build -t ceresdb .

使用编译好的镜像，启动服务：

docker run -d -t --name ceresdb -p 5440:5440 -p 8831:8831 ceresdb

通过源码编译运行

安装依赖

目前为了编译 CeresDB，需要安装相关依赖，以及 Rust 工具链。

开发依赖（Ubuntu20.04）

开发环境这里以 Ubuntu20.04 为例，执行如下的命令，即可安装好所需的依赖：

apt install git curl gcc g++ libssl-dev pkg-config cmake

需要注意的是，项目的编译对 cmake、gcc、g++ 等实际上都是有版本要求的，如果开发环境使用的是较老的 Linux 发行版的话，一般需要手动安装较高版本的这些依赖。

开发依赖（MacOS）

开发环境这里以 MacOS Monterey 为例，执行如下的命令，即可安装好所需的依赖。

1. 安装命令行工具:

xcode-select --install

2. 通过Brew安装cmake:

brew install cmake

Rust

Rust 的安装建议通过 rustup，安装了 rustup 之后，进入到 CeresDB 项目的时候，会自动根据 rust-toolchain 文件下载指定的 Rust 版本。

理论上执行了之后，需要添加环境变量，才能使用 Rust 工具链，一般会把下面的命令放入到自己的 ~/.bashrc 或者 ~/.bash_profile 中：

source $HOME/.cargo/env

编译和运行

编译 Release 版本，执行如下命令：

cargo build --release

使用下载的代码中提供的默认配置文件，即可启动：

./target/release/ceresdb-server --config ./docs/example.toml

进行数据读写

CeresDB 支持自定义扩展的 SQL 协议，目前可以通过 http 服务以 SQL 语句进行数据的读写、表的创建。

建表

curl --location --request POST 'http://127.0.0.1:5440/sql' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "CREATE TABLE `demo` (`name` string TAG, `value` double NOT NULL, `t` timestamp NOT NULL, TIMESTAMP KEY(t)) ENGINE=Analytic with (enable_ttl='\''false'\'')"
}'

插入数据

curl --location --request POST 'http://127.0.0.1:5440/sql' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "INSERT INTO demo(t, name, value) VALUES(1651737067000, '\''ceresdb'\'', 100)"
}'

查询数据

curl --location --request POST 'http://127.0.0.1:5440/sql' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "select * from demo"
}'

查看建表信息

curl --location --request POST 'http://127.0.0.1:5440/sql' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "show create table demo"
}'

删除表

curl --location --request POST 'http://127.0.0.1:5440/sql' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "DROP TABLE demo"
}'

平台支持

target	OS	status
x86_64-unknown-linux-gnu	kernel 4.9+	构建及运行
x86_64-apple-darwin	10.15+, Catalina+	构建
aarch64-apple-darwin	11+, Big Sur+	构建
aarch64-unknown-linux-gnu	TBD	详见 #63
*-windows	*	未支持

如何贡献

如何参与 CeresDB 代码贡献

约定式提交

架构及技术文档

相关技术文档请参考docs。

致谢

CeresDB 部分设计参考 influxdb_iox, 部分代码实现参考 tikv 以及其他的优秀开源项目，感谢 InfluxDB 团队、TiKV 团队，以及其他优秀的开源项目。

开源许可

CeresDB 基于 Apache License 2.0 协议。

社区

• CeresDB 社区角色
• Slack
• 邮箱: [email protected]
• 微信群
• 钉钉群: CeresDB 开源: 44602802