Connect to TiDB
TiDB is highly compatible with the MySQL protocol. For a full list of client link parameters, see MySQL Client Options.
TiDB supports the MySQL Client/Server Protocol, which allows most client drivers and ORM frameworks to connect to TiDB just as they connect to MySQL.
MySQL
You can choose to use MySQL Client or MySQL Shell based on your personal preferences.
- MySQL Client
- MySQL Shell
You can connect to TiDB using MySQL Client, which can be used as a command-line tool for TiDB. To install MySQL Client, follow the instructions below for YUM based Linux distributions.
sudo yum install mysql
After the installation, you can connect to TiDB using the following command:
mysql --host <tidb_server_host> --port 4000 -u root -p --comments
You can connect to TiDB using MySQL Shell, which can be used as a command-line tool for TiDB. To install MySQL Shell, follow the instructions in the MySQL Shell documentation. After the installation, you can connect to TiDB using the following command:
mysqlsh --sql mysql://root@<tidb_server_host>:4000
JDBC
You can connect to TiDB using the JDBC driver. To do that, you need to create a MysqlDataSource
or MysqlConnectionPoolDataSource
object (both objects support the DataSource
interface), and then set the connection string using the setURL
function.
For example:
MysqlDataSource mysqlDataSource = new MysqlDataSource();
mysqlDataSource.setURL("jdbc:mysql://{host}:{port}/{database}?user={username}&password={password}");
For more information on JDBC connections, see the JDBC documentation
Connection parameters
Parameter name | Description |
---|---|
{username} | A SQL user to connect to the TiDB cluster |
{password} | The password of the SQL user |
{host} | Host of a TiDB node |
{port} | Port that the TiDB node is listening on |
{database} | Name of an existing database |
For more information about TiDB SQL users, see TiDB User Account Management.
Hibernate
You can connect to TiDB using the Hibernate ORM. To do that, you need to set hibernate.connection.url
in the Hibernate configuration file to a legal TiDB connection string.
For example, if you use a hibernate.cfg.xml
configuration file, set hibernate.connection.url
as follows:
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
<session-factory>
<property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
<property name="hibernate.dialect">org.hibernate.dialect.TiDBDialect</property>
<property name="hibernate.connection.url">jdbc:mysql://{host}:{port}/{database}?user={user}&password={password}</property>
</session-factory>
</hibernate-configuration>
After the configuration is done, you can use the following command to read the configuration file and get the SessionFactory
object:
SessionFactory sessionFactory = new Configuration().configure("hibernate.cfg.xml").buildSessionFactory();
Note the following:
- Because the
hibernate.cfg.xml
configuration file is in the XML format and&
is a special character in XML, you need to change&
to&
when configuring the file. For example, you need to change the connection stringhibernate.connection.url
fromjdbc:mysql://{host}:{port}/{database}?user={user}&password={password}
tojdbc:mysql://{host}:{ port}/{database}?user={user}&password={password}
. - It is recommended that you use the
TiDB
dialect by settinghibernate.dialect
toorg.hibernate.dialect.TiDBDialect
. - Hibernate supports TiDB dialects starting from
6.0.0.Beta2
, so it is recommended that you use Hibernate6.0.0.Beta2
or a later version to connect to TiDB.
For more information about Hibernate connection parameters, see Hibernate documentation.
Connection parameters
Parameter name | Description |
---|---|
{username} | A SQL user to connect to the TiDB cluster |
{password} | The password of the SQL user |
{host} | Host of a TiDB node |
{port} | Port that the TiDB node is listening on |
{database} | Name of an existing database |
For more information about TiDB SQL users, see TiDB User Account Management.
Need help?
Ask questions on TiDB Community, or create a support ticket.