Configure the Bitable input component

Updated at:

The Bitable input component is used to read data from a Bitable data source. To synchronize data, you configure the Bitable input component to read from the source and then configure the component for the target data source. This topic explains how to configure the Bitable input component.

Prerequisites

Procedure

  1. In the top navigation bar of the Dataphin homepage, choose Develop > Data Integration.

  2. On the Data Integration page, select a project from the top navigation bar. In Dev-Prod mode, you must also select an environment.

  3. In the left-side navigation pane, click Offline Integration. In the Offline Integration list, click the desired offline pipeline to open its configuration page.

  4. In the upper-right corner of the page, click Component Library to open the Component Library panel.

  5. In the left-side navigation pane of the Component Library panel, select Input. From the list of input components on the right, find and drag the Bitable component to the canvas.

  6. Click the image icon on the Bitable input component card to open the Bitable Input Configuration dialog box.

  7. In the Bitable Input Configuration dialog box, configure the parameters.

    Parameter

    Description

    Step name

    The name of the Bitable input component. Dataphin automatically generates a step name, which you can modify based on your business requirements. The name must meet the following rules:

    • Can contain only Chinese characters, letters, underscores (_), and digits.

    • Cannot exceed 64 characters in length.

    Data source

    The drop-down list displays all Bitable data sources in Dataphin, including those with and without sync read permission.

    Table

    Select the source table. You can enter keywords to search for the table. After selecting a table, click the image icon to copy the name of the selected table.

    Page size (Optional)

    Sets the number of records to read per page from the Bitable table, enabling paginated data retrieval.

    Output fields

    This section shows all fields from the selected table that match the filter conditions. The following operations are supported:

    • To prevent specific fields from being sent to a downstream component, you can remove them:

      • To delete a single field: Click the sgaga icon in the Actions column for the field you want to remove.

      • To delete multiple fields: Click Field Management. In the Field Management dialog box, select the fields to remove, click the image left-arrow icon to move them to the unselected list, and then click OK.

        image..png

    • Batch Add: Click Batch Add to configure fields in batches by using the JSON, TEXT, or DDL format.

      Note

      After you add fields in a batch and click OK, the existing field configuration is overwritten.

      • To configure fields in JSON format:

        // Example:
          [{
             "index": 1,
             "name": "id",
             "type": "int(10)",
             "mapType": "Long",
             "comment": "comment1"
           },
           {
             "index": 2,
             "name": "user_name",
             "type": "varchar(255)",
             "mapType": "String",
             "comment": "comment2"
         }]
        Note

        index defines the column number, name the imported field name, and type the imported field type.

        For example, "index":3,"name":"user_id","type":"String" imports the third column from the file, names the field user_id, and sets its type to String.

      • To configure fields in TEXT format:

        // Example:
        1,id,int(10),Long,comment1
        2,user_name,varchar(255),Long,comment2
        • The row delimiter separates the information for each field. The default is a newline character (\n). You can also use a semicolon (;) or a period (.).

        • The column delimiter is used to separate a field name from its field type. The default is a single-byte comma (,). The',' character is supported. The field type is optional, and the default is','.

      • To configure fields in DDL format:

        CREATE TABLE tablename (
        	user_id serial,
        	username VARCHAR(50),
        	password VARCHAR(50),
        	email VARCHAR (255),
        	created_on TIMESTAMP,
        );
    • New output field: Click + New Output Field. Then, enter the Field, Type, and Comment, and select a mapping type. Click the image icon to save the new row.