') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); GitHub - neilydhan/docs: TiDB/TiKV/PD documents. · GitHub
Skip to content
BranchesTags

Latest commit

History

2,272 Commits

Folders and files

NameName
Last commit message
Last commit date
.circleci
.circleci
.github
.github
benchmark
benchmark
best-practices
best-practices
br
br
config-templates
config-templates
dashboard
dashboard
dev-guide
dev-guide
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
sync-diff-inspector
sync-diff-inspector
templates
templates
ticdc
ticdc
tidb-binlog
tidb-binlog
tidb-lightning
tidb-lightning
tiflash
tiflash
tiup
tiup
.gitignore
.gitignore
.markdownlint.yaml
.markdownlint.yaml
CONTRIBUTING.md
CONTRIBUTING.md
LICENSE
LICENSE
README.md
README.md
TOC.md
TOC.md
_index.md
_index.md
adopters.md
adopters.md
agg-distinct-optimization.md
agg-distinct-optimization.md
alert-rules.md
alert-rules.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
backup-and-restore-using-mydumper-lightning.md
backup-and-restore-using-mydumper-lightning.md
basic-features.md
basic-features.md
basic-sql-operations.md
basic-sql-operations.md
blocklist-control-plan.md
blocklist-control-plan.md
certificate-authentication.md
certificate-authentication.md
character-set-and-collation.md
character-set-and-collation.md
check-before-deployment.md
check-before-deployment.md
choose-index.md
choose-index.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
community.md
community.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
connectors-and-apis.md
connectors-and-apis.md
constraints.md
constraints.md
contribute.md
contribute.md
control-execution-plan.md
control-execution-plan.md
coprocessor-cache.md
coprocessor-cache.md
correlated-subquery-optimization.md
correlated-subquery-optimization.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
deploy-test-cluster-using-docker-compose.md
deploy-test-cluster-using-docker-compose.md
deploy-tidb-from-binary.md
deploy-tidb-from-binary.md
deploy-tidb-from-dbdeployer.md
deploy-tidb-from-dbdeployer.md
deploy-tidb-from-homebrew.md
deploy-tidb-from-homebrew.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-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
expression-syntax.md
expression-syntax.md
follower-read.md
follower-read.md
garbage-collection-configuration.md
garbage-collection-configuration.md
garbage-collection-overview.md
garbage-collection-overview.md
generate-self-signed-certificates.md
generate-self-signed-certificates.md
generated-columns.md
generated-columns.md
geo-distributed-deployment-topology.md
geo-distributed-deployment-topology.md
get-started-with-tidb-lightning.md
get-started-with-tidb-lightning.md
get-started-with-tispark.md
get-started-with-tispark.md
glossary.md
glossary.md
grafana-overview-dashboard.md
grafana-overview-dashboard.md
grafana-pd-dashboard.md
grafana-pd-dashboard.md
grafana-tidb-dashboard.md
grafana-tidb-dashboard.md
grafana-tikv-dashboard.md
grafana-tikv-dashboard.md
hardware-and-software-requirements.md
hardware-and-software-requirements.md

Repository files navigation

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.

Documentation versions

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

Branch nameTiDB docs version
masterThe latest development version
release-4.04.0 stable version
release-3.13.1 stable version
release-3.03.0 stable version
release-2.12.1 stable version

Contributing

contribution-map

See TiDB Documentation Contributing Guide to become a contributor! 🤓

About

TiDB/TiKV/PD documents.

pingcap.com/docs/

Resources

Readme
Apache-2.0 license

Contributing

Contributing
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages