Skip to content
Permalink
Browse files

*: fix many typos #1603

Signed-off-by: keyixie <keyixie@tencent.com>
  • Loading branch information
xiekeyi98 authored and lilin90 committed Oct 18, 2019
1 parent 34a751a commit 914b7a19e03ac6581bc3c5fc828a0fc74b8e76ce
Showing with 33 additions and 33 deletions.
  1. +1 −1 dev/how-to/get-started/deploy-tidb-from-binary.md
  2. +1 −1 dev/how-to/migrate/from-aurora.md
  3. +1 −1 dev/how-to/upgrade/from-previous-version.md
  4. +1 −1 dev/reference/sql/functions-and-operators/json-functions.md
  5. +1 −1 dev/reference/sql/statements/begin.md
  6. +1 −1 dev/reference/sql/statements/commit.md
  7. +1 −1 dev/reference/sql/statements/do.md
  8. +1 −1 dev/reference/sql/statements/show-create-user.md
  9. +1 −1 dev/reference/sql/statements/start-transaction.md
  10. +2 −2 dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-dind.md
  11. +1 −1 dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-minikube.md
  12. +1 −1 dev/tidb-in-kubernetes/reference/configuration/tidb-cluster.md
  13. +1 −1 v2.1/how-to/get-started/local-cluster/install-from-binary.md
  14. +1 −1 v2.1/how-to/migrate/from-aurora.md
  15. +1 −1 v2.1/reference/sql/statements/begin.md
  16. +1 −1 v2.1/reference/sql/statements/commit.md
  17. +1 −1 v2.1/reference/sql/statements/do.md
  18. +1 −1 v2.1/reference/sql/statements/show-create-user.md
  19. +1 −1 v2.1/reference/sql/statements/start-transaction.md
  20. +1 −1 v3.0/how-to/get-started/deploy-tidb-from-binary.md
  21. +1 −1 v3.0/how-to/migrate/from-aurora.md
  22. +1 −1 v3.0/how-to/upgrade/from-previous-version.md
  23. +1 −1 v3.0/reference/sql/functions-and-operators/json-functions.md
  24. +1 −1 v3.0/reference/sql/statements/begin.md
  25. +1 −1 v3.0/reference/sql/statements/commit.md
  26. +1 −1 v3.0/reference/sql/statements/do.md
  27. +1 −1 v3.0/reference/sql/statements/show-create-user.md
  28. +1 −1 v3.0/reference/sql/statements/start-transaction.md
  29. +2 −2 v3.0/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-dind.md
  30. +1 −1 v3.0/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-minikube.md
  31. +1 −1 v3.0/tidb-in-kubernetes/reference/configuration/tidb-cluster.md
@@ -8,7 +8,7 @@ category: how-to

This guide provides installation instructions for all TiDB components on a single developer machine. It is intended for evaluation purposes, and does not match the recommended usage for production systems.

See also [testing environment](/dev/how-to/deploy/from-tarball/testing-environment.md) and [production enviroment](/dev/how-to/deploy/from-tarball/production-environment.md) deployment.
See also [testing environment](/dev/how-to/deploy/from-tarball/testing-environment.md) and [production environment](/dev/how-to/deploy/from-tarball/production-environment.md) deployment.

The following local TCP ports will be used:

@@ -10,7 +10,7 @@ This document describes how to migrate from [Amazon Aurora MySQL](https://aws.am

## Step 1: Enable binlog in the Aurora cluster

Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a seperate reader endpoint.
Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a separate reader endpoint.

| Cluster | Endpoint | Port | Role |
|:-------- |:--- | :--- | :--- |
@@ -11,7 +11,7 @@ This document is targeted for users who want to upgrade from TiDB 2.0 (above V2.
## Upgrade caveat

- Rolling back to 2.1.x or earlier versions after upgrading is not supported
- Before upgrading to 3.0 from 2.0.6 or earlier versions, verify if there are any runing DDL operations, especially time-consuming ones like `Add Index`. If there are any, wait for the DDL to finish before you upgrade.
- Before upgrading to 3.0 from 2.0.6 or earlier versions, verify if there are any running DDL operations, especially time-consuming ones like `Add Index`. If there are any, wait for the DDL to finish before you upgrade.
- Parallel DDL is enabled in TiDB 2.1, so the clusters with TiDB version earlier than 2.0.1 cannot upgrade to 2.1 using rolling update. You can choose either of the following two options:

- Stop the cluster and upgrade to 2.1 directly
@@ -26,7 +26,7 @@ TiDB supports most of the JSON functions that shipped with the GA release of MyS
| [->][json_short_extract] | Returns the value from a JSON column after the evaluating path; the syntactic sugar of `JSON_EXTRACT(doc, path_literal)` |
| [->>][json_short_extract_unquote] | Returns the value from a JSON column after the evaluating path and unquoting the result; the syntactic sugar of `JSON_UNQUOTE(JSON_EXTRACT(doc, path_literal))` |
| [JSON_KEYS(json_doc[, path])][json_keys] | Returns the keys from the top-level value of a JSON object as a JSON array, or, if a path argument is given, the top-level keys from the selected path |
| [JSON_SEARCH(json_doc, one_or_all, search_string)][json_search] | Seach a JSON document for one or all matches of a string |
| [JSON_SEARCH(json_doc, one_or_all, search_string)][json_search] | Search a JSON document for one or all matches of a string |

## Functions that modify JSON values

@@ -8,7 +8,7 @@ category: reference

This statement starts a new transaction inside of TiDB. It is similar to the statements `START TRANSACTION` and `SET autocommit=0`.

In the absense of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.

## Synopsis

@@ -8,7 +8,7 @@ category: reference

This statement commits a transaction inside of the TIDB server.

In the absense of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.

## Synopsis

@@ -6,7 +6,7 @@ category: reference

# DO

This statement executes an expression, without returning a result. In MySQL, a common use-case is to excecute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.
This statement executes an expression, without returning a result. In MySQL, a common use-case is to execute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.

## Synopsis

@@ -40,7 +40,7 @@ mysql> SHOW GRANTS FOR 'root';

## MySQL compatibility

* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatiblity] for more details.
* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatibility] for more details.

## See also

@@ -8,7 +8,7 @@ category: reference

This statement starts a new transaction inside of TiDB. It is similar to the statements `BEGIN` and `SET autocommit=0`.

In the absense of a `START TRANSACTION` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.
In the absence of a `START TRANSACTION` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.

## Synopsis

@@ -348,7 +348,7 @@ To access the TiDB cluster, use `kubectl port-forward` to expose services to the
> **Note:**
>
> If the proxy is set up sucessfully, it will print something like `Forwarding from 0.0.0.0:4000 -> 4000`. After testing, press `Ctrl + C` to stop the proxy and exit.
> If the proxy is set up successfully, it will print something like `Forwarding from 0.0.0.0:4000 -> 4000`. After testing, press `Ctrl + C` to stop the proxy and exit.
2. To connect to TiDB using the MySQL client, open a new terminal tab or window and run the following command:
@@ -370,7 +370,7 @@ To access the TiDB cluster, use `kubectl port-forward` to expose services to the
> **Note:**
>
> If the proxy is set up sucessfully, it will print something like `Forwarding from 0.0.0.0:3000 -> 3000`. After testing, press `Ctrl + C` to stop the proxy and exit.
> If the proxy is set up successfully, it will print something like `Forwarding from 0.0.0.0:3000 -> 3000`. After testing, press `Ctrl + C` to stop the proxy and exit.
2. Then, open your web browser at <http://localhost:3000> to access the Grafana monitoring interface.
@@ -109,7 +109,7 @@ helm repo add pingcap https://charts.pingcap.org/
helm repo list
```

Then you can check the avaliable charts:
Then you can check the available charts:

```shell
helm repo update
@@ -78,7 +78,7 @@ TiDB Operator uses `Helm` to deploy and manage TiDB clusters. The configuration
| `tikv.readpoolStorageConcurrency` | The size of thread pool for high priority, normal priority or low priority operations in the TiKV storage<br>If the version of TiDB Operator is later than v1.0.0, configure this parameter via `tikv.config`:<br>`[readpool.storage]`<br>`high-concurrency = 4`<br>`normal-concurrency = 4`<br>`low-concurrency = 4` | `4` |
| `tikv.readpoolCoprocessorConcurrency` | If `tikv.resources.limits.cpu` is greater than `8`, set the value of `tikv.readpoolCoprocessorConcurrency` to `tikv.resources.limits.cpu` * 0.8<br>If the version of TiDB Operator is later than v1.0.0, configure this parameter via `tikv.config`:<br>`[readpool.coprocessor]`<br>`high-concurrency = 8`<br>`normal-concurrency = 8`<br>`low-concurrency = 8` | `8` |
| `tikv.storageSchedulerWorkerPoolSize` | The worker pool size of the TiKV scheduler. This size must be increased in the case of rewriting but be smaller than the total CPU cores.<br>If the version of TiDB Operator is later than v1.0.0, configure this parameter via `tikv.config`:<br>`[storage]`<br>`scheduler-worker-pool-size = 4` | `4` |
| `tidb.config` | The configuration of TiDB. Check [the `config.toml.example` file](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) for the default TiDB configuration file (by choosing the tag of the corresponding TiDB version). You can see [TiDB Configuration File Description](https://pingcap.com/docs/v3.0/reference/configuration/tidb-server/configuration-file/) for the detailed description of the configuration parameters (by choosing the corresponding document version). Here you must **modify the configuration based on the format of the configuration file**.<br/><br/>You need to explicitly configure the following configuration items:<br/><br/>`[performance]`<br/>&nbsp;&nbsp;`max-procs = 0`<br/>It is recommended to set `max-procs` to the value of corresponding cores of `tidb.resources.limits.cpu` | If the version of TiDB Operator is v1.0.0-beta.3 or ealier, the default value is<br>`nil`<br>If the version of TiDB Operator is later than v1.0.0-beta.3, the default value is<br>`[log]`<br>`level = "info"`<br>Sample configuration:<br>&nbsp;&nbsp;`config:` \|<br>&nbsp;&nbsp;&nbsp;&nbsp;`[log]`<br>&nbsp;&nbsp;&nbsp;&nbsp;`level = "info"` |
| `tidb.config` | The configuration of TiDB. Check [the `config.toml.example` file](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) for the default TiDB configuration file (by choosing the tag of the corresponding TiDB version). You can see [TiDB Configuration File Description](https://pingcap.com/docs/v3.0/reference/configuration/tidb-server/configuration-file/) for the detailed description of the configuration parameters (by choosing the corresponding document version). Here you must **modify the configuration based on the format of the configuration file**.<br/><br/>You need to explicitly configure the following configuration items:<br/><br/>`[performance]`<br/>&nbsp;&nbsp;`max-procs = 0`<br/>It is recommended to set `max-procs` to the value of corresponding cores of `tidb.resources.limits.cpu` | If the version of TiDB Operator is v1.0.0-beta.3 or earlier, the default value is<br>`nil`<br>If the version of TiDB Operator is later than v1.0.0-beta.3, the default value is<br>`[log]`<br>`level = "info"`<br>Sample configuration:<br>&nbsp;&nbsp;`config:` \|<br>&nbsp;&nbsp;&nbsp;&nbsp;`[log]`<br>&nbsp;&nbsp;&nbsp;&nbsp;`level = "info"` |
| `tidb.replicas` | The number of Pods in TiDB | `2` |
| `tidb.image` | The TiDB image | `pingcap/tidb:v3.0.0-rc.1` |
| `tidb.imagePullPolicy` | The pulling policy for the TiDB image | `IfNotPresent` |
@@ -8,7 +8,7 @@ category: how-to

This guide provides installation instructions for all TiDB components on a single developer machine. It is intended for evaluation purposes, and does not match the recommended usage for production systems.

See also [testing environment](/v2.1/how-to/deploy/from-tarball/testing-environment.md) and [production enviroment](/v2.1/how-to/deploy/from-tarball/production-environment.md) deployment.
See also [testing environment](/v2.1/how-to/deploy/from-tarball/testing-environment.md) and [production environment](/v2.1/how-to/deploy/from-tarball/production-environment.md) deployment.

The following local TCP ports will be used:

@@ -10,7 +10,7 @@ This document describes how to migrate from [Amazon Aurora MySQL](https://aws.am

## Step 1: Enable binlog in the Aurora cluster

Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a seperate reader endpoint.
Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a separate reader endpoint.

| Cluster | Endpoint | Port | Role |
|:-------- |:--- | :--- | :--- |
@@ -8,7 +8,7 @@ category: reference

This statement starts a new transaction inside of TiDB. It is similar to the statements `START TRANSACTION` and `SET autocommit=0`.

In the absense of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.

## Synopsis

@@ -8,7 +8,7 @@ category: reference

This statement commits a transaction inside of the TIDB server.

In the absense of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.

## Synopsis

@@ -6,7 +6,7 @@ category: reference

# DO

This statement executes an expression, without returning a result. In MySQL, a common use-case is to excecute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.
This statement executes an expression, without returning a result. In MySQL, a common use-case is to execute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.

## Synopsis

@@ -40,7 +40,7 @@ mysql> SHOW GRANTS FOR 'root';

## MySQL compatibility

* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatiblity] for more details.
* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatibility] for more details.

## See also

@@ -8,7 +8,7 @@ category: reference

This statement starts a new transaction inside of TiDB. It is similar to the statements `BEGIN` and `SET autocommit=0`.

In the absense of a `START TRANSACTION` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.
In the absence of a `START TRANSACTION` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.

## Synopsis

@@ -9,7 +9,7 @@ aliases: ['/docs/op-guide/binary-local-deployment/','/docs/v3.0/how-to/get-start

This guide provides installation instructions for all TiDB components on a single developer machine. It is intended for evaluation purposes, and does not match the recommended usage for production systems.

See also [testing environment](/v3.0/how-to/deploy/from-tarball/testing-environment.md) and [production enviroment](/v3.0/how-to/deploy/from-tarball/production-environment.md) deployment.
See also [testing environment](/v3.0/how-to/deploy/from-tarball/testing-environment.md) and [production environment](/v3.0/how-to/deploy/from-tarball/production-environment.md) deployment.

The following local TCP ports will be used:

@@ -10,7 +10,7 @@ This document describes how to migrate from [Amazon Aurora MySQL](https://aws.am

## Step 1: Enable binlog in the Aurora cluster

Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a seperate reader endpoint.
Assuming that you want to migrate data from two Aurora clusters to TiDB, the information of the Aurora clusters is listed in the following table. The Aurora-1 cluster contains a separate reader endpoint.

| Cluster | Endpoint | Port | Role |
|:-------- |:--- | :--- | :--- |
@@ -12,7 +12,7 @@ This document is targeted for users who want to upgrade from TiDB 2.0 (above V2.
## Upgrade caveat

- Rolling back to 2.1.x or earlier versions after upgrading is not supported
- Before upgrading to 3.0 from 2.0.6 or earlier versions, verify if there are any runing DDL operations, especially time-consuming ones like `Add Index`. If there are any, wait for the DDL to finish before you upgrade.
- Before upgrading to 3.0 from 2.0.6 or earlier versions, verify if there are any running DDL operations, especially time-consuming ones like `Add Index`. If there are any, wait for the DDL to finish before you upgrade.
- Parallel DDL is enabled in TiDB 2.1, so the clusters with TiDB version earlier than 2.0.1 cannot upgrade to 2.1 using rolling update. You can choose either of the following two options:

- Stop the cluster and upgrade to 2.1 directly
@@ -27,7 +27,7 @@ TiDB supports most of the JSON functions that shipped with the GA release of MyS
| [->][json_short_extract] | Returns the value from a JSON column after the evaluating path; the syntactic sugar of `JSON_EXTRACT(doc, path_literal)` |
| [->>][json_short_extract_unquote] | Returns the value from a JSON column after the evaluating path and unquoting the result; the syntactic sugar of `JSON_UNQUOTE(JSON_EXTRACT(doc, path_literal))` |
| [JSON_KEYS(json_doc[, path])][json_keys] | Returns the keys from the top-level value of a JSON object as a JSON array, or, if a path argument is given, the top-level keys from the selected path |
| [JSON_SEARCH(json_doc, one_or_all, search_string)][json_search] | Seach a JSON document for one or all matches of a string |
| [JSON_SEARCH(json_doc, one_or_all, search_string)][json_search] | Search a JSON document for one or all matches of a string |

## Functions that modify JSON values

@@ -8,7 +8,7 @@ category: reference

This statement starts a new transaction inside of TiDB. It is similar to the statements `START TRANSACTION` and `SET autocommit=0`.

In the absense of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` statement, every statement will by default autocommit in its own transaction. This behavior ensures MySQL compatibility.

## Synopsis

@@ -8,7 +8,7 @@ category: reference

This statement commits a transaction inside of the TIDB server.

In the absense of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.
In the absence of a `BEGIN` or `START TRANSACTION` statement, the default behavior of TiDB is that every statement will be its own transaction and autocommit. This behavior ensures MySQL compatibility.

## Synopsis

@@ -6,7 +6,7 @@ category: reference

# DO

This statement executes an expression, without returning a result. In MySQL, a common use-case is to excecute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.
This statement executes an expression, without returning a result. In MySQL, a common use-case is to execute stored programs without needing to handle the result. Since TiDB does not provide stored routines, this function has a more limited use.

## Synopsis

@@ -40,7 +40,7 @@ mysql> SHOW GRANTS FOR 'root';

## MySQL compatibility

* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatiblity] for more details.
* The output of `SHOW CREATE USER` is designed to match MySQL, but several of the `CREATE` options are not yet supported by TiDB. Not yet supported options will be parsed but ignored. See [security compatibility] for more details.

## See also

0 comments on commit 914b7a1

Please sign in to comment.
You can’t perform that action at this time.