op-guide: update format, fix typo, add notes

op-guide/history-read.md

@@ -27,105 +27,112 @@ TiDB 实现了通过标准 SQL 接口读取历史数据功能，无需特殊的
 
 TiDB 使用 MVCC 管理版本，当更新/删除数据时，不会做真正的数据删除，只会添加一个新版本数据，所以可以保留历史数据。历史数据不会全部保留，超过一定时间的历史数据会被彻底删除，以减小空间占用以及避免历史版本过多引入的性能开销。
 
-我们使用周期性运行的 GC （Garbage Collection， 垃圾回收）来进行清理，关于 GC 的详细介绍清参阅 [TiDB 垃圾回收 (GC)](gc.md)
+TiDB 使用周期性运行的 GC（Garbage Collection，垃圾回收）来进行清理，关于 GC 的详细介绍参见 [TiDB 垃圾回收 (GC)](gc.md)。
 
-这里我们需要重点关注的是 `tikv_gc_life_time` 和 `tikv_gc_safe_point` 这条。`tikv_gc_life_time` 用于配置历史版本保留时间，可以手动修改；`tikv_gc_safe_point` 记录了当前的 safePoint，用户可以安全地使用大于 safePoint 的时间戳创建 snapshot 读取历史版本。safePoint 在每次 GC 开始运行时自动更新。
+这里需要重点关注的是 `tikv_gc_life_time` 和 `tikv_gc_safe_point` 这条。`tikv_gc_life_time` 用于配置历史版本保留时间，可以手动修改；`tikv_gc_safe_point` 记录了当前的 safePoint，用户可以安全地使用大于 safePoint 的时间戳创建 snapshot 读取历史版本。safePoint 在每次 GC 开始运行时自动更新。
 
 ## 示例
 
-初始化阶段，创建一个表，并插入几行数据：
-
-```sql
-mysql> create table t (c int);
-Query OK, 0 rows affected (0.01 sec)
-
-mysql> insert into t values (1), (2), (3);
-Query OK, 3 rows affected (0.00 sec)
-```
-
-查看表中的数据：
-
-```
-mysql> select * from t;
-+------+
-| c    |
-+------+
-|    1 |
-|    2 |
-|    3 |
-+------+
-3 rows in set (0.00 sec)
-```
-
-查看当前时间：
-
-```sql
-mysql> select now();
-+---------------------+
-| now()               |
-+---------------------+
-| 2016-10-08 16:45:26 |
-+---------------------+
-1 row in set (0.00 sec)
-```
-
-更新某一行数据：
-
-```sql
-mysql> update t set c=22 where c=2;
-Query OK, 1 row affected (0.00 sec)
-```
-
-确认数据已经被更新：
-
-```sql
-mysql> select * from t;
-+------+
-| c    |
-+------+
-|    1 |
-|   22 |
-|    3 |
-+------+
-3 rows in set (0.00 sec)
-```
-
-设置一个特殊的环境变量，这个是一个 session scope 的变量，其意义为读取这个时间之前的最新的一个版本。注意这里的时间设置的是 update 语句之前的那个时间：
-
-```sql
-mysql> set @@tidb_snapshot="2016-10-08 16:45:26";
-Query OK, 0 rows affected (0.00 sec)
-```
-
-这里读取到的内容即为 update 之前的内容，也就是历史版本：
-
-```sql
-mysql> select * from t;
-+------+
-| c    |
-+------+
-|    1 |
-|    2 |
-|    3 |
-+------+
-3 rows in set (0.00 sec)
-```
-
-清空这个变量后，即可读取最新版本数据：
-
-```sql
-mysql> set @@tidb_snapshot="";
-Query OK, 0 rows affected (0.00 sec)
-```
-
-```sql
-mysql> select * from t;
-+------+
-| c    |
-+------+
-|    1 |
-|   22 |
-|    3 |
-+------+
-3 rows in set (0.00 sec)
-```
+1. 初始化阶段，创建一个表，并插入几行数据：
+
+    ```sql
+    mysql> create table t (c int);
+    Query OK, 0 rows affected (0.01 sec)
+
+    mysql> insert into t values (1), (2), (3);
+    Query OK, 3 rows affected (0.00 sec)
+    ```
+
+2. 查看表中的数据：
+
+    ```sql
+    mysql> select * from t;
+    +------+
+    | c    |
+    +------+
+    |    1 |
+    |    2 |
+    |    3 |
+    +------+
+    3 rows in set (0.00 sec)
+    ```
+
+3. 查看当前时间：
+
+    ```sql
+    mysql> select now();
+    +---------------------+
+    | now()               |
+    +---------------------+
+    | 2016-10-08 16:45:26 |
+    +---------------------+
+    1 row in set (0.00 sec)
+    ```
+
+4. 更新某一行数据：
+
+    ```sql
+    mysql> update t set c=22 where c=2;
+    Query OK, 1 row affected (0.00 sec)
+    ```
+
+5. 确认数据已经被更新：
+
+    ```sql
+    mysql> select * from t;
+    +------+
+    | c    |
+    +------+
+    |    1 |
+    |   22 |
+    |    3 |
+    +------+
+    3 rows in set (0.00 sec)
+    ```
+
+6. 设置一个特殊的环境变量，这个是一个 session scope 的变量，其意义为读取这个时间之前的最新的一个版本。
+
+    ```sql
+    mysql> set @@tidb_snapshot="2016-10-08 16:45:26";
+    Query OK, 0 rows affected (0.00 sec)
+    ```
+
+    > **注意**：
+    > 
+    > - 这里的时间设置的是 update 语句之前的那个时间。
+    > - 在 `tidb_snapshot` 前须使用 `@@` 而非 `@`，因为 `@@` 表示全局变量，`@` 表示 Session 变量。
+
+    这里读取到的内容即为 update 之前的内容，也就是历史版本：
+
+    ```sql
+    mysql> select * from t;
+    +------+
+    | c    |
+    +------+
+    |    1 |
+    |    2 |
+    |    3 |
+    +------+
+    3 rows in set (0.00 sec)
+    ```
+
+7. 清空这个变量后，即可读取最新版本数据：
+
+    ```sql
+    mysql> set @@tidb_snapshot="";
+    Query OK, 0 rows affected (0.00 sec)
+    ```
+
+    ```sql
+    mysql> select * from t;
+    +------+
+    | c    |
+    +------+
+    |    1 |
+    |   22 |
+    |    3 |
+    +------+
+    3 rows in set (0.00 sec)
+    ```
+
+    > **注意**：在 `tidb_snapshot` 前须使用 `@@` 而非 `@`，因为 `@@` 表示全局变量，`@` 表示 Session 变量。