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 of ONLINE at the TiDB Playground.
For more details and the latest updates, see the 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 the TiDB Cloud Quick Start Guide.
Start with TiDB
Start developing with TiDB
See TiDB Developer Guide and TiDB Cloud Developer 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 their 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
|
|
|
pkg/mock
Code generated by MockGen.
|
Code generated by MockGen. |
|
pkg/mock/mocklocal
Code generated by MockGen.
|
Code generated by MockGen. |
|
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. |
|
cmd
|
|
|
dumpling
|
|
|
lightning
|
|
|
pkg/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. |
|
parser
module
|
|
|
pkg
|
|
|
ddl
Package ddl is the core of TiDB DDL layer.
|
Package ddl is the core of TiDB DDL layer. |
|
ddl/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
ddl/systable
Package systable contains all constants/methods related accessing system tables related to DDL job execution
|
Package systable contains all constants/methods related accessing system tables related to DDL job execution |
|
disttask/framework/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
disttask/framework/mock/execute
Package mockexecute is a generated GoMock package.
|
Package mockexecute is a generated GoMock package. |
|
disttask/framework/scheduler/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
disttask/importinto/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
planner/core
Package core Copyright 2022 PingCAP, Inc.
|
Package core Copyright 2022 PingCAP, Inc. |
|
planner/core/resolve
Package resolve is used for semantic resolve of the AST tree.
|
Package resolve is used for semantic resolve of the AST tree. |
|
store/pdtypes
Package pdtypes contains type defines under PD.
|
Package pdtypes contains type defines under PD. |
|
tidb-binlog/proto/go-binlog
Package slave_binlog is a generated protocol buffer package.
|
Package slave_binlog is a generated protocol buffer package. |
|
util/dbutil/dbutiltest
Package dbutiltest is a package for some common used methods for db related testing.
|
Package dbutiltest is a package for some common used methods for db related testing. |
|
util/mock
Package mock is just for test only.
|
Package mock is just for test only. |
|
util/sqlexec/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
parser
Module
|
|
|
tests
|
|
|
tools
|
|