Skip to content
Permalink
Browse files

*: optimize anchor text of 61 links for SEO purposes (#1551)

* *: optimize anchor text for SEO purposes

* 2.1/reference/sql: remove a line
  • Loading branch information...
CaitinChen committed Sep 27, 2019
1 parent 55b22db commit 07af9a5c14b870bbf176b0dd9e71e4167ddf402b
Showing with 62 additions and 63 deletions.
  1. +1 −1 dev/benchmark/how-to-run-sysbench.md
  2. +1 −1 dev/how-to/get-started/deploy-tidb-from-docker-compose.md
  3. +1 −1 dev/reference/configuration/tidb-server/configuration-file.md
  4. +1 −1 dev/reference/configuration/tidb-server/tidb-specific-variables.md
  5. +4 −4 dev/reference/error-codes.md
  6. +1 −1 dev/reference/sql/functions-and-operators/date-and-time-functions.md
  7. +4 −4 dev/reference/sql/functions-and-operators/operators.md
  8. +1 −1 dev/reference/tispark.md
  9. +4 −4 dev/tidb-in-kubernetes/deploy/gcp-gke.md
  10. +3 −3 dev/tidb-in-kubernetes/reference/configuration/tidb-cluster.md
  11. +1 −1 v2.1/benchmark/how-to-run-sysbench.md
  12. +1 −1 v2.1/reference/configuration/tidb-server/configuration-file.md
  13. +1 −1 v2.1/reference/configuration/tidb-server/tidb-specific-variables.md
  14. +4 −4 v2.1/reference/error-codes.md
  15. +2 −3 v2.1/reference/sql/functions-and-operators/cast-functions-and-operators.md
  16. +2 −2 v2.1/reference/sql/functions-and-operators/date-and-time-functions.md
  17. +4 −4 v2.1/reference/sql/functions-and-operators/operators.md
  18. +3 −3 v2.1/reference/tispark.md
  19. +2 −2 v2.1/tispark/tispark-user-guide_v1.x.md
  20. +1 −1 v3.0/benchmark/how-to-run-sysbench.md
  21. +1 −1 v3.0/reference/configuration/tidb-server/configuration-file.md
  22. +1 −1 v3.0/reference/configuration/tidb-server/tidb-specific-variables.md
  23. +4 −4 v3.0/reference/error-codes.md
  24. +1 −1 v3.0/reference/sql/functions-and-operators/date-and-time-functions.md
  25. +4 −4 v3.0/reference/sql/functions-and-operators/operators.md
  26. +2 −2 v3.0/reference/tispark.md
  27. +4 −4 v3.0/tidb-in-kubernetes/deploy/gcp-gke.md
  28. +3 −3 v3.0/tidb-in-kubernetes/reference/configuration/tidb-cluster.md
@@ -5,7 +5,7 @@ category: benchmark

# How to Test TiDB Using Sysbench

In this test, Sysbench 1.0.14 and TiDB 3.0 Beta are used. It is recommended to use Sysbench 1.0 or later, which can be downloaded [here](https://github.com/akopytov/sysbench/releases/tag/1.0.14).
In this test, Sysbench 1.0.14 and TiDB 3.0 Beta are used. It is recommended to use Sysbench 1.0 or later, which can be [downloaded here](https://github.com/akopytov/sysbench/releases/tag/1.0.14).

## Test environment

@@ -177,6 +177,6 @@ docker-compose exec tispark-master /opt/spark/bin/pyspark
docker-compose exec tispark-master /opt/spark/bin/sparkR
```
For more details about TiSpark, see [here](/dev/how-to/deploy/tispark.md).
For more details about TiSpark, see [TiSpark Quick Start Guide](/dev/how-to/deploy/tispark.md).
Here is [a 5-minute tutorial](https://pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) for macOS users that shows how to spin up a standard TiDB cluster using Docker Compose on your local computer.
@@ -10,7 +10,7 @@ category: deployment

The TiDB configuration file supports more options than command line options. You can find the default configuration file in [config/config.toml.example](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) and rename it to `config.toml`.

This document describes the options that are not involved in command line options. For command line options, see [here](/dev/reference/configuration/tidb-server/configuration.md).
This document describes the options that are not involved in command line options. For command line options, see [Configuration Flags](/dev/reference/configuration/tidb-server/configuration.md).

### `split-table`

@@ -177,7 +177,7 @@ set @@global.tidb_distsql_scan_concurrency = 10

- Scope: SESSION
- Default value: 0
- This variable is used to set whether to divide the data for deletion automatically. It is valid only when you delete from a single table and `autocommit` is enabled. For the definition of single-table DELETE statement, see [here](https://dev.mysql.com/doc/refman/8.0/en/delete.html).
- This variable is used to set whether to divide the data for deletion automatically. It is valid only when you delete from a single table and `autocommit` is enabled. For the definition of single-table DELETE statement, see [DELETE Syntax](https://dev.mysql.com/doc/refman/8.0/en/delete.html).
- When deleting a large amount of data, you can set the variable value to `1`. Then, the data for deletion is automatically divided into multiple batches and each batch is deleted by a single transaction. This operation breaks the atomicity and isolation of the transaction. When performing this operation, you must ensure that there are **no other** ongoing operations on the table. When an error occurs, **manual intervention is required to check the consistency and integrity of the data**. Therefore, it is not recommended to set this variable in a production environment.

### tidb_dml_batch_size
@@ -17,16 +17,16 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the
| 8001 | The memory used by the request exceeds the threshold limit for the TiDB memory usage. | Increase the value of the system variable with the `tidb_mem_quota` prefix. |
| 8002 | To guarantee consistency, a transaction with the `SELECT FOR UPDATE` statement cannot be retried when it encounters a commit conflict. TiDB rolls back the transaction and returns this error. | Retry the failed transaction. |
| 8003 | If the data in a row is not consistent with the index when executing the `ADMIN CHECK TABLE` command, TiDB returns this error. |
| 8004 | A single transaction is too large. | See [here](/dev/faq/tidb.md#the-error-message-transaction-too-large-is-displayed) for the cause and solution. |
| 8005 | Transactions in TiDB encounter write conflicts. | See [here](/dev/faq/tidb.md#troubleshoot) for the cause and solution. |
| 8004 | A single transaction is too large. | See [the error message `transaction too large`](/dev/faq/tidb.md#the-error-message-transaction-too-large-is-displayed) for the cause and solution. |
| 8005 | Transactions in TiDB encounter write conflicts. | See [the Troubleshoot section](/dev/faq/tidb.md#troubleshoot) for the cause and solution. |
| 9001 | The PD request timed out. | Check the state/monitor/log of the PD server and the network between the TiDB server and the PD server. |
| 9002 | The TiKV request timed out. | Check the state/monitor/log of the TiKV server and the network between the TiDB server and the TiKV server. |
| 9003 | The TiKV server is busy and this usually occurs when the workload is too high. | Check the state/monitor/log of the TiKV server. |
| 9004 | This error occurs when a large number of transactional conflicts exist in the database. | Check the code of application. |
| 9005 | A certain Raft Group is not available, such as the number of replicas is not enough. This error usually occurs when the TiKV server is busy or the TiKV node is down. | Check the state/monitor/log of the TiKV server. |
| 9006 | The interval of GC Life Time is too short and the data that should be read by the long transactions might be cleared. | Extend the interval of GC Life Time. |
| 9500 | A single transaction is too large. | See [here](/dev/faq/tidb.md#the-error-message-transaction-too-large-is-displayed) for the solution. |
| 9007 | Transactions in TiKV encounter write conflicts. | See [here](/dev/faq/tidb.md#troubleshoot) for the cause and solution. |
| 9500 | A single transaction is too large. | See [the error message `transaction too large`](/dev/faq/tidb.md#the-error-message-transaction-too-large-is-displayed) for the solution. |
| 9007 | Transactions in TiKV encounter write conflicts. | See [the Troubleshoot section](/dev/faq/tidb.md#troubleshoot) for the cause and solution. |

## Troubleshooting

@@ -73,4 +73,4 @@ TiDB supports all of the [date and time functions](https://dev.mysql.com/doc/ref
| [`YEAR()`](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_year) | Return the year |
| [`YEARWEEK()`](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_yearweek) | Return the year and week |

For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html).
For details, see [Date and Time Functions](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html).
@@ -82,7 +82,7 @@ OR, ||
= (assignment), :=
```

For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/operator-precedence.html).
For details, see [Operator Precedence](https://dev.mysql.com/doc/refman/5.7/en/operator-precedence.html).

## Comparison functions and operators

@@ -112,7 +112,7 @@ For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/operator-precede
| [NOT LIKE](https://dev.mysql.com/doc/refman/5.7/en/string-comparison-functions.html#operator_not-like) | Negation of simple pattern matching |
| [STRCMP()](https://dev.mysql.com/doc/refman/5.7/en/string-comparison-functions.html#function_strcmp) | Compare two strings |

For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/comparison-operators.html).
For details, see [Comparison Functions and Operators](https://dev.mysql.com/doc/refman/5.7/en/comparison-operators.html).

## Logical operators

@@ -123,7 +123,7 @@ For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/comparison-opera
| [\|\|, OR](https://dev.mysql.com/doc/refman/5.7/en/logical-operators.html#operator_or) | Logical OR |
| [XOR](https://dev.mysql.com/doc/refman/5.7/en/logical-operators.html#operator_xor) | Logical XOR |

For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/group-by-handling.html).
For details, see [MySQL Handling of GROUP BY](https://dev.mysql.com/doc/refman/5.7/en/group-by-handling.html).

## Assignment operators

@@ -132,4 +132,4 @@ For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/group-by-handlin
| [=](https://dev.mysql.com/doc/refman/5.7/en/assignment-operators.html#operator_assign-equal) | Assign a value (as part of a [`SET`](https://dev.mysql.com/doc/refman/5.7/en/set-variable.html) statement, or as part of the `SET` clause in an [`UPDATE`](https://dev.mysql.com/doc/refman/5.7/en/update.html) statement) |
| [:=](https://dev.mysql.com/doc/refman/5.7/en/assignment-operators.html#operator_assign-value) | Assign a value |

For details, see [here](https://dev.mysql.com/doc/refman/5.7/en/group-by-functional-dependence.html).
For details, see [Detection of Functional Dependence](https://dev.mysql.com/doc/refman/5.7/en/group-by-functional-dependence.html).
@@ -233,7 +233,7 @@ TiSpark uses TiDB statistic information for the following items:
1. Determining which index to ues in your query plan with the estimated lowest cost.
2. Small table broadcasting, which enables efficient broadcast join.
If you would like TiSpark to use statistic information, first you need to make sure that concerning tables have already been analyzed. Read more about how to analyze tables [here](/dev/reference/performance/statistics.md).
If you would like TiSpark to use statistic information, first you need to make sure that concerning tables have already been analyzed. Read more about [how to analyze tables](/dev/reference/performance/statistics.md).
Starting from TiSpark 2.0, statistics information is default to auto load.
@@ -57,8 +57,8 @@ gcloud services enable cloudresourcemanager.googleapis.com \
The terraform script expects three variables to be provided by the user. You can let Terraform prompt you for them, or define them in a `.tfvars` file of your choice. The three variables are:

* `GCP_CREDENTIALS_PATH`: Path to a valid GCP credentials file.
- It is recommended for you to create a separate service account to be used by Terraform. See [this page](https://cloud.google.com/iam/docs/creating-managing-service-accounts) for more information. `./create-service-account.sh` will create such a service account with minimal permissions.
- See [this page](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) for information on creating service account keys. The steps in the script below detail how to do this using a script provided in the `deploy/gcp` directory, alternatively if creating the service account and key yourself, choose `JSON` key type during creation. The downloaded `JSON` file that contains the private key is the credentials file you need.
- It is recommended for you to create a separate service account to be used by Terraform. See [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts) for more information. `./create-service-account.sh` will create such a service account with minimal permissions.
- See [Creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) for information on creating service account keys. The steps in the script below detail how to do this using a script provided in the `deploy/gcp` directory, alternatively if creating the service account and key yourself, choose `JSON` key type during creation. The downloaded `JSON` file that contains the private key is the credentials file you need.
* `GCP_REGION`: The region in which to create the resources, for example: `us-west1`.
* `GCP_PROJECT`: The GCP project in which everything will be created.

@@ -110,7 +110,7 @@ The `prod.tfvars` setup creates a new VPC, two subnetworks, and an f1-micro inst
>
> The number of nodes created depends on how many availability zones there are in the chosen region. Most have 3 zones, but us-central1 has 4. See [Regions and Zones](https://cloud.google.com/compute/docs/regions-zones/) for more information and see the [Customize](#customize) section on how to customize node pools in a regional cluster.
The production setup, as listed above, requires at least 91 CPUs which exceed the default CPU quota of a GCP project. To increase your project's quota, follow the instructions [here](https://cloud.google.com/compute/quotas). You need more CPUs if you need to scale out.
The production setup, as listed above, requires at least 91 CPUs which exceed the default CPU quota of a GCP project. To increase your project's quota, follow these [instructions](https://cloud.google.com/compute/quotas). You need more CPUs if you need to scale out.

Now that you have configured everything needed, you can launch the script to deploy the TiDB cluster:

@@ -295,7 +295,7 @@ Currently, scaling in is not supported since we cannot determine which node to r

> **Note:**
>
> Scaling in by modifying `tikv_count` can lead to data loss due to deleting the underlying instance before rebalancing. See [this page](https://pingcap.com/docs/v3.0/tidb-in-kubernetes/scale-in-kubernetes/) for more information.
> Scaling in by modifying `tikv_count` can lead to data loss due to deleting the underlying instance before rebalancing. See [Scale TiDB in Kubernetes](https://pingcap.com/docs/v3.0/tidb-in-kubernetes/scale-in-kubernetes/) for more information.
```bash
kubectl --kubeconfig credentials/kubeconfig_<gke_cluster_name> get po -n <tidb_cluster_name> --watch

0 comments on commit 07af9a5

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