fix: Fix some problems (#46)

MichaelLeeHZ · web-flow · commit 3a13c3cd6f5a · 2023-02-28T18:13:35.000+08:00
* fix link available

* fix some problem

* fix

* update roadmap

* add note for hybrid

* exist-&gt;exists
diff --git a/docs/src/cn/dev/roadmap.md b/docs/src/cn/dev/roadmap.md
@@ -32,13 +32,13 @@
 
 ### v1.0.0
 
-- [ ] 正式发布 CeresDB 和相关 SDK，并完成所有的 breaking changes
-- [ ] 完成分区表的主要工作
-- [ ] 优化查询性能，特别是云原生集群模式下，包括：
+- [x] 正式发布 CeresDB 和相关 SDK，并完成所有的 breaking changes
+- [x] 完成分区表的主要工作
+- [x] 优化查询性能，特别是云原生集群模式下，包括：
   - 多级缓存
   - 多种方式减少从远端获取的数据量(提高 SST 数据过滤精度)
   - 提高获取远程对象存储数据的并发度
-- [ ] 通过控制合并时的资源消耗，提高数据写入性能
+- [x] 通过控制合并时的资源消耗，提高数据写入性能
 
 ### Afterwards
 
diff --git a/docs/src/cn/operation/cluster.md b/docs/src/cn/operation/cluster.md
@@ -1,10 +1,10 @@
 # 集群运维
 
-集群运维的接口，必须在 CeresDB 集群模式，部署了 CeresMeta 的前提下才能使用。
+集群运维接口的使用前提是，CeresDB 部署为使用 CeresMeta 的集群模式。
 
 ## 运维接口
 
-你需要将 {CeresMetaAddr} 替换为 CeresMeta 的实际地址，如果部署在本地，可以直接替换为 `127.0.0.1`
+注意： 如下接口在实际使用时需要将 {CeresMetaAddr} 替换为 CeresMeta 的真实地址，如果部署在本地，可以直接替换为 `127.0.0.1`
 
 - 查询表的路由信息
 
diff --git a/docs/src/cn/operation/observability.md b/docs/src/cn/operation/observability.md
@@ -1,6 +1,6 @@
 # 监控
 
-CeresDB 使用 Prometheus 和 Grafana 做自监控。
+CeresDB 支持使用 Prometheus 和 Grafana 做自监控。
 
 ## Prometheus
 
diff --git a/docs/src/cn/quick_start.md b/docs/src/cn/quick_start.md
@@ -4,7 +4,7 @@
 
 ## 启动
 
-使用 [CeresDB docker 镜像](https://hub.docker.com/r/ceresdb/ceresdb-server) 是一种最简单的启动方式；如果你还没有一个安装 Docker，请首先参考 [这里](https://www.docker.com/products/docker-desktop/) 安装 Docker。
+使用 [CeresDB docker 镜像](https://hub.docker.com/r/ceresdb/ceresdb-server) 是一种最简单的启动方式；如果你还没有安装 Docker，请首先参考 [这里](https://www.docker.com/products/docker-desktop/) 安装 Docker。
 
 使用如下命令安装并启动一个单机版 CeresDB。
 
@@ -84,7 +84,7 @@ DROP TABLE `demo`
 
 ## 使用 SDK
 
-当前我们支持多种开发语言 SDK，例如 Java，Rust，Python, Go 等 , 具体使用请参考 [sdk](sdk/README.md)。
+当前我们支持多种开发语言 SDK，例如 Java，Rust，Python, Go 等, 具体使用方式请参考 [sdk](sdk/README.md)。
 
 ## 下一步
 
diff --git a/docs/src/cn/sdk/rust.md b/docs/src/cn/sdk/rust.md
@@ -92,7 +92,7 @@ let resp = client
 
 ## 写入数据
 
-我们支持使用类似 [influxdb](https://awesome.influxdata.com/docs/part-2/influxdb-data-model) 的时序数据模型进行写入。
+我们支持使用类似 [InfluxDB](https://awesome.influxdata.com/docs/part-2/influxdb-data-model) 的时序数据模型进行写入。
 
 - 利用 `PointBuilder` 创建 `point`，`tag value` 和 `field value` 的相关数据结构为 `Value`，[`Value` 的详细信息](detail about Value](https://github.com/CeresDB/ceresdb-client-rs/blob/main/src/model/value.rs：
 
diff --git a/docs/src/cn/sql/ddl/README.md b/docs/src/cn/sql/ddl/README.md
@@ -1,6 +1,6 @@
 # 表结构操作
 
-本章介绍表结构相关
+本章介绍表结构相关 SQL 语句：
 
 - [建表](create_table.md)
 - [表结构变更](alter_table.md)
diff --git a/docs/src/cn/sql/ddl/create_table.md b/docs/src/cn/sql/ddl/create_table.md
@@ -5,7 +5,7 @@
 建表的基础语法如下 ( `[]` 之间的内容是可选部分):
 
 ```sql
-CREATE TABLE [IF NOT EXIST]
+CREATE TABLE [IF NOT EXISTS]
     table_name ( column_definitions )
     ENGINE = engine_type
     [WITH ( table_options )];
@@ -23,9 +23,9 @@ column_name column_type [[NOT] NULL] {[TAG] | [TIMESTAMP KEY] | [PRIMARY KEY]}
 ... WITH ( enable_ttl='false' )
 ```
 
-## IF NOT EXIST
+## IF NOT EXISTS
 
-添加 `IF NOT EXIST` 时，CeresDB 在表名已经存在时会忽略建表错误。
+添加 `IF NOT EXISTS` 时，CeresDB 在表名已经存在时会忽略建表错误。
 
 ## 定义列
 
@@ -43,8 +43,8 @@ a_nullable int NULL
 b_not_null NOT NULL
 ```
 
-定义列时可以使用相关的关键字标记列为 [特殊列](../model/special_columns.md)。
+定义列时可以使用相关的关键字将列标记为 [特殊列](../model/special_columns.md)。
 
 ## 引擎设置
 
-CeresDB 支持指定某个表使用哪种引擎，目前支持的引擎类型为 [`Analytic`](../../analytic_engine/README.md)。注意这个属性设置后不可更改。
+CeresDB 支持指定某个表使用哪种引擎，目前支持的引擎类型为 `Analytic`。注意这个属性设置后不可更改。
diff --git a/docs/src/cn/sql/ddl/drop_table.md b/docs/src/cn/sql/ddl/drop_table.md
@@ -5,7 +5,7 @@
 删除表的基础语法如下:
 
 ```sql
-DROP TABLE [IF EXIST] table_name
+DROP TABLE [IF EXISTS] table_name
 ```
 
 `Drop Table` 用来删除一个表，请谨慎使用这个语句，因为会同时删除表的定义和表的数据，并且无法恢复。
diff --git a/docs/src/cn/sql/engine_options.md b/docs/src/cn/sql/engine_options.md
@@ -2,12 +2,12 @@
 
 建表时可以使用下列的选项配置引擎：
 
-- `enable_ttl`, `bool`. 默认为 `true`，当一个表打开 TTL 能力，早于 `ttl` 的数据不会被查询到并且会被删除。
-- `ttl`, `duration`. 默认值为`7d`，此项定义数据的生命周期，只在 `enable_ttl` 为 `true` 的情况下使用。
-- `storage_format`, `string`. 数据存储的格式，有两种可选:
+- `enable_ttl`：布尔类型，默认为 `true`，当一个表配置 TTL 时，早于 `ttl` 的数据不会被查询到并且会被删除。
+- `ttl`：`duration` 类型，默认值为`7d`，此项定义数据的生命周期，只在 `enable_ttl` 为 `true` 的情况下使用。
+- `storage_format`： `string` 类型，数据存储的格式，有两种可选:
 
   - `columnar`, 默认值
-  - `hybrid`
+  - `hybrid`, 注意：此功能仍在开发中，将来可能会发生变化。
 
 上述两种存储格式详见 [存储格式](#存储格式) 部分。
 
diff --git a/docs/src/cn/sql/model/data_types.md b/docs/src/cn/sql/model/data_types.md
@@ -22,3 +22,5 @@ CeresDB 实现了 `Table` 模型，支持的数据类型和 MySQL 比较类似
 | int16/smallint | Int16     |
 | int8/tinyint   | Int8      |
 | boolean        | Boolean   |
+| date           | Date      |
+| time           | Time      |
diff --git a/docs/src/cn/sql/utility.md b/docs/src/cn/sql/utility.md
@@ -1,6 +1,6 @@
 # 常用 SQL
 
-CeresDB 中有许多实用的 SQL 工具，可以帮助进行表操作或查询检查。
+CeresDB 中有许多实用的 SQL 工具，可以辅助表操作或查询检查。
 
 ## 查看建表语句
 
@@ -50,15 +50,15 @@ DESCRIBE table_name;
 `DESCRIBE` 语句返回一个表的详细结构信息，包括每个字段的名称和类型，字段是否为 `Tag` 或主键，字段是否可空等。
 此外，自动生成的字段 `tsid` 也会展示在结果里。
 
-例如 :
+例如：
 
 ```sql
 CREATE TABLE `t`(a int, b string, t timestamp NOT NULL, TIMESTAMP KEY(t)) ENGINE = Analytic;
 
 DESCRIBE TABLE `t`;
 ```
 
-返回结果如下 :
+返回结果如下：
 
 ```
 name    type        is_primary  is_nullable is_tag
diff --git a/docs/src/en/dev/roadmap.md b/docs/src/en/dev/roadmap.md
@@ -32,13 +32,13 @@
 
 ### v1.0.0
 
-- [ ] Formally release CeresDB and its SDKs with all breaking changes finished.
-- [ ] Finish the majority of work related to `Table Partitioning`.
-- [ ] Various efforts to improve query performance, especially for cloud-native cluster mode. These works includes:
+- [x] Formally release CeresDB and its SDKs with all breaking changes finished.
+- [x] Finish the majority of work related to `Table Partitioning`.
+- [x] Various efforts to improve query performance, especially for cloud-native cluster mode. These works include:
   - Multi-tier cache.
   - Introduce various methods to reduce the data fetched from remote storage (improve the accuracy of SST data filtering).
   - Increase the parallelism while fetching data from remote object-store.
-- [ ] Improve data ingestion performance by introducing resource control over compaction.
+- [x] Improve data ingestion performance by introducing resource control over compaction.
 
 ### Afterwards
 
diff --git a/docs/src/en/sdk/rust.md b/docs/src/en/sdk/rust.md
@@ -92,7 +92,7 @@ let resp = client
 
 ## Write
 
-We support to write with the time series data model like [influxdb](https://awesome.influxdata.com/docs/part-2/influxdb-data-model/).
+We support to write with the time series data model like [InfluxDB](https://awesome.influxdata.com/docs/part-2/influxdb-data-model/).
 
 - Build the `point` first by `PointBuilder`, the related data structure of `tag value` and `field value` in it is defined as `Value`, [detail about Value](https://github.com/CeresDB/ceresdb-client-rs/blob/main/src/model/value.rs):
 
diff --git a/docs/src/en/sql/ddl/create_table.md b/docs/src/en/sql/ddl/create_table.md
@@ -5,7 +5,7 @@
 Basic syntax:
 
 ```sql
-CREATE TABLE [IF NOT EXIST]
+CREATE TABLE [IF NOT EXISTS]
     table_name ( column_definitions )
     [partition_options]
     ENGINE = engine_type
@@ -30,9 +30,9 @@ Table options syntax are key-value pairs. Value should be quoted with quotation
 ... WITH ( enable_ttl='false' )
 ```
 
-## IF NOT EXIST
+## IF NOT EXISTS
 
-Add `IF NOT EXIST` to tell CeresDB to ignore errors if the table name already exists.
+Add `IF NOT EXISTS` to tell CeresDB to ignore errors if the table name already exists.
 
 ## Define Column
 
@@ -54,7 +54,7 @@ A column can be marked as [special column](../model/special_columns.md) with rel
 
 ## Engine
 
-Specifies which engine this table belongs to. CeresDB current support [`Analytic`](../../analytic_engine/README.md) engine type. This attribute is immutable.
+Specifies which engine this table belongs to. CeresDB current support `Analytic` engine type. This attribute is immutable.
 
 ## Partition Options
 
diff --git a/docs/src/en/sql/ddl/drop_table.md b/docs/src/en/sql/ddl/drop_table.md
@@ -5,7 +5,7 @@
 Basic syntax:
 
 ```sql
-DROP TABLE [IF EXIST] table_name
+DROP TABLE [IF EXISTS] table_name
 ```
 
 `Drop Table` removes a specific table. This statement should be used with caution, because it removes both the table definition and table data, and this removal is not recoverable.
diff --git a/docs/src/en/sql/engine_options.md b/docs/src/en/sql/engine_options.md
@@ -7,7 +7,7 @@ Options below can be used when create table for analytic engine
 - `storage_format`, `string`. The underlying column's format. Availiable values:
 
   - `columnar`, default
-  - `hybrid`
+  - `hybrid`, Note: This feature is still in development, and it may change in the future.
 
   The meaning of those two values are in [Storage format](#storage-format) section.
 
diff --git a/docs/src/en/sql/model/data_types.md b/docs/src/en/sql/model/data_types.md
@@ -22,3 +22,5 @@ The following table lists the mapping relationship between MySQL and CeresDB.
 | int16/smallint | Int16     |
 | int8/tinyint   | Int8      |
 | boolean        | Boolean   |
+| date           | Date      |
+| time           | Time      |
