From a73baf3eb855ceed464022ccde145404b024647c Mon Sep 17 00:00:00 2001 From: qiancai Date: Thu, 5 Feb 2026 11:53:15 +0800 Subject: [PATCH] Reorganize docs and update internal links --- TOC-tidb-cloud.md | 2 +- TOC.md | 325 +----------------- .../best-practices-on-public-cloud.md | 0 .../ddl-introduction.md | 0 develop/dev-guide-connection-parameters.md | 2 +- .../dev-guide-optimize-sql-best-practices.md | 2 +- .../java-app-best-practices.md | 0 faq/sql-faq.md | 2 +- performance-tuning-practices.md | 2 +- releases/release-7.0.0.md | 6 +- releases/release-7.1.0.md | 2 +- releases/release-7.2.0.md | 2 +- releases/release-7.5.0.md | 2 +- .../sql-statement-admin-show-ddl.md | 2 +- telemetry.md | 2 +- tidb-distributed-execution-framework.md | 2 +- upgrade-tidb-using-tiup.md | 6 +- 17 files changed, 18 insertions(+), 341 deletions(-) rename best-practices-on-public-cloud.md => best-practices/best-practices-on-public-cloud.md (100%) rename ddl-introduction.md => best-practices/ddl-introduction.md (100%) rename {best-practices => develop}/java-app-best-practices.md (100%) diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 5d069a1c3aa29..dc3010b726af7 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -735,7 +735,7 @@ - [Table Filter](/table-filter.md) - [Resource Control](/tidb-resource-control.md) - [URI Formats of External Storage Services](/external-storage-uri.md) - - [DDL Execution Principles and Best Practices](/ddl-introduction.md) + - [DDL Execution Principles and Best Practices](/best-practices/ddl-introduction.md) - [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md) - [Support](/tidb-cloud/tidb-cloud-support.md) - [Glossary](/tidb-cloud/tidb-cloud-glossary.md) diff --git a/TOC.md b/TOC.md index 233b9194d50e3..092bb14858095 100644 --- a/TOC.md +++ b/TOC.md @@ -14,100 +14,6 @@ - [Learn TiDB SQL](/basic-sql-operations.md) - [Learn HTAP](/explore-htap.md) - [Import Example Database](/import-example-data.md) -- Develop - - [Overview](/develop/dev-guide-overview.md) - - Quick Start - - [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) - - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) - - Example Applications - - Java - - [JDBC](/develop/dev-guide-sample-application-java-jdbc.md) - - [MyBatis](/develop/dev-guide-sample-application-java-mybatis.md) - - [Hibernate](/develop/dev-guide-sample-application-java-hibernate.md) - - [Spring Boot](/develop/dev-guide-sample-application-java-spring-boot.md) - - Go - - [Go-MySQL-Driver](/develop/dev-guide-sample-application-golang-sql-driver.md) - - [GORM](/develop/dev-guide-sample-application-golang-gorm.md) - - Python - - [mysqlclient](/develop/dev-guide-sample-application-python-mysqlclient.md) - - [MySQL Connector/Python](/develop/dev-guide-sample-application-python-mysql-connector.md) - - [PyMySQL](/develop/dev-guide-sample-application-python-pymysql.md) - - [SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md) - - [peewee](/develop/dev-guide-sample-application-python-peewee.md) - - [Django](/develop/dev-guide-sample-application-python-django.md) - - Node.js - - [node-mysql2](/develop/dev-guide-sample-application-nodejs-mysql2.md) - - [mysql.js](/develop/dev-guide-sample-application-nodejs-mysqljs.md) - - [Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) - - [Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) - - [TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md) - - [Next.js](/develop/dev-guide-sample-application-nextjs.md) - - [AWS Lambda](/develop/dev-guide-sample-application-aws-lambda.md) - - Ruby - - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md) - - [Rails](/develop/dev-guide-sample-application-ruby-rails.md) - - Connect to TiDB - - GUI Database Tools - - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md) - - [DBeaver](/develop/dev-guide-gui-dbeaver.md) - - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md) - - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md) - - [Navicat](/develop/dev-guide-gui-navicat.md) - - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md) - - [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md) - - [Connection Pools and Connection Parameters](/develop/dev-guide-connection-parameters.md) - - Design Database Schema - - [Overview](/develop/dev-guide-schema-design-overview.md) - - [Create a Database](/develop/dev-guide-create-database.md) - - [Create a Table](/develop/dev-guide-create-table.md) - - [Create a Secondary Index](/develop/dev-guide-create-secondary-indexes.md) - - Write Data - - [Insert Data](/develop/dev-guide-insert-data.md) - - [Update Data](/develop/dev-guide-update-data.md) - - [Delete Data](/develop/dev-guide-delete-data.md) - - [Periodically Delete Data Using Time to Live](/time-to-live.md) - - [Prepared Statements](/develop/dev-guide-prepared-statement.md) - - Read Data - - [Query Data from a Single Table](/develop/dev-guide-get-data-from-single-table.md) - - [Multi-table Join Queries](/develop/dev-guide-join-tables.md) - - [Subquery](/develop/dev-guide-use-subqueries.md) - - [Paginate Results](/develop/dev-guide-paginate-results.md) - - [Views](/develop/dev-guide-use-views.md) - - [Temporary Tables](/develop/dev-guide-use-temporary-tables.md) - - [Common Table Expression](/develop/dev-guide-use-common-table-expression.md) - - Read Replica Data - - [Follower Read](/develop/dev-guide-use-follower-read.md) - - [Stale Read](/develop/dev-guide-use-stale-read.md) - - [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md) - - Transaction - - [Overview](/develop/dev-guide-transaction-overview.md) - - [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md) - - [Transaction Restraints](/develop/dev-guide-transaction-restraints.md) - - [Handle Transaction Errors](/develop/dev-guide-transaction-troubleshoot.md) - - Optimize - - [Overview](/develop/dev-guide-optimize-sql-overview.md) - - [SQL Performance Tuning](/develop/dev-guide-optimize-sql.md) - - [Best Practices for Performance Tuning](/develop/dev-guide-optimize-sql-best-practices.md) - - [Best Practices for Indexing](/develop/dev-guide-index-best-practice.md) - - Other Optimization Methods - - [Avoid Implicit Type Conversions](/develop/dev-guide-implicit-type-conversion.md) - - [Unique Serial Number Generation](/develop/dev-guide-unique-serial-number-generation.md) - - Troubleshoot - - [SQL or Transaction Issues](/develop/dev-guide-troubleshoot-overview.md) - - [Unstable Result Set](/develop/dev-guide-unstable-result-set.md) - - [Timeouts](/develop/dev-guide-timeouts-in-tidb.md) - - Reference - - [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md) - - Guidelines - - [Object Naming Convention](/develop/dev-guide-object-naming-guidelines.md) - - [SQL Development Specifications](/develop/dev-guide-sql-development-specification.md) - - Cloud Native Development Environment - - [Gitpod](/develop/dev-guide-playground-gitpod.md) - - Third-Party Support - - [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md) - - [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md) - - [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md) - - [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md) - Deploy - [Software and Hardware Requirements](/hardware-and-software-requirements.md) - [Environment Configuration Checklist](/check-before-deployment.md) @@ -282,7 +188,6 @@ - [TiFlash Performance Analysis Methods](/tiflash-performance-tuning-methods.md) - [TiCDC Performance Analysis Methods](/ticdc-performance-tuning-methods.md) - [Latency Breakdown](/latency-breakdown.md) - - [TiDB Best Practices on Public Cloud](/best-practices-on-public-cloud.md) - Configuration Tuning - [Tune Operating System Performance](/tune-operating-system.md) - [Tune TiDB Memory](/configure-memory-usage.md) @@ -349,22 +254,9 @@ - [Perform Stale Read Using `tidb_read_staleness`](/tidb-read-staleness.md) - [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md) - [Use the `tidb_snapshot` System Variable](/read-historical-data.md) - - Best Practices - - [Use TiDB](/best-practices/tidb-best-practices.md) - - [Java Application Development](/best-practices/java-app-best-practices.md) - - [Use HAProxy](/best-practices/haproxy-best-practices.md) - - [Highly Concurrent Write](/best-practices/high-concurrency-best-practices.md) - - [Grafana Monitoring](/best-practices/grafana-monitor-best-practices.md) - - [PD Scheduling](/best-practices/pd-scheduling-best-practices.md) - - [TiKV Performance Tuning with Massive Regions](/best-practices/massive-regions-best-practices.md) - - [Three-node Hybrid Deployment](/best-practices/three-nodes-hybrid-deployment.md) - - [Local Read Under Three Data Centers Deployment](/best-practices/three-dc-local-read.md) - - [Use UUIDs](/best-practices/uuid.md) - - [Read-Only Storage Nodes](/best-practices/readonly-nodes.md) - [Use Placement Rules](/configure-placement-rules.md) - [Use Load Base Split](/configure-load-base-split.md) - [Use Store Limit](/configure-store-limit.md) - - [DDL Execution Principles and Best Practices](/ddl-introduction.md) - TiDB Tools - [Overview](/ecosystem-tool-user-guide.md) - [Use Cases](/ecosystem-tool-user-case.md) @@ -1011,6 +903,7 @@ - [Metadata Lock](/metadata-lock.md) - [Telemetry](/telemetry.md) - [Error Codes](/error-codes.md) + - [TiDB Installation Packages](/binary-package.md) - [Table Filter](/table-filter.md) - [Schedule Replicas by Topology Labels](/schedule-replicas-by-topology-labels.md) - [URI Formats of External Storage Services](/external-storage-uri.md) @@ -1026,220 +919,4 @@ - [High Availability FAQs](/faq/high-availability-faq.md) - [High Reliability FAQs](/faq/high-reliability-faq.md) - [Backup and Restore FAQs](/faq/backup-and-restore-faq.md) -- Release Notes - - [All Releases](/releases/release-notes.md) - - [Release Timeline](/releases/release-timeline.md) - - [TiDB Versioning](/releases/versioning.md) - - [TiDB Installation Packages](/binary-package.md) - - v7.5 - - [7.5.7](/releases/release-7.5.7.md) - - [7.5.6](/releases/release-7.5.6.md) - - [7.5.5](/releases/release-7.5.5.md) - - [7.5.4](/releases/release-7.5.4.md) - - [7.5.3](/releases/release-7.5.3.md) - - [7.5.2](/releases/release-7.5.2.md) - - [7.5.1](/releases/release-7.5.1.md) - - [7.5.0](/releases/release-7.5.0.md) - - v7.4 - - [7.4.0-DMR](/releases/release-7.4.0.md) - - v7.3 - - [7.3.0-DMR](/releases/release-7.3.0.md) - - v7.2 - - [7.2.0-DMR](/releases/release-7.2.0.md) - - v7.1 - - [7.1.6](/releases/release-7.1.6.md) - - [7.1.5](/releases/release-7.1.5.md) - - [7.1.4](/releases/release-7.1.4.md) - - [7.1.3](/releases/release-7.1.3.md) - - [7.1.2](/releases/release-7.1.2.md) - - [7.1.1](/releases/release-7.1.1.md) - - [7.1.0](/releases/release-7.1.0.md) - - v7.0 - - [7.0.0-DMR](/releases/release-7.0.0.md) - - v6.6 - - [6.6.0-DMR](/releases/release-6.6.0.md) - - v6.5 - - [6.5.12](/releases/release-6.5.12.md) - - [6.5.11](/releases/release-6.5.11.md) - - [6.5.10](/releases/release-6.5.10.md) - - [6.5.9](/releases/release-6.5.9.md) - - [6.5.8](/releases/release-6.5.8.md) - - [6.5.7](/releases/release-6.5.7.md) - - [6.5.6](/releases/release-6.5.6.md) - - [6.5.5](/releases/release-6.5.5.md) - - [6.5.4](/releases/release-6.5.4.md) - - [6.5.3](/releases/release-6.5.3.md) - - [6.5.2](/releases/release-6.5.2.md) - - [6.5.1](/releases/release-6.5.1.md) - - [6.5.0](/releases/release-6.5.0.md) - - v6.4 - - [6.4.0-DMR](/releases/release-6.4.0.md) - - v6.3 - - [6.3.0-DMR](/releases/release-6.3.0.md) - - v6.2 - - [6.2.0-DMR](/releases/release-6.2.0.md) - - v6.1 - - [6.1.7](/releases/release-6.1.7.md) - - [6.1.6](/releases/release-6.1.6.md) - - [6.1.5](/releases/release-6.1.5.md) - - [6.1.4](/releases/release-6.1.4.md) - - [6.1.3](/releases/release-6.1.3.md) - - [6.1.2](/releases/release-6.1.2.md) - - [6.1.1](/releases/release-6.1.1.md) - - [6.1.0](/releases/release-6.1.0.md) - - v6.0 - - [6.0.0-DMR](/releases/release-6.0.0-dmr.md) - - v5.4 - - [5.4.3](/releases/release-5.4.3.md) - - [5.4.2](/releases/release-5.4.2.md) - - [5.4.1](/releases/release-5.4.1.md) - - [5.4.0](/releases/release-5.4.0.md) - - v5.3 - - [5.3.4](/releases/release-5.3.4.md) - - [5.3.3](/releases/release-5.3.3.md) - - [5.3.2](/releases/release-5.3.2.md) - - [5.3.1](/releases/release-5.3.1.md) - - [5.3.0](/releases/release-5.3.0.md) - - v5.2 - - [5.2.4](/releases/release-5.2.4.md) - - [5.2.3](/releases/release-5.2.3.md) - - [5.2.2](/releases/release-5.2.2.md) - - [5.2.1](/releases/release-5.2.1.md) - - [5.2.0](/releases/release-5.2.0.md) - - v5.1 - - [5.1.5](/releases/release-5.1.5.md) - - [5.1.4](/releases/release-5.1.4.md) - - [5.1.3](/releases/release-5.1.3.md) - - [5.1.2](/releases/release-5.1.2.md) - - [5.1.1](/releases/release-5.1.1.md) - - [5.1.0](/releases/release-5.1.0.md) - - v5.0 - - [5.0.6](/releases/release-5.0.6.md) - - [5.0.5](/releases/release-5.0.5.md) - - [5.0.4](/releases/release-5.0.4.md) - - [5.0.3](/releases/release-5.0.3.md) - - [5.0.2](/releases/release-5.0.2.md) - - [5.0.1](/releases/release-5.0.1.md) - - [5.0 GA](/releases/release-5.0.0.md) - - [5.0.0-rc](/releases/release-5.0.0-rc.md) - - v4.0 - - [4.0.16](/releases/release-4.0.16.md) - - [4.0.15](/releases/release-4.0.15.md) - - [4.0.14](/releases/release-4.0.14.md) - - [4.0.13](/releases/release-4.0.13.md) - - [4.0.12](/releases/release-4.0.12.md) - - [4.0.11](/releases/release-4.0.11.md) - - [4.0.10](/releases/release-4.0.10.md) - - [4.0.9](/releases/release-4.0.9.md) - - [4.0.8](/releases/release-4.0.8.md) - - [4.0.7](/releases/release-4.0.7.md) - - [4.0.6](/releases/release-4.0.6.md) - - [4.0.5](/releases/release-4.0.5.md) - - [4.0.4](/releases/release-4.0.4.md) - - [4.0.3](/releases/release-4.0.3.md) - - [4.0.2](/releases/release-4.0.2.md) - - [4.0.1](/releases/release-4.0.1.md) - - [4.0 GA](/releases/release-4.0-ga.md) - - [4.0.0-rc.2](/releases/release-4.0.0-rc.2.md) - - [4.0.0-rc.1](/releases/release-4.0.0-rc.1.md) - - [4.0.0-rc](/releases/release-4.0.0-rc.md) - - [4.0.0-beta.2](/releases/release-4.0.0-beta.2.md) - - [4.0.0-beta.1](/releases/release-4.0.0-beta.1.md) - - [4.0.0-beta](/releases/release-4.0.0-beta.md) - - v3.1 - - [3.1.2](/releases/release-3.1.2.md) - - [3.1.1](/releases/release-3.1.1.md) - - [3.1.0 GA](/releases/release-3.1.0-ga.md) - - [3.1.0-rc](/releases/release-3.1.0-rc.md) - - [3.1.0-beta.2](/releases/release-3.1.0-beta.2.md) - - [3.1.0-beta.1](/releases/release-3.1.0-beta.1.md) - - [3.1.0-beta](/releases/release-3.1.0-beta.md) - - v3.0 - - [3.0.20](/releases/release-3.0.20.md) - - [3.0.19](/releases/release-3.0.19.md) - - [3.0.18](/releases/release-3.0.18.md) - - [3.0.17](/releases/release-3.0.17.md) - - [3.0.16](/releases/release-3.0.16.md) - - [3.0.15](/releases/release-3.0.15.md) - - [3.0.14](/releases/release-3.0.14.md) - - [3.0.13](/releases/release-3.0.13.md) - - [3.0.12](/releases/release-3.0.12.md) - - [3.0.11](/releases/release-3.0.11.md) - - [3.0.10](/releases/release-3.0.10.md) - - [3.0.9](/releases/release-3.0.9.md) - - [3.0.8](/releases/release-3.0.8.md) - - [3.0.7](/releases/release-3.0.7.md) - - [3.0.6](/releases/release-3.0.6.md) - - [3.0.5](/releases/release-3.0.5.md) - - [3.0.4](/releases/release-3.0.4.md) - - [3.0.3](/releases/release-3.0.3.md) - - [3.0.2](/releases/release-3.0.2.md) - - [3.0.1](/releases/release-3.0.1.md) - - [3.0 GA](/releases/release-3.0-ga.md) - - [3.0.0-rc.3](/releases/release-3.0.0-rc.3.md) - - [3.0.0-rc.2](/releases/release-3.0.0-rc.2.md) - - [3.0.0-rc.1](/releases/release-3.0.0-rc.1.md) - - [3.0.0-beta.1](/releases/release-3.0.0-beta.1.md) - - [3.0.0-beta](/releases/release-3.0-beta.md) - - v2.1 - - [2.1.19](/releases/release-2.1.19.md) - - [2.1.18](/releases/release-2.1.18.md) - - [2.1.17](/releases/release-2.1.17.md) - - [2.1.16](/releases/release-2.1.16.md) - - [2.1.15](/releases/release-2.1.15.md) - - [2.1.14](/releases/release-2.1.14.md) - - [2.1.13](/releases/release-2.1.13.md) - - [2.1.12](/releases/release-2.1.12.md) - - [2.1.11](/releases/release-2.1.11.md) - - [2.1.10](/releases/release-2.1.10.md) - - [2.1.9](/releases/release-2.1.9.md) - - [2.1.8](/releases/release-2.1.8.md) - - [2.1.7](/releases/release-2.1.7.md) - - [2.1.6](/releases/release-2.1.6.md) - - [2.1.5](/releases/release-2.1.5.md) - - [2.1.4](/releases/release-2.1.4.md) - - [2.1.3](/releases/release-2.1.3.md) - - [2.1.2](/releases/release-2.1.2.md) - - [2.1.1](/releases/release-2.1.1.md) - - [2.1 GA](/releases/release-2.1-ga.md) - - [2.1 RC5](/releases/release-2.1-rc.5.md) - - [2.1 RC4](/releases/release-2.1-rc.4.md) - - [2.1 RC3](/releases/release-2.1-rc.3.md) - - [2.1 RC2](/releases/release-2.1-rc.2.md) - - [2.1 RC1](/releases/release-2.1-rc.1.md) - - [2.1 Beta](/releases/release-2.1-beta.md) - - v2.0 - - [2.0.11](/releases/release-2.0.11.md) - - [2.0.10](/releases/release-2.0.10.md) - - [2.0.9](/releases/release-2.0.9.md) - - [2.0.8](/releases/release-2.0.8.md) - - [2.0.7](/releases/release-2.0.7.md) - - [2.0.6](/releases/release-2.0.6.md) - - [2.0.5](/releases/release-2.0.5.md) - - [2.0.4](/releases/release-2.0.4.md) - - [2.0.3](/releases/release-2.0.3.md) - - [2.0.2](/releases/release-2.0.2.md) - - [2.0.1](/releases/release-2.0.1.md) - - [2.0](/releases/release-2.0-ga.md) - - [2.0 RC5](/releases/release-2.0-rc.5.md) - - [2.0 RC4](/releases/release-2.0-rc.4.md) - - [2.0 RC3](/releases/release-2.0-rc.3.md) - - [2.0 RC1](/releases/release-2.0-rc.1.md) - - [1.1 Beta](/releases/release-1.1-beta.md) - - [1.1 Alpha](/releases/release-1.1-alpha.md) - - v1.0 - - [1.0.8](/releases/release-1.0.8.md) - - [1.0.7](/releases/release-1.0.7.md) - - [1.0.6](/releases/release-1.0.6.md) - - [1.0.5](/releases/release-1.0.5.md) - - [1.0.4](/releases/release-1.0.4.md) - - [1.0.3](/releases/release-1.0.3.md) - - [1.0.2](/releases/release-1.0.2.md) - - [1.0.1](/releases/release-1.0.1.md) - - [1.0](/releases/release-1.0-ga.md) - - [Pre-GA](/releases/release-pre-ga.md) - - [RC4](/releases/release-rc.4.md) - - [RC3](/releases/release-rc.3.md) - - [RC2](/releases/release-rc.2.md) - - [RC1](/releases/release-rc.1.md) - [Glossary](/glossary.md) diff --git a/best-practices-on-public-cloud.md b/best-practices/best-practices-on-public-cloud.md similarity index 100% rename from best-practices-on-public-cloud.md rename to best-practices/best-practices-on-public-cloud.md diff --git a/ddl-introduction.md b/best-practices/ddl-introduction.md similarity index 100% rename from ddl-introduction.md rename to best-practices/ddl-introduction.md diff --git a/develop/dev-guide-connection-parameters.md b/develop/dev-guide-connection-parameters.md index 5c8d59770c3a3..46ebc92f08c86 100644 --- a/develop/dev-guide-connection-parameters.md +++ b/develop/dev-guide-connection-parameters.md @@ -9,7 +9,7 @@ This document describes how to configure connection pools and connection paramet -If you are interested in more tips about Java application development, see [Best Practices for Developing Java Applications with TiDB](/best-practices/java-app-best-practices.md#connection-pool) +If you are interested in more tips about Java application development, see [Best Practices for Developing Java Applications with TiDB](/develop/java-app-best-practices.md#connection-pool) diff --git a/develop/dev-guide-optimize-sql-best-practices.md b/develop/dev-guide-optimize-sql-best-practices.md index 95cd4445c6cd7..1f3a62262fbc7 100644 --- a/develop/dev-guide-optimize-sql-best-practices.md +++ b/develop/dev-guide-optimize-sql-best-practices.md @@ -167,7 +167,7 @@ For how to locate and resolve transaction conflicts, see [Troubleshoot Lock Conf -See [Best Practices for Developing Java Applications with TiDB](/best-practices/java-app-best-practices.md). +See [Best Practices for Developing Java Applications with TiDB](/develop/java-app-best-practices.md). diff --git a/best-practices/java-app-best-practices.md b/develop/java-app-best-practices.md similarity index 100% rename from best-practices/java-app-best-practices.md rename to develop/java-app-best-practices.md diff --git a/faq/sql-faq.md b/faq/sql-faq.md index 8af7ba2c51cb3..8e098d446ba5b 100644 --- a/faq/sql-faq.md +++ b/faq/sql-faq.md @@ -247,7 +247,7 @@ SELECT column_name FROM table_name USE INDEX（index_name）WHERE where_conditio ## DDL Execution -This section lists issues related to DDL statement execution. For detailed explanations on the DDL execution principles, see [Execution Principles and Best Practices of DDL Statements](/ddl-introduction.md). +This section lists issues related to DDL statement execution. For detailed explanations on the DDL execution principles, see [Execution Principles and Best Practices of DDL Statements](/best-practices/ddl-introduction.md). ### How long does it take to perform various DDL operations? diff --git a/performance-tuning-practices.md b/performance-tuning-practices.md index 1704b228e6f9d..7d31749bf1106 100644 --- a/performance-tuning-practices.md +++ b/performance-tuning-practices.md @@ -13,7 +13,7 @@ This document describes how to use these features together to analyze and compar > > [Top SQL](/dashboard/top-sql.md) and [Continuous Profiling](/dashboard/continuous-profiling.md) are not enabled by default. You need to enable them in advance. -By running the same application with different JDBC configurations in these scenarios, this document shows you how the overall system performance is affected by different interactions between applications and databases, so that you can apply [Best Practices for Developing Java Applications with TiDB](/best-practices/java-app-best-practices.md) for better performance. +By running the same application with different JDBC configurations in these scenarios, this document shows you how the overall system performance is affected by different interactions between applications and databases, so that you can apply [Best Practices for Developing Java Applications with TiDB](/develop/java-app-best-practices.md) for better performance. ## Environment description diff --git a/releases/release-7.0.0.md b/releases/release-7.0.0.md index 8c33c35ba0cd4..8900eb5d9e030 100644 --- a/releases/release-7.0.0.md +++ b/releases/release-7.0.0.md @@ -86,7 +86,7 @@ In v7.0.0-DMR, the key new features and improvements are as follows: Starting from TiDB v7.0.0, Fast Online DDL and PITR are fully compatible. When restoring cluster data through PITR, the index operations added via Fast Online DDL during log backup will be automatically replayed to achieve compatibility. - For more information, see [documentation](/ddl-introduction.md). + For more information, see [documentation](/best-practices/ddl-introduction.md). * TiFlash supports null-aware semi join and null-aware anti semi join operators [#6674](https://github.com/pingcap/tiflash/issues/6674) @[gengliqi](https://github.com/gengliqi) @@ -142,7 +142,7 @@ In v7.0.0-DMR, the key new features and improvements are as follows: TiDB v6.5.0 supports creating ordinary secondary indexes via Fast Online DDL. TiDB v7.0.0 supports creating unique indexes via Fast Online DDL. Compared to v6.1.0, adding unique indexes to large tables is expected to be several times faster with improved performance. - For more information, see [documentation](/ddl-introduction.md). + For more information, see [documentation](/best-practices/ddl-introduction.md). ### Reliability @@ -168,7 +168,7 @@ In v7.0.0-DMR, the key new features and improvements are as follows: TiDB v7.0.0 introduces a checkpoint mechanism for [Fast Online DDL](/system-variables.md#tidb_ddl_enable_fast_reorg-new-in-v630), which significantly improves its fault tolerance and automatic recovery capabilities. By periodically recording and synchronizing the DDL progress, ongoing DDL operations can continue to be executed in Fast Online DDL mode even if there is a TiDB DDL Owner failure or switch. This makes the execution of DDL more stable and efficient. - For more information, see [documentation](/ddl-introduction.md). + For more information, see [documentation](/best-practices/ddl-introduction.md). * TiFlash supports spilling to disk [#6528](https://github.com/pingcap/tiflash/issues/6528) @[windtalker](https://github.com/windtalker) diff --git a/releases/release-7.1.0.md b/releases/release-7.1.0.md index d228392800fa8..ffb18261b535e 100644 --- a/releases/release-7.1.0.md +++ b/releases/release-7.1.0.md @@ -156,7 +156,7 @@ Compared with the previous LTS 6.5.0, 7.1.0 not only includes new features, impr * Support the checkpoint mechanism for Fast Online DDL to improve fault tolerance and automatic recovery capability [#42164](https://github.com/pingcap/tidb/issues/42164) @[tangenta](https://github.com/tangenta) - TiDB v7.1.0 introduces a checkpoint mechanism for [Fast Online DDL](/ddl-introduction.md), which significantly improves the fault tolerance and automatic recovery capability of Fast Online DDL. Even if the TiDB owner node is restarted or changed due to failures, TiDB can still recover progress from checkpoints that are automatically updated on a regular basis, making the DDL execution more stable and efficient. + TiDB v7.1.0 introduces a checkpoint mechanism for [Fast Online DDL](/best-practices/ddl-introduction.md), which significantly improves the fault tolerance and automatic recovery capability of Fast Online DDL. Even if the TiDB owner node is restarted or changed due to failures, TiDB can still recover progress from checkpoints that are automatically updated on a regular basis, making the DDL execution more stable and efficient. For more information, see [documentation](/system-variables.md#tidb_ddl_enable_fast_reorg-new-in-v630). diff --git a/releases/release-7.2.0.md b/releases/release-7.2.0.md index 20620f138ae16..76dd43ebde4d1 100644 --- a/releases/release-7.2.0.md +++ b/releases/release-7.2.0.md @@ -146,7 +146,7 @@ Quick access: [Quick start](https://docs-archive.pingcap.com/tidb/v7.2/quick-sta ADMIN RESUME DDL JOBS 1,2; ``` - For more information, see [documentation](/ddl-introduction.md#ddl-related-commands). + For more information, see [documentation](/best-practices/ddl-introduction.md#ddl-related-commands). ### Data migration diff --git a/releases/release-7.5.0.md b/releases/release-7.5.0.md index c01b4a61323a6..cb6b6c6c9db44 100644 --- a/releases/release-7.5.0.md +++ b/releases/release-7.5.0.md @@ -110,7 +110,7 @@ Compared with the previous LTS 7.1.0, 7.5.0 includes new features, improvements, ADMIN RESUME DDL JOBS 1,2; ``` - For more information, see [documentation](/ddl-introduction.md#ddl-related-commands). + For more information, see [documentation](/best-practices/ddl-introduction.md#ddl-related-commands). * BR supports backing up and restoring statistics [#48008](https://github.com/pingcap/tidb/issues/48008) @[Leavrth](https://github.com/Leavrth) diff --git a/sql-statements/sql-statement-admin-show-ddl.md b/sql-statements/sql-statement-admin-show-ddl.md index d37376c7814b7..f89a837be0bce 100644 --- a/sql-statements/sql-statement-admin-show-ddl.md +++ b/sql-statements/sql-statement-admin-show-ddl.md @@ -67,7 +67,7 @@ The `ADMIN SHOW DDL JOBS` statement is used to view all the results in the curre - `txn-merge`: Transactional backfill with a temporary index that gets merged with the original index when the backfill is finished. - `SCHEMA_STATE`: the current state of the schema object that the DDL operates on. If `JOB_TYPE` is `ADD INDEX`, it is the state of the index; if `JOB_TYPE` is `ADD COLUMN`, it is the state of the column; if `JOB_TYPE` is `CREATE TABLE`, it is the state of the table. Common states include the following: - `none`: indicates that it does not exist. Generally, after the `DROP` operation or after the `CREATE` operation fails and rolls back, it will become the `none` state. - - `delete only`, `write only`, `delete reorganization`, `write reorganization`: these four states are intermediate states. For their specific meanings, see [How the Online DDL Asynchronous Change Works in TiDB](/ddl-introduction.md#how-the-online-ddl-asynchronous-change-works-in-tidb). As the intermediate state conversion is fast, these states are generally not visible during operation. Only when performing `ADD INDEX` operation can the `write reorganization` state be seen, indicating that index data is being added. + - `delete only`, `write only`, `delete reorganization`, `write reorganization`: these four states are intermediate states. For their specific meanings, see [How the Online DDL Asynchronous Change Works in TiDB](/best-practices/ddl-introduction.md#how-the-online-ddl-asynchronous-change-works-in-tidb). As the intermediate state conversion is fast, these states are generally not visible during operation. Only when performing `ADD INDEX` operation can the `write reorganization` state be seen, indicating that index data is being added. - `public`: indicates that it exists and is available to users. Generally, after `CREATE TABLE` and `ADD INDEX` (or `ADD COLUMN`) operations are completed, it will become the `public` state, indicating that the newly created table, column, and index can be read and written normally. - `SCHEMA_ID`: the ID of the database where the DDL operation is performed. - `TABLE_ID`: the ID of the table where the DDL operation is performed. diff --git a/telemetry.md b/telemetry.md index e7ce249427f1d..5dcd2be951c14 100644 --- a/telemetry.md +++ b/telemetry.md @@ -14,7 +14,7 @@ When the telemetry is enabled, TiDB, TiUP and TiDB Dashboard collect usage infor ## What is shared? -The following sections describe the shared usage information in detail for each component. The usage details that get shared might change over time. These changes (if any) will be announced in [release notes](/releases/release-notes.md). +The following sections describe the shared usage information in detail for each component. The usage details that get shared might change over time. These changes (if any) will be announced in [release notes](https://docs.pingcap.com/releases/tidb-self-managed/). > **Note:** > diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index 5a2a1899aeb6c..d4fdcf7a0bcb7 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -113,7 +113,7 @@ As shown in the preceding diagram, the execution of tasks in the DXF is mainly h -* [Execution Principles and Best Practices of DDL Statements](/ddl-introduction.md) +* [Execution Principles and Best Practices of DDL Statements](/best-practices/ddl-introduction.md) diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index a95ab74f477b3..c4daf6a11fd85 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -37,7 +37,7 @@ This document is targeted for the following upgrade paths: 4. Upgrade the cluster to v{{{ .tidb-version }}} according to this document. - Support upgrading the versions of TiDB Binlog, TiCDC, TiFlash, and other components. - When upgrading TiFlash from versions earlier than v6.3.0 to v6.3.0 and later versions, note that the CPU must support the AVX2 instruction set under the Linux AMD64 architecture and the ARMv8 instruction set architecture under the Linux ARM64 architecture. For details, see the description in [v6.3.0 Release Notes](/releases/release-6.3.0.md#others). -- For detailed compatibility changes of different versions, see the [Release Notes](/releases/release-notes.md) of each version. Modify your cluster configuration according to the "Compatibility Changes" section of the corresponding release notes. +- For detailed compatibility changes of different versions, see the [Release Notes](https://docs.pingcap.com/releases/tidb-self-managed/) of each version. Modify your cluster configuration according to the "Compatibility Changes" section of the corresponding release notes. - For clusters that upgrade from versions earlier than v5.3 to v5.3 or later versions, the default deployed Prometheus will upgrade from v2.8.1 to v2.27.1. Prometheus v2.27.1 provides more features and fixes a security issue. Compared with v2.8.1, alert time representation in v2.27.1 is changed. For more details, see [Prometheus commit](https://github.com/prometheus/prometheus/commit/7646cbca328278585be15fa615e22f2a50b47d06) for more details. ## Preparations @@ -48,7 +48,7 @@ This section introduces the preparation works needed before upgrading your TiDB Review compatibility changes in TiDB release notes. If any changes affect your upgrade, take actions accordingly. -The following provides compatibility changes you need to know when you upgrade from v7.5.0 to the current version (v{{{ .tidb-version }}}). If you are upgrading from v7.4.0 or earlier versions to the current version, you might also need to check the compatibility changes introduced in intermediate versions in the corresponding [release notes](/releases/release-notes.md). +The following provides compatibility changes you need to know when you upgrade from v7.5.0 to the current version (v{{{ .tidb-version }}}). If you are upgrading from v7.4.0 or earlier versions to the current version, you might also need to check the compatibility changes introduced in intermediate versions in the corresponding [release notes](https://docs.pingcap.com/releases/tidb-self-managed/). - TiDB v7.5.0 [compatibility changes](/releases/release-7.5.0.md#compatibility-changes) - TiDB v7.5.1 [compatibility changes](/releases/release-7.5.1.md#compatibility-changes) @@ -309,7 +309,7 @@ Re-execute the `tiup cluster upgrade` command to resume the upgrade. The upgrade ### How to fix the issue that the upgrade gets stuck when upgrading to v6.2.0 or later versions? -Starting from v6.2.0, TiDB enables the [concurrent DDL framework](/ddl-introduction.md#how-the-online-ddl-asynchronous-change-works-in-tidb) by default to execute concurrent DDLs. This framework changes the DDL job storage from a KV queue to a table queue. This change might cause the upgrade to get stuck in some scenarios. The following are some scenarios that might trigger this issue and the corresponding solutions: +Starting from v6.2.0, TiDB enables the [concurrent DDL framework](/best-practices/ddl-introduction.md#how-the-online-ddl-asynchronous-change-works-in-tidb) by default to execute concurrent DDLs. This framework changes the DDL job storage from a KV queue to a table queue. This change might cause the upgrade to get stuck in some scenarios. The following are some scenarios that might trigger this issue and the corresponding solutions: - Upgrade gets stuck due to plugin loading