Connect to TiDB with mysqlclient

TiDB is a MySQL-compatible database, and mysqlclient is a popular open-source driver for Python.

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

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

mysqlclient - 图1

Note

This tutorial works with TiDB Serverless, TiDB Dedicated, and TiDB Self-Hosted.

Prerequisites

To complete this tutorial, you need:

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:

  1. git clone https://github.com/tidb-samples/tidb-python-mysqlclient-quickstart.git
  2. cd tidb-python-mysqlclient-quickstart;

Step 2: Install dependencies

Run the following command to install the required packages (including mysqlclient) for the sample app:

  1. pip install -r requirements.txt

If you encounter installation issues, refer to the mysqlclient official documentation.

Step 3: 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
    • Branch is set to main
    • Connect With is set to General
    • Operating System matches your environment.

    mysqlclient - 图2

    Tip

    If your program is running in Windows Subsystem for Linux (WSL), switch to the corresponding Linux distribution.

  4. Click Generate Password to create a random password.

    mysqlclient - 图3

    Tip

    If you have created a password before, you can either use the original password or click Reset Password to generate a new one.

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

    1. cp .env.example .env

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

    1. TIDB_HOST='{gateway-region}.aws.tidbcloud.com'
    2. TIDB_PORT='4000'
    3. TIDB_USER='{prefix}.root'
    4. TIDB_PASSWORD='{password}'
    5. TIDB_DB_NAME='test'
    6. CA_PATH=''

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

    TiDB Serverless requires a secure connection. Since the ssl_mode of mysqlclient defaults to PREFERRED, you don’t need to manually specify CA_PATH. Just leave it empty. But if you have a special reason to specify CA_PATH manually, you can refer to the TLS connections to TiDB Serverless to get the certificate paths for different operating systems.

  7. Save the .env file.

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

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

  10. Click Allow Access from Anywhere and then click Download CA cert to download the CA certificate.

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

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

    1. cp .env.example .env

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

    1. TIDB_HOST='{host}.clusters.tidb-cloud.com'
    2. TIDB_PORT='4000'
    3. TIDB_USER='{username}'
    4. TIDB_PASSWORD='{password}'
    5. TIDB_DB_NAME='test'
    6. CA_PATH='{your-downloaded-ca-path}'

    Be sure to replace the placeholders {} with the connection parameters obtained from the connection dialog, and configure CA_PATH with the certificate path downloaded in the previous step.

  13. Save the .env file.

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

    1. cp .env.example .env

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

    1. TIDB_HOST='{tidb_server_host}'
    2. TIDB_PORT='4000'
    3. TIDB_USER='root'
    4. TIDB_PASSWORD='{password}'
    5. TIDB_DB_NAME='test'

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

  16. Save the .env file.

Step 4: Run the code and check the result

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

    1. python mysqlclient_example.py

  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-python-mysqlclient-quickstart repository.

Connect to TiDB

  1. def get_mysqlclient_connection(autocommit:bool=True) -> MySQLdb.Connection:
  2.     db_conf = {
  3.         "host": ${tidb_host},
  4.         "port": ${tidb_port},
  5.         "user": ${tidb_user},
  6.         "password": ${tidb_password},
  7.         "database": ${tidb_db_name},
  8.         "autocommit": autocommit
  9.     }
  11.     if ${ca_path}:
  12.         db_conf["ssl_mode"] = "VERIFY_IDENTITY"
  13.         db_conf["ssl"] = {"ca": ${ca_path}}
  15.     return MySQLdb.connect(**db_conf)

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

Insert data

  1. with get_mysqlclient_connection(autocommit=True) as conn:
  2.     with conn.cursor() as cur:
  3.         player = ("1", 1, 1)
  4.         cursor.execute("INSERT INTO players (id, coins, goods) VALUES (%s, %s, %s)", player)

For more information, refer to Insert data.

Query data

  1. with get_mysqlclient_connection(autocommit=True) as conn:
  2.     with conn.cursor() as cur:
  3.         cur.execute("SELECT count(*) FROM players")
  4.         print(cur.fetchone()[0])

For more information, refer to Query data.

Update data

  1. with get_mysqlclient_connection(autocommit=True) as conn:
  2.     with conn.cursor() as cur:
  3.         player_id, amount, price="1", 10, 500
  4.         cursor.execute(
  5.             "UPDATE players SET goods = goods + %s, coins = coins + %s WHERE id = %s",
  6.             (-amount, price, player_id),
  7.         )

For more information, refer to Update data.

Delete data

  1. with get_mysqlclient_connection(autocommit=True) as conn:
  2.     with conn.cursor() as cur:
  3.         player_id = "1"
  4.         cursor.execute("DELETE FROM players WHERE id = %s", (player_id,))

For more information, refer to Delete data.

Useful notes

Using driver or ORM framework?

The Python 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 (represented as tuples in mysqlclient) to data objects.

Unless you need to write complex SQL statements, it is recommended to use ORM framework for development, such as SQLAlchemy, Peewee, and Django ORM. 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.