@clickzetta/cz-cli-darwin-x64 0.5.16 → 0.5.18

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
@@ -16,25 +16,25 @@ Singdata Lakehouse Studio's real-time multi-table synchronization supports multi
16
16
 
17
17
  Navigate to Development -> Tasks, click "+", select "Real-time Multi-table Synchronization", and create a new real-time multi-table synchronization task.
18
18
 
19
- :-: ![](.topwrite/assets/image_1736147975347.png =494)
19
+
20
20
 
21
21
  Task Name: 06\_multi\_table\_rt\_sync\_from\_pg
22
22
 
23
23
  ##### Select "PostgreSQL" as the Source Data
24
24
 
25
- :-: ![](.topwrite/assets/image_1736147983573.png =502)
25
+
26
26
 
27
27
  ##### Select Synchronization Objects
28
28
 
29
29
  Singdata Lakehouse Studio will automatically synchronize the source database structure for selection:
30
30
 
31
- :-: ![](.topwrite/assets/image_1736147992225.png =467)
31
+
32
32
 
33
33
  ##### Database CDC Configuration
34
34
 
35
35
  Create a Slot
36
36
 
37
- :-: ![](.topwrite/assets/image_1736148001087.png =459)
37
+
38
38
 
39
39
  Plugin Type: pgoutput
40
40
 
@@ -44,49 +44,45 @@ Slot Name: slot\_for\_multi\_table\_ingest\_demo
44
44
 
45
45
  Rule Expression: multitable\_sync\_{SOURCE\_TABLE}. Add the prefix multitable\_sync\_{SOURCE\_TABLE} to the target table to distinguish it from tables synchronized by other methods.
46
46
 
47
- Check field mapping to ensure all mappings are successful:
47
+ Check field mapping to ensure all mappings are successful.
48
48
 
49
- :-: ![](.topwrite/assets/image_1736148015509.png =445)
50
49
 
51
50
  ##### Configure Synchronization Rules
52
51
 
53
- :-: ![](.topwrite/assets/image_1736148027202.png =443)
52
+
54
53
 
55
54
  ##### Submit
56
55
 
57
- Submit the real-time multi-table synchronization task after configuration:
56
+ Submit the real-time multi-table synchronization task after configuration.
58
57
 
59
- :-: ![](.topwrite/assets/image_1736148034594.png =427)
60
58
 
61
59
  ##### Operations and Maintenance
62
60
 
63
61
  Maintain the real-time multi-table synchronization task:
64
62
 
65
- :-: ![](.topwrite/assets/image_1736148045501.png =425)
63
+
66
64
 
67
65
  ##### Start
68
66
 
69
67
  Start the real-time multi-table synchronization task:
70
68
 
71
- :-: ![](.topwrite/assets/image_1736148052375.png =426)
72
69
 
73
- For the first start of this real-time multi-table synchronization task, select "Stateless Start" and "Full Data Synchronization":
74
70
 
75
- :-: ![](.topwrite/assets/image_1736148058726.png =426)
71
+ For the first start of this real-time multi-table synchronization task, select "Stateless Start" and "Full Data Synchronization".
72
+
73
+
76
74
 
77
75
  After starting, you can view the detailed status of the task. Once the full synchronization is complete, the system will automatically begin incremental real-time synchronization.
78
76
 
79
77
  ##### Progress Monitoring
80
78
 
81
- Full synchronization in progress:
79
+ Full synchronization in progress.
82
80
 
83
- :-: ![](.topwrite/assets/image_1736148083158.png =446)
84
81
 
85
82
  Full synchronization complete.
86
83
 
87
- Real-time synchronization begins:
84
+ Real-time synchronization begins.
88
85
 
89
- :-: ![](.topwrite/assets/image_1736148107686.png =430)
90
86
 
91
87
  ##### Incremental Real-time Synchronization
92
88
 
@@ -236,7 +232,6 @@ python rt_data_generate_insert_into_pg.py 100000 100 10
236
232
 
237
233
  In Singdata Lakehouse Studio, view the real-time synchronization progress:
238
234
 
239
- :-: ![](.topwrite/assets/image_1736148122833.png =484)
240
235
 
241
236
  #### Next Steps
242
237
 
@@ -16,7 +16,6 @@ Suitable for manually importing small amounts of data, user debugging, and testi
16
16
 
17
17
  Navigate to Development -> Tasks, and click "+" to create a new SQL task (both methods below are implemented in the same task).
18
18
 
19
- :-: ![](.topwrite/assets/image_1736148597217.png =470)
20
19
 
21
20
  You can use the `INSERT INTO VALUES` statement to directly insert data. Multiple records are separated by commas.
22
21
  ```SQL
@@ -191,7 +191,7 @@ Massive device data continuously written via Kafka; Dynamic Tables aggregate dev
191
191
 
192
192
  ## Ecosystem Compatibility
193
193
 
194
- Singdata Lakehouse natively supports Apache Iceberg format and supports direct read/write of Delta Lake, Hudi, and Paimon as external tables — existing data lake assets can be onboarded without migration. On the compute ecosystem side, [Spark Connector](spark-connector-summary.md), [Flink Connector](flink-write-connector.md), and Trino Connector are provided for smooth integration with existing big data pipelines. On the BI side, FineBI, Tableau, Superset, Metabase, and PowerBI have all completed integration certification.
194
+ Singdata Lakehouse natively supports Apache Iceberg format and supports direct read/write of Delta Lake, Hudi, and Paimon as external tables — existing data lake assets can be onboarded without migration. On the compute ecosystem side, [Spark Connector](spark-connector-summary.md) and [Flink Connector](flink-write-connector.md) are provided for smooth integration with existing big data pipelines. On the BI side, FineBI, Tableau, Superset, Metabase, and PowerBI have all completed integration certification.
195
195
 
196
196
  ## Start Here
197
197
 
@@ -10,20 +10,19 @@ This document aims to guide users on how to configure and manage data sources to
10
10
 
11
11
  First, log in to the Lakehouse product console. On the console homepage, select the "Management" module and click to enter the "Data Source" page. You will see a list of data sources showing all currently configured data sources.
12
12
 
13
- ![](.topwrite/assets/image_1740137071389.png =640)
13
+ :-: ![](.topwrite/assets/image_1740137071389.png =640)
14
14
 
15
15
  2. **Create a New Data Source**
16
16
 
17
17
  On the data source list page, click the "New Data Source" button in the upper right corner. At this point, you need to select the data source type. Lakehouse supports multiple data source types, including but not limited to MySQL, Oracle, SQL Server, etc.
18
18
 
19
- ![](.topwrite/assets/image_1740137096346.png =640)
20
-
19
+ :-: ![](.topwrite/assets/image_1740137096346.png =640)
21
20
 
22
21
  3. **Fill in the Data Source Definition and Test Connectivity**
23
22
 
24
23
  Based on the data source type you selected, fill in the corresponding connection information. For example, for a MySQL data source, you need to provide the database address, port, username, password, etc. After filling in, click the "Test Connection" button to ensure the information provided is correct.
25
24
 
26
- ![](.topwrite/assets/image_1740137122891.png =640)
25
+ :-: ![](.topwrite/assets/image_1740137122891.png =640)
27
26
 
28
27
  ## Connect to Data Sources within a VPC via SSH Tunnel
29
28
 
@@ -50,8 +49,7 @@ On the new data source page, enable the "Connect via SSH Tunnel" option. Fill in
50
49
  * **SSH Username**: Enter the username for SSH login.
51
50
  * **SSH Password**: Enter the corresponding SSH login password.
52
51
 
53
- ![](.topwrite/assets/image_1740137146102.png =640)
54
-
52
+ :-: ![](.topwrite/assets/image_1740137146102.png =640)
55
53
 
56
54
  After completing the above configuration, click the "Test Connection" button. If the connection is successful, you will see a green checkmark prompt. This means that the data synchronization service can establish a network connection with the data source within the VPC via SSH Tunnel when the task starts.
57
55
 
@@ -79,4 +77,4 @@ After completing the above configuration, click the "Test Connection" button. If
79
77
  3. Enable the "Connect via SSH Tunnel" option and fill in the relevant information of the ECS server within the VPC.
80
78
  4. Click "Test Connection". After confirming the connection is successful, click the "Save" button to complete the data source configuration.
81
79
 
82
- ^
80
+ ^
@@ -1,127 +1,171 @@
1
- # Singdata Lakehouse Command Line Client User Guide
1
+ # Connect to Lakehouse Using the Command Line Client
2
2
 
3
- This document aims to help you understand how to install, configure, and use the Singdata Lakehouse command line client. Through this guide, you will be able to smoothly connect to the Singdata Lakehouse service instance and execute various SQL commands.
3
+ This article describes how to install, configure, and use the sqlline-based Lakehouse command line client.
4
+
5
+ > 💡 **cz-cli is recommended**: cz-cli is the upgraded replacement for this tool (sqlline), offering a more modern terminal experience—Profile management (configure once, reuse globally), structured JSON output, task operations commands, AI Agent integration, and more. The sqlline client is no longer actively updated; new users are advised to use cz-cli directly.
6
+ >
7
+ > → [Connect using the cz-cli command line tool](connect-with-cz-cli.md)
8
+
9
+ ---
4
10
 
5
11
  ## Prerequisites
6
12
 
7
- Before using the client, please ensure the following conditions are met:
13
+ Before using the client, ensure the following conditions are met:
8
14
 
9
- 1. Your device has Java 8 or a higher version installed.
10
- 2. You have registered an account on the Singdata official website and created a Lakehouse service instance.
11
- 3. You have created a workspace for connection access.
12
- 4. The user identity using the client has been added to the workspace and authorized for access.
15
+ 1. Your device has Java 8 or a higher version installed
16
+ 2. You have registered an account on the Singdata platform and created a Lakehouse service instance
17
+ 3. You have created a workspace for connection access
18
+ 4. The user identity using the client has been added to the workspace and authorized for access
19
+
20
+ ---
13
21
 
14
22
  ## Installing the Client
15
23
 
16
- The Singdata Lakehouse command line client is developed based on the open-source SQL Line project. Please follow the steps below to install and configure the client:
24
+ The Lakehouse command line client is a secondary development of the open-source SQL Line project. Follow these steps to install and configure the client:
25
+
26
+ 1. Download the client installation package [sqlline_cz.tar.gz](https://autolake-dev-beijing.oss-cn-beijing.aliyuncs.com/clickzetta-tool/release/sqlline_cz.tar.gz) from the public network or obtain it from Singdata staff
27
+ 2. Unzip the installation package file to get the client tool's executable and configuration files:
28
+
29
+ ```bash
30
+ tar -zxvf sqlline_cz.tar.gz
31
+ ```
32
+
33
+ Extracted contents:
17
34
 
18
- 1. Download the client installation package [sqlline\_cz.tar.gz](https://autolake-dev-beijing.oss-cn-beijing.aliyuncs.com/clickzetta-tool/release/sqlline_cz.tar.gz) from the public network or obtain it from Singdata staff.
19
- 2. Unzip the installation package file, and you will get the executable file and configuration file of the client tool.
20
35
  ```
21
- % tar -zxvf sqlline_cz.tar.gz
22
- x sqlline_cz/
23
- x sqlline_cz/example.properties
24
- x sqlline_cz/log4j.properties
25
- x sqlline_cz/setup.sh
26
- x sqlline_cz/sqlline
27
- x sqlline_cz/sqlline-2.13.0-SNAPSHOT-jar-with-dependencies.jar
36
+ sqlline_cz/
37
+ ├── example.properties
38
+ ├── log4j.properties
39
+ ├── setup.sh
40
+ ├── sqlline
41
+ └── sqlline-2.13.0-SNAPSHOT-jar-with-dependencies.jar
28
42
  ```
43
+
44
+ ---
45
+
29
46
  ## Initialize Connection Environment
30
47
 
31
48
  1. Enter the working directory:
32
- ```
49
+
50
+ ```bash
33
51
  cd sqlline_cz
34
52
  ```
35
- 2. Initialize Connection Environment:
36
- The main purpose is to download the latest JDBC package and place it in the sqlline\_cz directory. You can also download the latest JDBC package from the links below and place it in the sqlline\_cz directory.
37
53
 
38
- * [Download Link One](https://mvnrepository.com/artifact/com.clickzetta/clickzetta-java)
39
- * [Download Link Two](https://central.sonatype.com/artifact/com.clickzetta/clickzetta-java/versions)
40
- ```
54
+ 2. Initialize the connection environment, downloading the latest JDBC driver:
55
+
56
+ ```bash
41
57
  sh setup.sh
42
58
  ```
59
+
60
+ If the setup script fails to download, manually download the JDBC driver and place it in the `sqlline_cz` directory:
61
+
62
+ - [Maven Central](https://central.sonatype.com/artifact/com.clickzetta/clickzetta-java/versions)
63
+ - [MVN Repository](https://mvnrepository.com/artifact/com.clickzetta/clickzetta-java)
64
+
65
+ ---
66
+
43
67
  ## Configure Client Connection
44
68
 
45
69
  ### Method 1: Specify Connection Parameters via Command Line
46
70
 
47
- Command parameters for connecting via specified method:
48
- ```
49
- sh sqlline -d com.clickzetta.client.jdbc.ClickZettaDriver -u "<JDBC URL>" -n <user_name> -p <password>
71
+ ```bash
72
+ sh sqlline -d com.clickzetta.client.jdbc.ClickZettaDriver \
73
+ -u "jdbc:clickzetta://<instance>.<region>.api.clickzetta.com/<workspace>?schema=<schema>&vcluster=<vcluster>" \
74
+ -n <user_name> \
75
+ -p <password>
50
76
  ```
51
- JDBC URL format:
77
+
78
+ **JDBC URL format:**
79
+
52
80
  ```
53
- jdbc:clickzetta://<Lakehouse service instance name>.api.singdata.com/<workspace name>?schema=<default schema name>&virtualCluster=<compute cluster name>
81
+ jdbc:clickzetta://<instance_name>.<region_id>.api.clickzetta.com/<workspace_name>?schema=<schema_name>&vcluster=<vcluster_name>
54
82
  ```
55
- Parameter Description:
56
83
 
57
- * `<JDBC URL>`: The JDBC connection string for the current service instance. For the detailed format, see [JDBC Driver](jdbc-driver.md).
58
- * `<user_name>`: The username of the workspace member in the target workspace.
59
- * `<password>`: The password of the workspace member in the target workspace.
60
- * `schema`: The schema to be linked must be specified.
61
- * `virtualCluster`: The computing resources to be used must be specified.
84
+ **Parameter descriptions:**
62
85
 
63
- Example:
64
- ```
65
- sh sqlline -d com.clickzetta.client.jdbc.ClickZettaDriver -u "jdbc:clickzetta://<lakehouse_instance_name>.api.singdata.com/<workspace_name>?schema=<target_schema_name>&vcluster=<your_virtualcluster_name>" -n <user_name> -p <your_password>
86
+ | Parameter | Description |
87
+ |------|------|
88
+ | `-d` | JDBC driver class name, fixed as `com.clickzetta.client.jdbc.ClickZettaDriver` |
89
+ | `-u` | JDBC connection URL, see [JDBC Driver](JDBC-Driver.md) for full format |
90
+ | `-n` | Workspace member username |
91
+ | `-p` | Workspace member password |
92
+ | `schema` | Specifies the Schema to connect to, required |
93
+ | `vcluster` | Virtual Cluster to use, required |
94
+
95
+ **Example:**
96
+
97
+ ```bash
98
+ sh sqlline -d com.clickzetta.client.jdbc.ClickZettaDriver \
99
+ -u "jdbc:clickzetta://my_instance.cn-shanghai-alicloud.api.clickzetta.com/my_workspace?schema=public&vcluster=DEFAULT" \
100
+ -n data_user \
101
+ -p your_password
66
102
  ```
103
+
67
104
  ### Method 2: Specify Configuration File via Command Line
68
105
 
69
- The command line tool provides a configuration file template, which you can modify and then specify the configuration file in the command line to achieve service connection. The sample configuration file format is as follows:
70
- ```
71
- url=jdbc:clickzetta://<Lakehouse_instance_name>.api.singdata.com/<workspace_name>?schema=<schma_name>&virtualCluster=<vcluster_name>
106
+ 1. Modify the configuration file template `example.properties`:
107
+
108
+ ```properties
109
+ url=jdbc:clickzetta://<instance>.<region>.api.clickzetta.com/<workspace>?schema=<schema>&vcluster=<vcluster>
72
110
  driver=com.clickzetta.client.jdbc.ClickZettaDriver
73
111
  user=<your_user_name>
74
112
  password=<your_password>
75
113
  ```
76
- After modifying the template configuration file according to your service information and saving it, connect to the service by specifying the configuration file name through command parameters.
77
- ```
78
- $ sh sqlline properties <configuration file name>
79
- ```
80
- Example:
81
- ```
82
- $ sh sqlline properties test.properties
83
- sqlline version 1.13.0-SNAPSHOT
84
- 0: jdbc:clickzetta://xxxx.api.singdata.com>show tables;
114
+
115
+ 2. Connect using the configuration file:
116
+
117
+ ```bash
118
+ sh sqlline properties test.properties
85
119
  ```
86
- Singdata Lakehouse command line tool can create multiple different service connection configuration files at once. During use, you can quickly switch between service connections corresponding to different configuration files using the `!properties` command. The following example demonstrates switching from the configuration file test.properties to test.properties.1:
120
+
121
+ After connecting, use the `!properties` command to quickly switch to another configuration file within the session:
122
+
87
123
  ```
88
- sqlline> !properties test.properties
89
- Transaction isolation level TRANSACTION_REPEATABLE_READ is not supported. Default (TRANSACTION_READ_COMMITTED) will be used instead.
90
- 0: jdbc:clickzetta://xxxx.api.singdata.com> !properties test.properties.1
91
- Transaction isolation level TRANSACTION_REPEATABLE_READ is not supported. Default (TRANSACTION_READ_COMMITTED) will be used instead.
92
- 1: jdbc:clickzetta://yyyyy.api.singdata.com> !go 0
93
- 0: jdbc:clickzetta://xxxx.api.singdata.com>
124
+ 0: jdbc:clickzetta://xxxx.api.clickzetta.com> !properties test.properties.1
125
+ 1: jdbc:clickzetta://yyyy.api.clickzetta.com>
94
126
  ```
127
+
128
+ ---
129
+
95
130
  ## Running SQL Commands
96
131
 
97
- After a successful connection, you can execute Lakehouse SQL commands in the command line client. Here are some examples of SQL commands:
132
+ After a successful connection, you can execute Lakehouse SQL commands in the command line client:
98
133
 
99
- Switch the vcluster and schema to use:
100
- ```
101
- use vcluster default;
134
+ ```sql
135
+ -- Switch Virtual Cluster and Schema
136
+ use vcluster DEFAULT;
102
137
  use schema nyc_taxi_data;
103
- ```
104
138
 
105
- View the tables in the current schema:
106
- ```
139
+ -- View tables in the current Schema
107
140
  show tables;
108
- ```
109
- ![](.topwrite/assets/image_1699879449976.png)
110
141
 
111
- Query data:
112
- ```
113
- select * from fhv_trips_staging limit 10;
142
+ -- Query data
143
+ select * from fhv_trips_staging limit 10;
114
144
  ```
115
- ![](.topwrite/assets/image_1699879794959.png)
145
+
146
+ ---
116
147
 
117
148
  ## Exit Client
149
+
118
150
  ```
119
151
  !quit
120
152
  ```
121
- ## Notes
122
153
 
123
- By setting the following environment variables in the current environment, you can enable debug mode, output log files, and facilitate troubleshooting.
124
- ```
154
+ ---
155
+
156
+ ## Enable Debug Logging
157
+
158
+ Enable debug mode by setting an environment variable to output log files for troubleshooting:
159
+
160
+ ```bash
125
161
  export SQLLINE_DEBUG_ENABLE=TRUE
126
162
  ```
127
163
 
164
+ ---
165
+
166
+ ## Related Documents
167
+
168
+ - [Connect using the cz-cli command line tool](connect-with-cz-cli.md) — Recommended alternative
169
+ - [JDBC Driver Connection](JDBC-Driver.md) — Full JDBC URL format and parameters
170
+ - [Connect to Lakehouse Tutorial](tutorial_connect_to_lakehouse.md) — Comparison of all connection methods
171
+
@@ -0,0 +1,151 @@
1
+ # Connecting to Lakehouse with cz-cli
2
+
3
+ cz-cli is the command-line tool for Singdata Lakehouse. It provides connection profile management, SQL execution, job operations, and more. Compared to JDBC clients, cz-cli uses **Profiles to manage connection information** — configure once, and all subsequent operations automatically use the same connection parameters without needing to re-enter a JDBC URL, username, or password every time.
4
+
5
+ ---
6
+
7
+ ## Prerequisites
8
+
9
+ 1. cz-cli is installed (see [cz-cli Installation and Setup Guide](setup_cz_cli.md))
10
+ 2. A Lakehouse instance exists and a workspace has been created
11
+ 3. Your user account has been added to the target workspace with appropriate permissions
12
+
13
+ ---
14
+
15
+ ## Configuring a Connection Profile
16
+
17
+ A Profile is a local configuration where cz-cli stores connection information. One Profile corresponds to one Lakehouse connection environment (instance + workspace + schema + Virtual Cluster). It is recommended to create a separate Profile for each environment such as production, test, and UAT.
18
+
19
+ ### Option 1: Create a Profile with Parameters (Recommended)
20
+
21
+ ```bash
22
+ cz-cli profile create <profile_name> \
23
+ --service <service> \
24
+ --instance <instance> \
25
+ --workspace <workspace> \
26
+ --schema <schema> \
27
+ --vcluster <vcluster> \
28
+ --username <username> \
29
+ --password '<password>'
30
+ ```
31
+
32
+ **Parameter descriptions:**
33
+
34
+ | Parameter | Description | How to obtain |
35
+ |------|------|---------|
36
+ | `--service` | Service endpoint address | See the cloud region table below |
37
+ | `--instance` | Instance ID | Instance name in the top-left of Studio homepage, or the `instanceId` parameter in the URL |
38
+ | `--workspace` | Workspace name | Dropdown at the top of Studio |
39
+ | `--schema` | Default schema | Run `SELECT CURRENT_SCHEMA()` after connecting |
40
+ | `--vcluster` | Default Virtual Cluster | Typically `DEFAULT` (general-purpose GP cluster) |
41
+ | `--username` | Login username | Your platform account |
42
+ | `--password` | Login password | Your platform password |
43
+
44
+ **Example: Configure Alibaba Cloud Shanghai production environment**
45
+
46
+ ```bash
47
+ cz-cli profile create prod_sh \
48
+ --service https://cn-shanghai-alicloud.api.clickzetta.com \
49
+ --instance f8866243 \
50
+ --workspace quick_start \
51
+ --schema semantic_model_test \
52
+ --vcluster DEFAULT \
53
+ --username qiliang \
54
+ --password 'your_password'
55
+ ```
56
+
57
+ ### Option 2: Create from a Connection String Generated in Studio
58
+
59
+ In Studio → Personal Settings → Developer Tools → CLI tab, select PAT or password authentication, click "Generate Connection String", copy it, and run it in the terminal.
60
+
61
+ ### Option 3: Create with a JDBC URL
62
+
63
+ ```bash
64
+ cz-cli profile create prod \
65
+ --jdbc "jdbc:clickzetta://<instance_name>.<service_endpoint>/<workspace_name>?username=<username>&password=<password>&schema=<schema>&virtualCluster=<vcluster>"
66
+ ```
67
+
68
+ ---
69
+
70
+ ## Verifying the Connection
71
+
72
+ ```bash
73
+ # View the list of created Profiles
74
+ cz-cli profile list
75
+
76
+ # Run a query using a specific Profile to verify the connection
77
+ cz-cli sql "SELECT 1" --profile prod_sh
78
+
79
+ # Set a commonly used Profile as default to omit --profile in future commands
80
+ cz-cli profile use prod_sh
81
+ ```
82
+
83
+ ---
84
+
85
+ ## Basic Operations After Connecting
86
+
87
+ ### Executing SQL
88
+
89
+ ```bash
90
+ # Query
91
+ cz-cli sql "SELECT * FROM silver.dim_player LIMIT 5" --sync
92
+
93
+ # DDL/DML (requires --write)
94
+ cz-cli sql "CREATE TABLE test (id INT)" --sync --write
95
+
96
+ # Execute a SQL file
97
+ cz-cli sql -f deploy.sql --write
98
+ ```
99
+
100
+ ### Switching Environments
101
+
102
+ ```bash
103
+ # View all Profiles
104
+ cz-cli profile list
105
+
106
+ # Switch to a different environment
107
+ cz-cli profile use prod_sh # production
108
+ cz-cli profile use uat # UAT
109
+ cz-cli profile use tencent_sh # Tencent Cloud Shanghai
110
+ ```
111
+
112
+ ---
113
+
114
+ ## Common Service Endpoints by Cloud and Region
115
+
116
+ | Cloud Platform | Region | Service Endpoint |
117
+ |--------|------|-----------------|
118
+ | Alibaba Cloud | Shanghai | `https://cn-shanghai-alicloud.api.clickzetta.com` |
119
+ | Tencent Cloud | Shanghai | `https://ap-shanghai-tencentcloud.api.clickzetta.com` |
120
+ | Tencent Cloud | Beijing | `https://ap-beijing-tencentcloud.api.clickzetta.com` |
121
+ | Tencent Cloud | Guangzhou | `https://ap-guangzhou-tencentcloud.api.clickzetta.com` |
122
+ | AWS | Beijing | `https://cn-north-1-aws.api.clickzetta.com` |
123
+ | AWS | Singapore | `https://ap-southeast-1-aws.api.singdata.com` |
124
+
125
+ > **Tip**: If you are unsure about the endpoint, go to Studio → Personal Settings → Developer Tools → CLI tab and copy the complete connection command, which includes the correct Service address.
126
+
127
+ ---
128
+
129
+ ## Troubleshooting
130
+
131
+ ### Connection Timeout or Refused
132
+
133
+ Check whether the network can reach the Service endpoint (production environments typically require a proxy or bastion host). Verify that the instance ID and workspace name are correct.
134
+
135
+ ### Schema or Virtual Cluster Not Found
136
+
137
+ Run `cz-cli sql "SHOW SCHEMAS"` to list available schemas, and `cz-cli sql "SHOW VCLUSTERS"` to list available Virtual Clusters. Confirm the spelling is correct, then recreate the Profile.
138
+
139
+ ### Authentication Failed
140
+
141
+ Verify the username and password are correct. If using PAT authentication, check whether the PAT has expired (regenerate it if it has).
142
+
143
+ ---
144
+
145
+ ## Related Documentation
146
+
147
+ - [cz-cli Installation and Setup Guide](setup_cz_cli.md) — Installation steps, PAT authentication, detailed Profile configuration
148
+ - [cz-cli SQL Execution and Data Exploration](cz-cli-sql.md) — SQL execution parameters, output format control
149
+ - [JDBC Driver Connection](JDBC-Driver.md) — Java application integration
150
+ - [Connecting with the CLI Client](connect-with-cli.md) — sqlline Java client
151
+ - [Connecting with SQLAlchemy](sqlalchemy.md) — Python SQLAlchemy integration
@@ -1,6 +1,6 @@
1
1
  # Streaming SQL
2
2
 
3
- > **[Preview Release]** This feature is currently in an invitation-only preview phase. If you need access, please contact our technical support team for assistance.
3
+ > \[**Preview Release**] This feature is currently in an invitation-only preview phase. If you need access, please contact our technical support team for assistance.
4
4
 
5
5
  Streaming SQL is a new SQL scheduling mode introduced by the Singdata Lakehouse platform. It uses a micro-batch processing mechanism that supports second-level data refresh intervals, similar to Spark Streaming's micro-batch execution model. Compared to traditional scheduled tasks, Streaming SQL significantly reduces the overhead of SQL submission and compilation by converting the submitted SQL into a persistent process that automatically triggers data execution and processing each time the configured interval elapses. Streaming SQL is designed for scenarios that require higher data freshness, and currently supports dt refresh and SQL processing that includes a table stream.
6
6
 
@@ -65,7 +65,6 @@ Streaming SQL brings greater flexibility and real-time capability to data proces
65
65
  ## Developing a Streaming SQL Task
66
66
 
67
67
  1. Create a new Streaming SQL node in Data Development.
68
- ![](.topwrite/assets/image_1727083278915.png)
69
68
 
70
69
  2. Write the SQL task.
71
70
 
@@ -80,32 +79,27 @@ Streaming SQL requirements:
80
79
  **Configure the Processing Interval**
81
80
 
82
81
  Click the configuration button to set the refresh interval — how often the data is processed. The minimum interval is currently 1 second.
83
- ![](.topwrite/assets/image_1727083303138.png)
84
82
 
85
83
  ## Running a Streaming SQL Task
86
84
 
87
85
  * Click the Submit button to submit the Streaming SQL job to the Operations Center.
88
-
89
- ![](.topwrite/assets/image_1727083345312.png)
90
-
91
86
  * Start the Streaming SQL job. Go to the Operations Center and click the Start button. The Streaming SQL job will begin running.
92
87
 
93
- ![](.topwrite/assets/image_1727083377948.png)
88
+ ^
94
89
 
95
90
  ## Operations
96
91
 
97
92
  * In the Operations Center, you can see a list of all Streaming SQL jobs in the current workspace.
98
- ![](.topwrite/assets/image_1727083398406.png)
99
93
 
100
94
  * You can monitor the running status of a Streaming SQL job using its job ID.
101
95
 
102
- ![](.topwrite/assets/image_1727083425696.png)
96
+ ^
103
97
 
104
98
  ## Monitoring and Alerts
105
99
 
106
100
  Monitoring and alerts support failure alerts for Streaming SQL task execution.
107
101
 
108
- ![](.topwrite/assets/image_1727083445006.png)
102
+ ^
109
103
 
110
104
  # Use Cases
111
105
 
@@ -156,12 +150,9 @@ AND source_stream.__change_type = 'INSERT' THEN
156
150
  INSERT VALUES (target.id, target.name, target.age);
157
151
  ```
158
152
 
159
- ![](.topwrite/assets/image_1727083470402.png)
153
+ ^
160
154
 
161
155
  4. Submit the Streaming SQL job and click Start in the Operations Center.
162
-
163
- ![](.topwrite/assets/image_1727083486439.png)
164
-
165
156
  5. After updating the source table data and waiting for the Streaming SQL job to complete, the SCD table will reflect the same changes.
166
157
 
167
158
  * Execute the following SQL in a regular SQL node:
@@ -185,7 +176,6 @@ SELECT "test_table_offset_consume",* FROM continuous_job.test_table_offset_consu
185
176
  6. Clean up the environment.
186
177
 
187
178
  * Stop the Streaming SQL job in the Operations Center.
188
- ![](.topwrite/assets/image_1727083510506.png)
189
179
 
190
180
  * Drop the schema.
191
181
 
@@ -235,11 +225,11 @@ GROUP BY
235
225
  refresh dynamic table event_group_minute;
236
226
  ```
237
227
 
238
- ![](.topwrite/assets/image_1727083531426.png)
228
+ ^
239
229
 
240
230
  * Start the Streaming SQL job to begin refreshing the dynamic table.
241
231
 
242
- ![](.topwrite/assets/image_1727083554105.png)
232
+ ^
243
233
 
244
234
  * Create a new regular SQL node, insert some data into the source table, and verify that the dynamic table is refreshed successfully.
245
235
 
@@ -254,3 +244,5 @@ refresh dynamic table event_group_minute;
254
244
  --Wait 10s and observe the dynamic table changes
255
245
  select * from event_group_minute;
256
246
  ```
247
+
248
+ ^