This is an automated email from the ASF dual-hosted git repository.
tanruixiang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-horaedb.git
The following commit(s) were added to refs/heads/main by this push:
new be7bbd1c chore: update README (#1390)
be7bbd1c is described below
commit be7bbd1c7ebf74472499fdbfac3b398593bcf7ff
Author: chunshao.rcs <[email protected]>
AuthorDate: Fri Dec 22 16:20:49 2023 +0800
chore: update README (#1390)
## Rationale
related https://github.com/apache/incubator-horaedb/issues/1342
Add quick start to `README` to help users experience horaedb better.
## Detailed Changes
Add quick start to `README`.
## Test Plan
No need.
---------
Co-authored-by: caicancai <[email protected]>
---
README-CN.md | 151 ++++++++++++++---------------------------------------------
README.md | 46 ++++++++++++++++++
2 files changed, 80 insertions(+), 117 deletions(-)
diff --git a/README-CN.md b/README-CN.md
index 5202d741..17dc4553 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -7,146 +7,63 @@
HoraeDB 是一款高性能、分布式的云原生时序数据库。
-## RoadMap
-项目 [Roadmap](https://apache.github.io/incubator-horaedb-docs/dev/roadmap.html)。
+## 文档
+- [用户文档](https://apache.github.io/incubator-horaedb-docs)
+- [研发文档](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html)
+- [Roadmap](https://apache.github.io/incubator-horaedb-docs/dev/roadmap.html)
## 快速开始
-### 获取代码
-通过 git 克隆代码仓库并进入代码目录：
-```bash
-git clone [email protected]:apache/incubator-horaedb.git horaedb
-cd horaedb
+### 通过 Docker 运行
+使用 Docker 运行单机版 HoraeDB
```
-<!-- TODO need to wait for first apache version release. -->
-<!-- ### 通过 Docker 运行
-确保开发环境安装了 docker，通过仓库中的提供的 Dockerfile 进行镜像的构建：
-```shell
-docker build -t horaedb .
+docker run -d --name horaedb-server \
+ -p 8831:8831 \
+ -p 3307:3307 \
+ -p 5440:5440 \
+ ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
```
-使用编译好的镜像，启动服务：
-```shell
-docker run -d -t --name horaedb -p 5440:5440 -p 8831:8831 horaedb
-``` -->
-
-### 通过源码编译运行
-#### 安装依赖
-目前为了编译 HoraeDB，需要安装相关依赖，以及 Rust 工具链。
-
-#### 开发依赖（Ubuntu20.04）
-开发环境这里以 Ubuntu20.04 为例，执行如下的命令，即可安装好所需的依赖：
-```shell
-sudo apt install git curl gcc g++ libssl-dev pkg-config cmake
-```
-
-需要注意的是，项目的编译对 cmake、gcc、g++ 等实际上都是有版本要求的，如果开发环境使用的是较老的 Linux
发行版的话，一般需要手动安装较高版本的这些依赖。
-
-
-#### 开发依赖（MacOS）
-开发环境这里以 MacOS Monterey 为例，执行如下的命令，即可安装好所需的依赖。
-
-1. 安装命令行工具:
-```shell
-xcode-select --install
-```
-2. 通过Brew安装cmake:
-```shell
-brew install cmake
-```
-
-#### Rust
-Rust 的安装建议通过 [rustup](https://rustup.rs/)，安装了 rustup 之后，进入到 HoraeDB
项目的时候，会自动根据 rust-toolchain 文件下载指定的 Rust 版本。
-
-理论上执行了之后，需要添加环境变量，才能使用 Rust 工具链，一般会把下面的命令放入到自己的 `~/.bashrc` 或者
`~/.bash_profile` 中：
-```bash
-source $HOME/.cargo/env
-```
-
-#### 编译和运行
-编译 Release 版本，执行如下命令：
-```
-cargo build --release
+创建表
```
-
-使用下载的代码中提供的默认配置文件，即可启动：
-```bash
-./target/release/horaedb-server --config ./docs/minimal.toml
-```
-
-### 进行数据读写
-HoraeDB 支持自定义扩展的 SQL 协议，目前可以通过 http 服务以 SQL 语句进行数据的读写、表的创建。
-#### 建表
-```shell
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'\'')"
-}'
+-d '
+CREATE TABLE `demo` (
+ `name` string TAG,
+ `value` double NOT NULL,
+ `t` timestamp NOT NULL,
+ timestamp KEY (t))
+ENGINE=Analytic
+ with
+(enable_ttl="false")
+'
```
-#### 插入数据
-```shell
-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,
'\''horaedb'\'', 100)"
-}'
+数据写入
```
-
-#### 查询数据
-```shell
curl --location --request POST 'http://127.0.0.1:5440/sql' \
---header 'Content-Type: application/json' \
---data-raw '{
- "query": "select * from demo"
-}'
+-d '
+INSERT INTO demo (t, name, value)
+ VALUES (1702224000000, "horaedb", 100)
+'
```
-#### 查看建表信息
-```shell
-curl --location --request POST 'http://127.0.0.1:5440/sql' \
---header 'Content-Type: application/json' \
---data-raw '{
- "query": "show create table demo"
-}'
+数据查询
```
-
-#### 删除表
-```shell
curl --location --request POST 'http://127.0.0.1:5440/sql' \
---header 'Content-Type: application/json' \
---data-raw '{
- "query": "DROP TABLE demo"
-}'
+-d '
+SELECT * FROM `demo`
+'
```
-### 支持使用 MySQL Client 连接
-
-HoraeDB 也支持使用 MySQL Client 连接执行 SQL
-
-```shell
-mysql -u root -P 3307 -h 127.0.0.1
-```
-
-## 平台支持
-
-| 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](https://github.com/apache/incubator-horaedb/issues/63)|
-| windows | * | 未支持 |
+### 通过源码编译运行
+详见[文档](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html)。
## 如何贡献
-[如何参与 HoraeDB 代码贡献](CONTRIBUTING.md)
[订阅邮箱参与讨论](mailto:[email protected])
([订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe))
/
[取消订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe))
/ [查看邮件历史记录](https://lists.apache.org/[email protected]))
-[约定式提交](https://apache.github.io/incubator-horaedb-docs/cn/dev/conventional_commit)
+[如何参与 HoraeDB 代码贡献](CONTRIBUTING.md)
-## 架构及技术文档
-相关技术文档请参考[docs](https://apache.github.io/incubator-horaedb-docs/)。
## 致谢
在开发 HoraeDB 的过程中， 我们受到很多开源项目的影响和启发，例如
[influxdb_iox](https://github.com/influxdata/influxdb/tree/main/influxdb_iox),
[tikv](https://github.com/tikv/tikv) 等等。感谢这些杰出的项目。
diff --git a/README.md b/README.md
index b19cf5e3..f9e1944d 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,52 @@ HoraeDB is a high-performance, distributed, cloud native
time-series database.
- [Development
Guide](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html)
- [Roadmap](https://apache.github.io/incubator-horaedb-docs/dev/roadmap.html)
+## Quick Start
+### Run with Docker
+Run HoraeDB standalone Server.
+```
+docker run -d --name horaedb-server \
+ -p 8831:8831 \
+ -p 3307:3307 \
+ -p 5440:5440 \
+ ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
+```
+
+Create Table.
+```
+curl --location --request POST 'http://127.0.0.1:5440/sql' \
+-d '
+CREATE TABLE `demo` (
+ `name` string TAG,
+ `value` double NOT NULL,
+ `t` timestamp NOT NULL,
+ timestamp KEY (t))
+ENGINE=Analytic
+ with
+(enable_ttl="false")
+'
+```
+
+Write data with SQL.
+```
+curl --location --request POST 'http://127.0.0.1:5440/sql' \
+-d '
+INSERT INTO demo (t, name, value)
+ VALUES (1702224000000, "horaedb", 100)
+'
+```
+
+Read data with SQL.
+```
+curl --location --request POST 'http://127.0.0.1:5440/sql' \
+-d '
+SELECT * FROM `demo`
+'
+```
+
+### Run from source code
+See details
[here](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html).
+
## Contributing
Any contribution is welcome!
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
