Creating Data Connections¶
You can create data connections by configuring data sources. Based on the data connections of the Management Center, DataArts Studio performs data development, governance, services, and operations on the data lake base.
Constraints¶
RDS data connections depend on OBS. If OBS is unavailable in the same region as DataArts Studio, RDS data connections are not supported.
If changes occur in the connected data lake (for example, the MRS cluster capacity is expanded), you need to edit and save the connection.
Prerequisites¶
You have created a data lake to connect, for example, a database or cloud service supported by DataArts Studio.
Before creating a DWS data connection, ensure that you have created a cluster in DWS and have the permissions required to view Key Management Service (KMS) keys.
Before creating an MRS HBase, MRS Hive, MRS Kafka, MRS Presto, or MRS Spark connection, ensure that you have created an MRS cluster and selected required components.
Before creating an RDS data connection, ensure that you have an RDS database instance. Currently, DataArts Studio supports only MySQL and PostgreSQL databases in RDS.
The data lake to connect communicates with the DataArts Studio instance properly.
If the data lake is an on-premises database, a public network or a dedicated connection is required. Ensure that the host where the data source is located can access the public network and the port has been enabled in the firewall rule.
If the data lake is a cloud service (such as DWS and MRS), the following requirements must be met for network interconnection:
If the CDM cluster in the DataArts Studio instance and the cloud service are in different regions, a public network or a dedicated connection is required.
If the CDM cluster in the DataArts Studio instance and the cloud service are in the same region, VPC, subnet, and security group, they can communicate with each other by default. If they are in the same VPC but in different subnets or security groups, you must configure routing rules and security group rules. For details about how to configure routing rules, see Adding Routes in Virtual Private Cloud (VPC) Usage Guide. For details about how to configure security group rules, see Security Group > Adding a Security Group Rule in Virtual Private Cloud (VPC) Usage Guide.
The cloud service instance and the DataArts Studio workspace belong to the same enterprise project. If they do not, you can modify the enterprise project of the workspace.
Creating a Data Connection¶
On the DataArts Studio console, locate a workspace and click Management Center.
In the navigation pane, choose Manage Data Connections.
On the Data Connection Management page, click Create Data Connection. Select a data connection type and set the relevant parameters. See Table 1.
Click Test to test connectivity of the data connection. If the test passes, the data connection is created.
After the test is successful, click OK. The system will create the data connection for you.
Data Connection Parameter Description¶
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Cluster Name | Yes | The name of the MRS Hive cluster. Select an MRS cluster that Hive belongs to. If the MRS cluster is not displayed in the drop-down list, check whether the network connection between the MRS cluster and the DataArts Studio instance is normal. Ensure that the MRS cluster and the DataArts Studio instance can communicate with each other. The following requirements must be met for network interconnection:
|
Connection Type | Yes | Connection type. Proxy connection is recommended.
|
Username | No | The username of the MRS cluster. This parameter is mandatory when Connection Type is set to Proxy connection. If a new MRS user is used for connection, you need to log in to Manager and change the initial password. You cannot create a data connection for an MRS security cluster as user admin. User admin is the management page user by default and cannot be used as the authentication user of a security cluster. You can create an MRS user by referring to Creating a Kerberos Authentication User for an MRS Security Cluster. When creating an MRS data connection, set Username and Password to the new MRS username and password. Note
|
Password | No | The password for accessing the MRS cluster. This parameter is mandatory when Connection Type is set to Proxy connection. |
KMS Key | No | The name of the KMS key. This parameter is mandatory when Connection Type is set to Proxy connection. |
Agent | No | This parameter is mandatory when Connection Type is set to Proxy connection. MRS is not a fully managed service and 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 an MRS data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with the MRS cluster. To ensure network connectivity, the CDM cluster must be in the same region, AZ, VPC, and subnet as the MRS cluster. The security group rule must also allow the CDM cluster communicate with the MRS cluster. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Cluster Name | Yes | The name of the MRS HBase cluster. Select an MRS cluster that HBase belongs to. If the MRS cluster is not displayed in the drop-down list, check whether the network connection between the MRS cluster and the DataArts Studio instance is normal. Ensure that the MRS cluster and the DataArts Studio instance can communicate with each other. The following requirements must be met for network interconnection:
|
Username | Yes | Username of the MRS cluster You cannot create a data connection for an MRS security cluster as user admin. User admin is the management page user by default and cannot be used as the authentication user of a security cluster. You can create an MRS user by referring to Creating a Kerberos Authentication User for an MRS Security Cluster. When creating an MRS data connection, set Username and Password to the new MRS username and password. Note
|
Password | Yes | Password for accessing the MRS cluster. |
KMS Key | Yes | Name of the KMS key. |
Agent | Yes | MRS is not a fully managed service and 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 an MRS data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with the MRS cluster. To ensure network connectivity, the CDM cluster must be in the same region, AZ, VPC, and subnet as the MRS cluster. The security group rule must also allow the CDM cluster communicate with the MRS cluster. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Cluster Name | Yes | The name of the MRS Kafka cluster. Select an MRS cluster that Kafka belongs to. If the MRS cluster is not displayed in the drop-down list, check whether the network connection between the MRS cluster and the DataArts Studio instance is normal. Ensure that the MRS cluster and the DataArts Studio instance can communicate with each other. The following requirements must be met for network interconnection:
|
Username | Yes | Username of the MRS cluster You cannot create a data connection for an MRS security cluster as user admin. User admin is the management page user by default and cannot be used as the authentication user of a security cluster. You can create an MRS user by referring to Creating a Kerberos Authentication User for an MRS Security Cluster. When creating an MRS data connection, set Username and Password to the new MRS username and password. Note
|
Password | Yes | Password for accessing the MRS cluster. |
KMS Key | Yes | Name of the KMS key. |
Agent | Yes | MRS is not a fully managed service and 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 an MRS data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with the MRS cluster. To ensure network connectivity, the CDM cluster must be in the same region, AZ, VPC, and subnet as the MRS cluster. The security group rule must also allow the CDM cluster communicate with the MRS cluster. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Cluster Name | Yes | The name of the MRS Spark cluster. Select an MRS cluster that Spark belongs to. If the MRS cluster is not displayed in the drop-down list, check whether the network connection between the MRS cluster and the DataArts Studio instance is normal. Ensure that the MRS cluster and the DataArts Studio instance can communicate with each other. The following requirements must be met for network interconnection:
|
Connection Type | Yes | Connection type. Proxy connection is recommended.
|
Username | No | The username of the MRS cluster. This parameter is mandatory when Connection Type is set to Proxy connection. If a new MRS user is used for connection, you need to log in to Manager and change the initial password. You cannot create a data connection for an MRS security cluster as user admin. User admin is the management page user by default and cannot be used as the authentication user of a security cluster. You can create an MRS user by referring to Creating a Kerberos Authentication User for an MRS Security Cluster. When creating an MRS data connection, set Username and Password to the new MRS username and password. Note
|
Password | No | The password for accessing the MRS cluster. This parameter is mandatory when Connection Type is set to Proxy connection. |
KMS Key | No | The name of the KMS key. This parameter is mandatory when Connection Type is set to Proxy connection. |
Agent | No | This parameter is mandatory when Connection Type is set to Proxy connection. MRS is not a fully managed service and 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 an MRS data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with the MRS cluster. To ensure network connectivity, the CDM cluster must be in the same region, AZ, VPC, and subnet as the MRS cluster. The security group rule must also allow the CDM cluster communicate with the MRS cluster. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
IP Address | Yes | The address for accessing RDS. If the data source is RDS, you can obtain the address from the RDS console.
You can obtain the IP address on the Connection Information tab. |
Port | Yes | The port for accessing RDS. If the data source is RDS, you can obtain the port from the RDS console.
You can obtain the database port on the Connection Information tab. |
Driver Name | Yes | The name of the driver. The following values are available:
|
Driver File Path | Yes | Path of the driver file in the OBS bucket. You need to download the .jar driver file from the corresponding official website and upload it to the OBS bucket.
Note To update the driver, you must restart the CDM cluster in DataArts Migration and then edit the data connection to upload the driver. |
Username | Yes | The username of the database. The username is required for creating a cluster. |
Password | Yes | The password for accessing the database. The password is required for creating a cluster. |
KMS Key | Yes | The name of the KMS key. To obtain the key:
You can obtain the key name from the key list. |
Agent | Yes | RDS is not a fully managed service and 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 an RDS data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with RDS. To ensure network connectivity, the CDM cluster must be in the same region, AZ, VPC, and subnet as RDS. The security group rule must also allow the CDM cluster to communicate with RDS. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Manual | Yes | You can turn off or turn on to disable or enable the Manual function.
|
IP Address | No | The IP address for accessing the cluster database through the internal network. This parameter is mandatory when Manual is enabled. The private network address is automatically generated when you create a cluster. |
Port | No | The database port specified during DWS cluster creation. This parameter is mandatory when Manual is enabled. 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. |
SSL Connection | Yes | DWS supports SSL encryption and certificate authentication for communication between the client and server. You can use SSL Connection to set the communication mode. If SSL Connection is enabled, only SSL encryption can be used. If SSL Connection is disabled, both modes can be used. SSL Connection is disabled by default. |
Cluster Name | Yes | The name of the selected DWS cluster. |
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. |
KMS Key | Yes | Name of the KMS key. |
Connection Type | Yes | Connection type. Proxy connection is recommended.
|
Agent | No | This parameter is mandatory when Connection Type is set to Proxy connection. 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 through the DataArts Migration incremental package. 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, AZ, VPC, and subnet as the DWS cluster. The security group rule must also allow the CDM cluster communicate with the DWS cluster. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
ip | Yes | The IP address of the database to connect. Both public and private IP addresses are supported. |
Port | Yes | The port of the database to connect. |
Username | Yes | The username of the account for accessing the database. This account must have the permissions required to read and write data tables and metadata. Note If you have the CONNECT permission (read-only permission) and are trying to create a connection, a message is displayed indicating that the table or schema does not exist. In this case, perform the following operations to grant permissions:
|
Password | Yes | The user password. |
sid | Yes | The unique identifier of the Oracle database. |
KMS Key | Yes | The name of the KMS key. To obtain the key:
You can obtain the key name from the key list. |
Agent | Yes | Oracle is not a fully managed service and 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 an Oracle data connection. If no CDM cluster is available, create one through the DataArts Migration incremental package. As a network proxy, the CDM cluster must be able to communicate with Oracle. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | The name of the data connection to create. Data connection names can contain 1 to 50 characters. They can include only letters, numbers, underscores (_), and hyphens (-). |
Tag | No | The attribute of the data connection to create. Tags make management easier. Note The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_). Enter up to 100 characters. |
Cluster Name | Yes | The name of the MRS cluster that Presto belongs to. If the MRS cluster is not displayed in the drop-down list, check whether the network connection between the MRS cluster and the DataArts Studio instance is normal. Ensure that the MRS cluster and the DataArts Studio instance can communicate with each other. The following requirements must be met for network interconnection:
|
Description | No | You can enter the description of the connection. |
Parameter | Mandatory | Description |
---|---|---|
Data Connection Name | Yes | Name of the host connection. The value can contain only letters, digits, hyphens (-), and underscores (_). |
Host Address | Yes | IP address of the host For details, see section "Viewing Details About an ECS" in Elastic Cloud Server User Guide. |
Agent | Yes | Agents provided by the CDM cluster. |
Port | Yes | SSH port number of the host |
Username | Yes | Username of the host |
Login Mode | Yes | Mode for logging in to the host
|
Key Pair | Yes | If you select Key pair for Login Mode, you need to obtain the private key file, upload it to OBS, and select the OBS path. This parameter is available only when Login Mode is set to Key pair. Note The uploaded private key file must be in PEM format, and the uploaded private key file and the public key configured on the host must be in the same key pair. |
Key Pair Password | No | If no password is set for the key pair, you do not need to set this parameter. |
Password | Yes | Password for logging in to the host. |
Host Connection Description | No | Description of the host connection |
Creating a Kerberos Authentication User for an MRS Security Cluster¶
You cannot create a data connection for an MRS security cluster as user admin. User admin is the management page user by default and cannot be used as the authentication user of a security cluster. To create an MRS user, perform the following steps:
For clusters of MRS 3.x:
Log in to MRS Manager as user admin.
Choose System > Permission > User. On the page displayed, click Create to add a dedicated user as the Kerberos authentication user. Select the user group superGroup for the user, and assign all roles to the user.
Note
For clusters of MRS 3.1.0 or later, the user must at least have permissions of the Manager_viewer role to create data connections in Management Center. To perform database, table, and data operations on components, the user must also have user group permissions of the components.
For clusters earlier than MRS 3.1.0, the user must have permissions of the Manager_administrator or System_administrator role to create data connections in Management Center.
A user with only the Manager_tenant or Manager_auditor permission cannot create connections.
Log in to Manager as the new user and change the initial password. Otherwise, the connection fails to be created.
Synchronize IAM users.
Log in to the MRS management console.
Choose Clusters > Active Clusters, select a running cluster, and click its name to go to its details page.
In the Basic Information area of the Dashboard page, click Synchronize on the right side of IAM User Sync to synchronize IAM users.
Note
When the policy of the user group to which the IAM user belongs changes from MRS ReadOnlyAccess to MRS CommonOperations, MRS FullAccess, or MRS Administrator, wait for 5 minutes until the new policy takes effect after the synchronization is complete because the SSSD (System Security Services Daemon) cache of cluster nodes needs time to be updated. Then, submit a job. Otherwise, the job may fail to be submitted.
When the policy of the user group to which the IAM user belongs changes from MRS CommonOperations, MRS FullAccess, or MRS Administrator to MRS ReadOnlyAccess, wait for 5 minutes until the new policy takes effect after the synchronization is complete because the SSSD cache of cluster nodes needs time to be updated.
For clusters of MRS 2.x or earlier:
Log in to MRS Manager as user admin.
Choose System > Manage User. On the page displayed, add a dedicated user as the Kerberos authentication user. Select the user group superGroup for the user, and assign all roles to the user.
Note
For clusters of MRS 2.x or earlier, the user must have permissions of the Manager_administrator or System_administrator role to create data connections in Management Center.
A user with only the Manager_tenant or Manager_auditor permission cannot create connections.
Log in to MRS Manager as the new user and change the initial password. Otherwise, the connection fails to be created.
Synchronize IAM users.
Log in to the MRS management console.
Choose Clusters > Active Clusters, select a running cluster, and click its name to go to its details page.
In the Basic Information area of the Dashboard page, click Synchronize on the right side of IAM User Sync to synchronize IAM users.
Note
When the policy of the user group to which the IAM user belongs changes from MRS ReadOnlyAccess to MRS CommonOperations, MRS FullAccess, or MRS Administrator, wait for 5 minutes until the new policy takes effect after the synchronization is complete because the SSSD (System Security Services Daemon) cache of cluster nodes needs time to be updated. Then, submit a job. Otherwise, the job may fail to be submitted.
When the policy of the user group to which the IAM user belongs changes from MRS CommonOperations, MRS FullAccess, or MRS Administrator to MRS ReadOnlyAccess, wait for 5 minutes until the new policy takes effect after the synchronization is complete because the SSSD cache of cluster nodes needs time to be updated.
Editing a Data Connection¶
Log in to Management Center and click Data Connection Management.
In the data connection list, locate the data connection you want to edit and click Edit in the Operation column.
In the Edit Data Connection dialog box, modify connection parameters as required. For parameter details, see Data Connection Parameter Description.
Click Test to test whether the data connection is valid. If the connection is normal, click Yes.
If the test connection is invalid, the data connection cannot be created. Modify the connection parameters as prompted and try again.
Deleting a Data Connection¶
If a data connection is deleted, the data table information of the data connection will also be deleted. Exercise caution when performing this operation. If the data connection you want to delete has been referenced, it cannot be deleted.
Log in to Management Center and click Data Connection Management.
In the data connection list, locate the data connection you want to delete and click Delete in the Operation column.
In the dialog box displayed, confirm the data connection information, and click Yes.