Add a StarRocks Data Source

Updated at:
Copy as MD

Add a StarRocks data source to connect your StarRocks database to Quick BI for data analysis and visualization. You can connect over a public network or through an Alibaba Cloud VPC.

Prerequisites

  • Ensure you have network connectivity:

    • If you connect to your StarRocks database over the public network, add the Quick BI IP addresses to your database whitelist. For more information, see Create an AccessKey.

    • If you are connecting over an internal network, ensure that Quick BI can connect to your data source by using one of the following methods:

      • If your StarRocks database is deployed on an Alibaba Cloud ECS instance, you can connect through an Alibaba Cloud VPC.

      • You can also set up a bastion host and use an SSH tunnel to access the database.

  • You have a user-created StarRocks database.

  • You have the username and password for your user-created StarRocks database.

Limitations

  • This connection supports StarRocks versions 2.5.18, 3.1.7, 3.1.9, and 3.2.6.

  • You can connect to StarRocks internal tables, and Hive and Iceberg external tables.

Procedure

  1. Log on to the Quick BI console.

  2. Add the data source.

    1. Navigate to the Create a Data Source page.

    2. On the User-Created Data Source tab, select StarRocks.image

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

    Parameter

    Description

    Display Name

    The display name of the data source, shown in the data source list.

    The name cannot contain special characters or leading or trailing spaces.

    Database Address

    The IP address or domain name of your StarRocks database.

    Port

    The port number of the database.

    Database

    The name of the database to connect to.

    Username and Password

    The username and password for your StarRocks database. The user must have CREATE, INSERT, UPDATE, and DELETE permissions on the tables.

    VPC Data Source

    If your database is in an Alibaba Cloud VPC, enable the VPC Data Source option.

    Select "Instance" if your database is deployed on an Alibaba Cloud ECS instance, or "CLB" if you are connecting through a Classic Load Balancer (CLB).

    • Instance

      • Owner's AccessKey ID: The AccessKey ID of the account that owns the instance.

        For more information, see Create an AccessKey.

        Note

        The AccessKey ID must have read permissions on the target instance. If it also has write permissions, Quick BI automatically adds its IP addresses to the security group of the instance. Otherwise, you must add them manually. For more information, see Create a custom policy.

      • Owner's AccessKey Secret: The AccessKey Secret of the account that owns the instance.

        For more information, see Create an AccessKey.

      • Instance ID: The ID of the ECS instance. You can find the instance ID on the Instances page in the ECS console.

        For more information, see View instance information.

      • Region: The region where the ECS instance is located. You can find the region in the upper-left corner of the ECS console.

        For more information, see View instance information.

    • CLB

      • Owner's AccessKey ID: The AccessKey ID of the account that owns the CLB instance. This account must have read permissions for the CLB instance. You can obtain the AccessKey ID from the Resource Access Management (RAM) console.

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

      • Owner's AccessKey Secret: The AccessKey Secret corresponding to the AccessKey ID. You can obtain the AccessKey Secret from the RAM console.

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

      • Instance ID: The ID of the CLB instance. You can find the instance ID in the instance list in the CLB console.

      • Region: The region where the instance is located. You can find the region in the upper-left corner of the Instance Management page in the CLB console.

    SSH

    Set up a bastion host and use an SSH tunnel to access your database. Contact your operations team or system administrator for the bastion host details.

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

    • SSH Username: The username for the bastion host.

    • SSH Password: The password for the specified SSH username.

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

    Initial SQL

    If enabled, SQL statements that you specify run automatically after the connection is established.

    Only SET statements are allowed. Separate statements with a semicolon (;).

    Enable File Upload

    If enabled, you can upload files.

  4. Click Test Connection to verify the connection.

    image

  5. If the test is successful, click OK to add the data source.

Next Steps

After creating the data source, create a dataset to start analyzing your data.