All Products
Search
Document Center

Quick BI:Add a user-created PostgreSQL data source

Last Updated:Sep 27, 2023

This topic describes how to add a user-created PostgreSQL data source in a group workspace.

Prerequisites

  • Your network meets the following requirements:

    • If you Quick BI connect to the PostgreSQL database over the Internet, add the Quick BI IP address to the whitelist of the database. For more information, see Add security group rules.

    • If you want to connect Quick BI to the PostgreSQL database over an internal network, make sure that one of the following methods is used to ensure the connectivity between Quick BI and the user-created PostgreSQL data source:

      • If the PostgreSQL database is deployed on an Elastic Compute Service (ECS) instance, you can connect Quick BI to the PostgreSQL database over a virtual private cloud (VPC).

      • You can deploy a jump server and access the database over an SSH tunnel.

  • A user-created PostgreSQL database is created.

  • The username and password that are used to access the user-created PostgreSQL database are obtained.

  • The AccessKey ID and AccessKey secret that are used for authentication are obtained.

Procedure

  1. Log on to the Quick BI console.

  2. Follow the instructions in the following figure to add a data source

    1. Go to the Create Data Source page.

    2. Select PostgreSQL Data Source.

      image
    3. Select User-created Data Source Type.

      image
  3. In the Configure Connection dialog box, set the following parameters.

    Component

    Description

    Display Name

    The name of the data source. The name is displayed in the data source list.

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

    Database Address

    The address where the PostgreSQL database is deployed, including the IP address or URL.

    Port

    The port number of the database that you want to access. Default value: 5432.

    Database

    The name of the database that you want to access.

    Schema

    The schema of the database. Default value: public.

    Username

    The username that is used to connect to the database.

    Password

    The password that is used to connect to the database.

    VPC data source

    Select this option if you use a virtual private cloud (VPC) to access the data source. If you select VPC Data Source, you must configure the following parameters:

    • AccessKey ID: the AccessKey ID that is used to purchase the instance.

    • AccessKey: the AccessKey secret that is used to purchase the instance.

    • Instance ID: the ID of the instance.

    • Region: the region in which the instance is deployed.

    SSL

    Specifies whether to use the SSL protocol for the data source based on your business requirements. If you select SSL, the MaxCompute Lightning service is supported. For more information, see Overview.

    SSH

    Specifies 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 of the SSH host.

    • SSH Username: the username that is used to log on to the SSH host.

    • SSH Password: the password that is used to log on to the SSH host.

    • SSH Port Number: the port number that is used to connect to the SSH host. Default value: 22.

    Note

    Only the Professional Edition allows you to access user-created data sources by using SSH tunnels.

  4. Click Test Connection to verify that the data source can be connected.

    image
  5. Click OK.

What to do next

After you add a data source, you can create a dataset and analyze data.