@clickzetta/cz-cli-linux-x64 0.3.2 → 0.3.5

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 (118) hide show
  1. package/bin/cz-cli +0 -0
  2. package/package.json +1 -1
  3. package/bin/skills/clickzetta-access-control/SKILL.md +0 -243
  4. package/bin/skills/clickzetta-access-control/references/dynamic-masking.md +0 -86
  5. package/bin/skills/clickzetta-access-control/references/grant-revoke.md +0 -103
  6. package/bin/skills/clickzetta-access-control/references/role-management.md +0 -66
  7. package/bin/skills/clickzetta-access-control/references/user-management.md +0 -61
  8. package/bin/skills/clickzetta-ai-vector-search/SKILL.md +0 -160
  9. package/bin/skills/clickzetta-ai-vector-search/references/vector-search.md +0 -155
  10. package/bin/skills/clickzetta-app-python-sdk/SKILL.md +0 -153
  11. package/bin/skills/clickzetta-app-python-sdk/references/bulkload.md +0 -196
  12. package/bin/skills/clickzetta-app-python-sdk/references/connector.md +0 -143
  13. package/bin/skills/clickzetta-app-python-sdk/references/realtime.md +0 -122
  14. package/bin/skills/clickzetta-batch-sync-pipeline/SKILL.md +0 -293
  15. package/bin/skills/clickzetta-bi-connect/SKILL.md +0 -176
  16. package/bin/skills/clickzetta-bi-connect/references/bi-tools.md +0 -170
  17. package/bin/skills/clickzetta-cdc-sync-pipeline/SKILL.md +0 -450
  18. package/bin/skills/clickzetta-concepts/SKILL.md +0 -282
  19. package/bin/skills/clickzetta-concepts/references/brands-and-endpoints.md +0 -79
  20. package/bin/skills/clickzetta-concepts/references/object-model.md +0 -311
  21. package/bin/skills/clickzetta-data-ingest-pipeline/SKILL.md +0 -165
  22. package/bin/skills/clickzetta-data-lifecycle/SKILL.md +0 -211
  23. package/bin/skills/clickzetta-data-lifecycle/references/lifecycle-reference.md +0 -175
  24. package/bin/skills/clickzetta-data-recovery/SKILL.md +0 -215
  25. package/bin/skills/clickzetta-data-recovery/evals/evals.json +0 -35
  26. package/bin/skills/clickzetta-data-science/SKILL.md +0 -125
  27. package/bin/skills/clickzetta-data-science/references/bitmap-profile.md +0 -146
  28. package/bin/skills/clickzetta-data-science/references/data-patterns.md +0 -110
  29. package/bin/skills/clickzetta-data-science/references/setup.md +0 -160
  30. package/bin/skills/clickzetta-data-science/references/stats-functions.md +0 -195
  31. package/bin/skills/clickzetta-data-science/references/write-and-infer.md +0 -122
  32. package/bin/skills/clickzetta-data-science/references/zettapark-api.md +0 -156
  33. package/bin/skills/clickzetta-data-sharing/SKILL.md +0 -160
  34. package/bin/skills/clickzetta-data-sharing/references/share-ddl.md +0 -134
  35. package/bin/skills/clickzetta-dba-guide/SKILL.md +0 -540
  36. package/bin/skills/clickzetta-dw-modeling/SKILL.md +0 -259
  37. package/bin/skills/clickzetta-dw-modeling/references/modeling-patterns.md +0 -100
  38. package/bin/skills/clickzetta-dynamic-table/SKILL.md +0 -86
  39. package/bin/skills/clickzetta-dynamic-table/best-practices/dimension-table-join-guide.md +0 -257
  40. package/bin/skills/clickzetta-dynamic-table/best-practices/medallion-and-stream-patterns.md +0 -124
  41. package/bin/skills/clickzetta-dynamic-table/best-practices/non-partitioned-merge-into-warning.md +0 -96
  42. package/bin/skills/clickzetta-dynamic-table/best-practices/performance-optimization.md +0 -109
  43. package/bin/skills/clickzetta-dynamic-table/dt-creator/SKILL.md +0 -15
  44. package/bin/skills/clickzetta-dynamic-table/dt-creator/references/dt-declaration-strategy.md +0 -185
  45. package/bin/skills/clickzetta-dynamic-table/dt-creator/references/incremental-config-reference.md +0 -429
  46. package/bin/skills/clickzetta-dynamic-table/dt-creator/references/refresh-history-guide.md +0 -268
  47. package/bin/skills/clickzetta-dynamic-table/dt-creator/references/sql-limitations.md +0 -80
  48. package/bin/skills/clickzetta-dynamic-table/dynamic-table-alter/SKILL.md +0 -190
  49. package/bin/skills/clickzetta-external-catalog/SKILL.md +0 -120
  50. package/bin/skills/clickzetta-external-catalog/references/external-catalog-ddl.md +0 -130
  51. package/bin/skills/clickzetta-external-function/SKILL.md +0 -203
  52. package/bin/skills/clickzetta-external-function/references/external-function-ddl.md +0 -171
  53. package/bin/skills/clickzetta-file-import-pipeline/SKILL.md +0 -117
  54. package/bin/skills/clickzetta-index-manager/SKILL.md +0 -140
  55. package/bin/skills/clickzetta-index-manager/references/bloomfilter-index.md +0 -67
  56. package/bin/skills/clickzetta-index-manager/references/index-management.md +0 -73
  57. package/bin/skills/clickzetta-index-manager/references/inverted-index.md +0 -80
  58. package/bin/skills/clickzetta-index-manager/references/vector-index.md +0 -81
  59. package/bin/skills/clickzetta-information-schema/SKILL.md +0 -367
  60. package/bin/skills/clickzetta-information-schema/references/instance-views-reference.md +0 -276
  61. package/bin/skills/clickzetta-information-schema/references/metering-views-reference.md +0 -137
  62. package/bin/skills/clickzetta-information-schema/references/views-reference.md +0 -271
  63. package/bin/skills/clickzetta-java-sdk/SKILL.md +0 -186
  64. package/bin/skills/clickzetta-java-sdk/references/bulkload.md +0 -163
  65. package/bin/skills/clickzetta-java-sdk/references/realtime.md +0 -212
  66. package/bin/skills/clickzetta-kafka-ingest-pipeline/SKILL.md +0 -531
  67. package/bin/skills/clickzetta-kafka-ingest-pipeline/references/kafka-pipe-syntax.md +0 -186
  68. package/bin/skills/clickzetta-lakehouse-connect/SKILL.md +0 -218
  69. package/bin/skills/clickzetta-lakehouse-connect/evals/evals.json +0 -35
  70. package/bin/skills/clickzetta-lakehouse-connect/references/config-file.md +0 -435
  71. package/bin/skills/clickzetta-lakehouse-connect/references/jdbc.md +0 -478
  72. package/bin/skills/clickzetta-lakehouse-connect/references/python-sdk.md +0 -225
  73. package/bin/skills/clickzetta-lakehouse-connect/references/sqlalchemy.md +0 -468
  74. package/bin/skills/clickzetta-lakehouse-connect/references/zettapark-session.md +0 -445
  75. package/bin/skills/clickzetta-manage-comments/SKILL.md +0 -219
  76. package/bin/skills/clickzetta-metadata-query/SKILL.md +0 -298
  77. package/bin/skills/clickzetta-metadata-query/references/show-desc-reference.md +0 -326
  78. package/bin/skills/clickzetta-monitoring/SKILL.md +0 -199
  79. package/bin/skills/clickzetta-monitoring/references/job-history-analysis.md +0 -97
  80. package/bin/skills/clickzetta-monitoring/references/show-jobs.md +0 -48
  81. package/bin/skills/clickzetta-oss-ingest-pipeline/SKILL.md +0 -402
  82. package/bin/skills/clickzetta-query-optimizer/SKILL.md +0 -156
  83. package/bin/skills/clickzetta-query-optimizer/references/explain.md +0 -56
  84. package/bin/skills/clickzetta-query-optimizer/references/hints-and-sortkey.md +0 -78
  85. package/bin/skills/clickzetta-query-optimizer/references/optimize.md +0 -65
  86. package/bin/skills/clickzetta-query-optimizer/references/result-cache.md +0 -49
  87. package/bin/skills/clickzetta-query-optimizer/references/show-jobs.md +0 -42
  88. package/bin/skills/clickzetta-realtime-sync-pipeline/SKILL.md +0 -197
  89. package/bin/skills/clickzetta-semantic-view/SKILL.md +0 -207
  90. package/bin/skills/clickzetta-semantic-view/references/semantic-view-reference.md +0 -167
  91. package/bin/skills/clickzetta-spark-flink-connector/SKILL.md +0 -92
  92. package/bin/skills/clickzetta-spark-flink-connector/references/flink.md +0 -147
  93. package/bin/skills/clickzetta-spark-flink-connector/references/spark.md +0 -132
  94. package/bin/skills/clickzetta-sql-pipeline-manager/SKILL.md +0 -353
  95. package/bin/skills/clickzetta-sql-pipeline-manager/evals/evals.json +0 -166
  96. package/bin/skills/clickzetta-sql-pipeline-manager/references/dynamic-table.md +0 -173
  97. package/bin/skills/clickzetta-sql-pipeline-manager/references/materialized-view.md +0 -129
  98. package/bin/skills/clickzetta-sql-pipeline-manager/references/pipe.md +0 -160
  99. package/bin/skills/clickzetta-sql-pipeline-manager/references/table-stream.md +0 -123
  100. package/bin/skills/clickzetta-sql-syntax-guide/SKILL.md +0 -172
  101. package/bin/skills/clickzetta-sql-syntax-guide/references/ddl-reference.md +0 -350
  102. package/bin/skills/clickzetta-sql-syntax-guide/references/dml-reference.md +0 -279
  103. package/bin/skills/clickzetta-sql-syntax-guide/references/dql-reference.md +0 -504
  104. package/bin/skills/clickzetta-sql-syntax-guide/references/functions-reference.md +0 -372
  105. package/bin/skills/clickzetta-sql-syntax-guide/references/migration-databricks.md +0 -260
  106. package/bin/skills/clickzetta-sql-syntax-guide/references/migration-snowflake.md +0 -382
  107. package/bin/skills/clickzetta-sql-syntax-guide/references/vs-snowflake.md +0 -346
  108. package/bin/skills/clickzetta-sql-syntax-guide/references/vs-spark.md +0 -229
  109. package/bin/skills/clickzetta-studio-overview/SKILL.md +0 -170
  110. package/bin/skills/clickzetta-studio-overview/references/studio-modules.md +0 -173
  111. package/bin/skills/clickzetta-table-stream-pipeline/SKILL.md +0 -155
  112. package/bin/skills/clickzetta-vcluster-manager/SKILL.md +0 -212
  113. package/bin/skills/clickzetta-vcluster-manager/references/vc-cache.md +0 -54
  114. package/bin/skills/clickzetta-vcluster-manager/references/vcluster-ddl.md +0 -150
  115. package/bin/skills/clickzetta-volume-manager/SKILL.md +0 -249
  116. package/bin/skills/clickzetta-volume-manager/references/volume-ddl.md +0 -194
  117. package/bin/skills/clickzetta-zettapark/SKILL.md +0 -248
  118. package/bin/skills/clickzetta-zettapark/references/zettapark-api.md +0 -283
