Connect to TiDB with mysql2 in AWS Lambda Function

TiDB is a MySQL-compatible database, AWS Lambda Function is a compute service, and mysql2 is a popular open-source driver for Node.js.

In this tutorial, you can learn how to use TiDB and mysql2 in AWS Lambda Function to accomplish the following tasks:

Set up your environment.
Connect to your TiDB cluster using mysql2.
Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations.
Deploy your AWS Lambda Function.

Note

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

Prerequisites

To complete this tutorial, you need:

Node.js 18 or later.
Git.
A TiDB cluster.
An AWS user with administrator permissions.
AWS CLI
AWS SAM CLI

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

(Recommended) Follow Creating a TiDB Serverless cluster to create your own TiDB Cloud cluster.
Follow Deploy a local test TiDB cluster or Deploy a production TiDB cluster to create a local cluster.

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

(Recommended) Follow Creating a TiDB Serverless cluster to create your own TiDB Cloud cluster.
Follow Deploy a local test TiDB cluster or Deploy a production TiDB cluster to create a local cluster.

If you don't have an AWS account or a user, you can create them by following the steps in the Getting Started with Lambda guide.

Run the sample app to connect to TiDB

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

Note

For complete code snippets and running instructions, refer to the tidb-samples/tidb-aws-lambda-quickstart GitHub repository.

Step 1: Clone the sample app repository

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

git clone git@github.com:tidb-samples/tidb-aws-lambda-quickstart.git
cd tidb-aws-lambda-quickstart

Step 2: Install dependencies

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

npm install

Step 3: Configure connection information

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

TiDB Serverless
TiDB Self-Hosted

Navigate to the Clusters page, and then click the name of your target cluster to go to its overview page.
Click Connect in the upper right corner. A connection dialog is displayed.
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.
Note
In Node.js applications, you don't have to provide an SSL CA certificate, because Node.js uses the built-in Mozilla CA certificate by default when establishing the TLS (SSL) connection.
Click Generate Password to create a random password.
Tip
If you have generated a password before, you can either use the original password or click Reset Password to generate a new one.

Copy and paste the corresponding connection string into env.json. The following is an example:

{
  "Parameters": {
    "TIDB_HOST": "{gateway-region}.aws.tidbcloud.com",
    "TIDB_PORT": "4000",
    "TIDB_USER": "{prefix}.root",
    "TIDB_PASSWORD": "{password}"
  }
}

Replace the placeholders in {} with the values obtained in the connection dialog.

Copy and paste the corresponding connection string into env.json. The following is an example:

{
  "Parameters": {
    "TIDB_HOST": "{tidb_server_host}",
    "TIDB_PORT": "4000",
    "TIDB_USER": "root",
    "TIDB_PASSWORD": "{password}"
  }
}

Replace the placeholders in {} with the values obtained in the Connect window.

Step 4: Run the code and check the result

(Prerequisite) Install the AWS SAM CLI.
Build the bundle:
```
npm run build
```

Invoke the sample Lambda function:

sam local invoke --env-vars env.json -e events/event.json "tidbHelloWorldFunction"

Check the output in the terminal. If the output is similar to the following, the connection is successful:
```
{"statusCode":200,"body":"{\"results\":[{\"Hello World\":\"Hello World\"}]}"}
```

After you confirm that the connection is successful, you can follow the next section to deploy the AWS Lambda Function.

Deploy the AWS Lambda Function

You can deploy the AWS Lambda Function using either the SAM CLI or the AWS Lambda console.

SAM CLI deployment (Recommended)

(Prerequisite) Install the AWS SAM CLI.
Build the bundle:
```
npm run build
```

Update the environment variables in template.yml:

Environment:
  Variables:
    TIDB_HOST: {tidb_server_host}
    TIDB_PORT: 4000
    TIDB_USER: {prefix}.root
    TIDB_PASSWORD: {password}

Set AWS environment variables (refer to Short-term credentials):

export AWS_ACCESS_KEY_ID={your_access_key_id}
export AWS_SECRET_ACCESS_KEY={your_secret_access_key}
export AWS_SESSION_TOKEN={your_session_token}

Deploy the AWS Lambda Function:

sam deploy --guided

# Example:

# Configuring SAM deploy
# ======================

#        Looking for config file [samconfig.toml] :  Not found

#        Setting default arguments for 'sam deploy'
#        =========================================
#        Stack Name [sam-app]: tidb-aws-lambda-quickstart
#        AWS Region [us-east-1]:
#        #Shows you resources changes to be deployed and require a 'Y' to initiate deploy
#        Confirm changes before deploy [y/N]:
#        #SAM needs permission to be able to create roles to connect to the resources in your template
#        Allow SAM CLI IAM role creation [Y/n]:
#        #Preserves the state of previously provisioned resources when an operation fails
#        Disable rollback [y/N]:
#        tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
#        tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
#        tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
#        tidbHelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
#        Save arguments to configuration file [Y/n]:
#        SAM configuration file [samconfig.toml]:
#        SAM configuration environment [default]:

