@clickzetta/cz-cli-darwin-arm64 0.5.15 → 0.5.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/bin/cz-cli +0 -0
  2. package/bin/skills/lakehouse-doc-en/SKILL.md +6 -11
  3. package/bin/skills/lakehouse-doc-en/references/AIGateway.md +58 -13
  4. package/bin/skills/lakehouse-doc-en/references/Computation.md +1 -1
  5. package/bin/skills/lakehouse-doc-en/references/DataSource_Amazon_DocumentDB.md +3 -1
  6. package/bin/skills/lakehouse-doc-en/references/Foreach.md +14 -14
  7. package/bin/skills/lakehouse-doc-en/references/JDBC-Driver.md +0 -1
  8. package/bin/skills/lakehouse-doc-en/references/LakehouseAI-overview.md +21 -8
  9. package/bin/skills/lakehouse-doc-en/references/LakehouseDataGPT-tour.md +4 -9
  10. package/bin/skills/lakehouse-doc-en/references/LakehouseStudio-tour.md +14 -19
  11. package/bin/skills/lakehouse-doc-en/references/Lakehouse_Zilliz_MakeDataReadyforBIandAI.md +1 -1
  12. package/bin/skills/lakehouse-doc-en/references/Logstash.md +3 -3
  13. package/bin/skills/lakehouse-doc-en/references/Migrate_Spark_DataEngineeringBestPractices_Project_to_Lakehouse.md +1 -1
  14. package/bin/skills/lakehouse-doc-en/references/Notebook.md +17 -17
  15. package/bin/skills/lakehouse-doc-en/references/RemoteFunction-as-udf.md +14 -14
  16. package/bin/skills/lakehouse-doc-en/references/SQL_External_Catalog_Guide.md +1 -9
  17. package/bin/skills/lakehouse-doc-en/references/SUMMARY.md +59 -29
  18. package/bin/skills/lakehouse-doc-en/references/WINDOWFUNCTION.md +99 -57
  19. package/bin/skills/lakehouse-doc-en/references/Zettapark_Data_Engineering_Demo.md +1 -1
  20. package/bin/skills/lakehouse-doc-en/references/access-control-configuration.md +1 -8
  21. package/bin/skills/lakehouse-doc-en/references/aigw-2026-2-5-1.0.md +16 -0
  22. package/bin/skills/lakehouse-doc-en/references/aigw-2026-3-29-1.0.2.md +14 -0
  23. package/bin/skills/lakehouse-doc-en/references/aigw-2026-3-8-1.0.1.md +16 -0
  24. package/bin/skills/lakehouse-doc-en/references/aigw-2026-4-28-1.1.md +29 -0
  25. package/bin/skills/lakehouse-doc-en/references/aigw-2026-5-12-1.1.1.md +18 -0
  26. package/bin/skills/lakehouse-doc-en/references/aigw-2026-5-15-1.2.md +9 -0
  27. package/bin/skills/lakehouse-doc-en/references/aigw-2026-5-21-1.3.md +9 -0
  28. package/bin/skills/lakehouse-doc-en/references/aigw-2026-5-28-1.4.md +10 -0
  29. package/bin/skills/lakehouse-doc-en/references/aigw-2026-6-3-1.5.md +9 -0
  30. package/bin/skills/lakehouse-doc-en/references/alicloud-arn-externalid.md +0 -5
  31. package/bin/skills/lakehouse-doc-en/references/answer-accuracy-improve.md +120 -103
  32. package/bin/skills/lakehouse-doc-en/references/application-list.md +1 -3
  33. package/bin/skills/lakehouse-doc-en/references/approval-list.md +16 -17
  34. package/bin/skills/lakehouse-doc-en/references/batch-load-parquet-file-into-lakehouse.md +1 -1
  35. package/bin/skills/lakehouse-doc-en/references/batch_sync.md +9 -9
  36. package/bin/skills/lakehouse-doc-en/references/batch_sync_Sop.md +2 -2
  37. package/bin/skills/lakehouse-doc-en/references/batchloadparquetfileintoLakehouse.md +1 -1
  38. package/bin/skills/lakehouse-doc-en/references/bulkloadv1-python-sdk.md +3 -3
  39. package/bin/skills/lakehouse-doc-en/references/chart-auto-refresh-guide.md +12 -6
  40. package/bin/skills/lakehouse-doc-en/references/clickzetta-sample-data.md +3 -3
  41. package/bin/skills/lakehouse-doc-en/references/code_approval.md +1 -5
  42. package/bin/skills/lakehouse-doc-en/references/composite_task.md +31 -42
  43. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_environment_and_data_generate.md +6 -9
  44. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_javasdk_bulkload_realtime.md +4 -10
  45. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_kafka_realtime_sync.md +1 -10
  46. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_local_file_into_table_by_studio.md +0 -6
  47. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_studio_batchload_public_network.md +0 -5
  48. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_studio_python_node.md +2 -7
  49. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_studio_realtime_cdc_public_network.md +13 -18
  50. package/bin/skills/lakehouse-doc-en/references/comprehensive_guide_to_ingesting_studio_sql_insert.md +0 -1
  51. package/bin/skills/lakehouse-doc-en/references/concepts.md +1 -1
  52. package/bin/skills/lakehouse-doc-en/references/config-datasource.md +5 -7
  53. package/bin/skills/lakehouse-doc-en/references/connect-with-cli.md +116 -72
  54. package/bin/skills/lakehouse-doc-en/references/connect-with-cz-cli.md +151 -0
  55. package/bin/skills/lakehouse-doc-en/references/continue-job.md +9 -17
  56. package/bin/skills/lakehouse-doc-en/references/create-api-connection.md +315 -286
  57. package/bin/skills/lakehouse-doc-en/references/create-catalog-connection.md +1 -0
  58. package/bin/skills/lakehouse-doc-en/references/create-dynamic-table.md +4 -4
  59. package/bin/skills/lakehouse-doc-en/references/create-external-catalog.md +85 -22
  60. package/bin/skills/lakehouse-doc-en/references/create-table-ddl.md +45 -0
  61. package/bin/skills/lakehouse-doc-en/references/creating_alicloud_privatelinkendpoint.md +4 -6
  62. package/bin/skills/lakehouse-doc-en/references/creating_alicloud_privatelinkservice.md +4 -7
  63. package/bin/skills/lakehouse-doc-en/references/creating_tencentcloud_privatelinkendpoint.md +2 -7
  64. package/bin/skills/lakehouse-doc-en/references/creating_tencentcloud_privatelinkservice.md +1 -5
  65. package/bin/skills/lakehouse-doc-en/references/cz-cli-agent.md +15 -10
  66. package/bin/skills/lakehouse-doc-en/references/cz-cli-datasource.md +0 -8
  67. package/bin/skills/lakehouse-doc-en/references/cz-cli-sql.md +2 -45
  68. package/bin/skills/lakehouse-doc-en/references/cz-cli.md +53 -42
  69. package/bin/skills/lakehouse-doc-en/references/dashboard-version-management-guide.md +12 -4
  70. package/bin/skills/lakehouse-doc-en/references/data-integration-intro.md +1 -1
  71. package/bin/skills/lakehouse-doc-en/references/data-integration.md +29 -27
  72. package/bin/skills/lakehouse-doc-en/references/data-load-summary.md +3 -3
  73. package/bin/skills/lakehouse-doc-en/references/data-quality.md +25 -25
  74. package/bin/skills/lakehouse-doc-en/references/data-sharing.md +31 -54
  75. package/bin/skills/lakehouse-doc-en/references/data-sources.md +45 -45
  76. package/bin/skills/lakehouse-doc-en/references/data_catalog.md +23 -25
  77. package/bin/skills/lakehouse-doc-en/references/data_privacy.md +5 -2
  78. package/bin/skills/lakehouse-doc-en/references/data_sharing_between_accounts_guide.md +0 -4
  79. package/bin/skills/lakehouse-doc-en/references/data_visualization.md +4 -15
  80. package/bin/skills/lakehouse-doc-en/references/dataagent.md +39 -7
  81. package/bin/skills/lakehouse-doc-en/references/databricks-delta-to-lakehouse-migration.md +168 -0
  82. package/bin/skills/lakehouse-doc-en/references/databricks-dlt-to-lakehouse-migration.md +331 -0
  83. package/bin/skills/lakehouse-doc-en/references/databricks-external-catalog-practice.md +367 -0
  84. package/bin/skills/lakehouse-doc-en/references/databricks-jobs-to-studio-migration.md +199 -0
  85. package/bin/skills/lakehouse-doc-en/references/databricks-notebook-to-studio-migration.md +350 -0
  86. package/bin/skills/lakehouse-doc-en/references/databricks-uc-governance-to-lakehouse-migration.md +327 -0
  87. package/bin/skills/lakehouse-doc-en/references/datagpt-model-config.md +34 -0
  88. package/bin/skills/lakehouse-doc-en/references/datagpt_data_source.md +50 -37
  89. package/bin/skills/lakehouse-doc-en/references/datagpt_introduction.md +55 -79
  90. package/bin/skills/lakehouse-doc-en/references/datagpt_quickstart.md +50 -64
  91. package/bin/skills/lakehouse-doc-en/references/datalake-acceleration.md +75 -2
  92. package/bin/skills/lakehouse-doc-en/references/dbt-databricks-to-clickzetta-migration.md +242 -0
  93. package/bin/skills/lakehouse-doc-en/references/dynamic-mask.md +30 -30
  94. package/bin/skills/lakehouse-doc-en/references/dynamic-table-bestpractice.md +1 -1
  95. package/bin/skills/lakehouse-doc-en/references/dynamic-table-introduce.md +1 -1
  96. package/bin/skills/lakehouse-doc-en/references/dynamic_table_summary.md +1 -1
  97. package/bin/skills/lakehouse-doc-en/references/eco_integration/streamlit.md +1 -1
  98. package/bin/skills/lakehouse-doc-en/references/eco_integration/superset.md +1 -1
  99. package/bin/skills/lakehouse-doc-en/references/ecosystem-all.md +1 -3
  100. package/bin/skills/lakehouse-doc-en/references/ecosystem.md +145 -0
  101. package/bin/skills/lakehouse-doc-en/references/external-catalog-summary.md +33 -38
  102. package/bin/skills/lakehouse-doc-en/references/external-function-combo-practice.md +466 -0
  103. package/bin/skills/lakehouse-doc-en/references/f6fc6447ee.md +7 -9
  104. package/bin/skills/lakehouse-doc-en/references/federation-query.md +56 -6
  105. package/bin/skills/lakehouse-doc-en/references/finebi-mysql.md +2 -0
  106. package/bin/skills/lakehouse-doc-en/references/get-started-with-sample-data.md +10 -11
  107. package/bin/skills/lakehouse-doc-en/references/gitfolder.md +2 -3
  108. package/bin/skills/lakehouse-doc-en/references/grant-privileges.md +2 -0
  109. package/bin/skills/lakehouse-doc-en/references/iceberg-rest-catalog-databricks.md +166 -0
  110. package/bin/skills/lakehouse-doc-en/references/ide.md +1 -1
  111. package/bin/skills/lakehouse-doc-en/references/if_else_task.md +59 -57
  112. package/bin/skills/lakehouse-doc-en/references/input_output.md +10 -7
  113. package/bin/skills/lakehouse-doc-en/references/jobprofile-bestpractices.md +60 -64
  114. package/bin/skills/lakehouse-doc-en/references/kafka-connection.md +0 -1
  115. package/bin/skills/lakehouse-doc-en/references/key-concepts.md +146 -117
  116. package/bin/skills/lakehouse-doc-en/references/lakehouse-ai-gateway-cz-cli.md +317 -0
  117. package/bin/skills/lakehouse-doc-en/references/lakehouse-ai-sql-analysis.md +345 -0
  118. package/bin/skills/lakehouse-doc-en/references/lakehouse-dqc-guide.md +300 -0
  119. package/bin/skills/lakehouse-doc-en/references/lakehouse-medallion-sql-dt-guide.md +543 -0
  120. package/bin/skills/lakehouse-doc-en/references/lakehouse-multi-cloud-acceleration.md +274 -0
  121. package/bin/skills/lakehouse-doc-en/references/lakehouse-multimodal-ai-pipeline.md +198 -0
  122. package/bin/skills/lakehouse-doc-en/references/lakehouse-quick-experience_guide.md +49 -52
  123. package/bin/skills/lakehouse-doc-en/references/lakehouse-volume-pipe-acceleration-guide.md +380 -0
  124. package/bin/skills/lakehouse-doc-en/references/langchain-plug-installation.md +1 -1
  125. package/bin/skills/lakehouse-doc-en/references/management.md +4 -9
  126. package/bin/skills/lakehouse-doc-en/references/medallion-lakehouse-from-scratch.md +2 -1
  127. package/bin/skills/lakehouse-doc-en/references/metrics_answer_build.md +58 -21
  128. package/bin/skills/lakehouse-doc-en/references/migrate-spark-data-engineering-best-practices-to-lakehouse.md +1 -1
  129. package/bin/skills/lakehouse-doc-en/references/mindsdb.md +1 -1
  130. package/bin/skills/lakehouse-doc-en/references/monitoring_and_alerting.md +65 -60
  131. package/bin/skills/lakehouse-doc-en/references/monitoring_item_specification.md +33 -33
  132. package/bin/skills/lakehouse-doc-en/references/multitable_batch_sync.md +16 -16
  133. package/bin/skills/lakehouse-doc-en/references/multitable_realtime_sync.md +65 -72
  134. package/bin/skills/lakehouse-doc-en/references/multitable_realtime_sync_sop.md +54 -52
  135. package/bin/skills/lakehouse-doc-en/references/navicat-mysql.md +2 -0
  136. package/bin/skills/lakehouse-doc-en/references/om-dynamic-table.md +71 -66
  137. package/bin/skills/lakehouse-doc-en/references/om-vcluster.md +2 -0
  138. package/bin/skills/lakehouse-doc-en/references/open-api-create-session.md +79 -0
  139. package/bin/skills/lakehouse-doc-en/references/open-api-generate-auth-token.md +63 -0
  140. package/bin/skills/lakehouse-doc-en/references/open-api-overview.md +96 -0
  141. package/bin/skills/lakehouse-doc-en/references/open-api-quick-start.md +286 -0
  142. package/bin/skills/lakehouse-doc-en/references/open-api-response-guide.md +264 -0
  143. package/bin/skills/lakehouse-doc-en/references/open-api-safe-question-poll.md +201 -0
  144. package/bin/skills/lakehouse-doc-en/references/open-api-text2insight-query.md +99 -0
  145. package/bin/skills/lakehouse-doc-en/references/open-api-text2insight-stop.md +74 -0
  146. package/bin/skills/lakehouse-doc-en/references/overview.md +6 -7
  147. package/bin/skills/lakehouse-doc-en/references/permission-application.md +5 -5
  148. package/bin/skills/lakehouse-doc-en/references/pipe-introduction.md +1 -0
  149. package/bin/skills/lakehouse-doc-en/references/pipe-kafka-table-stream.md +72 -70
  150. package/bin/skills/lakehouse-doc-en/references/pipe-kafka.md +105 -110
  151. package/bin/skills/lakehouse-doc-en/references/pipe-overview.md +40 -40
  152. package/bin/skills/lakehouse-doc-en/references/pipe-storage-object.md +43 -48
  153. package/bin/skills/lakehouse-doc-en/references/pipe-summary.md +14 -4
  154. package/bin/skills/lakehouse-doc-en/references/pipe-syntax.md +58 -151
  155. package/bin/skills/lakehouse-doc-en/references/practice_python_task.md +4 -4
  156. package/bin/skills/lakehouse-doc-en/references/pricing-ai-gateway.md +181 -0
  157. package/bin/skills/lakehouse-doc-en/references/pricing-lakehouse.md +316 -0
  158. package/bin/skills/lakehouse-doc-en/references/pricing.md +44 -288
  159. package/bin/skills/lakehouse-doc-en/references/private-link-general.md +0 -2
  160. package/bin/skills/lakehouse-doc-en/references/pyspark-to-zettapark-migration-f1.md +1 -1
  161. package/bin/skills/lakehouse-doc-en/references/python-igs.md +7 -3
  162. package/bin/skills/lakehouse-doc-en/references/python-sample-put-github-rt-events.md +1 -1
  163. package/bin/skills/lakehouse-doc-en/references/python-task.md +1 -1
  164. package/bin/skills/lakehouse-doc-en/references/python_reference/connector.md +3 -3
  165. package/bin/skills/lakehouse-doc-en/references/python_reference/connector_advanced.md +2 -2
  166. package/bin/skills/lakehouse-doc-en/references/python_reference/connector_examples.md +2 -2
  167. package/bin/skills/lakehouse-doc-en/references/python_sdk_guide.md +1 -1
  168. package/bin/skills/lakehouse-doc-en/references/python_shell_datasource.md +11 -9
  169. package/bin/skills/lakehouse-doc-en/references/quick_start_batch_sync_data.md +9 -18
  170. package/bin/skills/lakehouse-doc-en/references/quick_start_bi_analysis.md +8 -25
  171. package/bin/skills/lakehouse-doc-en/references/quick_start_create_workspace.md +4 -6
  172. package/bin/skills/lakehouse-doc-en/references/quick_start_data_quality.md +8 -8
  173. package/bin/skills/lakehouse-doc-en/references/quick_start_etl.md +16 -20
  174. package/bin/skills/lakehouse-doc-en/references/quick_start_monitoring_and_alerting.md +10 -18
  175. package/bin/skills/lakehouse-doc-en/references/quick_start_sql_query.md +7 -10
  176. package/bin/skills/lakehouse-doc-en/references/quick_start_upload_data.md +5 -7
  177. package/bin/skills/lakehouse-doc-en/references/quick_start_user_management.md +8 -8
  178. package/bin/skills/lakehouse-doc-en/references/quick_start_workspace.md +0 -5
  179. package/bin/skills/lakehouse-doc-en/references/quick_start_workspace_user.md +8 -8
  180. package/bin/skills/lakehouse-doc-en/references/quickstart.md +69 -56
  181. package/bin/skills/lakehouse-doc-en/references/quickstart_datashare_between_companies.md +0 -5
  182. package/bin/skills/lakehouse-doc-en/references/quickstart_envirment_for_team.md +0 -24
  183. package/bin/skills/lakehouse-doc-en/references/realtime-pipeline-selection-guide.md +1 -2
  184. package/bin/skills/lakehouse-doc-en/references/realtime-sales-dashboard-with-dynamic-table.md +3 -3
  185. package/bin/skills/lakehouse-doc-en/references/realtime_sync.md +0 -1
  186. package/bin/skills/lakehouse-doc-en/references/release-note-2026-05-19.md +5 -3
  187. package/bin/skills/lakehouse-doc-en/references/revoke-privileges.md +3 -1
  188. package/bin/skills/lakehouse-doc-en/references/roles.md +2 -3
  189. package/bin/skills/lakehouse-doc-en/references/row-filter.md +165 -0
  190. package/bin/skills/lakehouse-doc-en/references/row_level_permission.md +30 -19
  191. package/bin/skills/lakehouse-doc-en/references/scheduled_task.md +28 -21
  192. package/bin/skills/lakehouse-doc-en/references/security_overview.md +99 -21
  193. package/bin/skills/lakehouse-doc-en/references/set-command.md +1 -1
  194. package/bin/skills/lakehouse-doc-en/references/setup.md +13 -15
  195. package/bin/skills/lakehouse-doc-en/references/show-grants.md +1 -1
  196. package/bin/skills/lakehouse-doc-en/references/snowflake-dynamic-tables-to-lakehouse.md +2 -2
  197. package/bin/skills/lakehouse-doc-en/references/spark-connector-summary.md +1 -1
  198. package/bin/skills/lakehouse-doc-en/references/sql_functions/context_functions/current_vcluster.md +1 -1
  199. package/bin/skills/lakehouse-doc-en/references/sso-configuration.md +2 -2
  200. package/bin/skills/lakehouse-doc-en/references/streaming_pipeline_with_dynamic_table.md +0 -1
  201. package/bin/skills/lakehouse-doc-en/references/studio-incremental-sync-practice.md +27 -23
  202. package/bin/skills/lakehouse-doc-en/references/studio-shell-task.md +1 -1
  203. package/bin/skills/lakehouse-doc-en/references/supported-cloud-platforms.md +32 -0
  204. package/bin/skills/lakehouse-doc-en/references/table_rendering.md +18 -12
  205. package/bin/skills/lakehouse-doc-en/references/task-develop.md +89 -91
  206. package/bin/skills/lakehouse-doc-en/references/task_development.md +19 -17
  207. package/bin/skills/lakehouse-doc-en/references/task_group.md +16 -14
  208. package/bin/skills/lakehouse-doc-en/references/task_instance.md +21 -21
  209. package/bin/skills/lakehouse-doc-en/references/task_param.md +38 -35
  210. package/bin/skills/lakehouse-doc-en/references/task_param_reference.md +81 -79
  211. package/bin/skills/lakehouse-doc-en/references/task_scheduling_dependency.md +20 -21
  212. package/bin/skills/lakehouse-doc-en/references/tencentcloud_arn_and_externalid.md +1 -5
  213. package/bin/skills/lakehouse-doc-en/references/trial-account-quotas-and-limits.md +1 -3
  214. package/bin/skills/lakehouse-doc-en/references/tutorial_connect_to_lakehouse.md +69 -0
  215. package/bin/skills/lakehouse-doc-en/references/tutorials.md +4 -1
  216. package/bin/skills/lakehouse-doc-en/references/unique-key.md +167 -0
  217. package/bin/skills/lakehouse-doc-en/references/usageandbillingview.md +138 -0
  218. package/bin/skills/lakehouse-doc-en/references/use-dbt-dev.md +3 -3
  219. package/bin/skills/lakehouse-doc-en/references/use-java-sdk-realtime-uploaddata.md +1 -1
  220. package/bin/skills/lakehouse-doc-en/references/use-java-sdk-upload-data-local.md +3 -3
  221. package/bin/skills/lakehouse-doc-en/references/use-models.md +128 -0
  222. package/bin/skills/lakehouse-doc-en/references/use-mysql-client.md +81 -81
  223. package/bin/skills/lakehouse-doc-en/references/use-python-sdk-upload-data.md +10 -12
  224. package/bin/skills/lakehouse-doc-en/references/user-identification.md +2 -3
  225. package/bin/skills/lakehouse-doc-en/references/user_permission_grand_guide.md +1 -1
  226. package/bin/skills/lakehouse-doc-en/references/using-udf-in-dynamic-table.md +1 -1
  227. package/bin/skills/lakehouse-doc-en/references/vc_cache.md +18 -22
  228. package/bin/skills/lakehouse-doc-en/references/vcluster_size_description.md +33 -31
  229. package/bin/skills/lakehouse-doc-en/references/virtual-cluster.md +43 -45
  230. package/bin/skills/lakehouse-doc-en/references/web-job-history.md +94 -108
  231. package/bin/skills/lakehouse-doc-en/references/web_search.md +16 -7
  232. package/bin/skills/lakehouse-doc-en/references/zettapark-data-engineering-demo.md +1 -1
  233. package/bin/skills/lakehouse-doc-en/references/zettapark-dataframe-guide.md +144 -70
  234. package/bin/skills/lakehouse-doc-en/references/zettapark-dynamic-table-guide.md +2 -2
  235. package/bin/skills/lakehouse-doc-en/references/zettapark-etl-guide.md +73 -33
  236. package/bin/skills/lakehouse-doc-en/references/zettapark-feature-engineering.md +2 -2
  237. package/bin/skills/lakehouse-doc-en/references/zettapark-functions-guide.md +75 -46
  238. package/bin/skills/lakehouse-doc-en/references/zettapark-quick-start.md +2 -2
  239. package/bin/skills/lakehouse-doc-en/references/zettapark-stream-guide.md +4 -4
  240. package/bin/skills/lakehouse-doc-en/references/zettapark-volume-guide.md +93 -29
  241. package/package.json +1 -1
  242. package/bin/skills/lakehouse-doc-en/references/CLAUDE.md +0 -606
  243. package/bin/skills/lakehouse-doc-en/references/modelprice.md +0 -155
@@ -4,11 +4,11 @@ The task development module is a visual development page provided by Singdata La
4
4
 
5
5
  ## Development Concepts
6
6
 
7
- | **Concept** | **Definition** |
8
- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
9
- | Task | Simple node: a single, concrete task type, such as SQL or Python. |
10
- | | Complex workflow node: a group of nodes composed of multiple individual nodes, such as a composite node. Parameters and scheduling configuration for complex workflow nodes are managed centrally. |
11
- | Task Group | A task group is a virtual management concept provided by Singdata Lakehouse. You can add tasks to a task group for centralized management, including visual drag-and-drop dependency orchestration, task group parameter configuration, batch scheduling setup, and batch submission. **Note**: If you need to manage a group of tasks using a DAG-style drag interface, or copy and refactor a batch of task pipelines, the task group feature is recommended. |
7
+ | **Concept** | **Definition** |
8
+ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | Task | Simple node: a single, concrete task type, such as SQL or Python. |
10
+ | | Complex workflow node: a group of nodes composed of multiple individual nodes, such as a composite node. Parameters and scheduling configuration for complex workflow nodes are managed centrally. |
11
+ | Task Group | A task group is a virtual management concept provided by Singdata Lakehouse. You can add tasks to a task group for centralized management, including visual drag-and-drop dependency orchestration, task group parameter configuration, batch scheduling setup, and batch submission. **Note**: If you need to manage a group of tasks using a DAG-style drag interface, or copy and refactor a batch of task pipelines, the task group feature is recommended. |
12
12
 
13
13
  ## Dependencies: Node-level Dependencies
14
14
 
@@ -20,13 +20,13 @@ Dependencies are attached to nodes. Whether a node is a simple node or a complex
20
20
 
21
21
  ## Scenario Overview
22
22
 
23
- - You can create various task nodes directly under "Tasks" and establish dependencies between nodes through the scheduling dependency settings in the scheduling configuration.
24
- - You can also create new nodes or add existing nodes under a "Task Group" to organize and orchestrate a batch of tasks, including configuring task group-level parameters and visually dragging to set dependencies between tasks.
23
+ * You can create various task nodes directly under "Tasks" and establish dependencies between nodes through the scheduling dependency settings in the scheduling configuration.
24
+ * You can also create new nodes or add existing nodes under a "Task Group" to organize and orchestrate a batch of tasks, including configuring task group-level parameters and visually dragging to set dependencies between tasks.
25
25
 
26
- | **Development approach** | **Target users** | **Scenario advantages** | **Limitations and differences** |
27
- | -------- | ---------------------- | ---------------------------------------- | --------------------------------------------------------------- |
28
- | Create tasks directly | Teams with relatively innovative business needs or those who prefer a fast, lightweight pace. | No need to build complex business relationships — just set up node dependencies and get the pipeline running quickly. Ideal for fast-moving scenarios. | Does not support batch operations, such as bulk modification of task scheduling times or compute clusters. |
29
- | Manage tasks within a task group | Mature, standardized data warehouse teams that organize work around business domains. | Manage a related batch of task nodes by business scenario, with support for visual drag-and-drop dependency configuration. | Real-time tasks are not currently supported in task groups. A task node can only belong to one task group. Task group parameters only take effect after the task group is submitted. |
26
+ | **Development approach** | **Target users** | **Scenario advantages** | **Limitations and differences** |
27
+ | -------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
+ | Create tasks directly | Teams with relatively innovative business needs or those who prefer a fast, lightweight pace. | No need to build complex business relationships — just set up node dependencies and get the pipeline running quickly. Ideal for fast-moving scenarios. | Does not support batch operations, such as bulk modification of task scheduling times or compute clusters. |
29
+ | Manage tasks within a task group | Mature, standardized data warehouse teams that organize work around business domains. | Manage a related batch of task nodes by business scenario, with support for visual drag-and-drop dependency configuration. | Real-time tasks are not currently supported in task groups. A task node can only belong to one task group. Task group parameters only take effect after the task group is submitted. |
30
30
 
31
31
  ^
32
32
 
@@ -36,7 +36,7 @@ Dependencies are attached to nodes. Whether a node is a simple node or a complex
36
36
 
37
37
  A task group is a virtual management concept provided by Singdata Lakehouse. You can add tasks to a task group for centralized management, including visual drag-and-drop dependency orchestration, task group parameter configuration, batch scheduling setup, and batch submission.
38
38
 
39
- - **Note**: If you need to manage a group of tasks using a DAG-style drag interface, or copy and refactor a batch of task pipelines, the task group feature is recommended. For more details, see [Task Group](task_group.md).
39
+ * **Note**: If you need to manage a group of tasks using a DAG-style drag interface, or copy and refactor a batch of task pipelines, the task group feature is recommended. For more details, see [Task Group](task_group.md).
40
40
 
41
41
  #### Task
42
42
 
@@ -44,11 +44,13 @@ Singdata Lakehouse provides several types of task nodes, including real-time mul
44
44
 
45
45
  #### Parameters
46
46
 
47
- - **Task group parameters**: Parameters created within a task group, used for global management of tasks inside that group.
48
- - **Scheduling parameters**: Parameters used during scheduled task execution.
49
- - **Temporary parameters**: Parameters used during ad-hoc task execution.
47
+ * **Task group parameters**: Parameters created within a task group, used for global management of tasks inside that group.
48
+ * **Scheduling parameters**: Parameters used during scheduled task execution.
49
+ * **Temporary parameters**: Parameters used during ad-hoc task execution.
50
50
 
51
51
  #### Scheduling Configuration
52
52
 
53
- - Currently, only periodic scheduling is supported.
54
- - **Dependency method**: Interval dependency — the system determines whether upstream and downstream task instances overlap by comparing their start and end time ranges. For more on dependency relationships, see [Task Scheduling Dependencies](task_scheduling_dependency.md).
53
+ * Currently, only periodic scheduling is supported.
54
+ * **Dependency method**: Interval dependency — the system determines whether upstream and downstream task instances overlap by comparing their start and end time ranges. For more on dependency relationships, see [Task Scheduling Dependencies](task_scheduling_dependency.md).
55
+
56
+ ^
@@ -24,7 +24,7 @@ This article covers how to create, edit, and submit task groups, as well as how
24
24
 
25
25
  When you need to batch-copy a group of tasks that have dependencies and recreate those dependencies in the new tasks, you can use the task group copy feature.
26
26
 
27
- ![](.topwrite/assets/91c6efc6cd/3c6fcb545a6b507a072943955259ae593b4f1892.jpeg =700)
27
+ ^
28
28
 
29
29
  Add the tasks you want to copy (along with their dependencies) to Task Group 1. After copying Task Group 1, the resulting Task Group 2 will contain:
30
30
 
@@ -36,7 +36,7 @@ Add the tasks you want to copy (along with their dependencies) to Task Group 1.
36
36
 
37
37
  When you need to refactor a branch in the current task pipeline and batch-update custom variables across tasks, you can combine the downstream link copy feature with task groups.
38
38
 
39
- ![](.topwrite/assets/91c6efc6cd/f8dfd42b7ace23593c3f7d3d79bff8eb46d2a1f9.jpeg =751)
39
+ ^
40
40
 
41
41
  On any node (whether it belongs to a task group or is standalone), clicking "Copy Downstream Link" will batch-copy that node and all its downstream nodes.
42
42
 
@@ -54,7 +54,7 @@ Before creating a task group, plan and design a business process that fits your
54
54
 
55
55
  3. Click OK.
56
56
 
57
- ![](.topwrite/assets/image_1722251763584.png =434)
57
+ ^
58
58
 
59
59
  After creation:
60
60
 
@@ -65,7 +65,7 @@ After creation:
65
65
 
66
66
  You can design and manage task nodes and dependencies within a task group in either list mode or DAG mode.
67
67
 
68
- ![](.topwrite/assets/image_1722251928404.png)
68
+ ^
69
69
 
70
70
  1. **Create/Add nodes**: Both modes support creating new task nodes or adding existing tasks to the task group.
71
71
 
@@ -92,7 +92,7 @@ After successfully creating or adding a node, enter the node's editing interface
92
92
  * Click the "Parameters" tab in the task group operation area to open the parameter configuration interface.
93
93
  * Click the New button and enter the parameter name and value in the dialog. For details on built-in parameter values, see [Task Parameters](task_param.md). For the full syntax, see [Task Parameter Syntax Reference](task_param_reference.md).
94
94
 
95
- ![](.topwrite/assets/image_1722252018555.png =497)
95
+ ^
96
96
 
97
97
  After creating task group parameters, use them as follows:
98
98
 
@@ -102,7 +102,7 @@ After creating task group parameters, use them as follows:
102
102
 
103
103
  * In the "Value Source" dropdown, select the task group parameter.
104
104
 
105
- ![](.topwrite/assets/image_1722252102342.png =472)
105
+ ^
106
106
 
107
107
  After creating and referencing a task group parameter:
108
108
 
@@ -116,12 +116,12 @@ You can use the batch edit scheduling time feature to update the scheduling time
116
116
  1. Click "Batch Edit Scheduling Time."
117
117
 
118
118
  * In DAG editing mode: Hover over the batch button and select "Edit Scheduling Time."
119
- ![](.topwrite/assets/image_1736303777548.png =498)
119
+
120
120
  * In list mode: Select the target tasks you want to update, then click "Edit Scheduling Time."
121
121
 
122
122
  2. Batch edit the scheduling time.
123
123
  Select the scheduling time for the batch update. The operation is the same as the scheduling configuration in task scheduling. For details, see [Task Development and Scheduling](task-develop.md).
124
- ![](.topwrite/assets/image_1736303843406.png =499)
124
+
125
125
 
126
126
  3. Confirm and submit the batch operation.
127
127
 
@@ -135,7 +135,7 @@ After editing and creating the task group, you need to submit it to the producti
135
135
 
136
136
  ## FAQ
137
137
 
138
- **Q1: Why can't I click the Submit button again after the task group has been submitted?**
138
+ **Q1: Why can't I click the Submit button again after the task group has been submitted**?
139
139
 
140
140
  After a task group is submitted, if no changes have been made (i.e., the status has not changed to "Submitted with modifications"), it cannot be submitted again. To batch-submit task information within the task group, use one of these two approaches:
141
141
 
@@ -148,11 +148,13 @@ Task group status changes when:
148
148
  * Tasks are added to or removed from the task group.
149
149
  * Task group parameters are added, deleted, modified, or queried.
150
150
 
151
- ---
151
+ ***
152
152
 
153
153
  ## Related Documentation
154
154
 
155
- - [Task Parameters](task_param.md) — Task-level parameter concepts and configuration, and how they differ from task group parameters
156
- - [Task Parameter Syntax Reference](task_param_reference.md) — Full syntax for built-in parameters and time expressions
157
- - [Composite Task](composite_task.md) — How composite task parameters and task group parameters work together
158
- - [Task Development and Scheduling](task-develop.md) — Referencing task group parameters in individual tasks
155
+ * [Task Parameters](task_param.md) — Task-level parameter concepts and configuration, and how they differ from task group parameters
156
+ * [Task Parameter Syntax Reference](task_param_reference.md) — Full syntax for built-in parameters and time expressions
157
+ * [Composite Task](composite_task.md) — How composite task parameters and task group parameters work together
158
+ * [Task Development and Scheduling](task-develop.md) — Referencing task group parameters in individual tasks
159
+
160
+ ^
@@ -38,44 +38,44 @@ The system calculates the difference between the **actual time the instance ente
38
38
 
39
39
  ### Scenario 1: Run Timeout Duration
40
40
 
41
- | | |
42
- | ------------ | ----------------------- |
43
- | Time | Event |
44
- | 14:00 | T1 starts running |
45
- | 14:10 | Run time reaches the 10-minute limit; T1 is set to Failed |
41
+ | | |
42
+ | -------------------------------------- | -------------------------------------------------------------------------------- |
43
+ | Time | Event |
44
+ | 14:00 | T1 starts running |
45
+ | 14:10 | Run time reaches the 10-minute limit; T1 is set to Failed |
46
46
  | Subsequent instances from 14:05 onward | All self-dependent subsequent instances are suspended because upstream T1 failed |
47
47
 
48
- ![](/.topwrite/assets/image_1780067288681.png)
48
+ ^
49
49
 
50
50
  ### Scenario 2: Schedule Wait Duration
51
51
 
52
- | | |
53
- | ----- | ------------------------------------- |
54
- | Time | Event |
55
- | 14:00 | T1 starts running normally (not affected by this setting) |
56
- | 14:05 | T2 reaches its trigger time and enters the waiting-for-upstream (T1) state |
57
- | 14:15 | T2's wait time reaches the 10-minute limit; T2 is set to Failed. T1 can continue running normally |
52
+ | | |
53
+ | ----- | -------------------------------------------------------------------------------------------------------------- |
54
+ | Time | Event |
55
+ | 14:00 | T1 starts running normally (not affected by this setting) |
56
+ | 14:05 | T2 reaches its trigger time and enters the waiting-for-upstream (T1) state |
57
+ | 14:15 | T2's wait time reaches the 10-minute limit; T2 is set to Failed. T1 can continue running normally |
58
58
  | 14:10 | T3 reaches its trigger time and enters the waiting state; its downstream tasks are suspended because T2 failed |
59
- | 14:20 | T3's wait time reaches the 10-minute limit; T3 is set to Failed. T1 completes normally |
59
+ | 14:20 | T3's wait time reaches the 10-minute limit; T3 is set to Failed. T1 completes normally |
60
60
 
61
61
  > The schedule wait duration triggers independently for each instance; T1's normal execution is not affected.
62
- > ![](/.topwrite/assets/image_1780067342320.png)
62
+ >
63
63
 
64
64
  ### Scenario 3: Delayed Run Skip Duration
65
65
 
66
- | | |
67
- | ----- | -------------------------------------------------- |
68
- | Time | Event |
69
- | 14:00 | T1 starts running normally |
70
- | 14:05 | T2 reaches its trigger time and waits for T1 to complete |
66
+ | | |
67
+ | ----- | ------------------------------------------------------------------------------------------ |
68
+ | Time | Event |
69
+ | 14:00 | T1 starts running normally |
70
+ | 14:05 | T2 reaches its trigger time and waits for T1 to complete |
71
71
  | 14:20 | T1 completes; T2 enters the running state. Delay = 14:20 − 14:05 = 15 minutes > 10 minutes |
72
- | 14:20 | T2 is dry-run skipped and set to Succeeded, triggering T3's scheduling |
72
+ | 14:20 | T2 is dry-run skipped and set to Succeeded, triggering T3's scheduling |
73
73
 
74
74
  > A dry-run skip does not execute any actual business logic; it only marks the instance as Succeeded to keep the scheduling chain moving.
75
75
 
76
76
  ***
77
77
 
78
- ![](/.topwrite/assets/image_1780067317383.png)
78
+ ^
79
79
 
80
80
  ***
81
81
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  In day-to-day data development, you often encounter situations like these:
8
8
 
9
- - Processing the previous day's data: `WHERE dt = '2023-09-21'`
10
- - Aggregating last month's data: `WHERE month = '2023-08'`
11
- - Querying data for a specific city: `WHERE city = 'Shanghai'`
9
+ * Processing the previous day's data: `WHERE dt = '2023-09-21'`
10
+ * Aggregating last month's data: `WHERE month = '2023-08'`
11
+ * Querying data for a specific city: `WHERE city = 'Shanghai'`
12
12
 
13
13
  If you hard-code dates, cities, and other values directly in your code, the task cannot adapt dynamically at runtime. **Task parameters** are designed to solve this — use `${parameter_name}` as a placeholder in your code, and the system automatically substitutes the actual value at runtime.
14
14
 
@@ -16,15 +16,15 @@ If you hard-code dates, cities, and other values directly in your code, the task
16
16
 
17
17
  ### Basic Concepts
18
18
 
19
- | Category | Concept | Meaning | Example |
20
- | ---- | ---- | ---- | ---- |
21
- | Parameter definition | Custom parameter | Referenced in code using `${parameter_name}` | `${yesterday}` |
22
- | Parameter value | Constant | A fixed string or number | `Shanghai`, `1234` |
23
- | Parameter value | System built-in parameter | System-provided dynamic values, such as the scheduled time | `sys_plan_datetime` |
24
- | Parameter value | Time expression | Format and offset calculations based on the scheduled time | `$[yyyy-MM-dd, -1d]` |
25
- | Parameter value | Built-in time function | Handles complex time calculations like first day of month, Monday, etc. | `first_day_of_month()` |
19
+ | Category | Concept | Meaning | Example |
20
+ | -------------------- | ------------------------- | ----------------------------------------------------------------------- | ---------------------- |
21
+ | Parameter definition | Custom parameter | Referenced in code using `${parameter_name}` | `${yesterday}` |
22
+ | Parameter value | Constant | A fixed string or number | `Shanghai`, `1234` |
23
+ | Parameter value | System built-in parameter | System-provided dynamic values, such as the scheduled time | `sys_plan_datetime` |
24
+ | Parameter value | Time expression | Format and offset calculations based on the scheduled time | `$[yyyy-MM-dd, -1d]` |
25
+ | Parameter value | Built-in time function | Handles complex time calculations like first day of month, Monday, etc. | `first_day_of_month()` |
26
26
 
27
- ---
27
+ ***
28
28
 
29
29
  ## Quick Start
30
30
 
@@ -38,8 +38,8 @@ SELECT * FROM sales_table WHERE city = '${city}' AND dt = '${yesterday}';
38
38
 
39
39
  Click the "Parameters" button. The system automatically detects the `city` and `yesterday` parameters. Assign values to them:
40
40
 
41
- - `city` = `Shanghai`
42
- - `yesterday` = `$[yyyy-MM-dd, -1d]`
41
+ * `city` = `Shanghai`
42
+ * `yesterday` = `$[yyyy-MM-dd, -1d]`
43
43
 
44
44
  **Step 3: Run and verify**
45
45
 
@@ -50,11 +50,12 @@ SELECT * FROM sales_table WHERE city = 'Shanghai' AND dt = '2023-09-21';
50
50
  ```
51
51
 
52
52
  **Key points**:
53
- - The parameter format is always `${parameter_name}`. Parameter names may only contain letters, digits, and underscores.
54
- - You cannot reference built-in parameters (such as `sys_biz_day`) directly in code — you must first assign them to a custom parameter, then reference the custom parameter.
55
- - Add quotes in SQL yourself when needed: `'${city}'`
56
53
 
57
- ---
54
+ * The parameter format is always `${parameter_name}`. Parameter names may only contain letters, digits, and underscores.
55
+ * You cannot reference built-in parameters (such as `sys_biz_day`) directly in code — you must first assign them to a custom parameter, then reference the custom parameter.
56
+ * Add quotes in SQL yourself when needed: `'${city}'`
57
+
58
+ ***
58
59
 
59
60
  ## Parameter Types and Scope
60
61
 
@@ -66,13 +67,13 @@ Scoped to the current task only. Use these for configuration that is unique to a
66
67
 
67
68
  ![](.topwrite/assets/image_1740658949338.png =700)
68
69
 
69
- | Field | Description | Example |
70
- | ---- | ---- | ---- |
71
- | Parameter name | Unique identifier for the parameter | `city`, `yesterday` |
72
- | Value source | Select "Task" or "Task Group" | Task |
73
- | Parameter value | The actual value or expression | `Shanghai`, `$[yyyy-MM-dd, -1d]` |
74
- | Encrypt value | When checked, the value is masked | Use for passwords and other sensitive data |
75
- | Ignore | When checked, no substitution is performed | Treats `${var}` as literal text |
70
+ | Field | Description | Example |
71
+ | --------------- | ------------------------------------------ | ------------------------------------------ |
72
+ | Parameter name | Unique identifier for the parameter | `city`, `yesterday` |
73
+ | Value source | Select "Task" or "Task Group" | Task |
74
+ | Parameter value | The actual value or expression | `Shanghai`, `$[yyyy-MM-dd, -1d]` |
75
+ | Encrypt value | When checked, the value is masked | Use for passwords and other sensitive data |
76
+ | Ignore | When checked, no substitution is performed | Treats `${var}` as literal text |
76
77
 
77
78
  ### Task Group Parameters
78
79
 
@@ -89,7 +90,7 @@ SELECT * FROM ${db_name}.table_a;
89
90
  SELECT * FROM ${db_name}.table_b;
90
91
  ```
91
92
 
92
- ---
93
+ ***
93
94
 
94
95
  ## Parameter Behavior by Run Mode
95
96
 
@@ -97,13 +98,13 @@ SELECT * FROM ${db_name}.table_b;
97
98
 
98
99
  A dialog prompts you to enter parameter values. The values apply to this run only and do not affect the saved parameter configuration. Useful for debugging and validation.
99
100
 
100
- ![](/.topwrite/assets/image_1761284431760.png =680)
101
+ ![](/.topwrite/assets/image_1780887030206.png =668)
101
102
 
102
103
  ### Scheduled run
103
104
 
104
105
  Uses the saved parameter configuration and dynamically calculates parameter values based on the scheduled time. Use this in production.
105
106
 
106
- ---
107
+ ***
107
108
 
108
109
  ## Appendix: How to verify full parameter support
109
110
 
@@ -117,14 +118,16 @@ Parameter configuration: `lastDay` = `add_days('yyyy-MM-dd', -1)`
117
118
 
118
119
  If the result is yesterday's date (e.g., `2023-11-11`), your account is in the rollout scope and full parameter functionality is supported. If `${lastDay}` is not substituted, it is not yet supported.
119
120
 
120
- ---
121
+ ***
121
122
 
122
123
  ## Related Documentation
123
124
 
124
- | Document | Description |
125
- | ---- | ---- |
126
- | [Task Parameter Syntax Reference](task_param_reference.md) | Complete syntax and quick-reference for system built-in parameters, time expressions, and built-in time functions |
127
- | [Task Parameter Examples](task_param_examples.md) | Complete business scenario examples for daily reports, monthly reports, weekly reports, timestamp queries, and FAQ |
128
- | [Task Development and Scheduling](task-develop.md) | Creating, scheduling, and operating SQL tasks in Studio |
129
- | [Workflow (Composite Task)](composite_task.md) | Orchestrate multiple parameterized tasks into a DAG with unified scheduling |
130
- | [Python Task](python-task.md) | Using parameters in Python tasks |
125
+ | Document | Description |
126
+ | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
127
+ | [Task Parameter Syntax Reference](task_param_reference.md) | Complete syntax and quick-reference for system built-in parameters, time expressions, and built-in time functions |
128
+ | [Task Parameter Examples](task_param_examples.md) | Complete business scenario examples for daily reports, monthly reports, weekly reports, timestamp queries, and FAQ |
129
+ | [Task Development and Scheduling](task-develop.md) | Creating, scheduling, and operating SQL tasks in Studio |
130
+ | [Workflow (Composite Task)](composite_task.md) | Orchestrate multiple parameterized tasks into a DAG with unified scheduling |
131
+ | [Python Task](python-task.md) | Using parameters in Python tasks |
132
+
133
+ ^
@@ -12,22 +12,22 @@ The system provides a set of commonly used parameters that you can use directly
12
12
 
13
13
  ### Date and Time Parameters
14
14
 
15
- | Parameter name | Format | Description | Example (reference time: 2023-09-22 18:00:00) |
16
- | ---- | ---- | ---- | ---- |
17
- | `bizdate` | yyyyMMdd | Business date (scheduled time minus 1 day) | 20230921 |
18
- | `sys_biz_day` | yyyy-MM-dd | Business date | 2023-09-21 |
19
- | `sys_biz_datetime` | yyyy-MM-dd HH:mm:ss | Business datetime | 2023-09-21 18:00:00 |
20
- | `sys_plan_day` | yyyy-MM-dd | Scheduled date | 2023-09-22 |
21
- | `sys_plan_datetime` | yyyy-MM-dd HH:mm:ss | Scheduled datetime | 2023-09-22 18:00:00 |
22
- | `sys_plan_timestamp` | 13-digit timestamp | Scheduled timestamp (milliseconds) | 1695463200000 |
15
+ | Parameter name | Format | Description | Example (reference time: 2023-09-22 18:00:00) |
16
+ | -------------------- | -------------------- | ------------------------------------------ | --------------------------------------------- |
17
+ | `bizdate` | yyyyMMdd | Business date (scheduled time minus 1 day) | 20230921 |
18
+ | `sys_biz_day` | yyyy-MM-dd | Business date | 2023-09-21 |
19
+ | `sys_biz_datetime` | yyyy-MM-dd HH\:mm:ss | Business datetime | 2023-09-21 18:00:00 |
20
+ | `sys_plan_day` | yyyy-MM-dd | Scheduled date | 2023-09-22 |
21
+ | `sys_plan_datetime` | yyyy-MM-dd HH\:mm:ss | Scheduled datetime | 2023-09-22 18:00:00 |
22
+ | `sys_plan_timestamp` | 13-digit timestamp | Scheduled timestamp (milliseconds) | 1695463200000 |
23
23
 
24
24
  ### Task Information Parameters
25
25
 
26
- | Parameter name | Description | Example | Notes |
27
- | ---- | ---- | ---- | ---- |
28
- | `sys_task_id` | Task ID | 1002 | Scheduled run only |
29
- | `sys_task_name` | Task name | demo_task | Scheduled run only |
30
- | `sys_task_owner` | Task owner | UAT_TEST | Scheduled run only |
26
+ | Parameter name | Description | Example | Notes |
27
+ | ---------------- | ----------- | ---------- | ------------------ |
28
+ | `sys_task_id` | Task ID | 1002 | Scheduled run only |
29
+ | `sys_task_name` | Task name | demo\_task | Scheduled run only |
30
+ | `sys_task_owner` | Task owner | UAT\_TEST | Scheduled run only |
31
31
 
32
32
  ### Usage Examples
33
33
 
@@ -45,12 +45,12 @@ SELECT * FROM table WHERE create_time >= ${start_ts};
45
45
 
46
46
  ### Usage Recommendations
47
47
 
48
- - **Business date scenarios**: prefer `bizdate` or `sys_biz_day`
49
- - **When hours, minutes, and seconds are needed**: use `sys_biz_datetime` or `sys_plan_datetime`
50
- - **Timestamp calculations**: use `sys_plan_timestamp`
51
- - **Audit logging**: use the `sys_task_*` parameters to record task information
48
+ * **Business date scenarios**: prefer `bizdate` or `sys_biz_day`
49
+ * **When hours, minutes, and seconds are needed**: use `sys_biz_datetime` or `sys_plan_datetime`
50
+ * **Timestamp calculations**: use `sys_plan_timestamp`
51
+ * **Audit logging**: use the `sys_task_*` parameters to record task information
52
52
 
53
- ---
53
+ ***
54
54
 
55
55
  ## Time Expressions
56
56
 
@@ -68,17 +68,17 @@ $[time_format, offset1, offset2, ...] # Multiple offsets (applied in sequence)
68
68
 
69
69
  Time expressions follow the **ISO-8601 standard** and are strictly case-sensitive.
70
70
 
71
- | Element | Meaning | Example |
72
- | ---- | ---- | ---- |
73
- | `yyyy` | Four-digit year | 2023 |
74
- | `yy` | Two-digit year | 23 |
75
- | `MM` | Two-digit month (01-12) | 09 |
76
- | `dd` | Two-digit day (01-31) | 22 |
77
- | `HH` | 24-hour hour (00-23) | 18 |
78
- | `mm` | Minute (00-59) | 59 |
79
- | `ss` | Second (00-59) | 49 |
80
- | `.SSS` | Millisecond | 0.377 |
81
- | `ZZ` | Time zone | +08:00 |
71
+ | Element | Meaning | Example |
72
+ | ------- | ----------------------- | ------- |
73
+ | `yyyy` | Four-digit year | 2023 |
74
+ | `yy` | Two-digit year | 23 |
75
+ | `MM` | Two-digit month (01-12) | 09 |
76
+ | `dd` | Two-digit day (01-31) | 22 |
77
+ | `HH` | 24-hour hour (00-23) | 18 |
78
+ | `mm` | Minute (00-59) | 59 |
79
+ | `ss` | Second (00-59) | 49 |
80
+ | `.SSS` | Millisecond | 0.377 |
81
+ | `ZZ` | Time zone | +08:00 |
82
82
 
83
83
  > ⚠️ Common mistakes: `YYYY` (uppercase Y is not supported), `yyyy-mm-dd` (lowercase m is minute, not month), `hh` (lowercase h is 12-hour format). Correct form: `yyyy-MM-dd HH:mm:ss`.
84
84
 
@@ -96,16 +96,16 @@ $[yyyy-MM-dd HH:mm:ss.SSSZZ] → 2023-09-22 18:00:00.377+08:00
96
96
 
97
97
  ### Time Offsets
98
98
 
99
- | Unit | Abbreviation | Full name | Example |
100
- | ---- | ---- | ---- | ---- |
101
- | Millisecond | ms | milli/millisecond | 400ms |
102
- | Second | s | sec/second | 30s |
103
- | Minute | m | min/minute | 15m |
104
- | Hour | h | hour | 2h |
105
- | Day | d | day | -1d |
106
- | Week | w | week | -1w |
107
- | Month | mon | month | -1mon |
108
- | Year | y | year | -1y |
99
+ | Unit | Abbreviation | Full name | Example |
100
+ | ----------- | ------------ | ----------------- | ------- |
101
+ | Millisecond | ms | milli/millisecond | 400ms |
102
+ | Second | s | sec/second | 30s |
103
+ | Minute | m | min/minute | 15m |
104
+ | Hour | h | hour | 2h |
105
+ | Day | d | day | -1d |
106
+ | Week | w | week | -1w |
107
+ | Month | mon | month | -1mon |
108
+ | Year | y | year | -1y |
109
109
 
110
110
  ### Offset Examples
111
111
 
@@ -121,7 +121,7 @@ $[yyyy-MM-dd, -1y, -1mon, -1d] → Last year, last month, yesterday
121
121
  $[yyyyMMdd, 1mon, -7d] → Next month minus 7 days
122
122
  ```
123
123
 
124
- ---
124
+ ***
125
125
 
126
126
  ## Built-in Time Functions
127
127
 
@@ -270,53 +270,55 @@ today_start = biz_timestamp() → 1695312000000 (2023-09-22 00:00:00)
270
270
  yesterday_start = biz_timestamp(-1d) → 1695225600000
271
271
  ```
272
272
 
273
- ---
273
+ ***
274
274
 
275
275
  ## Quick Reference
276
276
 
277
277
  ### Common Time Requirements
278
278
 
279
- | Requirement | Parameter configuration | Example result (reference: 2023-09-22) |
280
- | ---- | ---- | ---- |
281
- | Today | `$[yyyy-MM-dd]` or `sys_plan_day` | 2023-09-22 |
282
- | Yesterday | `$[yyyy-MM-dd, -1d]` or `sys_biz_day` | 2023-09-21 |
283
- | Same day last week | `$[yyyy-MM-dd, -7d]` | 2023-09-15 |
284
- | Same day last month | `$[yyyy-MM-dd, -1mon]` | 2023-08-22 |
285
- | First day of this month | `first_day_of_month()` | 2023-09-01 |
286
- | Last day of this month | `last_day_of_month()` | 2023-09-30 |
287
- | First day of last month | `first_day_of_month('yyyy-MM-dd', '-1mon')` | 2023-08-01 |
288
- | Last day of last month | `last_day_of_month('yyyy-MM-dd', '-1mon')` | 2023-08-31 |
289
- | This Monday | `first_day_of_week()` | 2023-09-18 |
290
- | This Sunday | `last_day_of_week()` | 2023-09-24 |
291
- | Last Monday | `first_day_of_week('yyyy-MM-dd', '-1w')` | 2023-09-11 |
292
- | Last Sunday | `last_day_of_week('yyyy-MM-dd', '-1w')` | 2023-09-17 |
293
- | This Tuesday | `get_day_of_week('yyyy-MM-dd', 2)` | 2023-09-19 |
294
- | Last year yesterday | `$[yyyy-MM-dd, -1y, -1d]` | 2022-09-21 |
295
- | Today at 00:00 timestamp | `biz_timestamp()` | 1695312000000 |
296
- | Current timestamp | `timestamp()` | 1695463200000 |
279
+ | Requirement | Parameter configuration | Example result (reference: 2023-09-22) |
280
+ | ------------------------ | ------------------------------------------- | -------------------------------------- |
281
+ | Today | `$[yyyy-MM-dd]` or `sys_plan_day` | 2023-09-22 |
282
+ | Yesterday | `$[yyyy-MM-dd, -1d]` or `sys_biz_day` | 2023-09-21 |
283
+ | Same day last week | `$[yyyy-MM-dd, -7d]` | 2023-09-15 |
284
+ | Same day last month | `$[yyyy-MM-dd, -1mon]` | 2023-08-22 |
285
+ | First day of this month | `first_day_of_month()` | 2023-09-01 |
286
+ | Last day of this month | `last_day_of_month()` | 2023-09-30 |
287
+ | First day of last month | `first_day_of_month('yyyy-MM-dd', '-1mon')` | 2023-08-01 |
288
+ | Last day of last month | `last_day_of_month('yyyy-MM-dd', '-1mon')` | 2023-08-31 |
289
+ | This Monday | `first_day_of_week()` | 2023-09-18 |
290
+ | This Sunday | `last_day_of_week()` | 2023-09-24 |
291
+ | Last Monday | `first_day_of_week('yyyy-MM-dd', '-1w')` | 2023-09-11 |
292
+ | Last Sunday | `last_day_of_week('yyyy-MM-dd', '-1w')` | 2023-09-17 |
293
+ | This Tuesday | `get_day_of_week('yyyy-MM-dd', 2)` | 2023-09-19 |
294
+ | Last year yesterday | `$[yyyy-MM-dd, -1y, -1d]` | 2022-09-21 |
295
+ | Today at 00:00 timestamp | `biz_timestamp()` | 1695312000000 |
296
+ | Current timestamp | `timestamp()` | 1695463200000 |
297
297
 
298
298
  ### Time Function Quick Reference
299
299
 
300
- | Function | Purpose | Return type |
301
- | ---- | ---- | ---- |
302
- | `first_day_of_month()` | First day of the current month | Date string |
303
- | `last_day_of_month()` | Last day of the current month | Date string |
304
- | `first_day_of_week()` | First day of the current week (Monday) | Date string |
305
- | `last_day_of_week()` | Last day of the current week (Sunday) | Date string |
306
- | `day_of_week()` | Day of the week (1-7) | Integer |
307
- | `week_of_month()` | Week number within the current month | Integer |
308
- | `week_of_year()` | Week number within the current year | Integer |
309
- | `get_day_of_week()` | Date of a specific day of the week | Date string |
310
- | `timestamp()` | Millisecond timestamp (based on scheduled time) | 13-digit integer |
311
- | `biz_timestamp()` | Millisecond timestamp (based on 00:00:00) | 13-digit integer |
312
- | `unix_timestamp()` | Second timestamp | 10-digit integer |
313
- | `biz_unix_timestamp()` | Business second timestamp | 10-digit integer |
314
- | `biz_format()` | Business time formatting | String |
315
-
316
- ---
300
+ | Function | Purpose | Return type |
301
+ | ---------------------- | ----------------------------------------------- | ---------------- |
302
+ | `first_day_of_month()` | First day of the current month | Date string |
303
+ | `last_day_of_month()` | Last day of the current month | Date string |
304
+ | `first_day_of_week()` | First day of the current week (Monday) | Date string |
305
+ | `last_day_of_week()` | Last day of the current week (Sunday) | Date string |
306
+ | `day_of_week()` | Day of the week (1-7) | Integer |
307
+ | `week_of_month()` | Week number within the current month | Integer |
308
+ | `week_of_year()` | Week number within the current year | Integer |
309
+ | `get_day_of_week()` | Date of a specific day of the week | Date string |
310
+ | `timestamp()` | Millisecond timestamp (based on scheduled time) | 13-digit integer |
311
+ | `biz_timestamp()` | Millisecond timestamp (based on 00:00:00) | 13-digit integer |
312
+ | `unix_timestamp()` | Second timestamp | 10-digit integer |
313
+ | `biz_unix_timestamp()` | Business second timestamp | 10-digit integer |
314
+ | `biz_format()` | Business time formatting | String |
315
+
316
+ ***
317
317
 
318
318
  ## Related Documentation
319
319
 
320
- - [Task Parameters](task_param.md) — concepts, quick start, parameter types
321
- - [Task Parameter Examples](task_param_examples.md) — complete business scenarios for daily, monthly, and weekly reports
322
- - [Task Development and Scheduling](task-develop.md) — creating and scheduling SQL tasks in Studio
320
+ * [Task Parameters](task_param.md) — concepts, quick start, parameter types
321
+ * [Task Parameter Examples](task_param_examples.md) — complete business scenarios for daily, monthly, and weekly reports
322
+ * [Task Development and Scheduling](task-develop.md) — creating and scheduling SQL tasks in Studio
323
+
324
+ ^