-
Notifications
You must be signed in to change notification settings - Fork 688
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add global sort related docs. (#14801)
- Loading branch information
1 parent
53174a7
commit 0387a25
Showing
5 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
title: TiDB Global Sort | ||
summary: Learn the use cases, limitations, usage, and implementation principles of the TiDB Global Sort. | ||
--- | ||
|
||
<!-- markdownlint-disable MD029 --> | ||
<!-- markdownlint-disable MD046 --> | ||
|
||
# TiDB Global Sort | ||
|
||
> **Warning:** | ||
> | ||
> This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. | ||
<CustomContent platform="tidb-cloud"> | ||
|
||
> **Note:** | ||
> | ||
> Currently, this feature is only applicable to TiDB Dedicated clusters. You cannot use it on TiDB Serverless clusters. | ||
</CustomContent> | ||
|
||
## Overview | ||
|
||
The TiDB Global Sort feature enhances the stability and efficiency of data import and DDL (Data Definition Language) operations. It serves as a general operator in the [distributed execution framework](/tidb-distributed-execution-framework.md), providing a global sort service on cloud. | ||
|
||
The Global Sort feature currently only supports using Amazon S3 as cloud storage. In future releases, it will be extended to support multiple shared storage interfaces, such as POSIX, enabling seamless integration with different storage systems. This flexibility enables efficient and adaptable data sorting for various use cases. | ||
|
||
## Use cases | ||
|
||
The Global Sort feature enhances the stability and efficiency of `IMPORT INTO` and `CREATE INDEX`. By globally sorting the data that are processed by the tasks, it improves the stability, controllability, and scalability of writing data to TiKV. This provides an enhanced user experience for data import and DDL tasks, as well as higher-quality services. | ||
|
||
The Global Sort feature executes tasks within the unified distributed parallel execution framework, ensuring efficient and parallel sorting of data on a global scale. | ||
|
||
## Limitations | ||
|
||
Currently, the Global Sort feature is not used as a component of the query execution process responsible for sorting query results. | ||
|
||
## Usage | ||
|
||
To enable Global Sort, follow these steps: | ||
|
||
1. Enable the distributed execution framework by setting the value of [`tidb_enable_dist_task`](/system-variables.md#tidb_enable_dist_task-new-in-v710) to `ON`: | ||
|
||
```sql | ||
SET GLOBAL tidb_enable_dist_task = ON; | ||
``` | ||
|
||
<CustomContent platform="tidb"> | ||
|
||
2. Set [`tidb_cloud_storage_uri`](/system-variables.md#tidb_cloud_storage_uri-new-in-v740) to a correct cloud storage path. See [an example](/br/backup-and-restore-storages.md). | ||
|
||
</CustomContent> | ||
<CustomContent platform="tidb-cloud"> | ||
|
||
2. Set [`tidb_cloud_storage_uri`](/system-variables.md#tidb_cloud_storage_uri-new-in-v740) to a correct cloud storage path. See [an example](https://docs.pingcap.com/tidb/stable/backup-and-restore-storages). | ||
|
||
</CustomContent> | ||
|
||
```sql | ||
SET GLOBAL tidb_cloud_storage_uri = 's3://my-bucket/test-data?role-arn=arn:aws:iam::888888888888:role/my-role' | ||
``` | ||
|
||
## Implementation principles | ||
|
||
The algorithm of the Global Sort feature is as follows: | ||
|
||
![Algorithm of Global Sort](/media/dist-task/global-sort.jpeg) | ||
|
||
The detailed implementation principles are as follows: | ||
|
||
### Step 1: Scan and prepare data | ||
|
||
1. After TiDB nodes scan a specific range of data (the data source can be either CSV data or table data in TiKV): | ||
|
||
1. TiDB nodes encode them into Key-Value pairs. | ||
2. TiDB nodes sort Key-Value pairs into several block data segments (the data segments are locally sorted), where each segment is one file and is uploaded into the cloud storage. | ||
|
||
2. The TiDB node also records a serial actual Key-Value ranges for each segment (referred to as a statistics file), which is a key preparation for scalable sort implementation. These files are then uploaded into the cloud storage along with the real data. | ||
|
||
### Step 2: Sort and distribute data | ||
|
||
From step 1, the Global Sort program obtains a list of sorted blocks and their corresponding statistics files, which provide the number of locally sorted blocks. The program also has a real data scope that can be used by PD to split and scatter. The following steps are performed: | ||
|
||
1. Sort the records in the statistics file to divide them into nearly equal-sized ranges, which are subtasks that will be executed in parallel. | ||
2. Distribute the subtasks to TiDB nodes for execution. | ||
3. Each TiDB node independently sorts the data of subtasks into ranges and ingests them into TiKV without overlap. |