All Products
Search
Document Center

Quick BI:Add a SQL Server Data Source

Last Updated:Jun 24, 2025

This topic explains how to create a user-created SQL Server data source.

Prerequisites

  • Ensure that your network meets the following requirements:

    • If connecting Quick BI to the SQL Server database over the Internet, add the IP address of Quick BI to the database whitelist. For more information, see Add Security Group Rules.

    • If connecting Quick BI to the SQL Server database over an internal network, ensure connectivity using one of the following methods:

      • For SQL Server databases deployed on an ECS instance, connect Quick BI over a VPC.

      • Deploy a jump server and access the database via an SSH tunnel.

  • A user-created SQL Server database is established.

  • The username and password for the SQL Server database are retrieved.

  • The AccessKey ID and AccessKey Secret for authentication are obtained.

Limits

Support is provided for versions from 2008 to 2022.

Procedure

  1. Log on to the or the Quick BI console.

  2. Navigate to the data source creation page as shown in the following figure:

    1. Access the data source creation page from the data source creation entry.

    2. On the User-created Data Source tab, select SQL Server data source.image

  3. In the Configure Connection dialog box, complete the following configurations based on your business requirements.image

    Name

    Description

    Display Name

    The display name in the data source configuration list.

    The name cannot contain special characters or start or end with spaces.

    Database Address

    The address of the SQL Server database, including the IP address or domain name.

    Port

    Enter the correct port number. Default port: 1433.

    Database

    The name of the database that you want to access.

    Schema

    The schema of the database that you want to access. Default value: dbo.

    Username

    The username that is used to access the database.

    Password

    The password that is used to access the database.

    VPC Data Source

    Specify whether the data source is a VPC data source based on your business requirements. If you select VPC Data Source, you must configure the following parameters:

    • Purchaser Accessid: The AccessKey ID of the purchaser of the instance.

      For more information, see Obtain an AccessKey.

      Note

      Ensure that the AccessKey ID has Read permissions on the destination instance. If Write permissions are granted, the system automatically adds the whitelist. Otherwise, you must manually add it. For more information, see Create a custom policy.

    • Purchaser Accesskey: The AccessKey Secret of the purchaser of the instance.

      For more information, see Obtain an AccessKey.

    • Instance ID: The ID of the ECS instance. Log on to the ECS console and obtain the instance ID on the Instances tab.

      For more information, see View instance information.

    • Region: The region where the ECS instance resides. Log on to the ECS console and obtain the region in the upper-left corner of the page.

      For more information, see View instance information.

    SSH

    Specify whether to access the data source over an SSH tunnel based on your business requirements. If you select SSH, you must configure the following parameters:

    • SSH Host: The hostname or IP address.

    • SSH Username: The SSH username of the database.

    • SSH Password: The password of the SSH username.

    • SSH Port: The port of the database. Default value: 22.

    Enable file upload entry

    After this option is enabled, you can upload files.

    Initialize SQL

    After this option is enabled, you can configure SQL statements that are executed to initialize the data source connection.

    Only SET statements are allowed. Separate multiple statements with semicolons.

  4. Click Test Connection to verify the data source connectivity.

    image

  5. Once the test is successful, click OK to finalize the data source addition.

What to Do next

After creating a data source, proceed to create datasets and analyze data.