@@ -1,298 +0,0 @@
1
- ---
2
- name: clickzetta-metadata-query
3
- description: |
4
- 通过 SHOW / DESC 命令族和 load_history() 函数查询 ClickZetta Lakehouse 对象元数据。
5
- 覆盖所有 SHOW 命令(TABLES/SCHEMAS/CATALOGS/COLUMNS/VOLUMES/CONNECTIONS/JOBS/VCLUSTERS/
6
- PIPES/SHARES/USERS/ROLES/GRANTS/FUNCTIONS/TABLE STREAMS/PARTITIONS/SYNONYMS/INDEX/
7
- DYNAMIC TABLE REFRESH HISTORY/TABLES HISTORY),所有 DESC 命令(TABLE/SCHEMA/HISTORY/
8
- VCLUSTER/VOLUME/CONNECTION/FUNCTION/VIEW/DYNAMIC TABLE/SHARE/INDEX/TABLE STREAM),
9
- SHOW CREATE TABLE,load_history(),FROM (SHOW ...) 子查询,上下文函数。
10
- 与 information_schema 的区别:SHOW/DESC 是实时命令,返回当前状态;
11
- information_schema 是元数据视图,有约 15 分钟延迟但支持复杂 SQL 分析。
12
- 当用户说"查看表列表"、"查看字段"、"查看作业"、"SHOW TABLES"、"DESC TABLE"、
13
- "查看分区"、"查看历史版本"、"查看删除的表"、"查看导入历史"、"load_history"、
14
- "SHOW JOBS"、"查看集群状态"、"查看连接"、"查看权限"、"SHOW GRANTS"、
15
- "查看函数"、"查看 Volume"、"查看 Share"、"查看 Catalog"时触发。
16
- Keywords: SHOW, DESC, DESCRIBE, metadata, load_history, object info
17
- ---
18
-
19
- # ClickZetta 元数据查询命令
20
-
21
- 阅读 [references/show-desc-reference.md](references/show-desc-reference.md) 了解完整语法和返回字段。
22
-
23
- ---
24
-
25
- ## SHOW / DESC 与 information_schema 的选择
26
-
27
- | 场景 | 推荐方式 | 原因 |
28
- |---|---|---|
29
- | 快速查看当前状态 | `SHOW` / `DESC` | 实时,无延迟 |
30
- | 复杂 SQL 分析、聚合统计 | `information_schema` | 支持 JOIN/GROUP BY/WHERE |
31
- | 查看已删除对象 | `SHOW TABLES HISTORY` | 专用命令 |
32
- | 费用分析 | `SYS.information_schema.instance_usage` | 含金额字段 |
33
- | 导入文件去重 | `load_history()` | 专用函数 |
34
-
35
- ---
36
-
37
- ## 当前上下文
38
-
39
- ```sql
40
- -- 查看当前连接的工作空间、Schema、用户、集群
41
- SELECT current_workspace(), current_schema(), current_user(), current_vcluster();
42
- ```
43
-
44
- ---
45
-
46
- ## SHOW 命令速查
47
-
48
- ### 数据对象
49
-
50
- ```sql
51
- -- Schema
52
- SHOW SCHEMAS;
53
- SHOW SCHEMAS EXTENDED; -- 含 type 字段(managed/external)
54
- SHOW SCHEMAS LIKE 'ods%';
55
- -- SHOW SCHEMAS 支持 WHERE(如 WHERE schema_name LIKE '%xxx%')
56
-
57
- -- 表(含视图/物化视图/动态表/外部表)
58
- SHOW TABLES;
59
- SHOW TABLES IN my_schema;
60
- SHOW TABLES LIKE '%order%';
61
- -- WHERE 支持字段:table_name / is_view / is_materialized_view / is_external / is_dynamic
62
- SHOW TABLES WHERE is_view = false AND is_materialized_view = false; -- 普通表
63
- SHOW TABLES WHERE is_view = true; -- 视图
64
- SHOW TABLES WHERE is_materialized_view = true; -- 物化视图
65
- SHOW TABLES WHERE is_dynamic = true; -- 动态表
66
- SHOW TABLES WHERE is_external = true; -- 外部表
67
- -- ⚠️ SHOW VIEWS IN schema 语法不支持,用 SHOW TABLES WHERE is_view=true
68
-
69
- -- 字段
70
- SHOW COLUMNS IN my_schema.my_table;
71
- SHOW COLUMNS FROM my_table IN my_schema;
72
-
73
- -- 完整建表语句(表/视图/物化视图/动态表)
74
- SHOW CREATE TABLE my_table;
75
-
76
- -- 分区
77
- SHOW PARTITIONS my_table;
78
- SHOW PARTITIONS EXTENDED my_table; -- 含 rows/bytes/files/时间戳
79
- SHOW PARTITIONS my_table PARTITION (dt = '2024-01'); -- 按分区值过滤
80
- -- ⚠️ SHOW PARTITIONS WHERE dt='x' 不支持,需用 PARTITION() 子句
81
-
82
- -- Volume(不支持 IN schema,用 WHERE 过滤)
83
- SHOW VOLUMES;
84
- SHOW VOLUMES LIKE '%oss%';
85
- SHOW VOLUMES WHERE schema_name = 'my_schema';
86
-
87
- -- Table Stream
88
- SHOW TABLE STREAMS;
89
- SHOW TABLE STREAMS IN my_schema;
90
- SHOW TABLE STREAMS LIKE '%orders%';
91
-
92
- -- 同义词
93
- SHOW SYNONYMS IN my_schema;
94
-
95
- -- 索引
96
- SHOW INDEX IN my_schema.my_table;
97
-
98
- -- 语义视图
99
- SHOW SEMANTIC VIEWS;
100
- SHOW SEMANTIC VIEWS IN my_schema;
101
-
102
- -- 函数
103
- SHOW FUNCTIONS LIKE '%date%'; -- 内置函数(按名称过滤)
104
- SHOW EXTERNAL FUNCTIONS; -- 用户创建的外部函数
105
- -- ⚠️ 不支持 IN schema 子句,SHOW EXTERNAL FUNCTIONS IN my_schema 会报语法错误
106
- ```
107
-
108
- ### Catalog(联邦查询)
109
-
110
- ```sql
111
- -- 查看所有 Catalog(含 SHARED 和 EXTERNAL 类型)
112
- SHOW CATALOGS;
113
- -- 返回:workspace_name, created_time, category(SHARED/EXTERNAL)
114
-
115
- -- 查看 Catalog 下的 Schema
116
- SHOW SCHEMAS IN catalog_name;
117
-
118
- -- 查看 Catalog.Schema 下的表
119
- SHOW TABLES IN catalog_name.schema_name;
120
- ```
121
-
122
- ### 计算与连接
123
-
124
- ```sql
125
- -- 计算集群
126
- SHOW VCLUSTERS;
127
- SHOW VCLUSTERS WHERE state = 'RUNNING';
128
- SHOW VCLUSTERS WHERE vcluster_type = 'ANALYTICS';
129
-
130
- -- 作业(最近 7 天,最多 10000 条)
131
- SHOW JOBS LIMIT 20;
132
- SHOW JOBS IN VCLUSTER default_ap LIMIT 20;
133
-
134
- -- 动态表刷新历史(最近 7 天)
135
- SHOW DYNAMIC TABLE REFRESH HISTORY LIMIT 20;
136
- SHOW DYNAMIC TABLE REFRESH HISTORY WHERE state = 'FAILED';
137
-
138
- -- 连接对象
139
- SHOW CONNECTIONS;
140
- SHOW CONNECTIONS LIKE '%oss%';
141
- SHOW CONNECTIONS WHERE category = 'STORAGE';
142
-
143
- -- Pipe
144
- SHOW PIPES;
145
- SHOW PIPES IN my_schema;
146
- ```
147
-
148
- ### 用户、权限与共享
149
-
150
- ```sql
151
- -- 用户
152
- SHOW USERS;
153
-
154
- -- 角色
155
- SHOW ROLES;
156
-
157
- -- 权限
158
- SHOW GRANTS TO USER alice;
159
- SHOW GRANTS TO ROLE analyst_role;
160
-
161
- -- 数据共享
162
- SHOW SHARES;
163
- -- 返回:share_name, provider, provider_instance, provider_workspace, scope, to_instance, kind(OUTBOUND/INBOUND)
164
- ```
165
-
166
- ### 历史记录
167
-
168
- ```sql
169
- -- 表历史(含已删除表,delete_time 为 NULL 表示未删除)
170
- -- 返回字段说明:
171
- -- delete_time:删除时间,NULL 表示表仍存在
172
- -- retention_time:Time Travel 保留期(秒),保留期内可用 UNDROP 恢复或 AS OF 查询历史数据
173
- SHOW TABLES HISTORY;
174
- SHOW TABLES HISTORY IN my_schema;
175
- SHOW TABLES HISTORY LIKE '%temp%';
176
- ```
177
-
178
- ---
179
-
180
- ## DESC 命令速查
181
-
182
- ```sql
183
- -- 表/视图/动态表/物化视图字段
184
- DESC my_table;
185
- DESC EXTENDED my_table; -- 含 last_modified_time/properties/statistics
186
-
187
- -- Schema
188
- DESC SCHEMA my_schema;
189
- DESC SCHEMA EXTENDED my_schema; -- 含 creator/created_time/type
190
-
191
- -- 计算集群
192
- DESC VCLUSTER default_ap;
193
- DESC VCLUSTER EXTENDED default_ap;
194
-
195
- -- Volume
196
- DESC VOLUME my_volume;
197
- DESC VOLUME EXTENDED my_volume;
198
-
199
- -- 连接对象
200
- DESC CONNECTION my_oss_conn;
201
- DESC CONNECTION EXTENDED my_oss_conn;
202
-
203
- -- 外部函数(仅支持用户创建的外部函数,不支持内置函数)
204
- DESC FUNCTION my_schema.my_function;
205
-
206
- -- 视图(返回字段列表)
207
- DESC VIEW my_view;
208
-
209
- -- 动态表(返回字段 + 调度配置)
210
- DESC TABLE my_dt;
211
-
212
- -- 索引
213
- DESC INDEX idx_name;
214
-
215
- -- Table Stream
216
- DESC TABLE STREAM my_stream;
217
-
218
- -- Share(返回共享的对象列表)
219
- DESC SHARE my_share_name;
220
- -- 返回:kind(WORKSPACE/SCHEMA/TABLE), name, shared_on
221
-
222
- -- Catalog
223
- DESC CATALOG my_catalog;
224
- ```
225
-
226
- ---
227
-
228
- ## DESC HISTORY — 查看版本历史
229
-
230
- ```sql
231
- -- 表/动态表/物化视图的版本历史(依赖 data_retention_days)
232
- DESC HISTORY my_table;
233
- -- 返回:version, time, total_rows, total_bytes, user, operation, job_id, stats
234
- -- operation 值:INSERT_INTO / UPDATE / DELETE / ALTER / CREATE / REFRESH 等
235
- ```
236
-
237
- ---
238
-
239
- ## load_history() — 查看文件导入历史
240
-
241
- ```sql
242
- -- 参数必须是带引号的字符串(含 schema 前缀)
243
- SELECT * FROM load_history('my_schema.my_table');
244
- SELECT file_path, last_copy_time, file_size, status, first_error_message
245
- FROM load_history('my_schema.my_table')
246
- ORDER BY last_copy_time DESC
247
- LIMIT 20;
248
- -- ⚠️ load_history(schema.table) 不带引号会报错
249
- ```
250
-
251
- ---
252
-
253
- ## FROM (SHOW ...) 子查询 — 重要特性
254
-
255
- SHOW 命令结果可以直接作为子查询使用,支持 WHERE/GROUP BY/JOIN 等操作:
256
-
257
- ```sql
258
- -- 过滤 SHOW 结果
259
- SELECT schema_name, table_name
260
- FROM (SHOW TABLES IN my_schema)
261
- WHERE is_view = false;
262
-
263
- -- 统计各类型表数量
264
- SELECT
265
- CASE WHEN is_view THEN 'VIEW'
266
- WHEN is_materialized_view THEN 'MV'
267
- WHEN is_dynamic THEN 'DT'
268
- WHEN is_external THEN 'EXTERNAL'
269
- ELSE 'TABLE' END AS type,
270
- COUNT(*) AS cnt
271
- FROM (SHOW TABLES IN my_schema)
272
- GROUP BY 1;
273
-
274
- -- 查看挂起的集群
275
- SELECT name, state FROM (SHOW VCLUSTERS) WHERE state = 'SUSPENDED';
276
-
277
- -- 结合 information_schema 深度分析
278
- SELECT t.table_name, t.is_dynamic, i.create_time, i.row_count
279
- FROM (SHOW TABLES WHERE is_dynamic = true) t
280
- LEFT JOIN information_schema.tables i
281
- ON t.table_name = i.table_name AND t.schema_name = i.table_schema;
282
- ```
283
-
284
- **注意**:不支持创建包含 SHOW 命令的视图(`CREATE VIEW AS SELECT * FROM (SHOW TABLES)` 会失败)。
285
-
286
- ---
287
-
288
- ## 注意事项
289
-
290
- 1. **`SHOW SCHEMAS WHERE`**:不支持,需用 `SHOW SCHEMAS EXTENDED` 后应用层过滤
291
- 2. **`SHOW VIEWS IN schema`**:语法报错,用 `SHOW TABLES WHERE is_view=true`
292
- 3. **`SHOW VOLUMES IN schema`**:语法报错,用 `SHOW VOLUMES WHERE schema_name='x'`
293
- 4. **`SHOW PARTITIONS WHERE col='x'`**:不支持按分区列名过滤,用 `PARTITION(col='x')` 子句
294
- 5. **`load_history()` 语法**:参数必须是带引号的字符串 `'schema.table'`
295
- 6. **`DESC FUNCTION`**:仅支持用户创建的外部函数,不支持内置函数
296
- 7. **`SHOW JOBS`**:只显示最近 7 天,最多 10000 条;**不支持 ORDER BY 子句**,需用 LIMIT 控制返回量
297
- 8. **`SHOW DYNAMIC TABLE REFRESH HISTORY`**:只显示最近 7 天,最多 10000 条
298
- 9. **`LIKE` 和 `WHERE` 不能同时用**:用 `FROM (SHOW TABLES) WHERE table_name LIKE 'x%'` 替代
@@ -1,326 +0,0 @@
1
- # SHOW / DESC 命令完整语法参考
2
-
3
- > 已通过实际 Lakehouse 连接验证(cn-shanghai-alicloud, f8866243, quick_start)
4
-
5
- ---
6
-
7
- ## SHOW 命令通用语法
8
-
9
- ```sql
10
- SHOW <object_type_plural>
11
- [ IN <scope> ]
12
- [ LIKE '<pattern>' | WHERE <expression> ]
13
- [ LIMIT <num> ]
14
- ```
15
-
16
- ### 作用域(IN)对应关系
17
-
18
- | 对象类型 | IN 作用域 | 示例 |
19
- |---|---|---|
20
- | TABLE / VIEW / SYNONYM / TABLE STREAM / PIPE | `IN schema_name` | `SHOW TABLES IN sales` |
21
- | SCHEMA / VCLUSTER / USERS / ROLES / PIPES | `IN workspace_name` | `SHOW SCHEMAS IN my_ws` |
22
- | 作业 | `IN VCLUSTER vc_name`(可选) | `SHOW JOBS IN VCLUSTER prod` |
23
- | 索引 / 列 | `IN table_name` 或 `FROM table_name` | `SHOW COLUMNS IN orders` |
24
- | 分区 | 不支持 IN,直接跟表名 | `SHOW PARTITIONS my_table` |
25
- | VOLUME | 不支持 IN,用 WHERE external/connection 过滤 | `SHOW VOLUMES WHERE external=true` |
26
- | CONNECTION / SHARE / FUNCTION / CATALOG | 不支持作用域限定 | `SHOW CONNECTIONS` |
27
-
28
- ### WHERE 支持的对象和字段(实测验证)
29
-
30
- | 对象 | LIKE | WHERE | 可过滤字段 |
31
- |---|---|---|---|
32
- | TABLE | ✅ | ✅ | `table_name`, `is_view`, `is_materialized_view`, `is_external`, `is_dynamic` |
33
- | TABLE STREAM | ✅ | ✅ | `create_time`, `name`, `table_name`, `mode`, `comment` |
34
- | CONNECTION | ✅ | ✅ | `name`, `category`, `type`, `enabled`, `created_time` |
35
- | VCLUSTER | ✅ | ✅ | `name`, `vcluster_type`, `state`, `creator`, `create_time`, `running_jobs`, `queued_jobs` 等 |
36
- | VOLUME | ✅ | ✅ | `external`(true/false), `connection` — ⚠️ 不支持 `schema_name` 过滤 |
37
- | JOB | ❌ | ✅ | `status`, `creator`, `priority`, `vcluster_name`, `job_id`, `start_time`, `end_time` |
38
- | SHARE | ✅ | ✅ | `share_name`, `provider`, `provider_instance`, `scope`, `kind` |
39
- | SYNONYM | ✅ | ✅ | `synonym_name`, `create_time`, `target_type`, `target_name` |
40
- | PIPE | ✅ | ✅ | `pipe_name`, `pipe_kind`, `status`, `copy_statement` |
41
- | SCHEMA | ✅ | ✅ | `schema_name` — ⚠️ `type` 字段不存在 |
42
- | TABLE_HISTORY | ❌ | ✅ | `table_name` |
43
- | CATALOG | ✅ | ✅ | `category` |
44
- | ROLE | ✅ | ❌ | — |
45
- | USER | ❌ | ❌ | — |
46
- | FUNCTION | ❌ | ❌ | `SHOW FUNCTIONS` 不支持 LIKE/WHERE;用 `SHOW EXTERNAL FUNCTIONS LIKE '%xxx%'` 查用户自定义函数 |
47
- | GRANT | ❌ | ❌ | 用 `SHOW GRANTS ON/TO` 语法代替;⚠️ 不支持 LIMIT |
48
-
49
- ---
50
-
51
- ## SHOW TABLES 返回字段
52
-
53
- | 字段 | 类型 | 说明 |
54
- |---|---|---|
55
- | schema_name | STRING | 所属 Schema |
56
- | table_name | STRING | 对象名称 |
57
- | is_view | BOOLEAN | 是否为视图 |
58
- | is_materialized_view | BOOLEAN | 是否为物化视图 |
59
- | is_external | BOOLEAN | 是否为外部表 |
60
- | is_dynamic | BOOLEAN | 是否为动态表 |
61
-
62
- 常用过滤示例:
63
-
64
- ```sql
65
- -- 列出指定 Schema 下所有 Dynamic Table(最常用)
66
- SHOW TABLES IN my_schema WHERE is_dynamic;
67
-
68
- -- 列出当前 Schema 下所有 Dynamic Table
69
- SHOW TABLES WHERE is_dynamic;
70
-
71
- -- 其他类型过滤
72
- SHOW TABLES WHERE is_view = true;
73
- SHOW TABLES WHERE is_materialized_view = true;
74
- SHOW TABLES WHERE is_external = true;
75
- SHOW TABLES WHERE is_view = false AND is_materialized_view = false; -- 普通表
76
- ```
77
-
78
- **注意**:`SHOW VIEWS IN schema` 语法不支持,需用 `SHOW TABLES WHERE is_view=true`
79
-
80
- ---
81
-
82
- ## SHOW CATALOGS 返回字段
83
-
84
- | 字段 | 说明 |
85
- |---|---|
86
- | workspace_name | Catalog 名称 |
87
- | created_time | 创建时间 |
88
- | category | SHARED(共享 Catalog)/ EXTERNAL(外部 Catalog) |
89
-
90
- ---
91
-
92
- ## SHOW VOLUMES 返回字段
93
-
94
- | 字段 | 说明 |
95
- |---|---|
96
- | schema_name | 所属 Schema |
97
- | volume_name | Volume 名称 |
98
- | create_time | 创建时间 |
99
- | external | 是否为外部 Volume(BOOLEAN) |
100
- | workspace_name | 所属工作空间 |
101
- | url | 绑定的存储路径 |
102
- | recursive_file_lookup | 是否递归扫描 |
103
- | connection | 引用的 Connection 名称 |
104
-
105
- **注意**:`SHOW VOLUMES IN schema` 语法不支持;`WHERE schema_name='x'` 也不支持 — 只能用 `WHERE external=true/false` 或 `WHERE connection='xxx'` 过滤
106
-
107
- ---
108
-
109
- ## SHOW SHARES 返回字段
110
-
111
- | 字段 | 说明 |
112
- |---|---|
113
- | share_name | Share 名称 |
114
- | provider | 提供方账户名 |
115
- | provider_instance | 提供方实例 ID |
116
- | provider_workspace | 提供方工作空间 |
117
- | scope | PRIVATE / PUBLIC |
118
- | to_instance | 消费方实例(逗号分隔) |
119
- | kind | OUTBOUND(对外共享)/ INBOUND(接收共享) |
120
-
121
- ---
122
-
123
- ## SHOW TABLES HISTORY 返回字段
124
-
125
- | 字段 | 类型 | 说明 |
126
- |---|---|---|
127
- | schema_name | STRING | 所属 Schema |
128
- | table_name | STRING | 表名 |
129
- | create_time | TIMESTAMP | 创建时间 |
130
- | creator | STRING | 创建者 |
131
- | rows | BIGINT | 行数 |
132
- | bytes | BIGINT | 大小 |
133
- | comment | STRING | 注释 |
134
- | retention_time | INT | 数据保留天数 |
135
- | delete_time | TIMESTAMP | 删除时间(NULL 表示未删除) |
136
-
137
- ---
138
-
139
- ## SHOW PARTITIONS EXTENDED 返回字段
140
-
141
- | 字段 | 说明 |
142
- |---|---|
143
- | partitions | 分区值(如 `dt=2024-01`) |
144
- | total_rows | 分区行数 |
145
- | bytes | 分区大小 |
146
- | total_files | 文件数 |
147
- | created_time | 分区创建时间 |
148
- | last_modified_time | 最后修改时间(生命周期从此起算) |
149
- | last_data_time | 最后数据写入时间 |
150
- | last_compaction_time | 最后 compaction 时间 |
151
-
152
- **注意**:`SHOW PARTITIONS WHERE dt='2024-01'` 不支持,需用 `SHOW PARTITIONS my_table PARTITION(dt='2024-01')`
153
-
154
- ---
155
-
156
- ## SHOW JOBS 返回字段
157
-
158
- | 字段 | 说明 |
159
- |---|---|
160
- | job_id | 作业 ID |
161
- | status | SETUP / SUCCEED / FAILED / CANCELLED |
162
- | creator | 提交用户 |
163
- | priority | 优先级 |
164
- | start_time | 开始时间 |
165
- | end_time | 结束时间 |
166
- | execution_time | 执行时长(INTERVAL 类型) |
167
- | vcluster_name | 使用的集群 |
168
- | job_text | SQL 语句 |
169
- | query_tag | 用户标签 |
170
-
171
- ---
172
-
173
- ## SHOW FUNCTIONS / SHOW EXTERNAL FUNCTIONS 返回字段
174
-
175
- | 字段 | 说明 |
176
- |---|---|
177
- | name | 函数名称(注意:列名是 `name`,不是 `function_name`) |
178
- | type | 函数类型 |
179
-
180
- > `SHOW FUNCTIONS` 列出所有内置函数和用户自定义函数,不支持 LIKE/WHERE。
181
- > `SHOW EXTERNAL FUNCTIONS` 只列用户创建的外部函数,支持 `LIKE '%pattern%'`。
182
-
183
- ---
184
-
185
- ## SHOW DYNAMIC TABLE REFRESH HISTORY 返回字段
186
-
187
- ```sql
188
- -- 全局(所有动态表,最近 7 天)
189
- SHOW DYNAMIC TABLE REFRESH HISTORY LIMIT 20;
190
- SHOW DYNAMIC TABLE REFRESH HISTORY WHERE state = 'FAILED';
191
-
192
- -- 指定表
193
- SHOW DYNAMIC TABLE REFRESH HISTORY WHERE name = 'my_dt' LIMIT 10;
194
- SHOW DYNAMIC TABLE REFRESH HISTORY WHERE name = 'my_dt' AND state = 'SUCCEED' LIMIT 20;
195
- ```
196
-
197
- | 字段 | 说明 |
198
- |---|---|
199
- | workspace_name | 工作空间 |
200
- | schema_name | Schema |
201
- | name | 动态表名 |
202
- | virtual_cluster | 使用集群 |
203
- | start_time / end_time | 刷新时间 |
204
- | duration | 耗时(INTERVAL) |
205
- | state | SUCCEED / FAILED / RUNNING |
206
- | refresh_trigger | MANUAL / SYSTEM_SCHEDULED |
207
- | refresh_mode | NO_DATA / FULL / INCREMENTAL |
208
- | error_message | 失败信息 |
209
- | source_tables | 基表信息 |
210
- | stats | 增量刷新条数 |
211
-
212
- ---
213
-
214
- ## SHOW CONNECTIONS 返回字段
215
-
216
- | 字段 | 说明 |
217
- |---|---|
218
- | name | 连接名称(注意:列名是 `name`,不是 `connection_name`) |
219
- | category | STORAGE / API / CATALOG |
220
- | type | OSS / COS / S3 / KAFKA / CLOUD_FUNCTION / DATABRICKS_UNITY_CATALOG 等 |
221
- | enabled | ENABLED / DISABLED |
222
- | created_time | 创建时间 |
223
-
224
- ---
225
-
226
- ## DESC 命令支持的对象类型
227
-
228
- | 对象类型 | 语法 | EXTENDED 支持 | 说明 |
229
- |---|---|---|---|
230
- | table/view/dynamic_table/materialized_view/external_table | `DESC TABLE [EXTENDED] name` | ✅ | 所有表类型统一用 DESC TABLE |
231
- | semantic_view | `DESC EXTENDED name` | — | 返回维度/指标/逻辑表定义 |
232
- | schema | `DESC SCHEMA [EXTENDED] name` | ✅ | EXTENDED 返回创建者、时间、权限等 |
233
- | vcluster | `DESC VCLUSTER name` | ❌ | — |
234
- | connection | `DESC CONNECTION [EXTENDED] name` | ✅ | EXTENDED 返回完整属性 |
235
- | catalog | `DESC CATALOG name` | ❌ | — |
236
- | stream/table_stream | `DESC TABLE STREAM name` | ❌ | — |
237
- | job | `DESC JOB job_id` | ❌ | object_name 为 job_id |
238
- | share | `DESC SHARE name` | ❌ | 返回 share 中包含的对象 |
239
- | index | `DESC INDEX [EXTENDED] name` | ✅ | — |
240
- | function/external_function | `DESC FUNCTION [EXTENDED] name` | ✅ | 仅支持用户创建的函数 |
241
- | volume | `DESC VOLUME name` | ❌ | — |
242
- | pipe | `DESC PIPE name` | ❌ | — |
243
-
244
- > ⚠️ `DESC FUNCTION` 不支持内置函数(如 `year`、`count`),只支持用户创建的外部函数。
245
-
246
- ---
247
-
248
- ## DESC HISTORY 返回字段
249
-
250
- | 字段 | 说明 |
251
- |---|---|
252
- | version | 版本号 |
253
- | time | 操作时间 |
254
- | total_rows | 该版本行数 |
255
- | total_bytes | 该版本大小 |
256
- | user | 操作用户 |
257
- | operation | INSERT_INTO / UPDATE / DELETE / ALTER / CREATE / REFRESH 等 |
258
- | job_id | 对应作业 ID |
259
- | stats | 增量刷新统计(动态表专有) |
260
- | source_tables | 基表信息(动态表专有) |
261
-
262
- ---
263
-
264
- ## load_history() 语法
265
-
266
- ```sql
267
- -- 正确:参数为带引号的字符串
268
- SELECT * FROM load_history('schema_name.table_name');
269
- SELECT * FROM load_history('schema_name.table_name') LIMIT 100;
270
-
271
- -- 错误:不能用裸表名
272
- -- SELECT * FROM load_history(schema.table); ❌
273
- -- SELECT * FROM load_history(TABLE schema.table); ❌
274
- ```
275
-
276
- 返回字段:`file_path`, `last_copy_time`, `file_size`, `status`, `first_error_message`
277
-
278
- 保留时间:7 天
279
-
280
- ---
281
-
282
- ## FROM (SHOW ...) 子查询
283
-
284
- 大多数 SHOW 命令支持作为子查询使用,可实现排序、过滤、JOIN 等操作:
285
-
286
- ```sql
287
- -- ✅ 支持子查询的 SHOW 命令
288
- SELECT * FROM (SHOW TABLES) WHERE is_view = false ORDER BY table_name;
289
- SELECT * FROM (SHOW SCHEMAS) WHERE schema_name LIKE 'mcp%';
290
- SELECT * FROM (SHOW VCLUSTERS) WHERE state = 'RUNNING' ORDER BY name;
291
- SELECT * FROM (SHOW USERS);
292
- SELECT * FROM (SHOW ROLES);
293
- SELECT * FROM (SHOW SHARES);
294
- SELECT * FROM (SHOW CONNECTIONS);
295
- SELECT * FROM (SHOW JOBS) WHERE status = 'FAILED';
296
- SELECT * FROM (SHOW GRANTS);
297
- SELECT * FROM (SHOW FUNCTIONS) WHERE name LIKE '%count%';
298
- SELECT * FROM (SHOW DYNAMIC TABLE REFRESH HISTORY) WHERE state = 'FAILED';
299
- SELECT * FROM (SHOW COLUMNS FROM my_table);
300
-
301
- -- ❌ 不支持子查询
302
- -- SELECT * FROM (SHOW CREATE TABLE my_table); -- parser return null
303
- ```
304
-
305
- > 💡 **SHOW 结果排序的唯一方法**:`SHOW ... ORDER BY` 不支持,但可用子查询:
306
- > ```sql
307
- > SELECT * FROM (SHOW TABLES) ORDER BY table_name;
308
- > SELECT * FROM (SHOW VCLUSTERS) ORDER BY create_time DESC;
309
- > ```
310
-
311
- ---
312
-
313
- ## 常见陷阱
314
-
315
- | 命令 | 陷阱 | 正确做法 |
316
- |---|---|---|
317
- | `SHOW SCHEMAS WHERE type=...` | `type` 字段不存在 | `SHOW SCHEMAS WHERE schema_name LIKE '%xxx%'` |
318
- | `SHOW VIEWS IN schema` | 语法不支持 | `SHOW TABLES WHERE is_view=true` |
319
- | `SHOW VOLUMES IN schema` | 语法不支持 | `SHOW VOLUMES WHERE external=true/false` 或 `WHERE connection='xxx'` |
320
- | `SHOW VOLUMES WHERE schema_name='x'` | `schema_name` 字段不可过滤 | `SHOW VOLUMES LIKE '%name%'` |
321
- | `SHOW PARTITIONS t WHERE dt='x'` | 不支持按分区列 WHERE | `SHOW PARTITIONS t PARTITION(dt='x')` |
322
- | `load_history(schema.table)` | 需要字符串 | `load_history('schema.table')` |
323
- | `DESC FUNCTION year` | 不支持内置函数 | 仅支持用户创建的外部函数 |
324
- | `LIKE` + `WHERE` 同时用 | 不支持 | 用 `WHERE table_name LIKE 'x%'` 代替,或用子查询 `SELECT * FROM (SHOW TABLES) WHERE table_name LIKE 'x%'` |
325
- | `SHOW GRANTS ... LIMIT n` | 不支持 LIMIT | 直接 `SHOW GRANTS TO USER name` |
326
- | `SHOW FUNCTIONS LIKE '%xxx%'` | 不支持 LIKE | 用 `SHOW EXTERNAL FUNCTIONS LIKE '%xxx%'` |