README
¶
?style=for-the-badge){kind=icon}
?style=for-the-badge){kind=icon}
What is TiDB?
TiDB (/’taɪdiːbi:/, "Ti" stands for Titanium) is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability.
See what TiDB is capable ONLINE at TiDB Playground.
For more details and latest updates, see TiDB documentation and release notes.
For future plans, see the TiDB roadmap.
Quick start
Start with TiDB Cloud
TiDB Cloud is the fully-managed service of TiDB, currently available on AWS and GCP.
Quickly check out TiDB Cloud with a free trial.
See TiDB Cloud Quick Start Guide.
Start with TiDB
Start developing TiDB
See the Get Started chapter of TiDB Development Guide.
Community
You can join the following groups or channels to discuss or ask questions about TiDB, and to keep yourself informed of the latest TiDB updates:
- Seek help when you use TiDB
- TiDB Forum: English, Chinese
- Discord
- Slack channels: #everyone (English), #tidb-japan (Japanese)
- Stack Overflow (questions tagged with #tidb)
- Discuss TiDB's implementation and design
- Get the latest TiDB news or updates
- Follow @PingCAP on Twitter
- Read the PingCAP English Blog or Chinese Blog
For support, please contact PingCAP.
Contributing
The community repository hosts all information about the TiDB community, including how to contribute to TiDB, how the TiDB community is governed, how teams are organized.
Contributions are welcomed and greatly appreciated. You can get started with one of the good first issues or help wanted issues. For more details on typical contribution workflows, see Contribute to TiDB. For more contributing information about where to start, click the contributor icon below.
Every contributor is welcome to claim your contribution swag by filling in and submitting this form.
Case studies
Architecture
License
TiDB is under the Apache 2.0 license. See the LICENSE file for details.
Acknowledgments
Directories
¶
| Path | Synopsis |
|---|---|
|
br
|
|
|
cmd/br
command
|
|
|
cmd/tidb-lightning
command
|
|
|
cmd/tidb-lightning-ctl
command
|
|
|
pkg/lightning/importer/opts
Package opts contains all kinds of options definitions that can affect the behavior of restore & get infos.
|
Package opts contains all kinds of options definitions that can affect the behavior of restore & get infos. |
|
pkg/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
pkg/mock/mocklocal
Package mocklocal is a generated GoMock package.
|
Package mocklocal is a generated GoMock package. |
|
pkg/mock/storage
Package mockstorage is a generated GoMock package.
|
Package mockstorage is a generated GoMock package. |
|
pkg/utils/storewatch
package storewatch provides a `Watcher` type which allows the user to listen the events of lifetime of stores.
|
package storewatch provides a `Watcher` type which allows the user to listen the events of lifetime of stores. |
|
tests/br_gcs
command
|
|
|
tests/br_key_locked
command
|
|
|
tests/br_rawkv
command
|
|
|
tests/br_txn
command
|
|
|
tests/br_z_gc_safepoint
command
|
|
|
build
|
|
|
cmd
|
|
|
benchdb
command
|
|
|
benchkv
command
|
|
|
benchraw
command
|
|
|
importer
command
|
|
|
mirror
command
|
|
|
pluginpkg
command
|
|
|
portgenerator
command
|
|
|
disttask
|
|
|
framework/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
framework/mock/execute
Package execute is a generated GoMock package.
|
Package execute is a generated GoMock package. |
|
importinto/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
dumpling
|
|
|
cmd/dumpling
command
|
|
|
tests/s3
command
|
|
|
parser
module
|
|
|
pkg
|
|
|
parser
module
|
|
|
core
Package core Copyright 2022 PingCAP, Inc.
|
Package core Copyright 2022 PingCAP, Inc. |
|
conn_ip_example
command
|
|
|
pdtypes
Package pdtypes contains type defines under PD.
|
Package pdtypes contains type defines under PD. |
|
tests
|
|
|
tidb-binlog
|
|
|
proto/go-binlog
Package slave_binlog is a generated protocol buffer package.
|
Package slave_binlog is a generated protocol buffer package. |
|
timer
|
|
|
tools
|
|
|
check
command
|
|
|
patch-go
command
|
|
|
tazel
command
|
|
|
ttl
|
|
|
collate/ucadata/generator
command
|
|
|
collate/ucaimpl
command
|
|
|
mock
Package mock is just for test only.
|
Package mock is just for test only. |
|
sqlexec/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |