Connecting to a GaussDB Data Source

DataArts Insight allows you to connect to a GaussDB data source. This section describes how to connect DataArts Insight to a GaussDB data source.

DataArts Insight can connect to GaussDB through the following methods:

Public network connection: To connect to cloud service resources that do not belong to your current account, use this method. The data source must be bound to an EIP.
VPC network connection: To connect to cloud service resources under your current account, use this method.
VPCEP service: To connect to data sources that are not associated with your current account or for which you lack VPCEP permissions, as well as ECS self-built data sources, use this method.

Preparations

Do the following to check if an EIP or VPCEP security group is added:

Log in to the management console.
Choose Service List > Databases > GaussDB to go to the GaussDB console.
Select a region in the upper left corner.
Click Instances in the navigation pane on the left.
Click the name of the target instance to go to the basic information page.
Click the security group in the Connection Information > Security Group area. On the displayed page, click Inbound Rules. Then, check whether a public or private IP address is added.
- If yes, return to the DataArts Insight data source editing page to connect to the data source.
- If no, perform the following steps to add a security group:
  1. Click Add Rule. In the displayed Add Inbound Rule dialog box, set the protocol, port, and source IP address.
  2. Confirm the parameter settings and click OK to return to the DataArts Insight page and connect to the data source.
  If the data source connection test fails after the security group is added, the possible cause is that SASL_SSL is not enabled for that data source.

Accessing a GaussDB Data Source Through a Public Network

Log in to the DataArts Insight console.
Click in the upper left corner of the management console to select a region and select an enterprise project from Enterprise Project in the upper right corner of the Workspace page.
On the top menu of the console, click Project. On the displayed My Projects page, click the name of the desired project.
In the navigation pane on the left, choose Data Management > Data Sources. On the displayed page, click Create Data Source. In the slide-out panel, set Source Database Type to GaussDB and Access Network Type to Public network.

Set other parameters based on Table 1.

Figure 1 Connecting to a GaussDB data source
Click to enlarge

**Table 1** Parameters
Parameter	Mandatory	Description
Source Database Type	Yes	Type of the data source to be connected.
Access Network Type	Yes	Select Public network for GaussDB(DWS) instances with public IP addresses, not restricted by account, region, or other limitations.
Name	Yes	Name the current data connection for easier subsequent use and configuration.
Domain Name	Yes	Public IP address or domain name bound to the target data source, which can be obtained from the public IP address in the Connection Information area on the GaussDB(DWS) instance details page.
Port	Yes	External port of the target data source on the corresponding node, which can be obtained from the port number in the Connection Information area on the GaussDB(DWS) instance details page.
Database	Yes	Select the database in the target data source based on service requirements.
SASL_SSL	N/A	It is used for trusted identity authentication and secure data transmission when DataArts Insight retrieves data from the data source. This function is enabled by default.
Username	Yes	Username used for connection authentication.
Password	Yes	Password used for connection authentication.

Click Test Connection to test the data source connectivity.
After the test is successful, click OK.

Accessing a GaussDB Data Source Through a VPC Network

Log in to the DataArts Insight console.
Click in the upper left corner of the management console to select a region and select an enterprise project from Enterprise Project in the upper right corner of the Workspace page.
On the top menu of the console, click Project. On the displayed My Projects page, click the name of the desired project.
In the navigation pane on the left, choose Data Management > Data Sources. On the displayed page, click Create Data Source. In the slide-out panel, set Source Database Type to GaussDB and Access Network Type to GaussDB.

Set other parameters based on Table 2.

Figure 2 Parameters for connecting to a GaussDB cloud data source
Click to enlarge

