This article describes how to connect StarRocks to create datasets.

Before connecting to the data, collect the following information:

• The IP address and port number of the server where the database is located
• The username and password for the database

1. Go to BytePlus, select a specific project, click Data Preparation, find Data Connection in the drop-down list, and select it.

   

2. Select StarRocks on the page.

3. Fill in the required basic information, test the connection, and click Save after the connection is successful.

   • The parameter configuration instructions for the SaaS version are as follows:
     

     Parameters	Configuration instructions
     Data connection name	The name of the new data connection, used to distinguish between different database connections in the system. The default is StarRocks_timestamp. The name can be modified, but please enter a standard name. Only combinations of Chinese characters, English letters, numbers, and underscores are allowed, and there must be no spaces at the beginning or end.
     Server	The public network address of StarRocks. For details, refer to the StarRocks official documentation.
     Port	The instance port of StarRocks. For details, refer to the StarRocks official documentation.
     Username	The username created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel responsible for the corresponding engine.
     Password	The password created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel responsible for the corresponding engine.
     Connection method	The SaaS version provides the IP/Port connection method.
     externalCatalog	This field must be filled in when querying external data sources (such as Hive, Iceberg, Hudi, Delta Lake, JDBC, Elasticsearch, Paimon, and more) through an external catalog. Enter the database name part from “catalog name.database name”. (For example: my_catalog.hive_db1, enter hive_db1 here.)
     Permission mode	Both read and write modes are supported. Read: Only retrieves data from the data source. Modification, addition, or deletion of data is not allowed. Write: The user needs to write data to the data connection through visual modeling and must have data operation permissions.
     vpcMode and VPC ID	vpcMode: Select “Yes” if you need to connect through the BytePlus intranet; select “No” in all other cases. warning Currently, VPC intranet connections are only supported in the North China region. VPC ID: Required when vpcMode is set to “Yes”. For how to obtain it, see Preparation.

   • The parameter configuration instructions for the on-premises version are as follows:
     

     Parameters	Configuration description
     Data connection name	Name of the new data connection, used to distinguish connections to different databases in the system. The default is StarRocks_timestamp. The name can be modified, but please enter a standardized name. Only Chinese characters, English letters, digits, and underscores are allowed, and there must be no spaces at the beginning or end.
     Server	The public network address of StarRocks. For details, refer to the StarRocks official documentation.
     Port	The instance port of StarRocks. For details, refer to the StarRocks official documentation.
     Username	The username created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel responsible for the corresponding engine.
     Password	The password created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel responsible for the corresponding engine.
     Connection method	The on-premises version provides two connection methods: IP/Port and JDBC connection string. IP/Port: Suitable for general scenarios. JDBC connection string: Suitable for scenarios where users need to add connection parameters.
     externalCatalog	This field is required when querying external data sources (such as Hive, Iceberg, Hudi, Delta Lake, JDBC, Elasticsearch, Paimon, and more) through an external catalog. Enter the database name from “catalog name.database name”. (For example: my_catalog.hive_db1. In this case, enter hive_db1.)
     JDBC connection string	For information on how to obtain the JDBC connection string, refer to the StarRocks official documentation.
     Permission mode	Both read and write modes are supported. Read: Only retrieves data from the data source; modification, addition, or deletion of data is not allowed. Write: To write data to the data connection through visual modeling, the user must have data operation permissions.

1. Go to BytePlus, click Data Preparation --> Dataset, select the "New" button in the upper left corner to create a new dataset.

   

2. When selecting a data connection, click New Configuration.

   

3. The subsequent steps are the same as steps 2 and 3 of Create from data connection. After completing the configuration, you will remain in the pop-up window for selecting a data connection for the dataset, where you can proceed directly to the next step of dataset creation.

1. Use the previously created data connection to create a dataset: Click Data Preparation --> Dataset, and select the "New" button in the upper left corner to create a new dataset.

   

2. Search for or select from the drop-down list the data connection that was previously created.