TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

Connect to TiDB with JDBC

TiDB is a MySQL-compatible database, and JDBC (Java Database Connectivity) is the data access API for Java. MySQL Connector/J is MySQL's implementation of JDBC.

In this tutorial, you can learn how to use TiDB and JDBC to accomplish the following tasks:

  • Set up your environment.
  • Connect to your TiDB cluster using JDBC.
  • Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations.

Prerequisites

To complete this tutorial, you need:

  • Java Development Kit (JDK) 17 or higher. You can choose OpenJDK or Oracle JDK based on your business and personal requirements.
  • Maven 3.8 or higher.
  • Git.
  • A TiDB cluster.

If you don't have a TiDB cluster, you can create one as follows:

If you don't have a TiDB cluster, you can create one as follows:

Run the sample app to connect to TiDB

This section demonstrates how to run the sample application code and connect to TiDB.

Step 1: Clone the sample app repository

Run the following commands in your terminal window to clone the sample code repository:

git clone https://github.com/tidb-samples/tidb-java-jdbc-quickstart.git cd tidb-java-jdbc-quickstart

Step 2: Configure connection information

Connect to your TiDB cluster depending on the TiDB deployment option you've selected.

  • TiDB Serverless
  • TiDB Dedicated
  • TiDB Self-Hosted
  1. Navigate to the Clusters page, and then click the name of your target cluster to go to its overview page.

  2. Click Connect in the upper-right corner. A connection dialog is displayed.

  3. Ensure the configurations in the connection dialog match your operating environment.

    • Endpoint Type is set to Public
    • Connect With is set to General
    • Operating System matches your environment.
  4. Click Create password to create a random password.

  5. Run the following command to copy env.sh.example and rename it to env.sh:

    cp env.sh.example env.sh
  6. Copy and paste the corresponding connection string into the env.sh file. The example result is as follows:

    export TIDB_HOST='{host}' # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com export TIDB_PORT='4000' export TIDB_USER='{user}' # e.g. xxxxxx.root export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='true'

    Be sure to replace the placeholders {} with the connection parameters obtained from the connection dialog.

    TiDB Serverless requires a secure connection. Therefore, you need to set the value of USE_SSL to true.

  7. Save the env.sh file.

  1. Navigate to the Clusters page, and then click the name of your target cluster to go to its overview page.

  2. Click Connect in the upper-right corner. A connection dialog is displayed.

  3. Click Allow Access from Anywhere and then click Download TiDB cluster CA to download the CA certificate.

    For more details about how to obtain the connection string, refer to TiDB Dedicated standard connection.

  4. Run the following command to copy env.sh.example and rename it to env.sh:

    cp env.sh.example env.sh
  5. Copy and paste the corresponding connection string into the env.sh file. The example result is as follows:

    export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com export TIDB_PORT='4000' export TIDB_USER='{user}' # e.g. root export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='false'

    Be sure to replace the placeholders {} with the connection parameters obtained from the connection dialog.

  6. Save the env.sh file.

  1. Run the following command to copy env.sh.example and rename it to env.sh:

    cp env.sh.example env.sh
  2. Copy and paste the corresponding connection string into the env.sh file. The example result is as follows:

    export TIDB_HOST='{host}' export TIDB_PORT='4000' export TIDB_USER='root' export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='false'

    Be sure to replace the placeholders {} with the connection parameters, and set USE_SSL to false. If you are running TiDB locally, the default host address is 127.0.0.1, and the password is empty.

  3. Save the env.sh file.

Step 3: Run the code and check the result

  1. Execute the following command to run the sample code:

    make
  2. Check the Expected-Output.txt to see if the output matches.

Sample code snippets

You can refer to the following sample code snippets to complete your own application development.

For complete sample code and how to run it, check out the tidb-samples/tidb-java-jdbc-quickstart repository.

Connect to TiDB

public MysqlDataSource getMysqlDataSource() throws SQLException { MysqlDataSource mysqlDataSource = new MysqlDataSource(); mysqlDataSource.setServerName(${tidb_host}); mysqlDataSource.setPortNumber(${tidb_port}); mysqlDataSource.setUser(${tidb_user}); mysqlDataSource.setPassword(${tidb_password}); mysqlDataSource.setDatabaseName(${tidb_db_name}); if (${tidb_use_ssl}) { mysqlDataSource.setSslMode(PropertyDefinitions.SslMode.VERIFY_IDENTITY.name()); mysqlDataSource.setEnabledTLSProtocols("TLSv1.2,TLSv1.3"); } return mysqlDataSource; }

When using this function, you need to replace ${tidb_host}, ${tidb_port}, ${tidb_user}, ${tidb_password}, and ${tidb_db_name} with the actual values of your TiDB cluster.

Insert data

public void createPlayer(PlayerBean player) throws SQLException { MysqlDataSource mysqlDataSource = getMysqlDataSource(); try (Connection connection = mysqlDataSource.getConnection()) { PreparedStatement preparedStatement = connection.prepareStatement("INSERT INTO player (id, coins, goods) VALUES (?, ?, ?)"); preparedStatement.setString(1, player.getId()); preparedStatement.setInt(2, player.getCoins()); preparedStatement.setInt(3, player.getGoods()); preparedStatement.execute(); } }

For more information, refer to Insert data.

Query data

public void getPlayer(String id) throws SQLException { MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv(); try (Connection connection = mysqlDataSource.getConnection()) { PreparedStatement preparedStatement = connection.prepareStatement("SELECT * FROM player WHERE id = ?"); preparedStatement.setString(1, id); preparedStatement.execute(); ResultSet res = preparedStatement.executeQuery(); if(res.next()) { PlayerBean player = new PlayerBean(res.getString("id"), res.getInt("coins"), res.getInt("goods")); System.out.println(player); } } }

For more information, refer to Query data.

Update data

public void updatePlayer(String id, int amount, int price) throws SQLException { MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv(); try (Connection connection = mysqlDataSource.getConnection()) { PreparedStatement transfer = connection.prepareStatement("UPDATE player SET goods = goods + ?, coins = coins + ? WHERE id=?"); transfer.setInt(1, -amount); transfer.setInt(2, price); transfer.setString(3, id); transfer.execute(); } }

For more information, refer to Update data.

Delete data

public void deletePlayer(String id) throws SQLException { MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv(); try (Connection connection = mysqlDataSource.getConnection()) { PreparedStatement deleteStatement = connection.prepareStatement("DELETE FROM player WHERE id=?"); deleteStatement.setString(1, id); deleteStatement.execute(); } }

For more information, refer to Delete data.

Useful notes

Using driver or ORM framework?

The Java driver provides low-level access to the database, but it requires the developers to:

  • Manually establish and release database connections.
  • Manually manage database transactions.
  • Manually map data rows to data objects.

Unless you need to write complex SQL statements, it is recommended to use ORM framework for development, such as Hibernate, MyBatis, or Spring Data JPA. It can help you:

  • Reduce boilerplate code for managing connections and transactions.
  • Manipulate data with data objects instead of a number of SQL statements.

Next steps

Need help?

Ask questions on the Discord, or create a support ticket.

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.