This article describes how to integrate ByteHouse CE to create datasets for BI analysis and report presentation.

The user must have a ByteHouse CE Enterprise Edition account.

1. Refer to ByteHouse Enterprise Edition Quick Start to complete the purchase and activation, cluster creation, database and table creation, and data import operations.
2. (SaaS version only) The user must add the "DataWind public IP for access" to the allowlist settings area in order to connect to data in the SaaS environment. The "DataWind public IP for access" can be viewed at Data Connections Overview. For detailed steps, see ByteHouse CE Allowlist Management.
3. Obtain the server. Go to the "Cluster Management" - "Cluster List" page and obtain the server domain name from the network information section.
4. Obtain the port. Refer to ByteHouse CE Cluster Connection Information.
5. Obtain the username and password. Click "Account Management" to view the username and connection password.

6. (SaaS version only) Obtain the VPC ID. Click "Cluster Management" - "Cluster List" and obtain the VPC ID from the "Network Information" section.

1. Go to BytePlus, click to get into a specific project, click Data Preparation, find Data Connection in the dropdown list, and click Data Connection.

   

2. Select ByteHouse CE on the page.

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

   • The parameter configuration instructions are as follows:

     Parameters	Configuration description
     Data connection name	The name of the new data connection, used to distinguish connections to different databases in the system. The default is Bytehouse_CE_timestamp. The name can be modified, but please enter a valid name. Only Chinese characters, English letters, numbers, and underscores are allowed, and there must be no spaces at the beginning or end.
     Server	For the acquisition method, see Preparation.
     Port	See Preparation for how to obtain it.
     Username	See Preparation for how to obtain it.
     Password	See Preparation for how to obtain it.
     Permission mode	Both read and write modes are supported. Read: Only retrieves data from the data source. Data cannot be modified, added, or deleted. Write: Users must write data to the data connection through visual modeling and have permission to operate the data.
     vpcMode and VPC ID	These two parameters are required only for the Saas version. vpcMode: Select "Yes" to connect via the BytePlus intranet; otherwise, select "No". VPC ID: Required when vpcMode is set to "Yes". See Preparation for how to obtain it.

1. Go to BytePlus, click Data Preparation --> Dataset, and click 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 in Create from data connection. After completing the configuration, you will remain in the popup window to select 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 click the "New" button in the upper left corner to create a new dataset.

   

2. Search for or select from the dropdown the previously created data connection.

   

Identity verification #

If real-name authentication is not completed, you will not be able to access the BytePlus ByteHouse Enterprise Edition console normally. You need to complete real-name authentication.

Obtain the database LAN IP address and VPC ID #

Obtain the database LAN IP address #

There are two methods to obtain the database LAN IP address. The first method is to query by pinging the LAN domain name. The second method is to query through the network interface management under the VPC. The following sections provide detailed instructions.

Query by pinging the LAN domain name

1. Open the command-line tool: In Windows, press Windows+R, enter cmd, and press Enter to open the Command Prompt window; in macOS or Linux, open the Terminal application.
2. Ping the LAN domain name: Enter ping [database LAN domain name], for example, ping mysql-server.local, and press Enter. After executing the command, the IP address corresponding to the domain name will be displayed. This IP address is the LAN IP address of the database server.
   

Query through VPC network interface management

Taking MySQL as an example, the same applies to other products such as PostgreSQL, load balancer, ECS, and databases deployed in similar environments.

1. Go to the MySQL instance list page and click to view "Instance Information".

   

2. Go to the network interface page. In the Private IP Address section, you can view the LAN IP address.

Obtain the VPC ID #

Users can only query the VPC ID through VPC network interface management.
Taking MySQL as an example, the same applies to other products such as PostgreSQL, load balancer, ECS, and databases deployed in similar environments.

1. Go to the MySQL instance list page and click to view "Instance Information".

2. Copy the "ID" in the "Basic Information" section as shown in the figure below to obtain the VPC ID.

Enter the server IP address and VPC ID #

1. Go to the data connection configuration page and enter the copied "ID" in field A "VPC ID".
2. Copy the LAN IP address and enter this IP address in field B "Server" on the data connection page.

#