Dataphin:Create a Lark Base data source

Prerequisites

• A custom Lark application is created and its authorization information is obtained. Obtain application authorization information.

• The share link of the target Lark Base is obtained. Obtain a Base link.

Limits

• Lark Base tables support various field types. For field-type mappings, see Lark Base parsing rules.

• Starting October 31, 2024, the Lark Basic Free Edition limits cumulative API calls to 10,000 per month. To increase this quota, upgrade your Lark edition. Custom App API Call Limit Adjustment Description.

Permissions

Only super administrators, data source administrators, domain architects, project administrators, or custom global roles with the Create Data Source permission can create data sources.

Procedure

1. In the top menu bar, choose Management Hub > Datasource Management.

2. On the Datasource page, click +Create Data Source.

3. On the Create Data Source page, select Lark Base.

   You can also find it in the Recently Used area or use the search box.

4. On the Create Lark Base Data Source page, configure the connection parameters.

   1. Configure basic data source information.

      Parameter	Description
      Datasource Name	The data source name. Naming conventions: Can contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Maximum length: 64 characters.
      Datasource Code	Use the data source code to access tables in Flink SQL tasks or the Dataphin JDBC client with the format data_source_code.table_name or data_source_code.schema.table_name. To auto-switch data sources by environment, use the variable format ${data_source_code}.table or ${data_source_code}.schema.table. Dataphin Data Source Table Development Methods. Important The data source code cannot be modified after it is configured. You can preview data on the object details page in the asset directory and asset checklist only after the data source code is configured. In Flink SQL, only MySQL, Hologres, MaxCompute, Oracle, StarRocks, Hive, SelectDB, and GaussDB data warehouse service (DWS) data sources are currently supported.
      Data Source Description	A brief description of the data source. Maximum: 128 characters.
      Data Source Configuration	Select a configuration mode based on whether your data source separates production and development environments: If production and development are separate, select Production + Development Data Source. If they share the same environment, select Production Data Source.
      Tag	Categorize data sources using tags. To create tags, see Manage Data Source Tags.

   2. Configure connection parameters.

      If you selected Production + Development Data Source, configure connection information for both environments. For Production Data Source, configure only the production connection.

      Note

      To isolate development from production, use separate data sources for each environment. Dataphin also supports using the same data source for both.

      Parameter	Description
      Lark Base URL	The Lark Base URL, such as https://base.feishu.cn/base/appxxxx. Obtain a Base link.
      APP ID and APP Secret	The App ID and App Secret of your Lark enterprise application. Obtain application authorization information.

5. Select the Default Resource Group. This resource group runs tasks for the current data source, including SQL execution, offline full-database migration, and data preview.

6. Click Test Connection to verify connectivity, or click OK to save the data source directly.

   Click Test Connection to verify connectivity. If you click OK without testing, the system automatically tests all selected clusters. The data source is created even if all clusters fail the test.

   Test Connection tests the connection for the Default Cluster or Registered Scheduling Clusters that have been registered in Dataphin and are in normal use. The Default Cluster is selected by default and cannot be deselected. If there are no resource groups under a Registered Scheduling Cluster, connection testing is not supported. You need to create a resource group first before testing the connection.

   • The selected clusters are only used to test network connectivity with the current data source and are not used for running related tasks later.

   • The test connection usually takes less than 2 minutes. If it times out, you can click the icon to view the specific reason and retry.

   • Regardless of whether the test result is Connection Failed, Connection Successful, or Succeeded With Warning, the system will record the generation time of the final result.

     Note

     Only the test results for the Default Cluster include three connection statuses: Succeeded With Warning, Connection Successful, and Connection Failed. The test results for Registered Scheduling Clusters in Dataphin only include two connection statuses: Connection Successful and Connection Failed.

   • When the test result is Connection Failed, you can click the icon to view the specific failure reason.

   • When the test result is Succeeded With Warning, it means that the application cluster connection is successful but the scheduling cluster connection failed. The current data source cannot be used for data development and integration. You can click the icon to view the log information.

Appendix