@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
@@ -251,3 +251,4 @@ DROP CONNECTION my_conn;
251
251
  - [Create External Schema](create-external-schema.md) — Mount an external database into the current workspace
252
252
  - [Create Storage Connection](create-storage-connection.md) — Storage Connection required by HMS
253
253
  - [Accessing Iceberg Tables in Snowflake Open Catalog](query-snowflake-open-catalog-iceberg-table.md)
254
+ - [Databricks Unity Catalog Federated Query Practice](databricks-external-catalog-practice.md) — Complete path from Databricks-side configuration to query verification
@@ -262,7 +262,7 @@ When refreshing a partitioned table, the `partition_spec` must be specified in t
262
262
  ```sql
263
263
  set dt.args.day='2024-11-13';
264
264
  set dt.args.hour='23';
265
- REFRESH DYNAMIC TABLE dt PARTITION (day='2024-11-13', hour='23');
265
+ REFRESH DYNAMIC TABLE dt PARTITION (day='2024-11-13', hour='23');
266
266
  ```
267
267
 
268
268
  * **Invalid specification**: Skip an intermediate level (e.g., skip hour and directly specify min).
@@ -270,7 +270,7 @@ When refreshing a partitioned table, the `partition_spec` must be specified in t
270
270
  -- Error example: hour is skipped
271
271
  set dt.args.day='2024-11-13';
272
272
  set dt.args.min='30';
273
- REFRESH DYNAMIC TABLE dt PARTITION (day='2024-11-13', min='30');
273
+ REFRESH DYNAMIC TABLE dt PARTITION (day='2024-11-13', min='30');
274
274
  ```
275
275
 
276
276
 
@@ -412,8 +412,8 @@ CREATE DYNAMIC TABLE doc_dt_user_purchase_analysis (
412
412
  )
413
413
  COMMENT 'Real-time user purchase behavior analysis table'
414
414
  REFRESH INTERVAL 1 HOUR VCLUSTER default
415
- AS
416
- SELECT
415
+ AS
416
+ SELECT
417
417
  u.user_id, u.user_name, u.city,
418
418
  COUNT(o.order_id) AS total_orders,
419
419
  SUM(o.amount) AS total_amount
@@ -1,6 +1,6 @@
1
- # Create Hive External Catalog
1
+ # Create External Catalog
2
2
 
3
- Steps to create Hive External Catalog
3
+ Steps to create a Hive External Catalog:
4
4
 
5
5
  1. [Create Storage Connection](create-storage-connection.md): First, you need to create a storage connection to access the object storage service.
6
6
  2. [Create Catalog Connection](create-catalog-connection.md): Use the storage connection information and Hive Metastore address to create a Catalog Connection.
@@ -13,11 +13,11 @@ CREATE EXTERNAL CATALOG catalog_name
13
13
  ```
14
14
  **Parameter Description**
15
15
 
16
- catalog\_api\_connection: The name of the catalog connection. Currently, only HIVE is supported. [Refer to creating catalog connection](create-catalog-connection.md)
16
+ * **catalog_api_connection**: The name of the Catalog Connection. Supports HMS (Hive), Databricks Unity Catalog, Iceberg REST Catalog, and other types. [Refer to creating Catalog Connection](create-catalog-connection.md)
17
17
 
18
- ### Example
18
+ ### Examples
19
19
 
20
- Example 1: Hive ON OSS
20
+ **Case 1: Hive ON OSS (Read and Write Supported)**
21
21
 
22
22
  * Create storage connection
23
23
  ```SQL
@@ -57,9 +57,10 @@ SHOW SCHEMAS IN my_external_catalog;
57
57
  -- Verify reading data, STORAGE CONNECTION permission will be used when reading data
58
58
  SELECT * FROM my_external_catalog.my_schema.my_table;
59
59
  ```
60
- Case 2: Hive ON COS
60
+
61
+ **Case 2: Hive ON COS (Read and Write Supported)**
62
+
61
63
  * Create storage connection
62
- ```
63
64
  ```sql
64
65
  CREATE STORAGE CONNECTION catalog_storage_cos
65
66
  TYPE COS
@@ -81,12 +82,6 @@ type hms
81
82
  hive_metastore_uris='xxxx:9083'
82
83
  storage_connection='catalog_storage_cos';
