diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index 3ed6652fbfd2d..edfdfc702e9b8 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -174,4 +174,14 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index 026e2fc0fb5c9..9b22c2bede5c6 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -163,4 +163,14 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index bc2100505c1f3..b977e373b3236 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -191,4 +191,14 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index be63b57564aa0..a4c1795a15cf3 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -211,20 +211,20 @@ You can deploy the AWS Lambda Function using either the [SAM CLI](#sam-cli-deplo # Setting default arguments for 'sam deploy' # ========================================= # Stack Name [sam-app]: tidb-aws-lambda-quickstart - # AWS Region [us-east-1]: + # AWS Region [us-east-1]: # #Shows you resources changes to be deployed and require a 'Y' to initiate deploy - # Confirm changes before deploy [y/N]: + # Confirm changes before deploy [y/N]: # #SAM needs permission to be able to create roles to connect to the resources in your template - # Allow SAM CLI IAM role creation [Y/n]: + # Allow SAM CLI IAM role creation [Y/n]: # #Preserves the state of previously provisioned resources when an operation fails - # Disable rollback [y/N]: + # Disable rollback [y/N]: # tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y # tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y # tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y # tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y - # Save arguments to configuration file [Y/n]: - # SAM configuration file [samconfig.toml]: - # SAM configuration environment [default]: + # Save arguments to configuration file [Y/n]: + # SAM configuration file [samconfig.toml]: + # SAM configuration environment [default]: # Looking for resources needed for deployment: # Creating the required resources... @@ -352,7 +352,7 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). - Using [connection pools](https://github.com/sidorares/node-mysql2#using-connection-pools) to manage database connections can reduce the performance overhead caused by frequently establishing and destroying connections. - To avoid SQL injection, it is recommended to use [prepared statements](https://github.com/sidorares/node-mysql2#using-prepared-statements). -- In scenarios where there are not many complex SQL statements involved, using ORM frameworks like [Sequelize](https://sequelize.org/), [TypeORM](https://typeorm.io/), or [Prisma](https://www.prisma.io/) can greatly improve development efficiency. +- In scenarios where there are not many complex SQL statements involved, using ORM frameworks like [Sequelize](https://sequelize.org/), [TypeORM](https://typeorm.io/), or [Prisma](https://www.prisma.io/) can greatly improve development efficiency. - For building a RESTful API for your application, it is recommended to [use AWS Lambda with API Gateway](https://docs.aws.amazon.com/lambda/latest/dg/services-apigateway.html). - For designing high-performance applications using TiDB Serverless and AWS Lambda, refer to [this blog](https://aws.amazon.com/blogs/apn/designing-high-performance-applications-using-serverless-tidb-cloud-and-aws-lambda/). @@ -366,4 +366,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index fc9f6790853dc..cd4bf5b3c89a4 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -79,7 +79,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -241,4 +241,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index f88df0c5e40eb..fd240792f4d87 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -80,7 +80,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -292,4 +292,14 @@ Unless you need to write complex SQL statements, it is recommended to use [ORM]( ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 427dd79f68641..2583b686b0587 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -264,4 +264,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index 5e27a770a12fb..526824204b409 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -298,4 +298,14 @@ Unless you need to write complex SQL statements, it is recommended to use [ORM]( ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index 42f06f386681e..059300036b0da 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -314,4 +314,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 9e224a708fb10..8e20113cb4032 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -269,4 +269,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index fa73096b00145..fbb40d67e6070 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: - [Node.js **18**](https://nodejs.org/en/download/) or later. - [Git](https://git-scm.com/downloads). -- A TiDB cluster. +- A TiDB cluster. @@ -282,4 +282,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index c2e2c9cd9f656..3c36db22fddd2 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -308,4 +308,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). \ No newline at end of file + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index e2c1a38bc35cb..52329e2577019 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -331,4 +331,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index ac1484546223c..5fe2b9004c6ec 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -369,4 +369,14 @@ To check [referential integrity](https://en.wikipedia.org/wiki/Referential_integ ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index c4c905fe75185..cef1ba8d3f5f0 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -102,7 +102,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele ``` 6. Edit the `.env` file, set up the environment variables as follows, replace the corresponding placeholders `{}` with connection parameters on the connection dialog: - + ```dotenv TIDB_HOST='{host}' TIDB_PORT='4000' @@ -322,4 +322,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index 5f3190e9ca552..7cda0b40f4ca7 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -368,4 +368,14 @@ For more information, refer to the [TypeORM FAQ](https://typeorm.io/relations-fa ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index 1c8e00dbfee8b..a93a2ea73681f 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -98,7 +98,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -329,4 +329,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index a6f27f3839d97..f7225b1be5ce5 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -88,7 +88,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -280,4 +280,14 @@ Unless you need to write complex SQL statements, it is recommended to use [ORM]( ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index df0d202d38455..895bcf1fc3022 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -89,7 +89,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -281,4 +281,14 @@ Unless you need to write complex SQL statements, it is recommended to use [ORM]( ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index a8183a7c17e23..e72c04dcba4ee 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -91,7 +91,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -304,4 +304,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 64fefd08cdeae..14fe43ccadf58 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -87,7 +87,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -284,4 +284,14 @@ Unless you need to write complex SQL statements, it is recommended to use [ORM]( ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index bb3a48f9bd9aa..6277ce09f4631 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -94,7 +94,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele 4. Click **Create password** to create a random password. > **Tip:** - > + > > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one. 5. Run the following command to copy `.env.example` and rename it to `.env`: @@ -294,4 +294,14 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ## Need help? -Ask questions on the [Discord](https://discord.gg/vYU9h56kAX), or [create a support ticket](https://support.pingcap.com/). + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md). + + + + + +Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](https://support.pingcap.com/). + + diff --git a/sql-statements/sql-statement-admin-cleanup.md b/sql-statements/sql-statement-admin-cleanup.md index f10b57705f273..a750ceee4f967 100644 --- a/sql-statements/sql-statement-admin-cleanup.md +++ b/sql-statements/sql-statement-admin-cleanup.md @@ -53,6 +53,23 @@ ADMIN CHECK INDEX tbl idx; Query OK, 0 rows affected (0.01 sec) ``` + + +> **Note:** +> +> When the data and index are inconsistent due to the loss of replicas: +> +> - There might be a loss of both row data and index data. To restore the consistency, use the `ADMIN CLEANUP INDEX` and [`ADMIN RECOVER INDEX`](/sql-statements/sql-statement-admin-recover.md) statements together. +> - The `ADMIN CLEANUP INDEX` statement is always executed in a single thread. When the table data is large, it is recommended to recover the index data by rebuilding the index. +> - When you execute the `ADMIN CLEANUP INDEX` statement, the corresponding table or index is not locked and TiDB allows other sessions to modify the table records at the same time. However, in this case, `ADMIN CLEANUP INDEX` might not be able to handle all table records correctly. Therefore, when you execute `ADMIN CLEANUP INDEX`, avoid modifying the table data at the same time. +> - If you use the enterprise edition of TiDB, you can [submit a request](/support.md) to contact the support engineer for help. +> +> The `ADMIN CLEANUP INDEX` statement is not atomic: if the statement is interrupted during execution, it is recommended to execute it again until it succeeds. + + + + + > **Note:** > > When the data and index are inconsistent due to the loss of replicas: @@ -64,6 +81,8 @@ Query OK, 0 rows affected (0.01 sec) > > The `ADMIN CLEANUP INDEX` statement is not atomic: if the statement is interrupted during execution, it is recommended to execute it again until it succeeds. + + ## MySQL compatibility This statement is a TiDB extension to MySQL syntax. diff --git a/sql-statements/sql-statement-admin-recover.md b/sql-statements/sql-statement-admin-recover.md index 07d8fb6c69fd4..1bcee6c87b933 100644 --- a/sql-statements/sql-statement-admin-recover.md +++ b/sql-statements/sql-statement-admin-recover.md @@ -51,6 +51,23 @@ ADMIN CHECK INDEX tbl idx; Query OK, 0 rows affected (0.01 sec) ``` + + +> **Note:** +> +> When the data and index are inconsistent due to the loss of replicas: +> +> - There might be a loss of both row data and index data. To address the issue, use the [`ADMIN CLEANUP INDEX`](/sql-statements/sql-statement-admin-cleanup.md) and `ADMIN RECOVER INDEX` statements together to recover the consistency of row data and index data. +> - The `ADMIN RECOVER INDEX` statement is always executed in a single thread. When the table data is large, it is recommended to recover the index data by rebuilding the index. +> - When you execute the `ADMIN RECOVER INDEX` statement, the corresponding table or index is not locked and TiDB allows other sessions to modify the table records at the same time. However, in this case, `ADMIN RECOVER INDEX` might not be able to handle all table records correctly. Therefore, when you execute `ADMIN RECOVER INDEX`, avoid modifying the table data at the same time. +> - If you use the enterprise edition of TiDB, you can [submit a request](/support.md) to contact the support engineer for help. +> +> The `ADMIN RECOVER INDEX` statement is not atomic: if the statement is interrupted during execution, it is recommended to execute it again until it succeeds. + + + + + > **Note:** > > When the data and index are inconsistent due to the loss of replicas: @@ -62,6 +79,8 @@ Query OK, 0 rows affected (0.01 sec) > > The `ADMIN RECOVER INDEX` statement is not atomic: if the statement is interrupted during execution, it is recommended to execute it again until it succeeds. + + ## MySQL compatibility This statement is a TiDB extension to MySQL syntax.