Developer Guide Overview

TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads.

This guide helps application developers quickly learn how to connect to TiDB, design databases, write and query data, and build reliable, high-performance applications on TiDB.

Guides by language and framework

Build your application with the language you use by following the guides with sample codes.

JavaScript

Serverless Driver (beta)

Connect to TiDB over HTTPS from edge environments.

GuideGitHub

Next.js

Connect Next.js with mysql2 to TiDB.

GuideGitHub

Prisma

Connect to TiDB with Prisma ORM.

GuideGitHub

TypeORM

Connect to TiDB with TypeORM.

GuideGitHub

Sequelize

Connect to TiDB with Sequelize ORM.

GuideGitHub

mysql.js

Connect Node.js with mysql.js module to TiDB.

GuideGitHub

node-mysql2

Connect Node.js with node-mysql2 module to TiDB.

GuideGitHub

AWS Lambda

Connect AWS Lambda Function with mysql2 to TiDB.

GuideGitHub

Python

Django

Connect Django application with django-tidb to TiDB.

GuideGitHub

MySQL Connector/Python

Connect to TiDB with the official MySQL package.

GuideGitHub

PyMySQL

Connect to TiDB with PyMySQL package.

GuideGitHub

mysqlclient

Connect to TiDB with mysqlclient package.

GuideGitHub

SQLAlchemy

Connect to TiDB with SQLAlchemy ORM.

GuideGitHub

peewee

Connect to TiDB with Peewee ORM.

GuideGitHub

Java

JDBC

Connect to TiDB with JDBC (MySQL Connector/J).

GuideGitHub

MyBatis

Connect to TiDB with MyBatis ORM.

GuideGitHub

Hibernate

Connect to TiDB with Hibernate ORM.

GuideGitHub

Spring Boot

Connect Spring based application with Spring Data JPA to TiDB.

GuideGitHub

Go

Go-MySQL-Driver

Connect to TiDB with MySQL driver for Go.

GuideGitHub

GORM

Connect to TiDB with GORM.

GuideGitHub

Ruby

Ruby on Rails

Connect Ruby on Rails application with Active Record ORM to TiDB.

GuideGitHub

mysql2

Connect to TiDB with mysql2 driver.

GuideGitHub

In addition to these guides, PingCAP works with the community to support third-party MySQL drivers, ORMs, and tools.

Use MySQL client software

As TiDB is a MySQL-compatible database, you can use many familiar client software tools to connect to TiDB and manage your databases. Or, you can use our command line tool to connect and manage your databases.

MySQL Workbench

Connect and manage TiDB databases with MySQL Workbench.

Visual Studio Code

Connect and manage TiDB databases with the SQLTools extension in VS Code.

DBeaver

Connect and manage TiDB databases with DBeaver.

DataGrip

Connect and manage TiDB databases with DataGrip by JetBrains.

Additional resources

Learn other topics about developing with TiDB.

• Use TiDB Cloud CLI to develop, manage and deploy your applications.
• Explore popular service integrations with TiDB Cloud.
• Follow TiDB database development reference to design, interact with, optimize, and troubleshoot your data and schema.
• Follow the free online course Introduction to TiDB.