83
84
  ```
84
- ```SQL
85
- CREATE CATALOG CONNECTION if not exists catalog_api_connection
86
- type hms
87
- hive_metastore_uris='xxxx:9083'
88
- storage_connection='catalog_storage_oss';
89
- ```
90
85
  * Create Catalog
91
86
  ```SQL
92
87
  CREATE EXTERNAL CATALOG my_external_catalog
@@ -109,7 +104,8 @@ SHOW SCHEMAS IN my_external_catalog;
109
104
  -- Verify reading data, STORAGE CONNECTION permission will be used when reading data
110
105
  SELECT * FROM my_external_catalog.my_schema.my_table;
111
106
  ```
112
- Case 3: Hive ON S3
107
+
108
+ **Case 3: Hive ON S3 (Read and Write Supported)**
113
109
 
114
110
  * Create storage connection
115
111
  ```
@@ -155,7 +151,8 @@ SHOW SCHEMAS IN my_external_catalog;
155
151
  -- Verify reading data, STORAGE CONNECTION permission will be used when reading data
156
152
  SELECT * FROM my_external_catalog.my_schema.my_table;
157
153
  ```
158
- Case 4: Hive ON HDFS (Read Support)
154
+
155
+ **Case 4: Hive ON HDFS (Read Support)**
159
156
 
160
157
  * **Create Storage Connection**
161
158
 
@@ -196,25 +193,91 @@ Case 4: Hive ON HDFS (Read Support)
196
193
  SELECT * FROM my_external_catalog.my_schema.my_table;
197
194
  ```
198
195
 
196
+ > Lakehouse supports connecting to Hive Metastore and HDFS clusters with Kerberos authentication enabled.
197
+ >
198
+ > **Step 0: Prerequisites**
199
+ >
200
+ > 1. **Kerberos environment**: Ensure your Hive Metastore and HDFS cluster have Kerberos authentication enabled.
201
+ > 2. **Authentication files**: Prepare the following required Kerberos authentication files:
202
+ >
203
+ > * `krb5.conf`: Kerberos configuration file
204
+ > * `hive.keytab`: Keytab file for the service principal
205
+ >
206
+ > 3. **Network connectivity**: Ensure Singdata Lakehouse can access the Kerberos KDC and Hive Metastore services.
207
+ >
208
+ > **Step 1**: Upload the Kerberos config file and keytab file to a Volume using a [client tool](comprehensive_guide_to_ingesting_dbv_sql_put.md):
209
+ >
210
+ > ```
211
+ > -- upload krb5.conf
212
+ > PUT '/etc/krb5.conf' TO USER VOLUME FILE 'krb5.conf';
213
+ >
214
+ > -- upload keytab
215
+ > PUT '/path/to/hive.keytab' TO USER VOLUME FILE 'hive.keytab';
216
+ > ```
217
+ >
218
+ > **Step 2**: Create a Catalog Connection with Kerberos authentication using the following syntax:
219
+ >
220
+ > ```
221
+ > CREATE CATALOG CONNECTION conn_hms_kerberos_auth
222
+ > TYPE HMS
223
+ > AUTH_TYPE = 'kerberos'
224
+ > KERBEROS_CLIENT_PRINCIPAL = 'hive/localhost@YOUR-REALM.COM'
225
+ > KERBEROS_SERVICE_PRINCIPAL = 'hive/localhost@YOUR-REALM.COM'
226
+ > KERBEROS_KRB5_CONFIG_PATH = 'volume:user//~/krb5.conf'
227
+ > KERBEROS_KEYTAB_PATH = 'volume:user//~/hive.keytab'
228
+ > HIVE_METASTORE_URIS = 'thrift://your-hms-host:9083'
229
+ > STORAGE_CONNECTION = 'oss_conn_hz';
230
+ > ```
231
+ >
232
+ > | Parameter Name | Required | Description | Example |
233
+ > | -------------- | -------- | ----------- | ------- |
234
+ > | AUTH_TYPE | Yes | Authentication type, set to 'kerberos' | 'kerberos' |
235
+ > | KERBEROS\_CLIENT\_PRINCIPAL | Yes | Kerberos client principal | 'hive/localhost\@CZ.COM' |
236
+ > | KERBEROS\_SERVICE\_PRINCIPAL | Yes | Kerberos service principal | 'hive/localhost\@CZ.COM' |
237
+ > | KERBEROS\_KRB5\_CONFIG\_PATH | Yes | Path to krb5.conf file | 'volume://vol\_name/krb5.conf' |
238
+ > | KERBEROS\_KEYTAB\_PATH | Yes | Path to keytab file | 'volume://vol\_name/hive.keytab' |
239
+ >
240
+ > Connection parameters:
241
+ >
242
+ > `TYPE:` The connection type, set to `HMS`
243
+ >
244
+ > `HIVE_METASTORE_URIS:` The Hive Metastore service address `'thrift://host:9083'`
245
+ >
246
+ > `STORAGE_CONNECTION:` The associated storage connection name `'your_storage_conn'`
247
+ >
248
+ > ^
249
+ >
250
+ > **Step 3**: Create an External Schema based on the Kerberos-authenticated Catalog Connection
251
+ >
252
+ > ```
253
+ > CREATE EXTERNAL SCHEMA ext_kerberos_hms_sch
254
+ > CONNECTION conn_hms_kerberos_auth
255
+ > OPTIONS ('schema'='default');
256
+ > ```
257
+
258
+ ^
199
259
 