**Table 2** Parameters
Parameter	Mandatory	Description
Source Database Type	Yes	Type of the accessed data source. In this example, GaussDB is selected.
Access Network Type	Yes	In this example, GaussDB is selected.
Region	Yes	Region where the GaussDB service host is located.
Name	Yes	Name of the data source displayed in the list.
Description	No	Description of the data source.
Instance	Yes	Role instance corresponding to the GaussDB service.
Servers	Yes	List of servers where GaussDB is located.
Database	Yes	Name of the database to be logged in to.
Username	Yes	Username for logging in to the database.
Password	Yes	Password for logging in to the database.
SASL_SSL	N/A	It is used for trusted identity authentication and secure data transmission when DataArts Insight retrieves data from the data source. This function is enabled by default.

Click Test Connection to test the data source connectivity.
Once the test is successful, click OK.

Connecting to a GaussDB Data Source Through a VPC Endpoint Service

VPCEP enables connections to data sources using the VPCEP service name, offering flexible data access and addressing issues related to cross-account access and self-built data source access for ECS. Furthermore, the same main account and its IAM users can share a single connection channel, streamlining connection management. The existing access method eliminates the need for permission delegation, further simplifying operations.

Prerequisites
- Connection Approval has been enabled on the basic information page of the VPCEP service. For details, see Viewing a VPC Endpoint Service.
- You have whitelisted the VPCEP service by adding its domain ID to the whitelist. For details, see Managing Whitelist Records of a VPC Endpoint Service. You can obtain the domain ID in the Create Data Source dialog box.
  Figure 3 Obtaining the domain ID

Procedure

Log in to the DataArts Insight console.
Click in the upper left corner of the management console to select a region and select an enterprise project from Enterprise Project in the upper right corner of the Workspace page.
On the top menu of the console, click Project. On the displayed My Projects page, click the name of the desired project.
In the navigation pane on the left, choose Data Management > Data Sources. On the displayed page, click Create Data Source. In the slide-out panel, set Source Database Type to GaussDB and Access Network Type to VPC Endpoint Service.

Set other parameters based on Table 3.

Figure 4 Connection through a VPC endpoint service
Click to enlarge

**Table 3** Parameters
Parameter	Mandatory	Description
Source Database Type	Yes	Type of the accessed data source. In this example, GaussDB is selected.
Access Network Type	Yes	Select VPC Endpoint Service.
Region	Yes	Region where the GaussDB service host is located.
Name	Yes	Name of the data source displayed in the list, which is user-defined.
Description	No	Description of the data source.
VPC Endpoint Service	Yes	Name of the VPCEP service to be connected. The prerequisites for connecting to a VPCEP service are as follows: You have obtained the correct VPCEP service name. For details, see Checking a VPC Endpoint Service. You have whitelisted the VPCEP service by adding its domain ID to the whitelist. For details, see Managing Whitelist Records of a VPC Endpoint Service.
Verify	N/A	After entering the VPCEP service name, click Verify. If a green tick is displayed next to the VPC endpoint ID, the verification is successful. If a red exclamation mark () is displayed next to the VPC endpoint ID, the VPCEP service is connected to for the first time. In this case, you need to authorize the VPCEP service. To do so, log in to the VPCEP console. Under Network Console, choose VPC Endpoint > VPC Endpoint Services. On the displayed page, click the desired VPCEP service and click the Connection Management tab. On the tab page, authorize the VPCEP service. For details, see Managing Connections of a VPC Endpoint Service. Once the authorization is successful, click Verify again. The verification is successful. NOTE: All initial connections to the VPCEP service from different data sources require approval. Only an administrator account or an account with administrator privileges can approve the connection. If your current account does not have approval privileges, contact an administrator account for approval.
VPC Endpoint ID	Yes	This parameter is automatically filled in once you entered the VPCEP name and clicked Verify.
Port	Yes	Port number for logging in to the database.
Database	Yes	Name of the database to be logged in to.
Username	Yes	Username for logging in to the database.
Password	Yes	Password for logging in to the database.
SASL_SSL	N/A	It is used for trusted identity authentication and secure data transmission when DataArts Insight retrieves data from the data source. This function is enabled by default.