DWS Connection Parameters

Updated on 2025-02-27 GMT+08:00

View PDF

**Table 1** DWS connection
Parameter	Mandatory	Description
Data Connection Type	Yes	DWS is selected and cannot be changed.
Name	Yes	Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).
Tag	No	Attribute of the data connection to create. Tags make management easier. NOTE: The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.
Applicable Modules	Yes	Select the modules for which this connection is available. NOTE: When the data migration job feature is enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory. You can use offline processing migration jobs only after apply for the whitelist membership. To use this feature, contact customer service or technical support.
Basic and Network Connectivity Configuration
SSL Encryption	Yes	DWS supports SSL encryption and certificate authentication for communication between the client and server. You can set this parameter based on whether SSL connection is mandatory on the server. If this parameter is enabled, only SSL encryption can be used for communication. If this parameter is disabled, both SSL encryption and certificate authentication can be used for communication.
Manual	Yes	Select either of the following modes: Cluster Name Mode: Select an existing cluster. Connection String Mode: Enter the IP address/domain name and port of the corresponding cluster and enable the communication between the connection's agent (CDM cluster) and the DWS cluster. NOTE: DataArts Security does not support GaussDB(DWS) connections in connection string mode.
DWS Cluster Name	Yes	This parameter is mandatory when Manual is set to Cluster Name Mode. Select a DWS cluster from all the DWS clusters with the same project ID and enterprise project.
IP Address or Domain Name	Yes	This parameter is mandatory when Manual is set to Connection String Mode. If you choose to manually enter an IP address or domain name, you must enter an internal IP address and a port that is accessible to the network segment of the resource group. Otherwise, the network is disconnected. This parameter indicates the address for accessing the cluster database through an internal network. Enter an IP address or domain name. The IP address or domain name is automatically generated during cluster creation. You can obtain them on the management console by performing the following operations: Log in to the GaussDB(DWS) console. In the left navigation pane, choose Instances. Click the name of an instance to enter the basic information page. In the Connection Information area, you can obtain the private IP address, domain name, and port number.
Port	Yes	This parameter is mandatory when Manual is set to Connection String Mode. This parameter indicates the database port number specified during the DWS cluster creation. Ensure that you have enabled this port in the security group rule so that the DataArts Studio instance can connect to the database in the DWS cluster through this port.
KMS Key	Yes	KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key. NOTE: When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key dlf/default or kps/default is automatically generated. For more information about default keys, see What Is a Default Master Key?.
Agent	Yes	Data Warehouse Service (DWS) is not a fully managed service and thus cannot be directly connected to DataArts Studio. A CDM cluster can provide an agent for DataArts Studio to communicate with non-fully-managed services. Therefore, you need to select a CDM cluster when creating a DWS data connection. If no CDM cluster is available, create one first by referring to Creating a CDM Cluster. As a network proxy, the CDM cluster must be able to communicate with the DWS cluster. To ensure network connectivity, the CDM cluster must be in the same region and AZ and use the same VPC and subnet as the DWS cluster. The security group rule must also allow the CDM cluster communicate with the DWS cluster. NOTE: If a CDM cluster functions as the agent for a data connection in Management Center, the cluster supports a maximum of 200 concurrent active threads. If multiple data connections share an agent, a maximum of 200 SQL, Shell, and Python scripts submitted through the connections can run concurrently. Excess tasks will be queued. You are advised to plan multiple agents based on the workload.
Data Source Authentication and Other Function Configuration
Username	Yes	The database username, which is specified when the DWS cluster is created.
Password	Yes	The password for accessing the database, which is specified when the DWS cluster is created.
Metadata Collection Scope	No	Databases and data tables whose metadata will be synchronized in real time. If this parameter is not set, all metadata will be synchronized. The value can be in either of the following formats: database_name: databases whose names contain database_name database_name.table_name: databases whose names contain database_name and data tables whose names contain table_name Examples: If you enter datatest, metadata of the tables in the databases whose names contain datatest will be synchronized in real time. If you enter datatest.table1, metadata of the tables whose names contain table_name in the databases whose names contain datatest will be synchronized in real time.