200
260
  # Create Databricks External Catalog
201
261
 
202
- Steps to create Databricks External Catalog
262
+ Steps to create Databricks External Catalog:
203
263
 
204
- 1. [Create Catalog Connection](create-catalog-connection.md): Store Databricks' Unity Catalog, connection authentication information.
264
+ 1. [Create Catalog Connection](create-catalog-connection.md): Store Databricks' Unity Catalog connection authentication information.
205
265
  2. Create External Catalog: Use Catalog Connection to create an external Catalog to access external data in the data lake.
206
266
 
207
267
  ## Syntax
208
268
  ```SQL
209
269
  CREATE EXTERNAL CATALOG catalog_name
210
- CONNECTION catalog_api_connection;
270
+ CONNECTION catalog_api_connection
211
271
  OPTIONS ('catalog'='catalog_name');
212
272
  ```
213
273
  **Parameter Description**
214
- - **`catalog_name`** :The name of the external Catalog. This name is used to identify the Catalog, and it must be unique and comply with naming conventions.
215
- - **`CONNECTION catalog_api_connection`** Specifies the connection to the external Catalog. `catalog_api_connection` is the name of a pre-created connection used to access the external Catalog.
216
- - **`OPTIONS ('catalog'='catalog_name')`** : Specifies the configuration options for the external Catalog. `'catalog'='catalog_name'`: Indicates the name of the external Catalog, `catalog_name` is the name of the target Catalog.
274
+ - **`catalog_name`**: The name of the external Catalog. This name is used to identify the Catalog, and it must be unique and comply with naming conventions.
275
+ - **`CONNECTION catalog_api_connection`**: Specifies the connection to the external Catalog. `catalog_api_connection` is the name of a pre-created connection used to access the external Catalog.
276
+ - **`OPTIONS ('catalog'='catalog_name')`**: Specifies the configuration options for the external Catalog. `'catalog'='catalog_name'`: Indicates the name of the external Catalog, `catalog_name` is the name of the target Catalog.
277
+
278
+ ^
217
279
 
218
280
  ## Related Guides
219
281
 
220
- - [Federated Query](sql_external_catalog_guide.md): Complete examples for querying external data sources such as Hive and Databricks through External Catalog.
282
+ - [Federated Query](SQL_External_Catalog_Guide.md): Complete examples for querying external data sources such as Hive and Databricks through External Catalog.
283
+ - [Databricks Unity Catalog Federated Query Practice](databricks-external-catalog-practice.md) — Complete examples from Databricks-side configuration, permissions, common errors, and federated query scenarios
@@ -19,6 +19,7 @@ CREATE TABLE [ IF NOT EXISTS ] table_name
19
19
  [SORTED BY (column_name [ ASC | DESC ])]
20
20
  [INTO num_buckets BUCKETS]
21
21
  ]
22
+ [ ROW FILTER filter_function ON (column_name,...) ]
22
23
  [ COMMENT 'table_comment' ]
23
24
  [PROPERTIES('data_lifecycle'='day_num')];
24
25
 
@@ -31,6 +32,7 @@ CREATE TABLE [ IF NOT EXISTS ] table_name
31
32
  column_name column_type
