Updated on 2022-12-07 GMT+08:00

Flink Template Management

Flink templates include sample templates and custom templates. You can modify an existing sample template to meet the actual job logic requirements and save time for editing SQL statements. You can also customize a job template based on your habits and methods so that you can directly invoke or modify the template in later jobs.

Flink template management provides the following functions:

Flink SQL Sample Template

The template list displays existing sample templates for Flink SQL jobs. Table 1 describes the parameters in the template list.

Table 1 Parameters in the Flink SQL sample template list

Parameter

Description

Name

Name of a template, which has 1 to 64 characters and only contains letters, digits, hyphens (-), and underlines (_).

Description

Description of a template. It contains 0 to 512 characters.

Operation

Create Job: Create a job directly by using the template. After a job is created, the system switches to the Edit page under Job Management.

The existing sample templates apply to the following scenarios:

  • Real-time ETL of Nginx access logs to the database
  • Fake plate vehicle detection
  • Geo-fencing alarm
  • Vehicle yawing alarm
  • Vehicle speeding alarm
  • Stream-based random forest anomaly detection
  • CloudTable-DLI Flink-CloudTable
  • DIS-DLI Flink-CSS (Elasticsearch)
  • DIS-DLI Flink-CloudTable (OpenTSDB)
  • DIS-DLI Flink-CloudTable
  • DIS-DLI Flink-DCS
  • DIS-DLI Flink-DDS (MongoDB)
  • DIS-DLI Flink-DIS
  • DIS-DLI Flink-OBS-DWS
  • DIS-DLI Flink-SMN
  • Kafka-DLI Flink-Kafka
  • OBS-DLI Flink-RDS
  • Stream-Join-Table (DCS)
  • Stream-Join-Table (RDS)

Custom Templates

The custom template list displays all Jar job templates. Table 1 describes parameters in the custom template list.

Table 2 Parameters in the custom template list

Parameter

Description

Name

Name of a template, which has 1 to 64 characters and only contains letters, digits, hyphens (-), and underlines (_).

Description

Description of a template. It contains 0 to 512 characters.

Created

Time when a template is created.

Updated

Latest time when a template is modified.

Operation

  • Edit: Modify a template that has been created.
  • Create Job: Create a job directly by using the template. After a job is created, the system switches to the Edit page under Job Management.
  • More:
    • Delete: Delete a created template.

Creating a Template

You can create a template using any of the following methods:

  • Creating a template on the Template Management page
    1. In the left navigation pane of the DLI management console, choose Job Templates > Flink Templates.
    2. Click Create Template in the upper right corner of the page. The Create Template dialog box is displayed.
    3. Specify Name and Description.
      Table 3 Template parameters

      Parameter

      Description

      Name

      Name of a template, which has 1 to 64 characters and only contains letters, digits, hyphens (-), and underlines (_).

      NOTE:

      The template name must be unique.

      Description

      Description of a template. It contains 0 to 512 characters.

    4. Click OK to enter the Edit page.
      Job template parameters

      Parameter

      Description

      Name

      You can modify the template name.

      Description

      You can modify the template description.

      Saving Mode

      • Save Here: Save the modification to the current template.
      • Save as New: Save the modification as a new template.

      SQL statement editing area

      In the area, you can enter detailed SQL statements to implement business logic. For details about how to compile SQL statements, see the Data Lake Insight SQL Syntax Reference.

      Save

      Save the modifications.

      Create Job

      Use the current template to create a job.

      Format

      Format SQL statements. After SQL statements are formatted, you need to compile SQL statements again.

      Theme Settings

      Change the font size, word wrap, and page style (black or white background).

    5. In the SQL statement editing area, enter SQL statements to implement service logic. For details about how to compile SQL statements, see the Data Lake Insight SQL Syntax Reference.
    6. After the SQL statement is edited, click Save in the upper right corner to complete the template creation.
    7. (Optional) If you do not need to modify the template, click Create Job in the upper right corner to create a job based on the current template. For details about how to create a job, see Creating a Flink SQL Job, and Creating a Flink Jar Job.
  • Creating a template based on an existing job template
    1. In the left navigation pane of the DLI management console, choose Job Templates > Flink Templates. Click the Custom Templates tab.
    2. In the row where the desired template is located in the custom template list, click Edit under Operation to enter the Edit page.
    3. After the modification is complete, set Saving Mode to Save as New.
    4. Click Save in the upper right corner to save the template as a new one.
  • Creating a template using a created job
    1. In the left navigation pane of the DLI management console, choose Job Management > Flink Jobs. The Flink Jobs page is displayed.
    2. Click Create Job in the upper right corner. The Create Job page is displayed.
    3. Specify parameters as required.
    4. Click OK to enter the Edit page.
    5. After the SQL statement is compiled, click Set as Template.
    6. In the Set as Template dialog box that is displayed, specify Name and Description and click OK.
  • Creating a template based on the existing job
    1. In the left navigation pane of the DLI management console, choose Job Management > Flink Jobs. The Flink Jobs page is displayed.
    2. In the job list, locate the row where the job that you want to set as a template resides, and click Edit in the Operation column.
    3. After the SQL statement is compiled, click Set as Template.
    4. In the Set as Template dialog box that is displayed, specify Name and Description and click OK.

Creating a Job Based on a Template

You can create jobs based on sample templates or custom templates.

  1. In the left navigation pane of the DLI management console, choose Job Templates > Flink Templates.
  2. In the sample template list, click Create Job in the Operation column of the target template. For details about how to create a job, see Creating a Flink SQL Job and Creating a Flink Jar Job.

Modifying a Template

After creating a custom template, you can modify it as required. The sample template cannot be modified, but you can view the template details.

  1. In the left navigation pane of the DLI management console, choose Job Templates > Flink Templates. Click the Custom Templates tab.
  2. In the row where the template you want to modify is located in the custom template list, click Edit in the Operation column to enter the Edit page.
  3. In the SQL statement editing area, modify the SQL statements as required.
  4. Set Saving Mode to Save Here.
  5. Click Save in the upper right corner to save the modification.

Deleting a Template

You can delete a custom template as required. The sample templates cannot be deleted. Deleted templates cannot be restored. Exercise caution when performing this operation.

  1. In the left navigation pane of the DLI management console, choose Job Templates > Flink Templates. Click the Custom Templates tab.
  2. In the custom template list, select the templates you want to delete and click Delete in the upper left of the custom template list.

    Alternatively, you can delete a template by performing the following operations: In the custom template list, locate the row where the template you want to delete resides, and click More > Delete in the Operation column.

  3. In the displayed dialog box, click Yes.