DataWorks:Debug nodes and workflows

Debug a single node

1. Go to the DataStudio page. In the left-side navigation pane, under Data Development or Manually Triggered Workflow, find the target workflow and double-click the node that you want to edit.

2. Run the node to debug it.

   On the node's editor tab, use Run or Run with Parameters from the toolbar to debug the code logic. You can also use Quick run to debug a code snippet. The following table describes each option.

   Note

   If you do not have permissions for the data you want to query when you run a node, see Overview of permission management for compute engines and data to learn about permission control for different compute engines in DataWorks.

   Run option	Description	Use case
   Run ( icon)	This option lets you assign values to variables and specify a resource group for testing. These settings are saved for future runs. Note When you run a newly created node for the first time, a configuration dialog appears. You must manually assign constant values to the variables in the code. DataWorks saves the values you assign. The next time you run the node, the saved configuration is used by default.	Use this option when you need to debug code frequently.
   Run with Parameters ( icon)	Each time you run the node, you must assign constant values to variables for the test scenario and specify a resource group.	Use this option when you need to modify variable values in the code or change the resource group used by the task.
   Quick run ( icon)	This option lets you debug a code snippet in the code area of the node editor.	Use this option when you only need to debug a code snippet in a node. Note This feature is used only to debug the correctness of a code snippet. To debug the complete code logic, use Run or Run with Parameters.

Debug a workflow

1. Go to the DataStudio page. In the left-side navigation pane, under Data Development or Manually Triggered Workflow, double-click the target workflow to open its panel.

2. Debug the workflow.

   Click the Run ( icon) button on the workflow panel toolbar to run all tasks in the workflow sequentially based on dependencies.

   You can also right-click a specific node in the workflow panel and select Run Node and Downstream Nodes to run that node and all its downstream nodes based on dependencies.

   The toolbar run and the right-click run differ in their mechanisms:

   • Toolbar run: Runs all nodes sequentially from upstream to downstream based on the complete DAG of the workflow. Each node is submitted independently, which is equivalent to running each node individually on its editor tab.

   • Right-click Run Node and Downstream Nodes: Starts from the selected node and runs it along with its downstream nodes using the dependency scheduling logic. This method validates the run status and output of upstream nodes, which differs from running a node directly on its editor tab (standalone debug mode).

   If an error occurs when you right-click to run a node and its downstream nodes, but the same SQL runs without errors on the node editor tab, the cause is that the right-click run incorporates the dependency scheduling logic and validates the run status and output data of upstream nodes, while the direct run only executes the SQL code of the current node. Troubleshoot as follows:

   • Check the run status of upstream nodes. The right-click run validates upstream dependencies. If an upstream node has not run or has failed, the current node reports an error. Check the run status icons of upstream nodes in the workflow panel to confirm that all upstream nodes have run successfully.

   • Check the dependency configuration between nodes. Verify that the input and output parameter passing between nodes is correct and that the scheduling parameter assignments match expectations. On the schedule settings page of the node, check whether the upstream output table matches the input table of the current node.

   • Right-click the failed node, select View Run Logs, and locate the specific error information. The error in the logs usually contains the specific cause (such as table not found, insufficient permissions, or syntax error).

   • Check whether there are comment syntax issues in the SQL. Some engines parse comments differently in scheduling mode than in direct run mode, which may cause syntax errors. To troubleshoot, remove block comments (/* */) from the SQL first and keep only line comments (--) to see whether the error persists.

   • Check whether the output data of upstream nodes is ready. The right-click run depends on data tables produced by upstream nodes as input. If an upstream node has run successfully but its output data is not yet ready or has been cleaned up, the current node reports an error because it cannot read the input table.

   Note

   • When nodes in a manually triggered workflow have variables with the same name and the variables can be assigned uniformly, you can define workflow parameters on the workflow panel and assign values to the parameters. Then, run the workflow to view the assignment results and the execution status of the manual tasks.

   • Only some node types support workflow parameters. Refer to the actual interface for details.

   • After the run is complete, you can right-click a specific node in the workflow panel to view its runtime log.

View operating history

You can go to the Operating history page in Data Studio to view all task run records of the current account from the past three days.

After a task is run in Data Studio, it is submitted to the corresponding engine for execution. Even if you accidentally close the task during execution, the task continues to run. You can go to the Operating history page to view runtime logs or stop tasks that have been submitted for execution.

Create an ad hoc query file

Process query results