User-created Apache Doris data source

Updated at:

Connect your Apache Doris database to Quick BI by adding it as a data source. Once connected, you can analyze and visualize your data. Quick BI can connect to an Apache Doris database over the public network or through an Alibaba Cloud VPC. This topic shows you how.

Prerequisites

  • Ensure that your network connection is configured correctly:

    • If you connect to your Apache Doris database from Quick BI over the public network, add Quick BI's IP addresses to your database's whitelist. For more information, see Use security groups.

    • If you connect over an internal network, use one of the following methods to connect your data source to Quick BI:

      • If your Apache Doris database is deployed on an Alibaba Cloud ECS instance, you can connect to the database through an Alibaba Cloud VPC.

      • You can set up a bastion host and connect to your database through an SSH tunnel.

  • A user-created Apache Doris database.

  • The username and password for the Apache Doris database.

Limitations

Versions 1.2.4 and 2.1.4 are supported.

Procedure

  1. Log on to the Quick BI console.

  2. Follow these steps to add the data source:

    1. Go to the page for creating a data source.

    2. On the User-Created Data Source tab, click Apache Doris.image

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

    Parameter

    Description

    Display Name

    The display name of the data source. The name cannot contain special characters or leading or trailing spaces.

    Database Address

    The IP address or domain name of the Apache Doris database.

    Port

    The database server's port.

    Database

    The name of the database you want to connect to.

    Username and Password

    The username and password to connect to the Apache Doris database. Ensure that this user has CREATE, INSERT, UPDATE, and DELETE permissions on the database tables.

    VPC Data Source

    When your database needs to connect by using an Alibaba Cloud VPC network, select the VPC data source and configure the parameters below. If you select the VPC data source, the database address and port must be the internal network address and port.

    If the database is deployed on an ECS instance, select Instance. If you connect through a Classic Load Balancer (CLB), select CLB.

    • Instance

      • Purchaser AccessId: The AccessKey ID used to purchase this instance.

        Note

        Ensure that the AccessKey ID has Read permission for the target instance. In addition, if the AccessKey has Write permission for the corresponding security group, the system automatically adds entries to the whitelist. Otherwise, you must add them manually. For more information, see Create a custom permission policy.

        For more information, see Create an AccessKey.

      • Purchaser AccessKey: The AccessKey Secret used to purchase this instance.

        For more information, see Creating an AccessKey.

      • Instance ID: The ID of the ECS instance. Log in to the ECS console and obtain the ID from the Instances page.

        For more information, see View instance information.

      • Region: The region where the ECS instance is located. Log on to the ECS console and find the region in the upper-left corner.

        For more information, see View instance information.

    • CLB

      • Purchaser AccessKey ID: The AccessKey ID of the CLB purchaser. Ensure that this account has read permissions for CLB. Log in to the Resource Access Management (RAM) console to obtain the AccessKey ID.

        Note

        Ensure that the account has Read permissions for CLB.

        For more information, see View the AccessKey information of a RAM user.

      • Buyer's AccessKey Secret: The AccessKey Secret that corresponds to the AccessKey ID. The AccessKey Secret is displayed only once upon creation and cannot be viewed afterward. If you lose the AccessKey Secret, please create an AccessKey.

      • Instance ID: The ID of the Classic Load Balancer (CLB) instance. Log on to the Server Load Balancer console and obtain the instance ID from the Instances page.

      • Region: The region where the instance is located. Log on to the Load Balancing console to find the region in the upper-left corner of the Instance Management page.

    SSH

    If you select SSH, you must configure the following parameters:

    You can connect to your database through an SSH tunnel via a bastion host. Contact your O&M engineer or system administrator to obtain the required bastion host details.

    • SSH Host: The IP address of the bastion host.

    • SSH Username: The username used to log on to the bastion host.

    • SSH Password: The password for the SSH username.

    • SSH Port: The port of the bastion host. The default is 22.

    For more information, see Use OpenSSH or Xshell to remotely connect to a Linux instance.

    Enable Upload File

    Select this option to allow file uploads.

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

    image

  5. After a successful connection test, click OK.

Next steps

After you create the data source, you can create datasets and analyze data.