Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
248 changes: 1 addition & 247 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,73 +19,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 TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)
- Example Applications
- [Golang](/develop/dev-guide-sample-application-golang.md)
- [Java (Spring Boot)](/develop/dev-guide-sample-application-spring-boot.md)
- [Java](/develop/dev-guide-sample-application-java.md)
- [Python](/develop/dev-guide-sample-application-python.md)
- Connect to TiDB
- [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)
- [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)
- Legacy Docs
- [For Django](/develop/dev-guide-outdated-for-django.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)
Expand Down Expand Up @@ -248,17 +181,6 @@
- [Perform Stale Read Using `As OF TIMESTAMP`](/as-of-timestamp.md)
- [Perform Stale Read Using `tidb_read_staleness`](/tidb-read-staleness.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)
- [Use Placement Rules](/configure-placement-rules.md)
- [Use Load Base Split](/configure-load-base-split.md)
- [Use Store Limit](/configure-store-limit.md)
Expand Down Expand Up @@ -878,6 +800,7 @@
- [FAQ](/dashboard/dashboard-faq.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)
- FAQs
Expand All @@ -891,173 +814,4 @@
- [Cluster Management FAQs](/faq/manage-cluster-faq.md)
- [High Availability FAQs](/faq/high-availability-faq.md)
- [High Reliability FAQs](/faq/high-reliability-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)
- 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)
2 changes: 1 addition & 1 deletion backup-and-restore-use-cases-for-maintain.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ It is recommended that you deploy the TiDB cluster using [TiUP](/tiup/tiup-clust

> **Note:**
>
> It is recommended that you use the latest version of [TiDB/TiKV/PD/BR](/releases/release-notes.md) and make sure that the BR version is **consistent with** the TiDB version.
> It is recommended that you use the latest version of [TiDB/TiKV/PD/BR](https://docs.pingcap.com/releases/tidb-self-managed/) and make sure that the BR version is **consistent with** the TiDB version.

### TiKV hardware information

Expand Down
2 changes: 1 addition & 1 deletion br/backup-and-restore-use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ It is recommended that you deploy the TiDB cluster using [TiUP](/tiup/tiup-clust

> **Note:**
>
> It is recommended that you use the latest version of [TiDB/TiKV/PD/BR](/releases/release-notes.md) and make sure that the BR version is **consistent with** the TiDB version.
> It is recommended that you use the latest version of [TiDB/TiKV/PD/BR](https://docs.pingcap.com/releases/tidb-self-managed/) and make sure that the BR version is **consistent with** the TiDB version.

### TiKV hardware information

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-connection-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This document describes how to configure connection pools and connection paramet

<CustomContent platform="tidb">

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)

</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-optimize-sql-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ For how to locate and resolve transaction conflicts, see [Troubleshoot Lock Conf

<CustomContent platform="tidb">

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).

</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion performance-tuning-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
>
Expand Down
2 changes: 1 addition & 1 deletion upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This document is targeted for the following upgrade paths:
3. Update the 3.0 version to 4.0 according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup).
4. Upgrade the cluster to v6.1.0 according to this document.
- Support upgrading the versions of TiDB Binlog, TiCDC, TiFlash, and other components.
- 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
Expand Down
Loading