All Products
Search
Document Center

DataWorks:Add a data source

Last Updated:Feb 06, 2024

Before you use DataService Studio to create an API, you must add your database or data warehouse to DataWorks as a data source. Then, you can use the data source to create an API. During API development, DataService Studio accesses the data source to obtain the schema of a data table based on which you want to create an API to help you configure the request parameters and response parameters of the API. This topic describes how to add a data source.

Prerequisites

To ensure that resource groups for DataService Studio can access data sources, you must configure network connectivity between the resource groups and data sources and configure IP address whitelists for the data sources. Otherwise, tasks that are related to DataService Studio cannot be run as expected.

Procedure

  1. Go to the Data Source page.

    1. Log on to the DataWorks console. In the left-side navigation pane, click Management Center. On the page that appears, select the desired workspace from the drop-down list and click Go to Management Center.

    2. In the left-side navigation pane of the page that appears, click Data Source. The Data Source page appears.

  2. On the Data Source page, add a data source based on your business requirements. The following table describes the supported types of data sources and the configuration methods.

    Data source type

    Create an API by using the codeless UI

    Create an API by using the code editor

    Configuration method

    Hologres

    Supported

    Supported

    Add a Hologres data source

    Note

    Hologres is compatible with PostgreSQL. PostgreSQL does not support the DATETIME data type. If your Hologres instance contains data of the DATETIME type, Hologres converts the data from the DATETIME type to the TIMESTAMP type of PostgreSQL. This way, DataService Studio can query the data.

    ClickHouse

    Supported

    Supported

    Add a ClickHouse data source

    Note

    This type of data source supports only exclusive resource groups for DataService Studio. For information about exclusive resource groups for DataService Studio, see Create and use an exclusive resource group for DataService Studio.

    ApsaraDB RDS

    Supported

    Supported

    ApsaraDB RDS data sources that run the MySQL, PostgreSQL, or SQL Server engine are supported.

    PolarDB-X 1.0

    Supported

    Supported

    Add a PolarDB-X 1.0 data source

    Note

    You can add this type of data source only in connection string mode.

    MySQL

    Supported

    Supported

    Add a MySQL data source

    PostgreSQL

    Supported

    Supported

    Add a PostgreSQL data source

    SQL Server

    Supported

    Supported

    Add an SQL Server data source

    Oracle

    Supported

    Supported

    Add an Oracle data source

    Note

    You can add this type of data source only in connection string mode.

    AnalyticDB for MySQL 2.0

    Supported

    Supported

    Add an AnalyticDB for MySQL 2.0 data source

    AnalyticDB for MySQL 3.0

    Supported

    Supported

    Add an AnalyticDB for MySQL 3.0 data source

    AnalyticDB for PostgreSQL

    Supported

    Supported

    Add an AnalyticDB for PostgreSQL data source

    Tablestore

    Supported

    Supported

    Add a Tablestore data source

    Note
    • You can add this type of data source only in connection string mode.

    • This type of data source supports only exclusive resource groups for DataService Studio. For information about exclusive resource groups for DataService Studio, see Create and use an exclusive resource group for DataService Studio.

    • This type of data source can be used only in the China (Shanghai) and China (Hong Kong) regions.

    MongoDB

    Supported

    Not supported

    Add a MongoDB data source

    MaxCompute

    • Acceleration solution 1: Acceleration service

    • Acceleration solution 2: MCQA

    • Acceleration solution 1: Acceleration service

    • Acceleration solution 2: MCQA

    Important
    • Acceleration Solution 1 supports only single-table queries. Acceleration Solution 2 supports single-table queries and multi-table join queries.

    • In Acceleration Solution 1, you can use the shared resource group for DataService Studio or an exclusive resource group for DataService Studio. In Acceleration Solution 2, you can use only an exclusive resource group for DataService Studio.

    • The feature of generating an API by using this type of data source is available in the China (Beijing), China (Hangzhou), China (Shanghai), and China (Shenzhen) regions.

    StarRocks

    Supported

    Supported

    Add a StarRocks data source

    Doris

    Supported

    Supported

    Add a Doris data source

  3. In the dialog box in which you add the data source, set the Resource Group connectivity parameter to Data Service and test network connectivity for the resource group for DataService Studio that you want to use. The following example shows how to add a MySQL data source.

    测试连通性

    Note

    If the network connectivity test fails, check your configurations. For more information, see Configure network connectivity.

  4. After the data source passes the network connectivity test, return to DataService Studio to create an API based on the data source.