Connecting to Database Through Existing SDK

Last updated: 2020-07-28 17:53:59

    Operation Scenarios

    This document describes how to use an existing SDK to connect to a TencentDB for MySQL database in the SCF function code and perform operations such as insertion and query in the database. TencentDB for TDSQL databases can also be connected. You can perform relevant operations as needed.


    You have signed up for a Tencent Cloud account and completed identity verification. If you haven't done so, please sign up here.


    Creating VPC

    Create a VPC and subnet as instructed in Building VPC.

    Creating database instance

    1. Create a TencentDB for MySQL database as instructed in Purchase Method.


      Select the VPC created in Creating VPC as the "Network".

    2. Initialize the database as instructed in Initializing TencentDB for MySQL Database and get the database account name and password.
    3. On the TencentDB for MySQL - Instance List page, select the instance ID to enter the database details page and get the private address, network, and private port of the database as shown below:

    Creating security group (optional)

    You can add a security group for your database instance as instructed in TencentDB Security Group.

    Configuring environment variables and VPC

    1. Log in to the SCF Console and click Function Service on the left sidebar.
    2. Click the name of the function to be connected to the database to enter the "Function Configuration" page of the function and configure the function as shown below:
      • Add an environment variable and enter the information by referring to the table below:
        key value
        DB_PASSWORD Database password
        DB_USER Database username
        DB_HOST Database address
        DB_PORT Database port
        DB_DATABASE Database name
      • Enable VPC and select the same VPC and subnet as those of the database as shown below:

    Sample function code


    In Python, you can use the built-in pymysql dependency package in the SCF environment to connect to the database. The sample code is as follows:

    # -*- coding: utf8 -*-
    from os import getenv
    import pymysql
    from pymysql.err import OperationalError
    mysql_conn = None
    def __get_cursor():
            return mysql_conn.cursor()
        except OperationalError:
            return mysql_conn.cursor()
    def main_handler(event, context):
        global mysql_conn
        if not mysql_conn:
            mysql_conn = pymysql.connect(
            host        = getenv('DB_HOST', '<YOUR DB HOST>'),
            user        = getenv('DB_USER','<YOUR DB USER>'),
            password    = getenv('DB_PASSWORD','<YOUR DB PASSWORD>'),
            db          = getenv('DB_DATABASE','<YOUR DB DATABASE>'),
            port        = int(getenv('DB_PORT','<YOUR DB PORT>')),
            charset     = 'utf8mb4',
            autocommit  = True
        with __get_cursor() as cursor:
            cursor.execute('select * from employee')
            myresult = cursor.fetchall()
            for x in myresult:


    Node.js allows you to use a connection pool for connection, which supports automatic reconnection to effectively avoid connection unavailability due to connection release by the SCF underlying layer or database. The sample code is as follows:


    Before using a connection pool, you need to install the mysql2 dependency package first. For more information, please see Dependency Installation.

    'use strict';
    const DB_HOST       = process.env[`DB_HOST`]
    const DB_PORT       = process.env[`DB_PORT`]
    const DB_DATABASE   = process.env[`DB_DATABASE`]
    const DB_USER       = process.env[`DB_USER`]
    const DB_PASSWORD   = process.env[`DB_PASSWORD`]
    const promisePool = require('mysql2').createPool({
      host              : DB_HOST,
      user              : DB_USER,
      port              : DB_PORT,
      password          : DB_PASSWORD,
      database          : DB_DATABASE,
      connectionLimit   : 1
    exports.main_handler = async (event, context, callback) => {
      let result = await promisePool.query('select * from employee');


    In PHP, you can use the pdo_mysql dependency package for data connection. The sample code is as follows:

    function handler($event, $context) {
      $pdo = new PDO('mysql:host= getenv("DB_HOST");dbname= getenv("DB_DATABASE"),getenv("DB_USER"),getenv("DB_PASSWORD")');
      $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    }catch(PDOException $e){
      echo 'Databases connection failed: '.$e->getMessage();


    1. Please install the following dependencies as instructed in Dependency Installation.
    1. Use HikariCP for connection. The sample code is as follows:
    package example;
    import com.qcloud.scf.runtime.Context;
    import com.zaxxer.hikari.HikariConfig;
    import com.zaxxer.hikari.HikariDataSource;
    import javax.sql.DataSource;
    import java.sql.Connection;
    import java.sql.PreparedStatement;
    import java.sql.ResultSet;
    import java.sql.SQLException;
    import java.util.HashMap;
    import java.util.Map;
    public class Http {
        private DataSource dataSource;
        public Http() {
            HikariConfig config = new HikariConfig();
            config.setJdbcUrl("jdbc:mysql://" + System.getenv("DB_HOST") + ":"+ System.getenv("DB_PORT") + "/" + System.getenv("DB_DATABASE"));
            dataSource = new HikariDataSource(config);
        public String mainHandler(APIGatewayProxyRequestEvent requestEvent, Context context) {
            System.out.println("start main handler");
            System.out.println("requestEvent: " + requestEvent);
            System.out.println("context: " + context);
            try (Connection conn = dataSource.getConnection(); PreparedStatement ps = conn.prepareStatement("SELECT * FROM employee")) {
                ResultSet rs = ps.executeQuery();
                while ( {
            } catch (SQLException e) {
            APIGatewayProxyResponseEvent apiGatewayProxyResponseEvent = new APIGatewayProxyResponseEvent();
            apiGatewayProxyResponseEvent.setBody("API GW Test Success");
            Map<String, String> headers = new HashMap<>();
            headers.put("Content-Type", "text");
            headers.put("Access-Control-Allow-Origin", "*");
            return apiGatewayProxyResponseEvent.toString();

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback