This topic describes how to create a data source in OceanBase Cloud.
Background information
A data source is a collection of database connection information, including the connection address, port, username, and password. In OceanBase Cloud, by configuring a data source, you can quickly establish connections to databases for tasks such as data migration and job scheduling, improving operational efficiency and reliability.
OceanBase Cloud supports data sources deployed on Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Supported cloud providers and instance types vary by database type. See the following sections for details.
The connection method for a data source varies depending on the database type. Please select the appropriate connection method based on your database type.
OceanBase data sources (MySQL and Oracle compatibility modes)
For OceanBase Database, OceanBase Cloud provides four connection methods.
Quick connection to an OceanBase Cloud instance: This method is suitable for OceanBase Database instances created through the OceanBase Cloud console.
Endpoint connection, public network connection, or peering connection: Endpoint and public network connections apply to OceanBase Database deployed on Alibaba Cloud, AWS, Huawei Cloud, Azure, or Google Cloud. Peering connections apply to self-managed OceanBase Database deployed on Alibaba Cloud, AWS, or Google Cloud.
Prerequisites
You have created an instance and a tenant in the OceanBase Cloud console (either MySQL-compatible or Oracle-compatible mode is acceptable), and have an available database and account.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left navigation bar, click Data Services > Data Source.
On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner > OceanBase MySQL Compatible or OceanBase Oracle Compatible.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select OB Cloud Instance. Instance Type Includes Cluster Instance (Transactional), Cluster Instance (Flagship), Tenant Instance, and Cluster Instance (Analytical). This option is only displayed when Connection Method is set to OceanBase Cloud Instance. Note
Data migration only supports Flagship Edition instances and Cluster Instances (Analytical).
Instance Select the target instance from the drop-down list. This option is only displayed when Connection Method is set to OB Cloud Instance. Database Account The username of the OceanBase database. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner and then select OceanBase MySQL Compatible or OceanBase Oracle Compatible.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. Connection Information Enter the endpoint service name of the selected cloud provider. Instance The ID or name of the instance where the OceanBase database is located. You can view the ID or name of the target instance on the Instances page. Note
When the cloud provider is Alibaba Cloud, you can also select an instance of the Alibaba Cloud root account for cross-account authorization. For details, see Alibaba Cloud Account Authorization.
Tenant The ID or name of the OceanBase database tenant. Database Account The username of the OceanBase database user. Password The password of the database user. After selecting Connection Method as Endpoint, you can also decide whether to perform advanced settings based on your actual situation.
Notice
If the new migration task requires incremental synchronization, please enable both the sys tenant account and the incremental log proxy service.
ParameterDescriptionsys Tenant Account After enabling the sys tenant account, you need to enter the sys account and password. - Sys Account: The name of the sys user. This user is mainly used to read incremental logs and database object structure information from OceanBase Database. Please create it under the sys tenant of the business cluster.
- Password: The password of the sys user.
Incremental Log Proxy Service After enabling the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy is the incremental log proxy service for OceanBase Database. It provides real-time access to and management of incremental log projects, making it easier for applications to access incremental logs from OceanBase Database. It also enables incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify security group allowlists on Alibaba Cloud, AWS, Azure, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, depending on your requirements, click Create Data Source in the upper-right corner and select OceanBase MySQL Compatible or OceanBase Oracle Compatible.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. Connection Information Enter the IP address or hostname for the connection. Instance The ID or name of the instance where the OceanBase database is located. You can view the target instance's ID or name on the Instances page. Note
When the cloud provider is Alibaba Cloud, you can also select an Alibaba Cloud root account instance for cross-account authorization. For details, see Alibaba Cloud Account Authorization.
Tenant The ID or name of the OceanBase database tenant. Database Account The username of the OceanBase database user. Password The password of the database user. After selecting Connection Method as Public IP, you can decide whether to perform advanced settings based on your actual situation.
Notice
If the migration task you create requires incremental synchronization, you must also enable the sys tenant account and the incremental log proxy service.
ParameterDescriptionsys Tenant Account After enabling the sys tenant account, you need to enter the account and password of the sys tenant. - Sys Account: The name of the sys user. This user is mainly used to read incremental logs and database object structure information from OceanBase Database. Please create it under the sys tenant of the business cluster.
- Password: The password of the sys user.
Incremental Log Proxy Service After enabling the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy is the incremental log proxy service for OceanBase Database. It provides real-time access to and management of incremental log projects, making it easier for applications to access incremental logs from OceanBase Database. It also enables incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.Click Test Connection.
After the test connection succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select OceanBase MySQL Compatible or OceanBase Oracle Compatible.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Select Self-managed Database. Peering connections are supported only for this instance type. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Connection Information Enter the private IP address or hostname of the OceanBase instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity. Instance The ID or name of the instance where the OceanBase database is located. You can view it on the Instances page. Note
For Alibaba Cloud, you can also select an instance under an Alibaba Cloud root account that has granted cross-account authorization. For more information, see Alibaba Cloud account authorization.
Tenant The ID or name of the OceanBase database tenant. Database Account The username of the OceanBase database user. Password The password of the database user. After you set Connection Method to Peering Connection, you can configure advanced settings as needed.
Note
If the migration task requires incremental synchronization, enable both the sys tenant account and the incremental log proxy service.
ParameterDescriptionsys Tenant Account After you enable the sys tenant account, enter the sys account and password. - Sys Account: The name of the sys user. This user reads incremental logs and database object structures from OceanBase Database. Create the user in the sys tenant of the business cluster.
- Password: The password of the sys user.
Incremental Log Proxy Service After you enable the incremental log proxy service, enter the OBLogProxy Connection Information. OBLogProxy provides real-time access to and management of incremental log projects and supports incremental log subscription in network-isolated environments. The format is OBLogProxy IP:OBLogProxy Port.Click Test Connection.
After the connection test succeeds, click Save.
OceanBase HBase API compatible mode
For the OceanBase HBase API compatible mode, OceanBase Cloud provides a quick connection for an OceanBase Cloud instance.
Prerequisites
You have created a cluster instance of the KV or Flagship Edition and a tenant in OceanBase HBase API-compatible mode, and have an available database and account.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left navigation pane, click Data Services > Data Source.
On the Data Source page, depending on your actual situation, click Create Data Source in the upper-right corner > OceanBase HBase API Compatible.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Huawei Cloud, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select OceanBase Cloud Instance. Instance Type Includes Cluster Instance (Key-Value) or Cluster Instance (Flagship) Instance Select the target instance from the drop-down list. Tenant Select the target tenant from the drop-down list. Database Account The username of the OceanBase database. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
MySQL data source
For MySQL databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source > MySQL in the upper-right corner.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
When you set Cloud Vendor to AWS and select Enable for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the Data Migration Service prompts you to open the AWS console and Accept the Endpoint Connection Request the first time it accesses the private link.Instance Type - When you select Alibaba Cloud as the cloud provider, the instance types supported are RDS MySQL, PolarDB MySQL, and Self-managed MySQL.
- When you select AWS as the cloud provider, the instance types supported are Aurora MySQL, RDS MySQL, and Self-managed MySQL.
- When you select Azure as the cloud provider, the instance types supported are Azure MySQL and Self-managed MySQL.
- When you select Google Cloud as the cloud provider, the instance type supported is Self-managed MySQL.
Connection Information Enter the name of the endpoint service of the selected cloud provider. Database Account The username of the MySQL database. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud, AWS, Azure, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Sources page, click Create Data Source in the upper-right corner and select MySQL.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the MySQL database instance to ensure connectivity. For more information, see the Select a public network connection section. Instance Type - If Cloud Vendor is set to Alibaba Cloud, the instance types supported are RDS MySQL, PolarDB MySQL, and Self-managed MySQL.
- If the cloud provider is set to AWS, the instance types supported are Aurora MySQL, RDS MySQL, and Self-managed MySQL.
- If the cloud provider is set to Azure, the instance types supported are Azure MySQL and Self-managed MySQL.
- If the cloud provider is set to Google Cloud, the instance type supported is Self-managed MySQL.
Connection Information Enter the IP address or hostname to connect to. Database Account The username of the MySQL database. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select MySQL.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Select a MySQL instance type that supports peering connections for the selected cloud provider. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Connection Information Enter the private IP address or hostname of the MySQL instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity. Database Account The username of the MySQL database user. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Oracle data source
For Oracle databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner > Oracle.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private link, you are prompted to open the AWS console and Accept Endpoint Connection Request for the incoming request.Instance Type - When the cloud provider is AWS, the instance types supported are RDS Oracle and Self-managed Oracle.
- When the cloud provider is Alibaba Cloud, Azure, or Google Cloud, the instance type supported is Self-managed Oracle.
Connection Information Enter the name of the endpoint service of the selected cloud provider. Service Name The service name of the Oracle database. Database Account The username of the Oracle database. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud, AWS, Azure, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source > Oracle in the upper-right corner.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the Oracle database instance to ensure connectivity. For more information, see the Select a public network connection section. Instance Type - If the cloud provider is set to AWS, the instance type can be RDS Oracle or Self-managed Oracle.
- If the cloud provider is set to Alibaba Cloud, Azure, or Google Cloud, the instance type can be Self-managed Oracle.
Connection Information Enter the IP address or hostname to connect to. Service Name The service name of the Oracle database. Database Account The username of the Oracle database user. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select Oracle.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Only Self-managed Oracle is supported. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Connection Information Enter the private IP address or hostname of the Oracle instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity. Service Name The service name of the Oracle database. Database Account The username of the Oracle database user. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Kafka data source
For Kafka instances, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source > Kafka in the upper-right corner.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Link.
When Cloud Vendor is set to AWS and Require Enable is selected for the Require Accept to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private link, you are prompted to open the AWS console and perform the Accept Endpoint Connection Request operation for the incoming request.Instance Type Includes Self-managed Kafka and Cloud Instance Kafka. Connection Information Enter the name of the endpoint service of the selected cloud provider and the Kafka access point. Notice
- For cloud-managed Kafka on Alibaba Cloud, you cannot enter a domain name when entering the Kafka access point; only an IP address is supported.
Based on your business requirements, choose whether to enable SASL under Security Authentication. If SASL is enabled, configure the following parameters.
ParameterDescriptionAuthentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512. - The PLAIN authentication method is relatively simple but does not support dynamic user changes and configures the username and password in plaintext, which is not secure.
- SCRAM (Salted Challenge Response Authentication Mechanism) addresses security issues by using the traditional mechanism of username and password authentication. Kafka supports SCRAM-SHA-256, which can be used with TLS to perform secure authentication.
This authentication method allows for dynamic user changes, and user data is stored in Zookeeper. Before starting a broker, communication with Zookeeper is required to create a communication user between Zookeeper and the broker. However, this authentication method requires configuring the username and password in plaintext. - Kafka supports SCRAM-SHA-512, which can be used with TLS to perform secure authentication.
Username The username used for data migration. Password The password of the user used for data migration. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select Kafka.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the Kafka instance to ensure connectivity. For more information, see Select a public network connection. Instance Type Includes Self-managed Kafka and Cloud Instance Kafka. Connection Information Enter the Kafka access point information. If the security authentication configuration for the Kafka data source is not completed, the data migration task using this data source as the source or target may fail. The configuration area for security authentication is as follows.
Click Upload File to upload the trust certificate with the
.jksextension.Based on your business requirements, choose whether to enable SASL. If you enable SASL, configure the following parameters.
ParameterDescriptionAuthentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512. - The PLAIN authentication method is relatively simple but cannot dynamically change users and configures the username and password in plaintext, which is not secure.
- The SCRAM (Salted Challenge Response Authentication Mechanism) authentication method addresses security issues by implementing the traditional username and password authentication mechanism. Kafka supports SCRAM-SHA-256, which can be used with TLS to perform security authentication.
This authentication method allows dynamic user changes, and user data is stored in Zookeeper. Before starting a broker, communication with Zookeeper is required to create a communication user for the broker. However, this authentication method requires configuring the username and password in plaintext. - Kafka supports SCRAM-SHA-512, which can be used with TLS to perform security authentication.
Username The username used for data migration. Password The password for the user used for data migration.
Click Test Connection.
After the test connection succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select Kafka.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Includes Self-managed Kafka and Cloud Instance Kafka. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Kafka Endpoint Enter the Kafka endpoint. Add the IP address displayed on the page to the Kafka instance's inbound security group rules or allowlist to enable connectivity. If security authentication is not configured for the Kafka data source, data migration tasks that use the data source as the source or target may fail to connect. Configure security authentication as follows:
Click Upload File and upload a trust certificate with the
.jksextension.Enable SASL as needed. If you enable SASL, configure the following parameters.
ParameterDescriptionAuthentication Method Supports PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512. - PLAIN cannot dynamically change users and stores the username and password in plaintext, which provides limited security.
- SCRAM (Salted Challenge Response Authentication Mechanism) authenticates users by username and password. Kafka supports SCRAM-SHA-256 with TLS. This method supports dynamic user changes and stores user data in ZooKeeper. Before you start a broker, create the user that the broker uses to communicate with ZooKeeper. The username and password are configured in plaintext.
- Kafka also supports SCRAM-SHA-512 with TLS.
Username The username used for data migration. Password The password of the user used for data migration.
Click Test Connection.
After the connection test succeeds, click Save.
PostgreSQL data source
For PostgreSQL databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner > PostgreSQL.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Connection.
When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private connection, you are prompted to open the AWS console and Accept the Endpoint Connection Request for the incoming request.Instance Type - When the cloud provider is AWS, the instance types supported are RDS PostgreSQL, Aurora PostgreSQL, and Self-managed PostgreSQL.
- When the cloud provider is Alibaba Cloud, the instance types supported are RDS PostgreSQL and Self-managed PostgreSQL.
- When the cloud provider is Google Cloud, the instance type supported is Self-managed PostgreSQL.
Connection Information Enter the name of the endpoint service for the selected cloud provider. Database Name The name of the PostgreSQL database. Database Account The username of the PostgreSQL database user. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select PostgreSQL.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must add the data source IP address displayed on the page to the allowlist of the PostgreSQL database instance to ensure connectivity. For more information, see the Select a public network connection section. Instance Type - If the cloud provider is AWS, the instance types supported are RDS PostgreSQL, Aurora PostgreSQL, and Self-managed PostgreSQL.
- If the cloud provider is Alibaba Cloud, the instance types supported are RDS PostgreSQL and Self-managed PostgreSQL.
- If the cloud provider is Google Cloud, the instance type supported is Self-managed PostgreSQL.
Connection Information Enter the IP address or hostname to connect to. Database Name The name of the PostgreSQL database. Database Account The username for the PostgreSQL database. Password The password for the database user. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select PostgreSQL.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Select RDS PostgreSQL or Self-managed PostgreSQL for the selected cloud provider. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Connection Information Enter the private IP address or hostname of the PostgreSQL instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity. Database Name The name of the PostgreSQL database. Database Account The username of the PostgreSQL database user. Password The password of the database user. Click Test Connection.
After the connection test succeeds, click Save.
TiDB data source
For TiDB databases, OceanBase Cloud provides three connection methods: endpoint connection, public network connection, and peering connection.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, Azure, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select TiDB.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Endpoint. You must first add the account ID displayed on the page to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select Private Network Connection.
When Cloud Vendor is set to AWS and Enable is selected for the Require Acceptance to Use Endpoint parameter when creating the endpoint service, the first time the data migration service accesses the private connection, you are prompted to open the AWS console and Accept the Endpoint Connection Request.Instance Type Currently only supports Self-managed TiDB. Connection Information Enter the name of the endpoint service of the selected cloud provider. Database Account The username of the TiDB database. Password The password of the database user. Click Test Connection.
After the test connection succeeds, click Save.
Prerequisites
You have permission to modify security group allowlists on Alibaba Cloud, AWS, Azure, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and then select TiDB.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, Azure, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the data source IP address displayed on the page to the allowlist of the TiDB database instance to ensure connectivity. For more information, see the Select a public network connection section. Instance Type Currently only supports Self-managed TiDB. Connection Information Enter the IP address or hostname for the connection. Database Account The username for the TiDB database. Password The password for the database user. If you need to obtain incremental data from TiDB via Kafka, fill in the Incremental Sync Settings section to enable the Binlog and TiCDC data sources. If you do not configure this section, you will not be able to select Incremental Synchronization on the Select Type & Objects page when creating a data migration task from a new TiDB database to OceanBase Database in MySQL-compatible mode.
ParameterDescriptionKafka Data Source The Kafka data source is used to store information about Binlogs and incremental logs of TiDB data converted by the TiCDC tool, facilitating consumption by data migration. Note
You can only select a Kafka data source from the same cloud provider as TiDB.
Topic Select the topic of the Kafka data source to bind from the drop-down list. TiDB Data Format When migrating data from a TiDB database to OceanBase Database in MySQL-compatible mode, you can choose data in TiCDC or TiDB Binlog format. Select from the drop-down list. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have created a peering connection in the Connected state and have permission to view it. For more information, see AWS peering connection, Alibaba Cloud peering connection, and Google Cloud peering connection.
You have permission to modify the database instance's inbound security group rules or allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select TiDB.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Instance Type Only Self-managed TiDB is supported. Connection Type Select Peering Connection. Peering Connection ID Select an available peering connection from the drop-down list. The list displays only connections that match the selected cloud provider and region and are in the Connected state. It also displays the corresponding VPC ID and CIDR block. If no connection is available, click Create to open a new tab and create a data service peering connection. Connection Information Enter the private IP address or hostname of the TiDB instance. Add the IP address displayed on the page to the instance's inbound security group rules or allowlist to enable connectivity. Database Account The username of the TiDB database user. Password The password of the database user. If you need to obtain incremental TiDB data through Kafka, configure Incremental Sync Settings to enable the Binlog and TiCDC data sources. Otherwise, you cannot select Incremental Synchronization on the Select Type & Objects page when you create a data migration task from TiDB to OceanBase Database in MySQL-compatible mode.
ParameterDescriptionKafka Data Source The Kafka data source stores the TiDB incremental logs converted by Binlog or TiCDC for consumption by data migration. Note
You can select only a Kafka data source from the same cloud provider as TiDB.
Topic Select the topic to bind from the drop-down list. TiDB Data Format When you migrate data from TiDB to OceanBase Database in MySQL-compatible mode, select the TiCDC or TiDB Binlog format from the drop-down list. Click Test Connection.
After the connection test succeeds, click Save.
HBase data source
For an HBase data source, OceanBase Cloud provides a public network connection method.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select HBase.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the displayed data source IP address to the allowlist of the HBase database instance to ensure connectivity. For more information, see Select a public network connection. Instance Type Currently only supports Alibaba Cloud HBase Enhanced Edition. Connection Information Enter the IP address or hostname for the connection. Port The port used for accessing your database. The specific value depends on your endpoint service configuration. Database Account The username for the HBase database. Password The password for the database user. If you need to obtain HBase incremental data via Kafka, please fill in the Kafka data source and Topic. Missing configurations may result in unavailable incremental synchronization.
ParameterDescriptionKafka Data Source You can select a Kafka data source saved during data transfer. For details, see the Kafka data sources section in this topic. Note
You can only select a Kafka data source from the same cloud provider.
Topic You can select or enter a Topic. Incremental Data Format Select the supported incremental data format. Currently supports DEBEZIUM_V2. Click Test Connection.
After the connection test succeeds, click Save.
Lindorm data source
For a Lindorm data source, OceanBase Cloud provides a public network connection method.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select Lindorm.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. You must first add the displayed data source IP address to the allowlist of the Lindorm database instance to ensure connectivity. For more information, see Select a public network connection. Instance Type Currently only supports Alibaba Cloud Lindorm. Connection Information Enter the IP address or hostname to connect to. Port The port used for accessing your database. The specific value depends on your endpoint service configuration. Database Account The username for the Lindorm database. Password The password for the database user. If you need to obtain Lindorm incremental data via Kafka, please fill in the Kafka data source and Topic. Missing configurations may result in unavailable incremental synchronization.
ParameterDescriptionKafka Data Source You can select a Kafka data source saved during data transmission. For details, see the Kafka data sources section in this topic. Note
You can only select a Kafka data source from the same cloud provider.
Topic You can select or enter a Topic. Incremental Data Format Select the supported incremental data format. Currently supports DEBEZIUM_V2. Click Test Connection.
After the connection test succeeds, click Save.
RocketMQ data source
For the RocketMQ data source, OceanBase Cloud provides both public network and private network connection methods.
Prerequisites
You have created an endpoint service on Alibaba Cloud, AWS, or Google Cloud and have permission to modify its allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner > RocketMQ.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Private Network. You must first add the account ID displayed in How to obtain? to the allowlist of your endpoint service to allow the endpoint of this account to connect to the endpoint service. For more information, see Select a private link. Note
When the cloud provider is set to AWS and Required is selected for Require Acceptance to Use Endpoint when creating the endpoint service, the Data Migration Service prompts you to open the AWS console and perform the Accept Endpoint Connection Request operation for the incoming request the first time it accesses the private connection.
Instance Type The default is Self-managed RocketMQ. Namesrv Configuration Enter the endpoint service information and corresponding RocketMQ access point information for the namesrv configuration. Notice
Ensure that each endpoint service node corresponds one-to-one with a RocketMQ access point.
Broker Configuration Enter the endpoint service information and corresponding RocketMQ access point information for the broker configuration. Notice
Ensure that each endpoint service node corresponds one-to-one with a RocketMQ access point.
Based on your business requirements, choose whether to enable Security Authentication. If enabled, configure the following parameters.
ParameterDescriptionAuthentication Method You can select AccessKey. AccessKey The AccessKey ID you created in the cloud account management console, used for authentication. SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the security group allowlist on Alibaba Cloud, AWS, or Google Cloud.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select RocketMQ.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud, AWS, and Google Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. Instance Type - The Alibaba Cloud channel supports RocketMQ on Alibaba Cloud and Self-managed RocketMQ.
- The AWS channel only supports Self-managed RocketMQ.
RocketMQ Access Point Enter the RocketMQ access point ID and port. You must first add the data source IP address displayed on the page to the allowlist of the RocketMQ instance to ensure connectivity. For more information, see Select a public network connection. Based on your business requirements, choose whether to enable Security Authentication. If enabled, configure the following parameters.
Note
- When the data source is a RocketMQ cloud instance on Alibaba Cloud V4.x, you need to enter the AK/SK corresponding to the cloud account.
- When the data source is a RocketMQ cloud instance on Alibaba Cloud V5.x, you need to enter the AK/SK that controls access to the cloud instance.
ParameterDescriptionAuthentication Method You can select AccessKey. AccessKey The AccessKey ID you created in the cloud account management console, used for identity authentication. SecretKey The AccessKey Secret you created in the cloud account management console, used for identity authentication. Click Test Connection.
After the connection test succeeds, click Save.
DataHub data source
For a DataHub data source, OceanBase Cloud provides both private network and public network connection methods.
Prerequisites
You have configured Alibaba Cloud to complete RAM access permission control. For detailed operations, see Add access control for an Alibaba Cloud DataHub instance in Add an Alibaba Cloud instance to the allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner > DataHub.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud. Region Select the region where the data source is located. Connection Type Select Private Network. Instance Type The default is Alibaba Cloud DataHub Instance. Access Point Select a target address access point from the drop-down list. You must first add the data source IP address displayed on the page to the allowlist of the cloud database security group to ensure connectivity. For details, see Add access control for an Alibaba Cloud DataHub instance in Add an Alibaba Cloud instance to the allowlist. Project Name The name of the DataHub instance. AccessKey The AccessKey ID you created in the cloud account management console, used for authentication. SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication. Click Test Connection.
After the connection test succeeds, click Save.
Prerequisites
You have permission to modify the Alibaba Cloud security group allowlist.
You have Organization Admin or Project Admin permissions in the OceanBase Cloud console.
Procedure
Log in to the OceanBase Cloud console.
In the left-side navigation pane, click Data Services > Data Source.
On the Data Source page, click Create Data Source in the upper-right corner and select DataHub.
In the Create Data Source dialog box, configure the parameters.
ParameterDescriptionCloud Provider Currently supports Alibaba Cloud. Region Select the region where the data source is located. Connection Type Select Public IP. Instance Type The default value is Alibaba Cloud DataHub Instance. Access Point Information about the DataHub instance. You must first add the displayed data source IP address to the allowlist of the cloud database security group to ensure connectivity. For details, see Add access control for Alibaba Cloud DataHub instances in Add an Alibaba Cloud instance to the allowlist. Project Name The name of the DataHub instance. AccessKey The AccessKey ID you created in the cloud account management console, used for authentication. SecretKey The AccessKey Secret you created in the cloud account management console, used for authentication. Click Test Connection.
After the connection test succeeds, click Save.