This article describes how to integrate ByteHouse CDW to create datasets for BI analysis and report display.

A ByteHouse CDW account is required.

1. Refer to ByteHouse CDW Quick Started to complete the purchase and activation, set the default compute group, create data objects, and import data.
2. (SaaS version only) Go to 'Tenant Management' - 'Basic Information', click 'Allowlist Configuration', perform the add allowlist operation, and enter the 'DataWind public IP for access' in the allowlist settings area to grant this IP address permission to access the CDW service. The 'DataWind public IP for access' can be viewed at Data Connections Overview.
3. Obtain the access key. Go to 'Tenant Management' - 'Connection Information', click 'Create', and obtain the API Key.

   warning

   The generated API Key is displayed only once. Please store it securely.

4. Obtain the compute group. Go to the 'Compute Group' page to obtain the required compute group name.

   warning

   Ensure that the current compute group status is "Running" or "Auto Start".

5. Obtain the role. Go to the 'Permission Management' page, click 'Role', and obtain the required role name.

   warning

   Ensure that this role has SELECT, SHOW, and CREATE permissions on the table in order to use the table in DataWind. For details, refer to data permission management.

6. Obtain the server. Go to 'Tenant Management' - 'Basic Information', and obtain the server domain name in the network information section.

   tip

   You can obtain the ByteHouse CDW connection domain name information using the following methods. If your current environment does not support connecting to ByteHouse CDW via domain name, you need to configure ByteHouse CDW to use its IP address. You can contact BytePlus technical support to obtain the corresponding IP address.

7. Obtain the port. Refer to ByteHouse CDW Regions and Availability Zones.
8. Obtain the VPC ID. Go to 'Tenant Management' - 'Basic Information', in the 'Network Information' section, select the private network domain name, click 'Details', and obtain the VPC ID.

1. In BytePluso a specific project, click Data Preparation, find Data Connection in the dropdown list, and click Data Connection.

   

2. Select ByteHouse CDW on the page.

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

   • The parameter configuration instructions 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 Bytehouse_CDW_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.
     Region	Use the default value.
     Access key	For how to obtain, see Preparation.
     Compute group	For how to obtain, see Preparation.
     Role	For how to obtain, see Preparation.
     Connection method	The SaaS version provides two connection methods: Volcano Cloud and Server. The privatized deployment version provides three connection methods: Volcano Cloud, JDBC connection string, and Server.

     • The SaaS version connection method configuration instructions are as follows:

       Connection method	Configuration description
       Volcano Cloud	Applicable to scenarios where the DataWind and ByteHouse CDW region is North China 2 (Beijing). vpcMode: To connect through BytePlus net, select "Yes"; otherwise, select "No". Select "Yes" here. VPC ID: Required when vpcMode is set to "Yes". For how to obtain it, see Preparation.
       Server	Applicable to other general scenarios. Server and port: For how to obtain them, see Preparation. vpcMode: To connect through the BytePlus intranet, select "Yes"; otherwise, select "No". Select "No" here. VPC ID: Required when vpcMode is set to "Yes". For how to obtain it, see Preparation.

     • The private deployment version connection method configuration instructions are as follows:

       Connection method	Configuration description
       BytePlus	Applicable to scenarios where the DataWind and ByteHouse CDW region is North China 2 (Beijing).
       JDBC connection string	Applicable to scenarios where users need to add connection parameters. JDBC connection string: To obtain it, refer to Get ByteHouse connection string information.
       Server	Applicable to other general scenarios. Server and port: For how to obtain them, see Preparation.

1. In BytePlus, click Data Preparation --> Dataset, select the 'Create' button in the upper left corner to create a new dataset.

   

2. When selecting the data connection, click Create Configuration.

   

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

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

   

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

   

• To access the BytePlus ByteHouse (Cloud Data Warehouse Edition) console, you must complete identity verification.
• To use the LAS service, cross-service authorization is required. Otherwise, you can ignore this step.