@clickzetta/cz-cli-linux-x64 0.3.4 → 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 -457
  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 -112
  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 -156
  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 -639
  67. package/bin/skills/clickzetta-kafka-ingest-pipeline/references/kafka-pipe-syntax.md +0 -324
  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 -427
  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 -379
  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 -185
  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 -222
  99. package/bin/skills/clickzetta-sql-pipeline-manager/references/table-stream.md +0 -125
  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 -206
  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 -292
  116. package/bin/skills/clickzetta-volume-manager/references/volume-ddl.md +0 -199
  117. package/bin/skills/clickzetta-zettapark/SKILL.md +0 -248
  118. package/bin/skills/clickzetta-zettapark/references/zettapark-api.md +0 -283
@@ -1,137 +0,0 @@
1
- # 费用计量视图字段说明
2
-
3
- > 已通过实际 Lakehouse 连接验证(cn-shanghai-alicloud, f8866243)
4
- > 访问路径:`SYS.information_schema.<视图名>`
5
- > 权限要求:INSTANCE ADMIN
6
-
7
- ---
8
-
9
- ## STORAGE_METERING 视图
10
-
11
- 存储费用明细,按天、按工作空间、按 SKU 记录存储计量数据。
12
-
13
- 实际字段(16列):
14
-
15
- | 字段名 | 类型 | 说明 |
16
- |---|---|---|
17
- | ACCOUNT_ID | BIGINT | 账户 ID |
18
- | ACCOUNT_NAME | STRING | 账户名称 |
19
- | INSTANCE_ID | BIGINT | 实例 ID |
20
- | REGION_NAME | STRING | 地域名称(如 阿里云-华东2(上海)) |
21
- | SKU_CATEGORY | STRING | 费用类别:`storage` / `network` |
22
- | SKU_NAME | STRING | 具体 SKU 名称(见下表) |
23
- | WORKSPACE_ID | BIGINT | 工作空间 ID |
24
- | WORKSPACE_NAME | STRING | 工作空间名称 |
25
- | MEASUREMENT_START | TIMESTAMP | 计量周期开始时间(通常为某天 00:00:00) |
26
- | MEASUREMENT_END | TIMESTAMP | 计量周期结束时间(通常为某天 23:59:59) |
27
- | MEASUREMENTS_UNIT | STRING | 计量单位(如 `yuan/GB/day`、`yuan/gb`、`none`) |
28
- | MEASUREMENTS_CONSUMPTION | DECIMAL | 消耗量(单位由 MEASUREMENTS_UNIT 决定) |
29
- | PRICE_RATE | DECIMAL | 单价 |
30
- | AMOUNT | DECIMAL | 费用金额(元) |
31
- | DISCOUNT_RATE | DECIMAL | 折扣率(1.0 = 无折扣) |
32
- | TOTAL_AFTER_DISCOUNT | DECIMAL | 折后金额(元) |
33
-
34
- ### SKU 枚举值
35
-
36
- | SKU_CATEGORY | SKU_NAME | MEASUREMENTS_UNIT | 说明 |
37
- |---|---|---|---|
38
- | storage | 托管存储容量 | yuan/GB/day | 内部表数据文件存储 |
39
- | storage | 多版本未删除存储 | none | Time Travel 历史版本存储 |
40
- | network | 数据查询Internet数据传输 | yuan/gb | 公网数据传输 |
41
-
42
- ---
43
-
44
- ## INSTANCE_USAGE 视图
45
-
46
- 计算费用明细,按天、按工作空间、按 SKU 记录计算资源使用数据。
47
-
48
- 实际字段(16列,与 STORAGE_METERING 相同结构):
49
-
50
- | 字段名 | 类型 | 说明 |
51
- |---|---|---|
52
- | ACCOUNT_ID | BIGINT | 账户 ID |
53
- | ACCOUNT_NAME | STRING | 账户名称 |
54
- | INSTANCE_ID | BIGINT | 实例 ID |
55
- | REGION_NAME | STRING | 地域名称 |
56
- | SKU_CATEGORY | STRING | 费用类别:`compute` |
57
- | SKU_NAME | STRING | 具体 SKU 名称(见下表) |
58
- | WORKSPACE_ID | BIGINT | 工作空间 ID |
59
- | WORKSPACE_NAME | STRING | 工作空间名称 |
60
- | MEASUREMENT_START | TIMESTAMP | 计量周期开始时间 |
61
- | MEASUREMENT_END | TIMESTAMP | 计量周期结束时间 |
62
- | MEASUREMENTS_UNIT | STRING | 计量单位(`yuan/cru`) |
63
- | MEASUREMENTS_CONSUMPTION | DECIMAL | 消耗的 CRU 量 |
64
- | PRICE_RATE | DECIMAL | 单价(元/CRU) |
65
- | AMOUNT | DECIMAL | 费用金额(元) |
66
- | DISCOUNT_RATE | DECIMAL | 折扣率 |
67
- | TOTAL_AFTER_DISCOUNT | DECIMAL | 折后金额(元) |
68
-
69
- ### SKU 枚举值
70
-
71
- | SKU_CATEGORY | SKU_NAME | 说明 |
72
- |---|---|---|
73
- | compute | AP类型计算集群 | 分析型 VCluster 费用 |
74
- | compute | GP类型计算集群 | 通用型 VCluster 费用 |
75
- | compute | 任务调度 | Studio 任务调度费用 |
76
- | compute | 数据集成 | 离线/实时同步任务费用 |
77
- | compute | 流式集成 | 流式数据集成费用 |
78
-
79
- ---
80
-
81
- ## 常用费用查询
82
-
83
- ```sql
84
- -- 本月各工作空间计算费用汇总
85
- SELECT workspace_name,
86
- sku_name,
87
- ROUND(SUM(measurements_consumption), 2) AS total_cru,
88
- ROUND(SUM(amount), 2) AS total_yuan
89
- FROM SYS.information_schema.instance_usage
90
- WHERE measurement_start >= DATE_TRUNC('month', CURRENT_DATE)
91
- GROUP BY workspace_name, sku_name
92
- ORDER BY total_yuan DESC;
93
-
94
- -- 本月各工作空间存储费用汇总
95
- SELECT workspace_name,
96
- sku_name,
97
- ROUND(SUM(measurements_consumption), 4) AS consumption,
98
- measurements_unit,
99
- ROUND(SUM(amount), 4) AS total_yuan
100
- FROM SYS.information_schema.storage_metering
101
- WHERE measurement_start >= DATE_TRUNC('month', CURRENT_DATE)
102
- GROUP BY workspace_name, sku_name, measurements_unit
103
- ORDER BY workspace_name, total_yuan DESC;
104
-
105
- -- 按天统计计算费用趋势(最近 30 天)
106
- SELECT DATE(measurement_start) AS dt,
107
- sku_name,
108
- ROUND(SUM(amount), 2) AS daily_yuan
109
- FROM SYS.information_schema.instance_usage
110
- WHERE measurement_start >= CURRENT_DATE - INTERVAL 30 DAY
111
- GROUP BY DATE(measurement_start), sku_name
112
- ORDER BY dt, daily_yuan DESC;
113
-
114
- -- 存储 + 计算综合费用(本月)
115
- SELECT cost_type, workspace_name,
116
- ROUND(SUM(amount), 2) AS total_yuan
117
- FROM (
118
- SELECT 'compute' AS cost_type, workspace_name, amount
119
- FROM SYS.information_schema.instance_usage
120
- WHERE measurement_start >= DATE_TRUNC('month', CURRENT_DATE)
121
- UNION ALL
122
- SELECT 'storage' AS cost_type, workspace_name, amount
123
- FROM SYS.information_schema.storage_metering
124
- WHERE measurement_start >= DATE_TRUNC('month', CURRENT_DATE)
125
- ) t
126
- GROUP BY cost_type, workspace_name
127
- ORDER BY cost_type, total_yuan DESC;
128
- ```
129
-
130
- ---
131
-
132
- ## 注意事项
133
-
134
- - 两个视图数据保留范围:从实例创建起至今(验证数据最早可追溯到 2025-01)
135
- - `WORKSPACE_NAME` 可能为 NULL(对应实例级别的费用,不归属特定工作空间)
136
- - `AMOUNT` 字段为实际计费金额(元),`TOTAL_AFTER_DISCOUNT` 为折后金额
137
- - 与 `JOB_HISTORY.CRU` 的区别:JOB_HISTORY 记录单次作业的 CRU 消耗,INSTANCE_USAGE 是按天汇总的计费数据,含金额
@@ -1,271 +0,0 @@
1
- # 空间级 INFORMATION_SCHEMA 视图字段说明
2
-
3
- > 来源:https://www.yunqi.tech/documents/worksapce-informaiton_schema-views
4
- > 已通过实际 Lakehouse 连接验证(cn-shanghai-alicloud, f8866243, quick_start)
5
-
6
- 访问路径:`information_schema.<视图名>`
7
- 权限要求:workspace_admin
8
-
9
- ---
10
-
11
- ## SCHEMAS 视图
12
-
13
- 实际字段(8列):
14
-
15
- | 字段名 | 类型 | 说明 |
16
- |---|---|---|
17
- | CATALOG_NAME | STRING | 当前 WORKSPACE 的名称 |
18
- | SCHEMA_NAME | STRING | Schema 名称 |
19
- | TYPE | STRING | EXTERNAL(外部)/ MANAGED(内部) |
20
- | SCHEMA_CREATOR | STRING | Schema 所有者账号名称 |
21
- | CREATE_TIME | TIMESTAMP | 创建时间 |
22
- | LAST_MODIFY_TIME | TIMESTAMP | 修改时间 |
23
- | COMMENT | STRING | 创建时的注释 |
24
- | PROPERTIES | ARRAY | 自定义属性 |
25
-
26
- ---
27
-
28
- ## TABLES 视图
29
-
30
- 实际字段(14列):
31
-
32
- | 字段名 | 类型 | 说明 |
33
- |---|---|---|
34
- | TABLE_CATALOG | STRING | 当前 WORKSPACE 名称 |
35
- | TABLE_SCHEMA | STRING | 所属 Schema |
36
- | TABLE_NAME | STRING | 表名 |
37
- | TABLE_CREATOR | STRING | 表所有者账号名称 |
38
- | TABLE_TYPE | STRING | MANAGED_TABLE / EXTERNAL_TABLE / VIRTUAL_VIEW / MATERIALIZED_VIEW |
39
- | ROW_COUNT | BIGINT | 行数(估计值,VIEW 为 NULL) |
40
- | BYTES | BIGINT | 存储大小字节(估计值,VIEW 为 NULL) |
41
- | CREATE_TIME | TIMESTAMP | 创建时间 |
42
- | LAST_MODIFY_TIME | TIMESTAMP | 修改时间 |
43
- | IS_PARTITIONED | BOOLEAN | 是否分区表 |
44
- | IS_CLUSTERED | BOOLEAN | 是否分桶表 |
45
- | COMMENT | STRING | 表注释 |
46
- | PROPERTIES | ARRAY | 自定义属性 |
47
- | DATA_LIFECYCLE | BIGINT | 生命周期(天),-1 表示永久 |
48
-
49
- ---
50
-
51
- ## COLUMNS 视图
52
-
53
- 实际字段(11列):
54
-
55
- | 字段名 | 类型 | 说明 |
56
- |---|---|---|
57
- | TABLE_CATALOG | STRING | 当前 WORKSPACE 名称 |
58
- | TABLE_SCHEMA | STRING | 所属 Schema |
59
- | TABLE_NAME | STRING | 表名 |
60
- | COLUMN_NAME | STRING | 字段名 |
61
- | COLUMN_DEFAULT | STRING | 字段默认值 |
62
- | IS_NULLABLE | BOOLEAN | 是否可为 NULL |
63
- | DATA_TYPE | STRING | 字段类型 |
64
- | COMMENT | STRING | 字段注释 |
65
- | IS_PRIMARY_KEY | BOOLEAN | 是否主键 |
66
- | IS_CLUSTERING_COLUMN | BOOLEAN | 是否 CLUSTER 字段 |
67
- | CREATE_TIME | TIMESTAMP | 表创建时间 |
68
-
69
- ---
70
-
71
- ## VIEWS 视图
72
-
73
- 实际字段(8列):
74
-
75
- | 字段名 | 类型 | 说明 |
76
- |---|---|---|
77
- | TABLE_CATALOG | STRING | 当前 WORKSPACE 名称 |
78
- | TABLE_SCHEMA | STRING | 所属 Schema |
79
- | TABLE_NAME | STRING | 视图名 |
80
- | TABLE_CREATOR | STRING | 视图所有者账号名称 |
81
- | VIEW_DEFINITION | STRING | 创建视图的 SQL 语句 |
82
- | CREATE_TIME | TIMESTAMP | 创建时间 |
83
- | LAST_MODIFY_TIME | TIMESTAMP | 修改时间 |
84
- | COMMENT | STRING | 视图注释 |
85
-
86
- ---
87
-
88
- ## USERS 视图
89
-
90
- 实际字段(8列):
91
-
92
- | 字段名 | 类型 | 说明 |
93
- |---|---|---|
94
- | WORKSPACE_NAME | STRING | 空间名称 |
95
- | USER_NAME | STRING | 用户名称 |
96
- | ROLE_NAMES | STRING | 拥有的角色(多个用逗号分隔)⚠️ 注意:是 ROLE_NAMES 不是 ROLE_NAME |
97
- | CREATE_TIME | TIMESTAMP | 用户加入时间 |
98
- | EMAIL | STRING | 用户邮箱 |
99
- | TELPHONE | STRING | 用户电话 ⚠️ 注意:拼写为 TELPHONE(非 TELEPHONE) |
100
- | COMMENT | STRING | 描述信息 |
101
- | PROPERTIES | ARRAY | 保留字段 |
102
-
103
- ---
104
-
105
- ## ROLES 视图
106
-
107
- 实际字段(5列):
108
-
109
- | 字段名 | 类型 | 说明 |
110
- |---|---|---|
111
- | WORKSPACE_NAME | STRING | 空间名称 |
112
- | ROLE_NAME | STRING | 角色名称 |
113
- | USER_NAMES | STRING | 被授予该角色的用户(逗号分隔) |
114
- | COMMENT | STRING | 描述信息 |
115
- | PROPERTIES | ARRAY | 保留字段 |
116
-
117
- 注意:无 `CREATE_TIME` 字段。
118
-
119
- ---
120
-
121
- ## JOB_HISTORY 视图
122
-
123
- 实际字段(31列):
124
-
125
- | 字段名 | 类型 | 说明 |
126
- |---|---|---|
127
- | WORKSPACE_NAME | STRING | 作业所在空间 |
128
- | WORKSPACE_ID | BIGINT | 空间 ID |
129
- | JOB_ID | STRING | 作业 ID |
130
- | JOB_NAME | STRING | 作业名称 |
131
- | JOB_CREATOR | STRING | 执行用户 |
132
- | STATUS | STRING | SUCCEED / FAILED / CANCELLED / RUNNING |
133
- | CRU | DECIMAL | 消耗的计算资源 |
134
- | ERROR_MESSAGE | STRING | 错误信息(失败时有值) |
135
- | JOB_TYPE | STRING | 作业类型:SQL_JOB 等 |
136
- | JOB_SUB_TYPE | STRING | 作业子类型 |
137
- | JOB_TEXT | STRING | 执行的 SQL 语句 |
138
- | START_TIME | TIMESTAMP | 开始时间 |
139
- | END_TIME | TIMESTAMP | 结束时间 |
140
- | EXECUTION_TIME | DOUBLE | 执行时间(秒) |
141
- | INPUT_OBJECTS | STRING | 输入表名(schema.table 格式) |
142
- | OUTPUT_OBJECTS | STRING | 输出表名 |
143
- | INPUT_TABLES | STRING | 输入表详情(JSON 格式) |
144
- | OUTPUT_TABLES | STRING | 输出表详情(JSON 格式) |
145
- | INPUT_BYTES | BIGINT | 实际扫描数据量 |
146
- | OUTPUT_BYTES | BIGINT | 输出字节数 |
147
- | CACHE_HIT | BIGINT | 从缓存读取的数据量 |
148
- | ROWS_PRODUCED | BIGINT | 处理的总记录数 ⚠️ 注意:是 ROWS_PRODUCED 不是 ROW_PRODUCED |
149
- | ROWS_INSERTED | BIGINT | 插入行数 ⚠️ 注意:是 ROWS_INSERTED 不是 ROW_INSERTED |
150
- | ROWS_UPDATED | BIGINT | 更新行数 ⚠️ 注意:是 ROWS_UPDATED 不是 ROW_UPDATED |
151
- | ROWS_DELETED | BIGINT | 删除行数 ⚠️ 注意:是 ROWS_DELETED 不是 ROW_DELETED |
152
- | VIRTUAL_CLUSTER | STRING | 使用的计算集群 |
153
- | JOB_CONFIG | STRING | 提交时的参数信息(JSON) |
154
- | JOB_PRIORITY | STRING | 作业优先级 |
155
- | QUERY_TAG | STRING | 用户设置的 TAG |
156
- | CLIENT_INFO | STRING | 客户端信息(JDBC/SDK/Web) |
157
- | PT_DATE | DATE | 分区日期(用于按日期过滤,性能更好) |
158
-
159
- ---
160
-
161
- ## MATERIALIZED_VIEW_REFRESH_HISTORY 视图
162
-
163
- 实际字段(12列):
164
-
165
- | 字段名 | 类型 | 说明 |
166
- |---|---|---|
167
- | WORKSPACE_NAME | STRING | 空间名称 |
168
- | SCHEMA_NAME | STRING | Schema 名称 |
169
- | MATERIALIZED_VIEW_NAME | STRING | 物化视图名称 |
170
- | CRU | DECIMAL | 刷新消耗的计费 |
171
- | VIRTUAL_CLUSTER_NAME | STRING | 使用的虚拟集群 |
172
- | STATUS | STRING | SUCCEED / FAILED / RUNNING |
173
- | SCHEDULED_START_TIME | TIMESTAMP | 计划刷新时间 |
174
- | START_TIME | TIMESTAMP | 实际开始时间 |
175
- | END_TIME | TIMESTAMP | 结束时间 |
176
- | ERROR_CODE | STRING | 错误码 |
177
- | ERROR_MESSAGE | STRING | 刷新失败信息 |
178
- | PT_DATE | DATE | 分区日期 |
179
-
180
- ---
181
-
182
- ## AUTOMV_REFRESH_HISTORY 视图
183
-
184
- 实际字段(12列):
185
-
186
- | 字段名 | 类型 | 说明 |
187
- |---|---|---|
188
- | WORKSPACE_NAME | STRING | 空间名称 |
189
- | SCHEMA_NAME | STRING | Schema 名称 |
190
- | MATERIALIZED_VIEW_NAME | STRING | 物化视图名称 |
191
- | CRU | DECIMAL | 刷新消耗的计费 |
192
- | STATUS | STRING | PROCESSING / SUCCEEDED / FAILED / CANCELLED |
193
- | MV_PROCESS_TYPE | STRING | BUILD(构建)/ REFRESH(刷新) |
194
- | START_TIME | TIMESTAMP | 开始时间 |
195
- | END_TIME | TIMESTAMP | 结束时间 |
196
- | BUILD_FROM_WORKSPACE | STRING | 构建 MV 对应的源表空间 |
197
- | JOB_ID | STRING | 构建 MV 的作业 ID |
198
- | ERROR_MESSAGE | STRING | 刷新失败信息 |
199
- | PT_DATE | DATE | 分区日期 |
200
-
201
- ---
202
-
203
- ## VOLUMES 视图
204
-
205
- 实际字段(12列):
206
-
207
- | 字段名 | 类型 | 说明 |
208
- |---|---|---|
209
- | VOLUME_CATALOG | STRING | 所属 Workspace 名称 |
210
- | VOLUME_SCHEMA | STRING | 所属 Schema 名称 |
211
- | VOLUME_NAME | STRING | Volume 名称 |
212
- | VOLUME_URL | STRING | Volume 绑定的 URL |
213
- | VOLUME_REGION | STRING | Volume 所属区域 |
214
- | VOLUME_TYPE | STRING | INTERNAL / EXTERNAL |
215
- | VOLUME_CREATOR | STRING | Volume 的 owner |
216
- | CONNECTION_NAME | STRING | 引用的 Connection 名称 |
217
- | COMMENT | STRING | 注释 |
218
- | PROPERTIES | ARRAY | 保留字段 |
219
- | CREATE_TIME | TIMESTAMP | 创建时间 |
220
- | LAST_MODIFY_TIME | TIMESTAMP | 修改时间 |
221
-
222
- ---
223
-
224
- ## CONNECTIONS 视图
225
-
226
- 实际字段(11列):
227
-
228
- | 字段名 | 类型 | 说明 |
229
- |---|---|---|
230
- | WORKSPACE_NAME | STRING | 所在空间 |
231
- | CONNECTION_NAME | STRING | 连接对象名称 |
232
- | CONNECTION_KIND | STRING | STORAGE / API |
233
- | TYPE | STRING | FILE_SYSTEM(存储)/ CLOUD_FUNCTION(云函数) |
234
- | PROVIDER | STRING | FILE_SYSTEM 时:OSS / COS;CLOUD_FUNCTION 时:aliyun / tencent |
235
- | REGION | STRING | 连接的 region(如 ap-shanghai / cn-beijing) |
236
- | SOURCE_CREATOR | STRING | 创建者 |
237
- | CREATE_TIME | TIMESTAMP | 创建时间 ⚠️ 注意:是 CREATE_TIME 不是 CREATED_TIME |
238
- | LAST_MODIFY_TIME | TIMESTAMP | 修改时间 |
239
- | COMMENT | STRING | 注释 |
240
- | PROPERTIES | ARRAY | 保留字段 |
241
-
242
- ---
243
-
244
- ## SORTKEY_CANDIDATES 视图
245
-
246
- 实际字段(12列):
247
-
248
- | 字段名 | 类型 | 说明 |
249
- |---|---|---|
250
- | INSTANCE_ID | STRING | 实例 ID |
251
- | WORKSPACE_ID | BIGINT | 空间 ID |
252
- | WORKSPACE_NAME | STRING | 空间名称 |
253
- | SCHEMA_ID | BIGINT | Schema ID |
254
- | SCHEMA_NAME | STRING | Schema 名称 |
255
- | TABLE_ID | BIGINT | 表 ID |
256
- | TABLE_NAME | STRING | 表名 |
257
- | COL | STRING | 推荐作为排序列的字段名 |
258
- | STATEMENT | STRING | 对应的 ALTER TABLE 设置 SQL |
259
- | RATIO | DOUBLE | 预估提升效果比例 |
260
- | INSERT_TIME | TIMESTAMP | 记录插入时间 |
261
- | P_DATE | DATE | 分区日期 |
262
-
263
- ---
264
-
265
- ## 授权管理
266
-
267
- ```sql
268
- -- 授予用户查询 information_schema 的权限
269
- GRANT ALL ON ALL VIEWS IN SCHEMA information_schema TO ROLE <role_name>;
270
- GRANT ALL ON ALL VIEWS IN SCHEMA information_schema TO USER <user_name>;
271
- ```
@@ -1,186 +0,0 @@
1
- ---
2
- name: clickzetta-java-sdk
3
- description: |
4
- 使用 ClickZetta Java SDK 将数据批量或实时写入 Lakehouse 表。
5
- 覆盖 BulkloadStream(本地文件/数据库批量上传)和 RealtimeStream(Kafka 实时消费写入)
6
- 两种接口的完整使用模式,包括 Maven 依赖、连接 URL 格式、行写入 API、
7
- 状态监控、Options 调优和常见错误处理。
8
- 当用户说"Java SDK"、"BulkloadStream"、"RealtimeStream"、
9
- "Java 写入 Lakehouse"、"Java 批量上传"、"Kafka Java 写入"、
10
- "clickzetta-java"、"Maven 依赖"、"Java 数据导入"时触发。
11
- Keywords: Java SDK, BulkloadStream, RealtimeStream, Kafka consumer, batch write, real-time write
12
- ---
13
-
14
- # ClickZetta Java SDK
15
-
16
- Java SDK 提供两种写入接口:
17
- - **BulkloadStream** — 批量写入,适合定时 ETL、本地文件导入(不支持主键表,不适合 5 分钟以内的高频写入)
18
- - **RealtimeStream** — 实时写入,适合 Kafka 消费、流式数据接入(秒级可查)
19
-
20
- 阅读 [references/bulkload.md](references/bulkload.md) 了解批量写入,[references/realtime.md](references/realtime.md) 了解实时写入。
21
-
22
- ---
23
-
24
- ## Maven 依赖
25
-
26
- ```xml
27
- <!-- clickzetta-java 最新版本见 https://central.sonatype.com/artifact/com.clickzetta/clickzetta-java -->
28
- <dependency>
29
- <groupId>com.clickzetta</groupId>
30
- <artifactId>clickzetta-java</artifactId>
31
- <version>2.0.0</version>
32
- </dependency>
33
- ```
34
-
35
- RealtimeStream + Kafka 还需要:
36
-
37
- ```xml
38
- <dependency>
39
- <groupId>org.apache.kafka</groupId>
40
- <artifactId>kafka-clients</artifactId>
41
- <version>3.2.0</version>
42
- </dependency>
43
- ```
44
-
45
- ---
46
-
47
- ## 连接 URL 格式
48
-
49
- ```java
50
- // 推荐:显式参数方式(2.0.0+ 支持,不依赖 URL 解析)
51
- ClickZettaClient client = ClickZettaClient.newBuilder()
52
- .service("cn-shanghai-alicloud.api.clickzetta.com")
53
- .instance("your_instance")
54
- .workspace("your_workspace")
55
- .schema("public")
56
- .username("your_user")
57
- .password("your_password")
58
- .vcluster("default")
59
- .build();
60
-
61
- // 兼容:URL 方式(BulkloadStream 用 virtualcluster=,RealtimeStream 用 vcluster=)
62
- String bulkUrl = MessageFormat.format(
63
- "jdbc:clickzetta://{0}.{1}/{2}?schema={3}&username={4}&password={5}&virtualcluster={6}",
64
- instance, region_endpoint, workspace, schema, username, password, vcluster
65
- );
66
- String rtUrl = MessageFormat.format(
67
- "jdbc:clickzetta://{0}.{1}/{2}?schema={3}&username={4}&password={5}&vcluster={6}",
68
- instance, region_endpoint, workspace, schema, username, password, vcluster
69
- );
70
- ClickZettaClient client = ClickZettaClient.newBuilder().url(url).build();
71
- ```
72
-
73
- JDBC 连接(DDL / 查询):
74
-
75
- ```java
76
- // 2.0.0+ 驱动类:com.clickzetta.client.jdbc.ClickZettaDriver
77
- // 1.x 驱动类:com.clickzetta.jdbc.ClickZettaDriver
78
- Class.forName("com.clickzetta.client.jdbc.ClickZettaDriver");
79
- Connection conn = DriverManager.getConnection(jdbcUrl);
80
- ```
81
-
82
- ---
83
-
84
- ## BulkloadStream 快速示例
85
-
86
- ```java
87
- // 创建 BulkloadStream
88
- BulkloadStream stream = client.newBulkloadStreamBuilder()
89
- .schema("public")
90
- .table("orders")
91
- .operate(RowStream.BulkLoadOperate.APPEND)
92
- .build();
93
-
94
- // 写入数据(列索引从 0 开始,顺序与建表 DDL 一致)
95
- Row row = stream.createRow();
96
- row.setValue(0, "order-001"); // STRING
97
- row.setValue(1, 1); // INT
98
- row.setValue(2, 299.99); // DOUBLE
99
- stream.apply(row); // ⚠️ 必须调用,否则数据不发送到服务端
100
-
101
- // 关闭并等待完成
102
- stream.close();
103
- while (stream.getState() == StreamState.RUNNING) {
104
- Thread.sleep(1000);
105
- }
106
- if (stream.getState() == StreamState.FAILED) {
107
- throw new RuntimeException(stream.getErrorMessage());
108
- }
109
- client.close();
110
- ```
111
-
112
- ---
113
-
114
- ## RealtimeStream 快速示例
115
-
116
- ```java
117
- // Options 调优
118
- Options options = Options.builder()
119
- .withMutationBufferLinesNum(10) // 缓冲行数
120
- .build();
121
-
122
- // 创建 RealtimeStream(普通表,APPEND_ONLY)
123
- RealtimeStream stream = client.newRealtimeStreamBuilder()
124
- .operate(RowStream.RealTimeOperate.APPEND_ONLY)
125
- .options(options)
126
- .schema("public")
127
- .table("events")
128
- .build();
129
-
130
- // 写入数据(用列名,不用索引)
131
- Row row = stream.createRow(Stream.Operator.INSERT);
132
- row.setValue("id", 1);
133
- row.setValue("event", "{\"type\":\"click\"}");
134
- stream.apply(row);
135
- stream.close();
136
- ```
137
-
138
- ## RealtimeStream CDC 示例(主键表 UPSERT / DELETE)
139
-
140
- ```java
141
- // 建表:CREATE TABLE orders (txid STRING NOT NULL PRIMARY KEY, amount DOUBLE, status STRING);
142
-
143
- RealtimeStream stream = client.newRealtimeStreamBuilder()
144
- .operate(RowStream.RealTimeOperate.CDC) // 主键表必须用 CDC
145
- .options(options)
146
- .schema("public")
147
- .table("orders")
148
- .build();
149
-
150
- // UPSERT:存在则更新,不存在则插入
151
- Row row = stream.createRow(Stream.Operator.UPSERT);
152
- row.setValue("txid", "order-001");
153
- row.setValue("amount", 299.99);
154
- row.setValue("status", "paid");
155
- stream.apply(row);
156
-
157
- // DELETE_IGNORE:删除,目标行不存在时自动忽略
158
- Row del = stream.createRow(Stream.Operator.DELETE_IGNORE);
159
- del.setValue("txid", "order-001");
160
- stream.apply(del);
161
-
162
- stream.close();
163
- ```
164
-
165
- ---
166
-
167
- ## 选择指南
168
-
169
- | 场景 | 推荐接口 |
170
- |---|---|
171
- | 定时批量 ETL(每小时/每天) | BulkloadStream |
172
- | Kafka 实时消费 | RealtimeStream |
173
- | 5 分钟以内高频写入 | RealtimeStream |
174
- | 主键表写入(UPSERT / DELETE) | RealtimeStream CDC 模式 |
175
-
176
- ---
177
-
178
- ## 使用限制
179
-
180
- | 限制 | BulkloadStream | RealtimeStream |
181
- |---|---|---|
182
- | 主键表 | ❌ 不支持 | ✅ CDC 模式支持 |
183
- | 高频写入(< 5 分钟) | ❌ 不适合 | ✅ 支持 |
184
- | 数据可见延迟 | 写完 close() 后可见 | ~1 分钟后可见 |
185
- | Table Stream/Dynamic Table 可见 | close() 后 | ~1 分钟后 |
186
- | 表结构变更 | 重建 Stream | 停止任务,变更后约 90 分钟重启 |