All Products
Search

This Product

    Dataphin:Improve the efficiency of code development in the code editor

    Document Center

    Dataphin:Improve the efficiency of code development in the code editor

    Last Updated:Feb 06, 2025

    The Dataphin code editor not only facilitates basic code highlighting and completion but also enhances the coding experience with intelligent code hinting and permission verification, helping to reduce development costs and accelerate the delivery of reliable code. This topic outlines the operations that improve code development efficiency within the code editor.

    Limits

    The availability of code efficiency features varies across different compute engines. The following table details the compute engines and their respective code efficiency features:

    Compute Engine

    Table Hinting

    Table Field Hinting

    Code Hinting

    Access Control Verification

    Data Source Code Hinting

    Offline Computing Engine

    Supported

    Supported

    Supported

    Supported

    -

    Real-time Computing Engine (Flink)

    Supported

    Supported

    Supported

    Supported

    Supported

    Explanation of improving code efficiency in the editor

    The following details the explanation and operation of features that enhance code efficiency in the Dataphin editor:

    Feature

    Description

    Code Highlighting

    The editor intelligently analyzes and highlights code keywords based on the language syntax, facilitating easier code review and editing. image.png

    Code Completion

    Upon entering relevant code fields, the editor proactively suggests keywords and provides hints, allowing for swift code completion based on the provided suggestions. image.png

    Note

    Use the keyboard's up and down arrows to navigate through suggestions and press Enter to select, or click with the mouse to choose the desired code.

    Table Hinting

    The editor provides intelligent hints for logical fact tables, logical dimension tables, and physical tables within the project, enabling you to select the required table name for queries based on the hints. image.png

    Field Hinting in Tables

    • Hover over a table name to receive hints about the fields and their descriptions within the table.

    • In the intelligent hinting overlay, select a table to view its field information.

      Note

      Within the table's tooltip layer, simply View More with a single click to access the table's asset page for efficient management and querying.

    • After entering a table name, the editor hints at the relevant field information, allowing you to select based on the hints, or enter a field name to receive hints for matching fields within the table. image.png

    Code Hinting

    Upon entering the SQL function into the editor, hovering your mouse over the function reveals its rules and descriptive information. For further details, simply View Details with a single click.

    image.png

    Verifying Permissions

    Hovering over a table field with the mouse will prompt you to confirm if you possess the necessary read/write access control list permissions for that field. Should you lack these permissions, a notification will appear. To request the appropriate permissions, simply single click Quick Fix -> Request Permission, which will redirect you to the permission request page for the table. Proceed with your operations after obtaining the necessary permissions. For more information, see or the referenced document.

    Data Source Code Hinting

    Upon entering the data source encoding into the editor, the system provides prompts for table information related to the current Dataphin instance's data source, based on the input statement.

    image.png