#        Looking for resources needed for deployment:
#        Creating the required resources...
#        Successfully created!

Web console deployment

Build the bundle:

npm run build

# Bundle for AWS Lambda
# =====================
# dist/index.zip

Visit the AWS Lambda console.
Follow the steps in Creating a Lambda function to create a Node.js Lambda function.
Follow the steps in Lambda deployment packages and upload the dist/index.zip file.
Copy and configure the corresponding connection string in Lambda Function.
1. In the Functions page of the Lambda console, select the Configuration tab, and then choose Environment variables.
2. Choose Edit.
3. To add your database access credentials, do the following:
  - Choose Add environment variable, then for Key enter TIDB_HOST and for Value enter the host name.
  - Choose Add environment variable, then for Key enter TIDB_PORT and for Value enter the port (4000 is default).
  - Choose Add environment variable, then for Key enter TIDB_USER and for Value enter the user name.
  - Choose Add environment variable, then for Key enter TIDB_PASSWORD and for Value enter the password you chose when you created your database.
  - Choose Save.

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-aws-lambda-quickstart repository.

Connect to TiDB

The following code establish a connection to TiDB with options defined in the environment variables:

// lib/tidb.ts
import mysql from 'mysql2';

let pool: mysql.Pool | null = null;

function connect() {
  return mysql.createPool({
    host: process.env.TIDB_HOST, // TiDB host, for example: {gateway-region}.aws.tidbcloud.com
    port: process.env.TIDB_PORT ? Number(process.env.TIDB_PORT) : 4000, // TiDB port, default: 4000
    user: process.env.TIDB_USER, // TiDB user, for example: {prefix}.root
    password: process.env.TIDB_PASSWORD, // TiDB password
    database: process.env.TIDB_DATABASE || 'test', // TiDB database name, default: test
    ssl: {
      minVersion: 'TLSv1.2',
      rejectUnauthorized: true,
    },
    connectionLimit: 1, // Setting connectionLimit to "1" in a serverless function environment optimizes resource usage, reduces costs, ensures connection stability, and enables seamless scalability.
    maxIdle: 1, // max idle connections, the default value is the same as `connectionLimit`
    enableKeepAlive: true,
  });
}

export function getPool(): mysql.Pool {
  if (!pool) {
    pool = connect();
  }
  return pool;
}

Insert data

The following query creates a single Player record and returns a ResultSetHeader object:

const [rsh] = await pool.query('INSERT INTO players (coins, goods) VALUES (?, ?);', [100, 100]);
console.log(rsh.insertId);

For more information, refer to Insert data.

Query data

The following query returns a single Player record by ID 1:

const [rows] = await pool.query('SELECT id, coins, goods FROM players WHERE id = ?;', [1]);
console.log(rows[0]);

For more information, refer to Query data.

Update data

The following query adds 50 coins and 50 goods to the Player with ID 1:

const [rsh] = await pool.query(
    'UPDATE players SET coins = coins + ?, goods = goods + ? WHERE id = ?;',
    [50, 50, 1]
);
console.log(rsh.affectedRows);

For more information, refer to Update data.

Delete data

The following query deletes the Player record with ID 1:

const [rsh] = await pool.query('DELETE FROM players WHERE id = ?;', [1]);
console.log(rsh.affectedRows);

For more information, refer to Delete data.

Useful notes

Using connection pools to manage database connections can reduce the performance overhead caused by frequently establishing and destroying connections.
To avoid SQL injection, it is recommended to use prepared statements.
In scenarios where there are not many complex SQL statements involved, using ORM frameworks like Sequelize, TypeORM, or Prisma can greatly improve development efficiency.
For building a RESTful API for your application, it is recommended to use AWS Lambda with API Gateway.
For designing high-performance applications using TiDB Serverless and AWS Lambda, refer to this blog.

Next steps

For more details on how to use TiDB in AWS Lambda Function, see our TiDB-Lambda-integration/aws-lambda-bookstore Demo. You can also use AWS API Gateway to build a RESTful API for your application.
Learn more usage of mysql2 from the documentation of mysql2.
Learn more usage of AWS Lambda from the AWS developer guide of Lambda.
Learn the best practices for TiDB application development with the chapters in the Developer guide, such as Insert data, Update data, Delete data, Single table reading, Transactions, and SQL performance optimization.
Learn through the professional TiDB developer courses and earn TiDB certifications after passing the exam.

Need help?

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