Skip to content

Commit a752801

Browse files
authored
docs: use "the number of X" instead of "X number" for counts (#24361) (#24475)
1 parent e65d125 commit a752801

12 files changed

Lines changed: 18 additions & 18 deletions

‎benchmark/benchmark-tidb-using-ch.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ creating view revenue1
6464

6565
## Create TiFlash replicas
6666

67-
After TiFlash is deployed, TiFlash does not automatically replicate TiKV data. You need to execute the following SQL statement to create TiFlash replicas for the `tpcc` database. Once the specified TiFlash replicas are created, TiKV automatically replicates the latest data to TiFlash in real-time. In the following example, two TiFlash nodes are deployed in the cluster and the replica number is set to 2.
67+
After TiFlash is deployed, TiFlash does not automatically replicate TiKV data. You need to execute the following SQL statement to create TiFlash replicas for the `tpcc` database. Once the specified TiFlash replicas are created, TiKV automatically replicates the latest data to TiFlash in real-time. In the following example, two TiFlash nodes are deployed in the cluster and the number of replicas is set to 2.
6868

6969
```
7070
ALTER DATABASE tpcc SET tiflash replica 2;

‎best-practices/saas-best-practices.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ By adding appropriate filter conditions to the preceding SQL statements, memory
7777
In SaaS multi-tenant scenarios, each user usually connects to TiDB to operate data in their own tenant (database). To support a high number of connections:
7878

7979
* Increase the TiDB configuration item [`token-limit`](/tidb-configuration-file.md#token-limit) (`1000` by default) to support more concurrent requests.
80-
* The memory usage of TiDB is roughly linear with the number of connections. In actual tests, 200,000 idle connections increase TiDB memory usage by about 30 GiB. It is recommended to increase TiDB memory specifications based on actual connection numbers.
80+
* The memory usage of TiDB is roughly linear with the number of connections. In actual tests, 200,000 idle connections increase TiDB memory usage by about 30 GiB. It is recommended to increase TiDB memory specifications based on the actual number of connections.
8181
* If you use `PREPARED` statements, each connection maintains a session-level Prepared Plan Cache. If the `DEALLOCATE` statement is not executed for a long time, the cache might accumulate too many plans, increasing memory usage. In actual tests, 400,000 execution plans involving `IndexRangeScan` consume approximately 5 GiB of memory. It is recommended to increase memory specifications accordingly.
8282

8383
## Use stale read carefully

‎best-practices/three-nodes-hybrid-deployment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ In this test, the value of this parameter is set to `2`. Observe the **gRPC poll
7070

7171
#### `storage.scheduler-worker-pool-size`
7272

73-
When TiKV detects that the CPU core number of the machine is greater than or equal to `16`, this parameter value defaults to `8`. When the CPU core number is smaller than `16`, the parameter value defaults to `4`. This parameter is used when TiKV converts complex transaction requests to simple key-value reads or writes, but the scheduler thread pool does not perform any writes.
73+
When TiKV detects that the number of CPU cores of the machine is greater than or equal to `16`, this parameter value defaults to `8`. When the number of CPU cores is smaller than `16`, the parameter value defaults to `4`. This parameter is used when TiKV converts complex transaction requests to simple key-value reads or writes, but the scheduler thread pool does not perform any writes.
7474

7575
Ideally, the usage rate of the scheduler thread pool is kept between 50% and 75%. Similar to the gRPC thread pool, the default value of `storage.scheduler-worker-pool-size` can be too large for a hybrid deployment, resulting in low Scheduler thread pool utilization. In this test, the value of this parameter is set to `2`, which is in line with the best practices, a conclusion drawn by observing the corresponding metrics in the **Scheduler worker CPU** panel.
7676

‎br/br-pitr-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The following steps describe how to clean up backup data that exceeds the backup
144144
> - Log data restore speed = Total size of restored log data on all TiKV nodes in the cluster / (duration * the number of TiKV nodes)
145145
>
146146
> External storage only contains KV data of a single replica. Therefore, the data size in external storage does not represent the actual data size restored in the cluster. BR restores all replicas according to the number of replicas configured for the cluster. The more replicas there are, the more data can be actually restored.
147-
> The default replica number for all clusters in the test is 3.
147+
> The default number of replicas for all clusters in the test is 3.
148148
> To improve the overall restore performance, you can modify the [`import.num-threads`](/tikv-configuration-file.md#import) item in the TiKV configuration file and the [`pitr-concurrency`](/br/br-pitr-manual.md#restore-to-a-specified-point-in-time-pitr) option in the BR command.
149149
> When the upstream cluster has **many Regions** and a **short flush interval**, PITR generates a large number of small files. This increases batching and dispatching overhead during restore. To raise the number of files processed per batch, you can **moderately** increase the values of the following parameters:
150150
>

‎br/br-snapshot-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ You can use the following methods to manually control the impact of backup tasks
229229
> - [Scale out a cluster](/tiup/tiup-cluster.md#scale-out-a-cluster) to increase available resources.
230230
> - Enable [`Log Backup`](/br/br-log-architecture.md) to offload backup pressure and minimize disruption to online workloads.
231231
232-
The impact of backup on cluster performance can be reduced by limiting the backup threads number, but this affects the backup performance. The preceding tests show that the backup speed is proportional to the number of backup threads. When the number of threads is small, the backup speed is about 20 MiB/thread. For example, 5 backup threads on a single TiKV node can reach a backup speed of 100 MiB/s.
232+
The impact of backup on cluster performance can be reduced by limiting the number of backup threads, but this affects the backup performance. The preceding tests show that the backup speed is proportional to the number of backup threads. When the number of threads is small, the backup speed is about 20 MiB/thread. For example, 5 backup threads on a single TiKV node can reach a backup speed of 100 MiB/s.
233233

234234
### Performance and impact of snapshot restore
235235

‎dm/dm-best-practices.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ This document introduces how to use DM in an elegant and efficient way, and how
2020
| Performance item | Limitation |
2121
| ----------------- | :--------: |
2222
| Max work nodes | 1000 |
23-
| Max task number | 600 |
23+
| Max number of tasks | 600 |
2424
| Max QPS | 30k QPS/worker |
2525
| Max Binlog throughput | 20 MB/s/worker |
26-
| Table number limit per task | Unlimited |
26+
| Max number of tables per task | Unlimited |
2727

2828
- DM supports managing 1000 work nodes simultaneously, and the maximum number of tasks is 600. To ensure the high availability of work nodes, you should reserve some work nodes as standby nodes. The recommended number of standby nodes is 20% to 50% of the number of the work nodes that have running migration tasks.
2929
- A single work node can theoretically support replication QPS of up to 30K QPS/worker. It varies for different schemas and workloads. The ability to handle upstream binlogs is up to 20 MB/s/worker.

‎information-schema/information-schema-cluster-hardware.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Field description:
4242
* `memory`: The hardware name is memory.
4343
* `disk`: The disk name.
4444
* `net`: The network card name.
45-
* `NAME`: The different information names of the hardware. For example, cpu has two information names: `cpu-logical-cores` and `cpu-physical-cores`, which respectively mean logical core numbers and physical core numbers.
46-
* `VALUE`: The value of the corresponding hardware information, such as the disk volume and CPU core numbers.
45+
* `NAME`: The different information names of the hardware. For example, cpu has two information names: `cpu-logical-cores` and `cpu-physical-cores`, which respectively mean the number of logical cores and the number of physical cores.
46+
* `VALUE`: The value of the corresponding hardware information, such as the disk volume and the number of CPU cores.
4747

4848
The following example shows how to query the CPU information using the `CLUSTER_HARDWARE` table:
4949

‎migrate-with-more-columns-downstream.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document provides the additional steps to be taken when you migrate data to
1414

1515
## Use DM to migrate data to a downstream TiDB table with more columns
1616

17-
When replicating the upstream binlog, DM tries to use the current table schema of the downstream to parse the binlog and generate the corresponding DML statements. If the column number of the table in the upstream binlog does not match the column number in the downstream table schema, the following error occurs:
17+
When replicating the upstream binlog, DM tries to use the current table schema of the downstream to parse the binlog and generate the corresponding DML statements. If the number of columns of the table in the upstream binlog does not match the number of columns in the downstream table schema, the following error occurs:
1818

1919
```json
2020
"errors": [

‎multi-data-centers-in-one-city-deployment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ The following example assumes that three AZs (AZ1, AZ2, and AZ3) are located in
103103

104104
#### TiKV labels
105105

106-
TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 96 MB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the TiKV instance numbers, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas.
106+
TiKV is a Multi-Raft system where data is divided into Regions and the size of each Region is 96 MB by default. Three replicas of each Region form a Raft group. For a TiDB cluster of three replicas, because the number of Region replicas is independent of the number of TiKV instances, three replicas of a Region are only scheduled to three TiKV instances. This means that even if the cluster is scaled out to have N TiKV instances, it is still a cluster of three replicas.
107107

108108
Because a Raft group of three replicas tolerates only one replica failure, even if the cluster is scaled out to have N TiKV instances, this cluster still tolerates only one replica failure. Two failed TiKV instances might cause some Regions to lose replicas and the data in this cluster is no longer complete. SQL requests that access data from these Regions will fail. The probability of two simultaneous failures among N TiKV instances is much higher than the probability of two simultaneous failures among three TiKV instances. This means that the more TiKV instances the Multi-Raft system is scaled out to have, the less the availability of the system.
109109

‎ticdc/ticdc-open-api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Compared to the optional parameters for creating a replication task using the `c
125125
| `ignore_ineligible_table` | `BOOLEAN` type. Determines whether to ignore the tables that cannot be replicated. (Optional) |
126126
| `filter_rules` | `STRING` type array. The rules for table schema filtering. (Optional) |
127127
| `ignore_txn_start_ts` | `UINT64` type array. Ignores the transaction of a specified start_ts. (Optional) |
128-
| `mounter_worker_num` | `INT` type. The mounter thread number. (Optional) |
128+
| `mounter_worker_num` | `INT` type. The number of mounter threads. (Optional) |
129129
| `sink_config` | The configuration parameters of sink. (Optional) |
130130

131131
The meaning and format of `changefeed_id`, `start_ts`, `target_ts`, and `sink_uri` are the same as those described in the [Use `cdc cli` to create a replication task](/ticdc/ticdc-manage-changefeed.md#create-a-replication-task) document. For the detailed description of these parameters, see this document. Note that when you specify the certificate path in `sink_uri`, make sure you have uploaded the corresponding certificate to the corresponding TiCDC server.
@@ -233,7 +233,7 @@ Currently, only the following configuration can be modified via the API.
233233
| `sink_uri` | `STRING` type. The downstream address of the replication task. (Optional) |
234234
| `filter_rules` | `STRING` type array. The rules for table schema filtering. (Optional) |
235235
| `ignore_txn_start_ts` | `UINT64` type array. Ignores the transaction of a specified start_ts. (Optional) |
236-
| `mounter_worker_num` | `INT` type. The mounter thread number. (Optional) |
236+
| `mounter_worker_num` | `INT` type. The number of mounter threads. (Optional) |
237237
| `sink_config` | The configuration parameters of sink. (Optional) |
238238

239239
The meanings of the above parameters are the same as those in the [Create a replication task](#create-a-replication-task) section. See that section for details.

0 commit comments

Comments
 (0)