Skip to content

Commit

Permalink
docs(stonedb): Update the latest docs(#1450)
Browse files Browse the repository at this point in the history
- update all installation and deployment docs
- update the version information from 1.0.2-GA to 1.0.3-GA
  • Loading branch information
Nliver authored and mergify[bot] committed Mar 20, 2023
1 parent 3ddea31 commit 0580406
Show file tree
Hide file tree
Showing 11 changed files with 108 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Currently, this shell script applies only to StoneDB-5.7.

1. Download the shell script.
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/shell.for.deploy.stonedb.as.replic.tar.gz
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/shell.for.deploy.stonedb.as.replic.tar.gz
```

2. Download the package of the shell script.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 3.15
## Step 1. Install StoneDB
1. Download the StoneDB software package.
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7-v1.0.2.el7.x86_64.rpm
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7-v1.0.3.el7.x86_64.rpm
```

2. Install the RPM package.
```sql
rpm -ivh stonedb-ce-5.7-v1.0.2.el7.x86_64.rpm
rpm -ivh stonedb-ce-5.7-v1.0.3.el7.x86_64.rpm
```
:::info
If this step fails, run `ldd /opt/stonedb57/install/bin/mysqld | grep 'not found'` to check whether any dependent libraries are missing. If yes, run `source /opt/stonedb57/install/bin/sourceenv` and then retry this step.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 3.13
## Step 1. Install StoneDB
1. Download the StoneDB software package.
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz
```

2. Decompress the TAR package and install the software.
```sql
tar -vxf stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz -C /opt/
tar -vxf stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz -C /opt/
```

3. Map dependent libraries.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ sidebar_position: 3.12

# Quick Deploy StoneDB-5.7
## 1. Download the installation package
Click [here](https://static.stoneatom.com/custom/stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz) to download the latest installation package of StoneDB.
Click [here](https://static.stoneatom.com/custom/stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz) to download the latest installation package of StoneDB.
:::info
To simplify deployment, the installation package provided here is pre-compiled to include all required dependencies.
:::
## 2. Upload and decompress the TAR package
```shell
cd /
tar -zxvf stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz
tar -zxvf stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz
```
You can upload the installation package to the server. The name of the folder extracted from the package is **stonedb57**. In this topic, **/stonedb57** is used as the installation package.
## 3. Check dependencies
Expand Down
41 changes: 41 additions & 0 deletions Docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,47 @@ sidebar_position: 11.0
---

# Release Notes

## StoneDB-5.7-V1.0.3
Release date: March 15,2023

- Reconstructed the binlog mechanism to filter out DDL statements that are not supported by the Tianmu storage engine.
- Added an argument named **NO_KEY_ERROR** for SQL mode to directly skip DDL statements that are not supported by the SQL layer, instead of reporting errors.

Syntax:
```sql
# At global level:
mysql>set global sql_mode='NO_KEY_ERROR';

# At session level:
mysql>set session sql_mode='NO_KEY_ERROR';

# Configuration file my.cnf:
[mysqld]
sql_mode = 'NO_KEY_ERROR'
```
### Ecosystem Adaptation
Better adapted to the ecosystem to display the version number of StoneDB.
### Perfomance
Improved the primary/secondary synchronization performance. [#1213](https://github.com/stoneatom/stonedb/issues/1213)
### Bug Fixes
The following bugs are fixed:

- Incorrect result is returned when an `ALTER TABLE` statement is executed to add a TIMESTAMP field. [#](https://github.com/stoneatom/stonedb/issues/1327)[1327](https://github.com/stoneatom/stonedb/issues/1327)
- Incorrect result is returned for an UPDATE operation on a table after it is modified by an `ALTER TABLE` statement. [#](https://github.com/stoneatom/stonedb/issues/1253)[1253](https://github.com/stoneatom/stonedb/issues/1253)
- Incorrect result is returned for a query on BIGINT data that is unsigned. [#1203](https://github.com/stoneatom/stonedb/issues/1203)
- An error is reported when a statement is executed to load data. [#](https://github.com/stoneatom/stonedb/issues/1209)[1209](https://github.com/stoneatom/stonedb/issues/1209)
- The result returned for an AVG function call is incorrect. [#](https://github.com/stoneatom/stonedb/issues/1125)[1125](https://github.com/stoneatom/stonedb/issues/1125)
- An error is reported when an `ALTER TABLE` statement is executed to change the data type of a field. [#](https://github.com/stoneatom/stonedb/issues/752)[752](https://github.com/stoneatom/stonedb/issues/752)
- Other bugs. [#](https://github.com/stoneatom/stonedb/issues/103)[103](https://github.com/stoneatom/stonedb/issues/103)[#1230](https://github.com/stoneatom/stonedb/issues/1230)[#1255](https://github.com/stoneatom/stonedb/issues/1255)[#1188](https://github.com/stoneatom/stonedb/issues/1188)[#1262](https://github.com/stoneatom/stonedb/issues/1262)
### Supported OSs

- CentOS 7.6 and later
- Ubuntu 20

For more details on the update, please visit [Github](https://github.com/stoneatom/stonedb/releases) and [Gitee](https://gitee.com/StoneDB/stonedb/releases).


## StoneDB-5.7-V1.0.2
Release date: January 15,2023
### New features
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ sidebar_position: 3.5
1. 下载 Shell 脚本。您可以通过以下两种方式进行下载:
- GitHub 下载
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/shell.for.deploy.stonedb.as.replic.tar.gz
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/shell.for.deploy.stonedb.as.replic.tar.gz
```

- Gitee 下载
```sql
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.2-GA/shell.for.deploy.stonedb.as.replic.tar.gz
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.3-GA/shell.for.deploy.stonedb.as.replic.tar.gz
```
## 解压 Shell 脚本安装包。
```sql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ sidebar_position: 3.14

- GitHub 下载
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7_v1.0.2.ubuntu.amd64.deb
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7_v1.0.2.ubuntu.amd64.deb
```

- Gitee 下载
```sql
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7_v1.0.2.ubuntu.amd64.deb
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7_v1.0.2.ubuntu.amd64.deb
```

2. 使用 DPKG 命令进行安装。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ sidebar_position: 3.15

- GitHub 下载
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7-v1.0.2.el7.x86_64.rpm
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7-v1.0.3.el7.x86_64.rpm
```

- Gitee 下载
```sql
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7-v1.0.2.el7.x86_64.rpm
wget https://gitee.com/StoneDB/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7-v1.0.3.el7.x86_64.rpm

```

2. 安装 RPM 包。
```sql
rpm -ivh stonedb-ce-5.7-v1.0.2.el7.x86_64.rpm
rpm -ivh stonedb-ce-5.7-v1.0.3.el7.x86_64.rpm
```
:::info
如该步骤执行失败,请执行 `ldd /opt/stonedb57/install/bin/mysqld | grep 'not found'` 命令,检查是否缺少依赖。如是,请执行 `source /opt/stonedb57/install/bin/sourceenv` 问题后重试。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 3.13
## 步骤 1:安装 StoneDB
1. 下载 StoneDB 软件包。
```sql
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.2-GA/stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz
wget https://github.com/stoneatom/stonedb/releases/download/5.7-v1.0.3-GA/stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz
```

2. 解压软件包。
```sql
tar -vxf stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz -C /opt/
tar -vxf stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz -C /opt/
```

3. 映射依赖包。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_position: 3.12
# 快速部署 StoneDB-5.7
为方便用户快速上手,安装包是已经编译好的,只需要检查自己的环境是否缺少依赖。
## 下载安装包
点击 [此处](https://static.stoneatom.com/custom/stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz)下载最新的安装包。
点击 [此处](https://static.stoneatom.com/custom/stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz)下载最新的安装包。
## 上传tar包并解压
```shell
cd /
tar -zxvf stonedb-ce-5.7-v1.0.2.el7.x86_64.tar.gz
tar -zxvf stonedb-ce-5.7-v1.0.3.el7.x86_64.tar.gz
```
用户可根据安装规范将安装包上传至服务器,解压出来的目录是 stonedb57,示例中的安装路径是 /stonedb57。
# 检查依赖文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,50 @@ sidebar_position: 11.0
---

# 发版日志
## StoneDB-5.7-v1.0.3 的发行日志 (2023-03-19, GA)
发布日期: 2023 年 03 月 19 日
### 主备能力

## StoneDB_5.7_v1.0.2 的发行日志 (2023-01-15, GA)
- Binlog 改造 — 指定 DDL 过滤。
- SQL MODE 中增加参数 NO_KEY_ERROR,SQL 层对不支持 DDL 报错忽略。
- 语法举例:
```sql
# 全局级别
mysql>set global sql_mode='NO_KEY_ERROR';

# 会话级别
mysql>set session sql_mode='NO_KEY_ERROR';

# my.cnf 配置文件
[mysqld]
sql_mode='NO_KEY_ERROR'
```

### 生态适配

- StoneDB 版本号展示。
### 性能

- 主从同步性能提升 [#1213](https://github.com/stoneatom/stonedb/issues/1213)
### 问题修复
修复了如下 Bug:

- 执行 ALTER TABLE 语句添加 TIMESTAMP 字段返回结果不正确。[#1327](https://github.com/stoneatom/stonedb/issues/1327)
- 执行 ALTER TABLE 语句后 Update 表数据不正确。[#1253](https://github.com/stoneatom/stonedb/issues/1253)
- Bigint unsigned 返回结果不正确。 [#1203](https://github.com/stoneatom/stonedb/issues/1203)
- Load data 报错。[#1209](https://github.com/stoneatom/stonedb/issues/1209)
- AVG 函数返回结果不正确。[#1125](https://github.com/stoneatom/stonedb/issues/1125)
- ALTER TABLE 更改字段数据类型报错。[#752](https://github.com/stoneatom/stonedb/issues/752)
- 其它 Bug。[#103](https://github.com/stoneatom/stonedb/issues/103) [#1230](https://github.com/stoneatom/stonedb/issues/1230) [#1255](https://github.com/stoneatom/stonedb/issues/1255)[#1188](https://github.com/stoneatom/stonedb/issues/1188) [#1262](https://github.com/stoneatom/stonedb/issues/1262)

### 支持平台

- CentOS 7.6 以上
- Ubuntu 20

更多该版本的详细更新记录,请访问 [Github](https://github.com/stoneatom/stonedb/releases)[Gitee](https://gitee.com/StoneDB/stonedb/releases) 查看。

## StoneDB-5.7-v1.0.2 的发行日志 (2023-01-15, GA)
发布日期: 2023 年 01 月 15 日
### 功能开发

Expand Down Expand Up @@ -71,7 +113,7 @@ sql_mode = 'STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTI
- 添加一些MTR测试用例。


## StoneDB_5.7_v1.0.1 的发行日志 (2022-10-21, RC;2022-10-24,GA)
## StoneDB-5.7-v1.0.1 的发行日志 (2022-10-21, RC;2022-10-24,GA)
- 功能添加或改变
- 编译相关改动
- 文档变更
Expand Down Expand Up @@ -100,7 +142,7 @@ sql_mode = 'STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTI
- 修复及完善 Tianmu 功能:
>修复 issue 有: [#282](https://github.com/stoneatom/stonedb/issues/282),[#274](about:blank),[#270](https://github.com/stoneatom/stonedb/issues/270),[#663](https://github.com/stoneatom/stonedb/issues/663),[#669](https://github.com/stoneatom/stonedb/issues/669),[#670](https://github.com/stoneatom/stonedb/issues/670),[#675](https://github.com/stoneatom/stonedb/issues/675),[#678](https://github.com/stoneatom/stonedb/issues/678),[#682](https://github.com/stoneatom/stonedb/issues/682),[#487](https://github.com/stoneatom/stonedb/issues/487),[#426](https://github.com/stoneatom/stonedb/issues/426),[#250](https://github.com/stoneatom/stonedb/issues/250),[#247](https://github.com/stoneatom/stonedb/issues/247),[#569](https://github.com/stoneatom/stonedb/issues/569),[#566](https://github.com/stoneatom/stonedb/issues/566),[#290](https://github.com/stoneatom/stonedb/issues/290),[#736](https://github.com/stoneatom/stonedb/issues/736),[#567](https://github.com/stoneatom/stonedb/issues/567),[#500](https://github.com/stoneatom/stonedb/issues/500),[#300](https://github.com/stoneatom/stonedb/issues/300),[#289](https://github.com/stoneatom/stonedb/issues/289),[#566](https://github.com/stoneatom/stonedb/issues/566),[#279](https://github.com/stoneatom/stonedb/issues/279),[#570](https://github.com/stoneatom/stonedb/issues/570)[,#571](https://github.com/stoneatom/stonedb/issues/571),[#580](https://github.com/stoneatom/stonedb/issues/580),[#581](https://github.com/stoneatom/stonedb/issues/581),[#586](https://github.com/stoneatom/stonedb/issues/586),[#589](https://github.com/stoneatom/stonedb/issues/589),[#674](https://github.com/stoneatom/stonedb/issues/674),[#646](https://github.com/stoneatom/stonedb/issues/646),[#280](https://github.com/stoneatom/stonedb/issues/280),[#301](https://github.com/stoneatom/stonedb/issues/301),[#733](https://github.com/stoneatom/stonedb/issues/733) 等。

## StoneDB_5.7_v1.0.0的发行日志 (2022-08-31, 发行版)
## StoneDB-5.7-v1.0.0 的发行日志 (2022-08-31, 发行版)
- 支持MySQL 5.7
- 功能添加或改变
- 编译相关改动
Expand Down Expand Up @@ -142,7 +184,9 @@ mysql> show engines;
- **修复 mtr 用例: **[BUG #78](https://github.com/stoneatom/stonedb/issues/78), [BUG #73](https://github.com/stoneatom/stonedb/issues/73),[ BUG #170](https://github.com/stoneatom/stonedb/issues/170), [BUG #192](https://github.com/stoneatom/stonedb/issues/192), [BUG #191](https://github.com/stoneatom/stonedb/issues/191), [BUG #227](https://github.com/stoneatom/stonedb/issues/227), [BUG #245](https://github.com/stoneatom/stonedb/issues/245), [BUG #263](https://github.com/stoneatom/stonedb/issues/263)
- **修复 Tianmu 缺陷: **[BUG #338](https://github.com/stoneatom/stonedb/issues/388),[ BUG #327](https://github.com/stoneatom/stonedb/issues/327), [BUG #212](https://github.com/stoneatom/stonedb/issues/212), [BUG #142](https://github.com/stoneatom/stonedb/issues/142)

## StoneDB-5.6-V1.0.0
## StoneDB-5.6-v1.0.0

发布时间: 2022 年 6 月 30 号

发布时间: 2022 年 6 月 30 号,
全面兼容 MySQL5.6 版本。

0 comments on commit 0580406

Please sign in to comment.