32
33
  { NOT NULL |
33
34
  PRIMARY KEY|
35
+ UNIQUE|
34
36
  IDENTITY[(seed)]|
35
37
  GENERATED ALWAYS AS ( expr ) |
36
38
  DEFAULT default_expression |
@@ -75,6 +77,26 @@ CREATE TABLE pk_table (
75
77
  PRIMARY key (id, pt)
76
78
  ) PARTITIONED BY (pt);
77
79
  ```
80
+ #### Unique Key (UNIQUE)
81
+
82
+ * **Unique Key (UNIQUE)** is used to declare that the values of a column or a combination of columns are unique. Unlike primary keys, UNIQUE is a **declarative constraint**: in the default mode (`DISABLE NOVALIDATE RELY`), uniqueness is not enforced at write time. It is primarily used to declare data semantics to the query optimizer to improve query optimization. UNIQUE columns allow NULL values. A table can have multiple UNIQUE constraints, and they can only be specified at table creation time. Both column-level and table-level (including composite) forms are supported. For detailed behavior, see [Unique Key Introduction](unique-key.md).
83
+
84
+ ```
85
+ -- Column-level
86
+ CREATE TABLE uk_table (id int UNIQUE, col string);
87
+
88
+ -- Table-level (single column)
89
+ CREATE TABLE uk_table (id int, col string, UNIQUE (id));
90
+
91
+ -- Table-level (composite)
92
+ CREATE TABLE uk_table (a int, b int, UNIQUE (a, b));
93
+
94
+ -- With modifier (default is DISABLE NOVALIDATE RELY)
95
+ CREATE TABLE uk_table (id int UNIQUE NORELY, col string);
96
+ ```
97
+
98
+ > ⚠️ If you need to enforce deduplication at write time, use a primary key (PRIMARY KEY); do not rely on the UNIQUE constraint.
99
+
78
100
  #### Auto-increment Column (IDENTITY\[(seed)])
79
101
 
80
102
  * **IDENTITY\[(seed**)]: Supports specifying auto-increment. It cannot guarantee that the values in the sequence are continuous (gapless), nor can it guarantee that the sequence values are allocated in a specific order. This is because other concurrent inserts may occur in the table. These limitations are part of the design to improve performance. For specific usage, refer to the [IDENTITY Column documentation](identity-column.md)
@@ -168,6 +190,27 @@ CREATE TABLE sales_data (
168
190
  )
169
191
  SORTED BY (sale_date DESC);
170
192
  ```
193
+ ### ROW FILTER (Row-Level Security)
194
+
195
+ > [Preview Release] This feature is currently in an invite-only preview. Contact our technical support team for assistance.
196
+
197
+ * **ROW FILTER**: Binds a filter function that returns `BOOLEAN` to a table. The system automatically applies it during queries and DML operations — only rows for which the function returns `true` are visible to the current operation. Commonly used for multi-tenant isolation and row-level data access control by user/role. The filter function can use security context functions such as `current_user()` and `current_roles()` to dynamically filter based on the current login identity. Columns listed in `ON (...)` are passed in order as arguments to the filter function; their types and count must match the function definition. It is recommended to reference filter functions using schema-qualified names. See [Row-Level Security (Row Filter)](row-filter.md).
198
+
199
+ ```sql
200
+ -- Create a filter function: each user can only see rows where owner equals their login name
201
+ CREATE FUNCTION my_schema.owner_only(owner STRING) RETURNS BOOLEAN
202
+ AS owner = current_user();
203
+
204
+ -- Bind a row filter at table creation
205
+ CREATE TABLE my_schema.docs (
206
+ id INT,
207
+ owner STRING,
208
+ content STRING
209
+ ) ROW FILTER my_schema.owner_only ON (owner);
210
+ ```
211
+
212
+ You can also bind or remove a row filter on an existing table using `ALTER TABLE ... SET ROW FILTER ...` and `ALTER TABLE ... DROP ROW FILTER`.
213
+
171
214
  ### PROPERTIES
172
215
 
173
216
  You can set table-level properties via `PROPERTIES` at table creation time, and also modify them via `ALTER TABLE ... SET PROPERTIES`.
@@ -370,6 +413,8 @@ Users can create indexes on multiple columns when creating a table. Indexes can
370
413
  | [Partitioned Table Usage Guide](notes-and-guidelines-for-partition-tables.md) | Usage patterns for partition design, partition pruning, and dynamic partitions |
371
414
  | [Bucketing (CLUSTERED BY)](cluster-table-guide.md) | Hash bucketing to improve Join and aggregation performance |
372
415
  | [Primary Key](primary-key.md) | Primary key table design, supporting CDC real-time write deduplication |
416
+ | [Unique Key](unique-key.md) | Declarative UNIQUE constraint for query optimization |
417
+ | [Row-Level Security (Row Filter)](row-filter.md) | Bind a filter function to a table to control row-level data visibility |
373
418
 
374
419
  **Indexing**
375
420
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  When you need to access the Singdata Lakehouse service through the internal network within the cloud provider's VPC, you need to create an endpoint in Alibaba Cloud that connects to the Singdata Lakehouse endpoint service. Then replace the domain name of the JDBC connection or API accessing Singdata Lakehouse with the domain name of the endpoint.
4
4
 
5
- :-: ![](.topwrite/assets/privatelink_customer_access_LH_example.png)
5
+
6
6
 
7
7
  ## Steps
8
8
 
@@ -10,7 +10,6 @@ The following operations need to be completed in the Alibaba Cloud console envir
10
10
 
11
11
  1\. **Add to Whitelist**. First, please confirm that you have added your cloud platform account to the whitelist.
12
12
 
13
- :-: ![](.topwrite/assets/image_1733063925523.png =817)
14
13
 
15
14
  To ensure that Lakehouse can normally read the status of your endpoint and enhance the security of obtaining endpoint information within your cloud service platform, please create an independent access control role in the cloud service platform, and authorize and add the external ID.
16
15
 
@@ -18,19 +17,18 @@ To ensure that Lakehouse can normally read the status of your endpoint and enhan
18
17
 
19
18
  On the Alibaba Cloud "RAM Access Control" - "Roles" page, select the access control role whose ARN you want to add, copy the values of ARN and externalID respectively, return to the Singdata Lakehouse page, and in the add whitelist popup, copy the above two items into the corresponding options.
20
19
 
21
- :-: ![](.topwrite/assets/image_1733069144028.png =796)
20
+
22
21
 
23
22
  ^
24
23
 
25
- :-: ![](.topwrite/assets/image_1733069236299.png =366)
26
24
 
27
25
  2\. **Create Endpoint**. On the "Endpoints" page of the Alibaba Cloud console, click the "Create Endpoint" button. Select the same region as Lakehouse in the "Region" field, and select "Other Endpoint Services" on the page. Copy the endpoint service name of the region from the Lakehouse service and fill it in on this page.
28
26
 
29
- :-: ![](.topwrite/assets/image_1733063937656.png =819)
27
+
30
28
 
31
29
  ^
32
30
 
33
- :-: ![](.topwrite/assets/image_1733063950478.png =815)
31
+
34
32
 
35
33
  3\. **Allow Endpoint Connection**. After creation, refresh the "Endpoints" page in Lakehouse, and you will see the endpoint you created in the list. Click "Allow Connection" to complete the network interconnection configuration based on the private network connection.
36
34
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  When you need to use Singdata Lakehouse to access services within your cloud vendor's VPC (such as a self-built MySQL database), you first need to create an endpoint service on Alibaba Cloud and configure the service to be accessed as the service resource of the endpoint service.
4
4
 
5
- :-: ![](.topwrite/assets/private_link_access_customer_example.png)
5
+
6
6
 
7
7
  ## Steps
8
8
 
@@ -12,20 +12,17 @@ The following operations need to be completed in the Alibaba Cloud console envir
12
12
 
13
13
  2\. In the Alibaba Cloud console, click PrivateLink - Endpoint Services in the left navigation bar, and select the same region as the current Lakehouse service instance to create the endpoint service. You can find the region and availability zone of the current service instance at the top of the "Create Endpoint Service" popup in the Lakehouse service. Please create the endpoint service according to the region and availability zone of the current service instance, otherwise, Lakehouse will not be able to create the corresponding endpoint and establish PrivateLink.
14
14
 
15
- :-: ![](.topwrite/assets/image_1733063729452.png =381)
16
15
 
17
16
  3\. Configure other options for creating the endpoint service according to the actual situation of your service on Alibaba Cloud. Please note, select "Service Provider" for the "Service Payer" option, otherwise, it will affect the normal creation of the connection.
18
17
 
19
- :-: ![](.topwrite/assets/image_1733063748752.png =791)
18
+
20
19
 
21
20
  4\. After the endpoint service is created, click the name of the endpoint to enter the endpoint service details page, and add the Singdata cloud account ID to the whitelist.
22
21
 
23
- :-: ![](.topwrite/assets/image_1733063764046.png =757)
22
+
24
23
 
25
24
  ^
26
25
 
27
- :-: ![](.topwrite/assets/image_1733063781421.png =367)
28
26
 
29
- 5\. After completing the above operations, return to the Lakehouse page. In the "Create Endpoint Service" popup, fill in the endpoint service instance ID (found on the Alibaba Cloud endpoint service details page) and name created in the above steps, and click "OK".
30
27
 
31
- :-: ![](.topwrite/assets/image_1733063795296.png =557)
28
+ 5\. After completing the above operations, return to the Lakehouse page. In the "Create Endpoint Service" popup, fill in the endpoint service instance ID (found on the Alibaba Cloud endpoint service details page) and name created in the above steps, and click "OK".
@@ -2,7 +2,6 @@
2
2
 
3
3
  When you need to access the Singdata Lakehouse service through the internal network within the cloud provider's VPC, you need to create an endpoint in Tencent Cloud that connects to the Singdata Lakehouse endpoint service. Then replace the domain name of the JDBC connection or API accessing Singdata Lakehouse with the domain name of the endpoint.
4
4
 
5
- :-: ![](.topwrite/assets/privatelink_customer_access_LH_example.png)
6
5
 
7
6
  ## Steps
8
7
 
@@ -10,7 +9,7 @@ The following operations need to be completed in the Alibaba Cloud console envir
10
9
 
11
10
  1\. **Add to Whitelist**. First, please confirm that you have added your cloud platform account to the whitelist.
12
11
 
13
- ![](.topwrite/assets/image_1732869126126.png)
12
+
14
13
 
15
14
  To ensure that Lakehouse can correctly read the status of your endpoint and enhance the security of obtaining endpoint information within your cloud service platform, please create an independent access control role within the cloud service platform, and authorize and add an external ID.
16
15
 
@@ -20,16 +19,12 @@ On the Tencent Cloud access control role list page, click the role name you want
20
19
 
21
20
  After pasting, click "OK".
22
21
 
23
- :-: ![](.topwrite/assets/image_1733067670318.png =826)
24
-
25
- :-: ![](.topwrite/assets/image_1733067744128.png =826)
26
22
 
27
23
  ^
28
24
 
29
- :-: ![](.topwrite/assets/image_1733067854956.png =447)
25
+
30
26
 
31
27
  2\. **Create a New Endpoint**. On the endpoint page, click the "New" button, select "Other Account" for "Peer Account Type". Then, in "Peer Account UIN" and "Peer Endpoint Service ID", respectively fill in the "Lakehouse UID" and "Endpoint Service ID" copied from the Lakehouse page. Click "OK".
32
28
 
33
- :-: ![](.topwrite/assets/image_1733063999441.png =455)
34
29
 
35
30
  3\. **Allow Endpoint Connection**. After creation, refresh the "Endpoint" page in Lakehouse, and you will see the endpoint you created in the list. Click "Allow Connection" to complete the network interconnection configuration based on the private connection.
@@ -2,18 +2,14 @@
2
2
 
3
3
  When you need to use Singdata Lakehouse to access services within your cloud vendor's VPC (such as a self-built MySQL database), you first need to create an endpoint service on Tencent Cloud and configure the service to be accessed as a service resource for that endpoint service.
4
4
 
5
- :-: ![](.topwrite/assets/private_link_access_customer_example.png)
5
+
6
6
 
7
7
  ## Steps
8
8
 
9
9
  1\. On the Tencent Cloud Network Connection - Endpoint Service page, select the same region as the current Lakehouse service instance to create an endpoint service. You can find the region and availability zone of the current service instance at the top of the "Create Endpoint Service" popup in the Lakehouse service. Please create the endpoint service according to the region and availability zone of the current service instance, otherwise, Lakehouse will not be able to create the corresponding endpoint and establish PrivateLink.
10
10
 
11
- :-: ![](.topwrite/assets/image.png =412)
12
11
 
13
12
  2\. After completing the creation of the endpoint service, click on the endpoint service name to enter the details page. Switch to the "Whitelist" tab, click the "Add" button, and add the UIN of the Lakehouse service. You can copy the "Lakehouse UID" from the information popup of the newly created endpoint service in the Lakehouse service and fill it in.
14
13
 
15
- :-: ![](.topwrite/assets/image.png =412)
16
14
 
17
15
  3\. After completion, please copy your endpoint service ID and paste it into the Lakehouse creation page, then click "Confirm" to complete the creation of the endpoint service.
18
-
19
- :-: ![](.topwrite/assets/image_1733063879303.png =408)
@@ -55,18 +55,30 @@ If you use an enterprise bot such as Hermes to host an AI Agent, it is recommend
55
55
 
56
56
  `cz-cli agent run` requires an LLM to be configured before use. LLM configuration is independent of the Lakehouse connection profile and is stored in the `[llm.*]` section of `~/.clickzetta/profiles.toml`.
57
57
 
58
- ### Method 1: Use the Singdata Built-in LLM (Recommended for New Users)
58
+ ### Method 1: Use the Singdata Built-in LLM (Recommended, provided by AI Gateway)
59
59
 
60
- Complete configuration in one step using the CLI connection string:
60
+ The Singdata built-in LLM is provided uniformly through [AI Gateway](AIGateway.md) — no separate model API Key required. Complete configuration in one step using the CLI connection string:
61
61
 
62
62
  ```bash
63
63
  cz-cli setup --credential <CLI connection string>
64
64
  ```
65
65
 
66
- The CLI connection string is available on the LakehouseMCP page in the account console (see the [Installation and Configuration Guide](setup_cz_cli.md)).
66
+ The CLI connection string is available on the LakehouseMCP page in the account console (see the [Installation and Configuration Guide](setup_cz_cli.md)). The connection string already contains the AI Gateway endpoint and authentication information — ready to use once configured.
67
67
 
68
68
  ### Method 2: Connect an External LLM
69
69
 
70
+ Supports any OpenAI-compatible interface. If your enterprise already has an AI Gateway, simply enter its endpoint:
71
+
72
+ **Use AI Gateway (enterprise self-hosted or Singdata-managed)**
73
+
74
+ ```bash
75
+ cz-cli agent llm add my-gateway \
76
+ --provider openai-compatible \
77
+ --base-url https://<your-instance>.singdata.com/gateway/v1 \
78
+ --api-key <AI-Gateway-API-Key> \
79
+ --use
80
+ ```
81
+
70
82
  **OpenAI / GPT**
71
83
 
72
84
  ```bash
@@ -88,35 +100,28 @@ cz-cli agent llm add my-relay \
88
100
 
89
101
  ### Verify and Manage
90
102
 
91
- ```bash
92
- ```
93
-
94
103
  View the currently active LLM and all configurations:
95
104
 
96
105
  ```bash
97
106
  cz-cli agent llm show
98
-
99
107
  ```
100
108
 
101
109
  List all configured LLMs:
102
110
 
103
111
  ```bash
104
112
  cz-cli agent llm list
105
-
106
113
  ```
107
114
 
108
115
  Test connectivity:
109
116
 
110
117
  ```bash
111
118
  cz-cli agent llm test my-openai
112
-
113
119
  ```
114
120
 
115
121
  Switch the active LLM:
116
122
 
117
123
  ```bash
118
124
  cz-cli agent llm use my-openai
119
-
120
125
  ```
121
126
 
122
127
  Remove an LLM configuration:
@@ -2,42 +2,34 @@
2
2
 
3
3
  The `datasource` command browses and tests external data sources configured in Studio (MySQL, PostgreSQL, Kafka, etc.). It is commonly used to validate connections before configuring sync tasks:
4
4
 
5
- ```bash
6
- ```
7
-
8
5
  List all configured data sources:
9
6
 
10
7
  ```bash
11
8
  cz-cli -p prod datasource list
12
-
13
9
  ```
14
10
 
15
11
  Test data source connectivity:
16
12
 
17
13
  ```bash
18
14
  cz-cli -p prod datasource test <datasource_name>
19
-
20
15
  ```
21
16
 
22
17
  Browse databases/schemas in a data source:
23
18
 
24
19
  ```bash
25
20
  cz-cli -p prod datasource catalogs <datasource_name>
26
-
27
21
  ```
28
22
 
29
23
  Browse tables in a specific database:
30
24
 
31
25
  ```bash
32
26
  cz-cli -p prod datasource objects <datasource_name> <catalog_name>
33
-
34
27
  ```
35
28
 
36
29
  View metadata for a specific table:
37
30
 
38
31
  ```bash
39
32
  cz-cli -p prod datasource describe <datasource_name> <catalog_name> <table_name>
40
-
41
33
  ```
42
34
 
43
35
  Preview sample data from a table: