TiDB Documentation

Welcome to TiDB documentation!

This repository stores all the source files of TiDB Docs at the PingCAP website, while the pingcap/docs-cn repository stores all the source files of TiDB Documentation in Chinese.

If you find documentation issues, feel free to create an Issue to let us know or directly create a Pull Request to help fix or update it.

Currently, the official documentation supports two languages:

en: documentation in English
zh: documentation in Chinese

You can use Google Translate to view the documentation in different languages. For example:

Documentation versions

Currently, we maintain the following versions of TiDB documentation in different branches:

Branch name	TiDB docs version
`master`	The latest development version
`release-6.3`	6.3 Development Milestone Release
`release-6.2`	6.2 Development Milestone Release
`release-6.1`	6.1 LTS (Long-Term Support) version
`release-6.0`	6.0 Development Milestone Release
`release-5.4`	5.4 stable version
`release-5.3`	5.3 stable version
`release-5.2`	5.2 stable version
`release-5.1`	5.1 stable version
`release-5.0`	5.0 stable version
`release-4.0`	4.0 stable version
`release-3.1`	3.1 stable version
`release-3.0`	3.0 stable version
`release-2.1`	2.1 stable version

Contributing

See TiDB Documentation Contributing Guide to become a contributor! 🤓

Name		Name	Last commit message	Last commit date
Latest commit History 4,646 Commits
.github		.github
benchmark		benchmark
best-practices		best-practices
br		br
clinic		clinic
config-templates		config-templates
dashboard		dashboard
develop		develop
dm		dm
etc		etc
faq		faq
functions-and-operators		functions-and-operators
information-schema		information-schema
media		media
releases		releases
resources		resources
scripts		scripts
sql-statements		sql-statements
storage-engine		storage-engine
styles		styles
sync-diff-inspector		sync-diff-inspector
templates		templates
ticdc		ticdc
tidb-binlog		tidb-binlog
tidb-cloud		tidb-cloud
tidb-lightning		tidb-lightning
tiflash		tiflash
tiup		tiup
.gitignore		.gitignore
.lycheeignore		.lycheeignore
.markdownlint.yaml		.markdownlint.yaml
.vale.ini		.vale.ini
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
TOC-tidb-cloud.md		TOC-tidb-cloud.md
TOC.md		TOC.md
_docHome.md		_docHome.md
_index.md		_index.md
agg-distinct-optimization.md		agg-distinct-optimization.md
alert-rules.md		alert-rules.md
analyze-slow-queries.md		analyze-slow-queries.md
as-of-timestamp.md		as-of-timestamp.md
auto-increment.md		auto-increment.md
auto-random.md		auto-random.md
backup-and-restore-using-dumpling-lightning.md		backup-and-restore-using-dumpling-lightning.md
basic-features.md		basic-features.md
basic-sql-operations.md		basic-sql-operations.md
binary-package.md		binary-package.md
blocklist-control-plan.md		blocklist-control-plan.md
cached-tables.md		cached-tables.md
certificate-authentication.md		certificate-authentication.md
character-set-and-collation.md		character-set-and-collation.md
character-set-gbk.md		character-set-gbk.md
check-before-deployment.md		check-before-deployment.md
choose-index.md		choose-index.md
clustered-indexes.md		clustered-indexes.md
column-pruning.md		column-pruning.md
command-line-flags-for-pd-configuration.md		command-line-flags-for-pd-configuration.md
command-line-flags-for-tidb-configuration.md		command-line-flags-for-tidb-configuration.md
command-line-flags-for-tikv-configuration.md		command-line-flags-for-tikv-configuration.md
comment-syntax.md		comment-syntax.md
configure-load-base-split.md		configure-load-base-split.md
configure-memory-usage.md		configure-memory-usage.md
configure-placement-rules.md		configure-placement-rules.md
configure-store-limit.md		configure-store-limit.md
configure-time-zone.md		configure-time-zone.md
constraints.md		constraints.md
control-execution-plan.md		control-execution-plan.md
coprocessor-cache.md		coprocessor-cache.md
correlated-subquery-optimization.md		correlated-subquery-optimization.md
cost-model.md		cost-model.md
credits.md		credits.md
daily-check.md		daily-check.md
data-type-date-and-time.md		data-type-date-and-time.md
data-type-default-values.md		data-type-default-values.md
data-type-json.md		data-type-json.md
data-type-numeric.md		data-type-numeric.md
data-type-overview.md		data-type-overview.md
data-type-string.md		data-type-string.md
deploy-monitoring-services.md		deploy-monitoring-services.md
download-ecosystem-tools.md		download-ecosystem-tools.md
dumpling-overview.md		dumpling-overview.md
dynamic-config.md		dynamic-config.md
ecosystem-tool-user-case.md		ecosystem-tool-user-case.md
ecosystem-tool-user-guide.md		ecosystem-tool-user-guide.md
enable-disk-spill-encrypt.md		enable-disk-spill-encrypt.md
enable-tls-between-clients-and-servers.md		enable-tls-between-clients-and-servers.md
enable-tls-between-components.md		enable-tls-between-components.md
encryption-at-rest.md		encryption-at-rest.md
error-codes.md		error-codes.md
experimental-features.md		experimental-features.md
explain-aggregation.md		explain-aggregation.md
explain-index-merge.md		explain-index-merge.md
explain-indexes.md		explain-indexes.md
explain-joins.md		explain-joins.md
explain-mpp.md		explain-mpp.md
explain-overview.md		explain-overview.md
explain-partitions.md		explain-partitions.md
explain-subqueries.md		explain-subqueries.md

License

ti-srebot/docs

Folders and files

Latest commit

History