@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
@@ -11,11 +11,11 @@ from clickzetta.zettapark.session import Session
11
11
  session = Session.builder.configs({
12
12
  "username": "your_username",
13
13
  "password": "your_password",
14
- "service": "cn-shanghai-alicloud.api.singdata.com",
14
+ "service": "cn-shanghai-alicloud.api.clickzetta.com",
15
15
  "instance": "your_instance",
16
16
  "workspace": "your_workspace",
17
17
  "schema": "public",
18
- "vcluster": "default"
18
+ "vcluster": "DEFAULT"
19
19
  }).create()
20
20
  ```
21
21
 
@@ -25,8 +25,9 @@ Examples in each section use `create_dataframe` to create DataFrames directly fr
25
25
 
26
26
  ## String Functions
27
27
 
28
+ Create sample data
29
+
28
30
  ```python
29
- # Create sample data
30
31
  df = session.create_dataframe(
31
32
  [(1, "Alice"), (2, " hello world "), (3, "bob")],
32
33
  schema=["id", "name"]
@@ -70,13 +71,16 @@ df.select(
70
71
  F.replace(F.col("name"), "world", "Lakehouse").alias("replaced"),
71
72
  F.regexp_replace(F.col("name"), r"\s+", "_").alias("no_space"),
72
73
  ).show()
73
- # +---+---------------+------------+---+------------------+---------------+
74
- # | id| upper| trim|len| replaced| no_space|
75
- # +---+---------------+------------+---+------------------+---------------+
76
- # | 1| HELLO WORLD | hello world| 11| hello Lakehouse |_hello_world_ |
77
- # | 2| ALICE| Alice| 5| Alice| Alice|
78
- # | 3| BOB| bob| 3| bob| bob|
79
- # +---+---------------+------------+---+------------------+---------------+
74
+ ```
75
+
76
+ ```Plain
77
+ +---+---------------+------------+---+------------------+---------------+
78
+ | id| upper| trim|len| replaced| no_space|
79
+ +---+---------------+------------+---+------------------+---------------+
80
+ | 1| HELLO WORLD | hello world| 11| hello Lakehouse |_hello_world_ |
81
+ | 2| ALICE| Alice| 5| Alice| Alice|
82
+ | 3| BOB| bob| 3| bob| bob|
83
+ +---+---------------+------------+---+------------------+---------------+
80
84
  ```
81
85
 
82
86
  ---
@@ -112,12 +116,15 @@ df.select(
112
116
  F.greatest(F.col("a"), F.col("b")).alias("max_ab"),
113
117
  F.least(F.col("a"), F.col("b")).alias("min_ab"),
114
118
  ).show()
115
- # +-----+----+-----+-------+------+------+
116
- # |round|ceil|floor| abs|max_ab|min_ab|
117
- # +-----+----+-----+-------+------+------+
118
- # | 3.14| 4| 3|3.14159| 200| 100|
119
- # |-2.72| -2| -3| 2.718| 300| 50|
120
- # +-----+----+-----+-------+------+------+
119
+ ```
120
+
121
+ ```Plain
122
+ +-----+----+-----+-------+------+------+
123
+ |round|ceil|floor| abs|max_ab|min_ab|
124
+ +-----+----+-----+-------+------+------+
125
+ | 3.14| 4| 3|3.14159| 200| 100|
126
+ |-2.72| -2| -3| 2.718| 300| 50|
127
+ +-----+----+-----+-------+------+------+
121
128
  ```
122
129
 
123
130
  ---
@@ -162,32 +169,45 @@ df.select(
162
169
  F.last_day(F.to_date(F.col("dt_str"))).alias("last_day"),
163
170
  F.add_months(F.to_date(F.col("dt_str")), 1).alias("next_month"),
164
171
  ).show()
165
- # +----------+----+-----+----------+-----------+----------+----------+
166
- # | date|year|month| plus_7d| formatted| last_day|next_month|
167
- # +----------+----+-----+----------+-----------+----------+----------+
168
- # |2024-01-15|2024| 1|2024-01-22|2024/01/15 |2024-01-31|2024-02-15|
169
- # |2024-03-31|2024| 3|2024-04-07|2024/03/31 |2024-03-31|2024-04-30|
170
- # +----------+----+-----+----------+-----------+----------+----------+
172
+ ```
173
+
174
+ ```Plain
175
+ +----------+----+-----+----------+-----------+----------+----------+
176
+ | date|year|month| plus_7d| formatted| last_day|next_month|
177
+ +----------+----+-----+----------+-----------+----------+----------+
178
+ |2024-01-15|2024| 1|2024-01-22|2024/01/15 |2024-01-31|2024-02-15|
179
+ |2024-03-31|2024| 3|2024-04-07|2024/03/31 |2024-03-31|2024-04-30|
180
+ +----------+----+-----+----------+-----------+----------+----------+
171
181
  ```
172
182
 
173
183
  ---
174
184
 
175
185
  ## Conditional Functions
176
186
 
187
+ when / otherwise — multi-branch condition (like CASE WHEN)
188
+
177
189
  ```python
178
- # when / otherwise — multi-branch condition (like CASE WHEN)
179
190
  F.when(F.col("score") >= 90, "A") \
180
191
  .when(F.col("score") >= 80, "B") \
181
192
  .when(F.col("score") >= 60, "C") \
182
193
  .otherwise("F")
194
+ ```
183
195
 
184
- # iff — simple binary condition (like ternary operator)
196
+ iff — simple binary condition (like ternary operator)
197
+
198
+ ```python
185
199
  F.iff(F.col("amount") > 0, "positive", "non-positive")
200
+ ```
186
201
 
187
- # coalesce — return the first non-NULL value
202
+ coalesce — return the first non-NULL value
203
+
204
+ ```python
188
205
  F.coalesce(F.col("value"), F.col("default_value"), F.lit(0))
206
+ ```
189
207
 
190
- # is_null / is_not_null
208
+ is\_null / is\_not\_null
209
+
210
+ ```python
191
211
  F.is_null(F.col("name"))
192
212
  ```
193
213
 
@@ -206,14 +226,17 @@ df.select(
206
226
  .otherwise("F").alias("grade"),
207
227
  F.iff(F.col("score") >= 60, "pass", "fail").alias("result"),
208
228
  ).show()
209
- # +---+-----+-----+------+
210
- # | id|score|grade|result|
211
- # +---+-----+-----+------+
212
- # | 1| 95| A| pass|
213
- # | 2| 82| B| pass|
214
- # | 3| 67| C| pass|
215
- # | 4| 45| F| fail|
216
- # +---+-----+-----+------+
229
+ ```
230
+
231
+ ```Plain
232
+ +---+-----+-----+------+
233
+ | id|score|grade|result|
234
+ +---+-----+-----+------+
235
+ | 1| 95| A| pass|
236
+ | 2| 82| B| pass|
237
+ | 3| 67| C| pass|
238
+ | 4| 45| F| fail|
239
+ +---+-----+-----+------+
217
240
  ```
218
241
 
219
242
  ---
@@ -249,12 +272,15 @@ df.group_by("category").agg(
249
272
  F.max(F.col("amount")).alias("max"),
250
273
  F.min(F.col("amount")).alias("min"),
251
274
  ).show()
252
- # +--------+---+-----+-----+---+---+
253
- # |category|cnt|total| avg|max|min|
254
- # +--------+---+-----+-----+---+---+
255
- # | A| 3| 350|116.7|200| 50|
256
- # | B| 2| 450|225.0|300|150|
257
- # +--------+---+-----+-----+---+---+
275
+ ```
276
+
277
+ ```Plain
278
+ +--------+---+-----+-----+---+---+
279
+ |category|cnt|total| avg|max|min|
280
+ +--------+---+-----+-----+---+---+
281
+ | A| 3| 350|116.7|200| 50|
282
+ | B| 2| 450|225.0|300|150|
283
+ +--------+---+-----+-----+---+---+
258
284
  ```
259
285
 
260
286
  ---
@@ -279,11 +305,14 @@ df.select(
279
305
  F.get_json_object(F.col("data"), "$.age").alias("age"),
280
306
  F.get_json_object(F.col("data"), "$.addr.city").alias("city"),
281
307
  ).show()
282
- # +-----+---+-------+
283
- # | name|age| city|
284
- # +-----+---+-------+
285
- # |Alice| 30|Beijing|
286
- # +-----+---+-------+
308
+ ```
309
+
310
+ ```Plain
311
+ +-----+---+-------+
312
+ | name|age| city|
313
+ +-----+---+-------+
314
+ |Alice| 30|Beijing|
315
+ +-----+---+-------+
287
316
  ```
288
317
 
289
318
  ---
@@ -318,4 +347,4 @@ F.typeof(F.col("value")) # Return the data type name of a column
318
347
  |------|------|
319
348
  | [Zettapark DataFrame API Guide](zettapark-dataframe-guide.md) | Complete DataFrame operations guide |
320
349
  | [Zettapark Quick Start](zettapark-quick-start.md) | Installation and basic examples |
321
- | [SQL Functions Reference](../sql_functions/) | Complete list of Lakehouse built-in SQL functions |
350
+ | [SQL Functions Reference](sql_functions/) | Complete list of Lakehouse built-in SQL functions |
@@ -25,11 +25,11 @@ from clickzetta.zettapark.session import Session
25
25
  session = Session.builder.configs({
26
26
  "username": "your_username",
27
27
  "password": "your_password",
28
- "service": "cn-shanghai-alicloud.api.singdata.com",
28
+ "service": "cn-shanghai-alicloud.api.clickzetta.com",
29
29
  "instance": "your_instance",
30
30
  "workspace": "your_workspace",
31
31
  "schema": "public",
32
- "vcluster": "default"
32
+ "vcluster": "DEFAULT"
33
33
  }).create()
34
34
  ```
35
35
 
@@ -13,11 +13,11 @@ from clickzetta.zettapark import functions as F
13
13
  session = Session.builder.configs({
14
14
  "username": "your_username",
15
15
  "password": "your_password",
16
- "service": "cn-shanghai-alicloud.api.singdata.com",
16
+ "service": "cn-shanghai-alicloud.api.clickzetta.com",
17
17
  "instance": "your_instance",
18
18
  "workspace": "your_workspace",
19
19
  "schema": "public",
20
- "vcluster": "default"
20
+ "vcluster": "DEFAULT"
21
21
  }).create()
22
22
  ```
23
23
 
@@ -59,7 +59,7 @@ session.sql("""
59
59
  """).collect()
60
60
  ```
61
61
 
62
- > 💡 **Tip:** `change_tracking` must be enabled via `ALTER TABLE SET PROPERTIES`. Specifying it at table creation time has no effect.
62
+ > 💡 `change_tracking` must be enabled via `ALTER TABLE SET PROPERTIES`. Specifying it at table creation time has no effect.
63
63
 
64
64
  ---
65
65
 
@@ -131,7 +131,7 @@ deletes = stream_df.filter(
131
131
  ).select("id")
132
132
  ```
133
133
 
134
- > ⚠️ **Note:** The `__change_type` column name contains double underscores. Reference it with backticks: `` F.col("`__change_type`") ``
134
+ > ⚠️ The `__change_type` column name contains double underscores. Reference it with backticks: `` F.col("`__change_type`") ``
135
135
 
136
136
  ---
137
137
 
@@ -13,11 +13,11 @@ from clickzetta.zettapark import functions as F
13
13
  session = Session.builder.configs({
14
14
  "username": "your_username",
15
15
  "password": "your_password",
16
- "service": "cn-shanghai-alicloud.api.singdata.com",
16
+ "service": "cn-shanghai-alicloud.api.clickzetta.com",
17
17
  "instance": "your_instance",
18
18
  "workspace": "your_workspace",
19
19
  "schema": "public",
20
- "vcluster": "default"
20
+ "vcluster": "DEFAULT"
21
21
  }).create()
22
22
  ```
23
23
 
@@ -36,8 +36,9 @@ session = Session.builder.configs({
36
36
 
37
37
  The examples in this guide use Named Volume (internal Volume), which requires no external storage mount and can be used immediately after creation:
38
38
 
39
+ Create a Named Volume (one-time operation)
40
+
39
41
  ```python
40
- # Create a Named Volume (one-time operation)
41
42
  session.sql("CREATE VOLUME IF NOT EXISTS my_named_vol").collect()
42
43
  ```
43
44
 
@@ -51,17 +52,24 @@ session.sql("CREATE VOLUME IF NOT EXISTS my_named_vol").collect()
51
52
 
52
53
  ### Upload a Local File to a Volume
53
54
 
55
+ Upload a single file
56
+
54
57
  ```python
55
- # Upload a single file
56
58
  result = session.file.put(
57
59
  "/local/path/data.csv",
58
60
  "volume://my_named_vol/data/data.csv",
59
61
  auto_compress=False
60
62
  )
61
63
  print(result)
62
- # [PutResult(source='/local/path/data.csv', target='/data/data.csv', source_size=1024, target_size=1024)]
64
+ ```
65
+
66
+ ```Plain
67
+ [PutResult(source='/local/path/data.csv', target='/data/data.csv', source_size=1024, target_size=1024)]
68
+ ```
69
+
70
+ Refresh the directory index after upload so session.read can see the new file
63
71
 
64
- # Refresh the directory index after upload so session.read can see the new file
72
+ ```python
65
73
  session.sql("ALTER VOLUME my_named_vol REFRESH").collect()
66
74
  ```
67
75
 
@@ -73,7 +81,10 @@ result = session.file.get(
73
81
  "/local/output/"
74
82
  )
75
83
  print(result)
76
- # [GetResult(file='data.csv', size=1024)]
84
+ ```
85
+
86
+ ```Plain
87
+ [GetResult(file='data.csv', size=1024)]
77
88
  ```
78
89
 
79
90
  ### List a Volume Directory
@@ -82,17 +93,24 @@ print(result)
82
93
  files = session.file.list_("volume://my_named_vol/data/")
83
94
  for f in files:
84
95
  print(f.file, f.size)
85
- # data/orders.csv 2048
86
- # data/users.csv 1024
96
+ ```
97
+
98
+ ```Plain
99
+ data/orders.csv 2048
100
+ data/users.csv 1024
87
101
  ```
88
102
 
89
103
  ### Delete a Volume File
90
104
 
105
+ Delete a single file
106
+
91
107
  ```python
92
- # Delete a single file
93
108
  session.file.delete("volume://my_named_vol/data/old_file.csv")
109
+ ```
110
+
111
+ Delete a directory (deletes all files under it)
94
112
 
95
- # Delete a directory (deletes all files under it)
113
+ ```python
96
114
  session.file.delete("volume://my_named_vol/archive/")
97
115
  ```
98
116
 
@@ -114,8 +132,9 @@ df.printSchema()
114
132
 
115
133
  ### Read Parquet
116
134
 
135
+ Read all Parquet files in a directory
136
+
117
137
  ```python
118
- # Read all Parquet files in a directory
119
138
  df = session.read.parquet("volume://my_named_vol/data/parquet_dir/")
120
139
  df.show()
121
140
  ```
@@ -160,10 +179,11 @@ df.write.copy_into_volume(
160
179
 
161
180
  Read raw files from a Volume, process them, write to a table, then export results back to a Volume:
162
181
 
182
+ Step 1: Upload raw data to Volume
183
+
163
184
  ```python
164
185
  import csv
165
186
 
166
- # Step 1: Upload raw data to Volume
167
187
  raw_data = [
168
188
  ["order_id", "user_id", "product", "amount", "status"],
169
189
  [1001, 101, "iPhone", 7999.0, "paid"],
@@ -178,32 +198,50 @@ session.file.put(
178
198
  "volume://my_named_vol/raw/orders.csv",
179
199
  auto_compress=False
180
200
  )
201
+ ```
181
202
 
182
- # Refresh directory index so session.read can see the newly uploaded file
203
+ Refresh the directory index so session.read can see the newly uploaded file
204
+
205
+ ```python
183
206
  session.sql("ALTER VOLUME my_named_vol REFRESH").collect()
207
+ ```
208
+
209
+ Step 2: Read from Volume and clean data
184
210
 
185
- # Step 2: Read from Volume and clean data
211
+ ```python
186
212
  df = session.read \
187
213
  .option("header", True) \
188
214
  .option("infer_schema", True) \
189
215
  .csv("volume://my_named_vol/raw/orders.csv")
216
+ ```
190
217
 
191
- # Filter and transform
218
+ Filter and transform
219
+
220
+ ```python
192
221
  paid_df = df.filter(F.col("status") == "paid") \
193
222
  .with_column("amount_with_tax", F.col("amount") * 1.13)
223
+ ```
224
+
225
+ Step 3: Write to a Lakehouse table
194
226
 
195
- # Step 3: Write to a Lakehouse table
227
+ ```python
196
228
  paid_df.write.save_as_table("paid_orders", mode="overwrite")
197
229
  print(f"Written {paid_df.count()} records")
230
+ ```
231
+
232
+ Step 4: Export processed results back to Volume
198
233
 
199
- # Step 4: Export processed results back to Volume
234
+ ```python
200
235
  session.table("paid_orders") \
201
236
  .write.copy_into_volume(
202
237
  "volume://my_named_vol/processed/paid_orders/",
203
238
  file_format_type="parquet"
204
239
  )
240
+ ```
205
241
 
206
- # Verify export
242
+ Verify export results
243
+
244
+ ```python
207
245
  files = session.file.list_("volume://my_named_vol/processed/paid_orders/")
208
246
  print(f"Exported files: {[f.file for f in files]}")
209
247
  ```
@@ -214,25 +252,41 @@ print(f"Exported files: {[f.file for f in files]}")
214
252
 
215
253
  Named Volume is internal storage — no external dependencies required. Suitable for temporary storage and export scenarios.
216
254
 
255
+ Create a Named Volume
256
+
217
257
  ```python
218
- # Create a Named Volume
219
258
  session.sql("CREATE VOLUME IF NOT EXISTS my_named_vol").collect()
259
+ ```
220
260
 
221
- # Upload a file (using SQL PUT command)
261
+ Upload a file (using SQL PUT command)
262
+
263
+ ```python
222
264
  session.sql("PUT '/local/path/file.csv' TO VOLUME my_named_vol FILE 'data/file.csv'").collect()
265
+ ```
266
+
267
+ List files
223
268
 
224
- # List files
269
+ ```python
225
270
  files = session.file.list_("volume://my_named_vol/")
226
271
  for f in files:
227
272
  print(f.file, f.size)
273
+ ```
228
274
 
229
- # Download a file
275
+ Download a file
276
+
277
+ ```python
230
278
  session.file.get("volume://my_named_vol/data/file.csv", "/local/output/")
279
+ ```
231
280
 
232
- # Delete a file
281
+ Delete a file
282
+
283
+ ```python
233
284
  session.file.delete("volume://my_named_vol/data/file.csv")
285
+ ```
286
+
287
+ Export DataFrame to Named Volume
234
288
 
235
- # Export DataFrame to Named Volume
289
+ ```python
236
290
  df.write.copy_into_volume(
237
291
  "volume://my_named_vol/export/",
238
292
  file_format_type="csv",
@@ -246,16 +300,23 @@ df.write.copy_into_volume(
246
300
 
247
301
  User Volume is each user's personal storage space. `session.file` methods are not supported — use SQL commands instead:
248
302
 
303
+ Upload to User Volume
304
+
249
305
  ```python
250
- # Upload to User Volume
251
306
  session.sql("PUT '/local/path/file.csv' TO USER VOLUME FILE 'subdir/file.csv'").collect()
307
+ ```
308
+
309
+ List User Volume files
252
310
 
253
- # List User Volume files
311
+ ```python
254
312
  files = session.sql("SHOW USER VOLUME DIRECTORY").collect()
255
313
  for f in files:
256
314
  print(f["relative_path"], f["size"])
315
+ ```
257
316
 
258
- # Read from User Volume (via SQL SELECT FROM VOLUME)
317
+ Read from User Volume (via SQL SELECT FROM VOLUME)
318
+
319
+ ```python
259
320
  df = session.sql("""
260
321
  SELECT * FROM USER VOLUME
261
322
  USING CSV
@@ -263,8 +324,11 @@ df = session.sql("""
263
324
  FILES('subdir/file.csv')
264
325
  """)
265
326
  df.show()
327
+ ```
328
+
329
+ Download a User Volume file
266
330
 
267
- # Download a User Volume file
331
+ ```python
268
332
  session.sql("GET USER VOLUME FILE 'subdir/file.csv' TO '/local/output/'").collect()
269
333
  ```
270
334
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clickzetta/cz-cli-darwin-x64",
3
- "version": "0.5.16",
3
+ "version": "0.5.18",
4
4
  "description": "cz-cli binary for macOS x64 (Intel)",
5
5
  "os": [
6
6
  "darwin"