docs: add doc for procedure_info table

GreptimeTeam · Oct 30, 2024 · af1daaf · af1daaf
1 parent ba3a2b6
commit af1daaf
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 9 deletions.
diff --git a/docs/reference/sql/information-schema/overview.md b/docs/reference/sql/information-schema/overview.md
@@ -55,8 +55,4 @@ There is still lots of work to do for `INFORMATION_SCHEMA`. The tracking [issue]
 | [`RUNTIME_METRICS`](./runtime-metrics.md)| Provides the system runtime metrics.|
 | [`CLUSTER_INFO`](./cluster-info.md)| Provides the topology information of the cluster.|
 | [`FLOWS`](./flows.md) | Provides the flow information.|
-
-
-
-
-
+| [`PROCEDURE_INFO`](./procedure-info.md) | Procedure information.|
diff --git a/docs/reference/sql/information-schema/procedure-info.md b/docs/reference/sql/information-schema/procedure-info.md
@@ -0,0 +1,32 @@
+# PROCEDURE_INFO
+The `PROCEDURE_INFO` table provides detailed information about various procedures.
+
+:::tip NOTE
+This table is not available on [GreptimeCloud](https://greptime.cloud/).
+:::
+
+```sql
+DESC TABLE INFORMATION_SCHEMA.PROCEDURE_INFO;
+```
+
+```sql
++----------------+----------------------+------+------+---------+---------------+
+| Column         | Type                 | Key  | Null | Default | Semantic Type |
++----------------+----------------------+------+------+---------+---------------+
+| procedure_id   | String               |      | NO   |         | FIELD         |
+| procedure_type | String               |      | NO   |         | FIELD         |
+| start_time     | TimestampMillisecond |      | YES  |         | FIELD         |
+| end_time       | TimestampMillisecond |      | YES  |         | FIELD         |
+| status         | String               |      | NO   |         | FIELD         |
+| lock_keys      | String               |      | YES  |         | FIELD         |
++----------------+----------------------+------+------+---------+---------------+
+```
+
+Fields in the `PROCEDURE_INFO` table are described as follows:
+
+- `procedure`: The ID of the Procedure.
+- `procedure_type`: The type of the Procedure.
+- `start_time`: Timestamp indicating when the procedure started.
+- `end_time`: Timestamp indicating when the procedure ended.
+- `status`: Current status of the procedure.
+- `lock_keys`: Keys locked by the procedure, if any.
diff --git a/...saurus-plugin-content-docs/current/reference/sql/information-schema/overview.md b/...saurus-plugin-content-docs/current/reference/sql/information-schema/overview.md
@@ -53,4 +53,4 @@
 | [`RUNTIME_METRICS`](./runtime-metrics.md)| 提供了系统运行时指标。|
 | [`CLUSTER_INFO`](./cluster-info.md)| 提供了集群的节点拓扑信息。|
 | [`FLOWS`](./flows.md) | 提供 Flow 相关信息。|
-  
+| [`PROCEDURE_INFO`](./procedure-info.md) | 提供 Procedure 相关信息。|
diff --git a/...-plugin-content-docs/current/reference/sql/information-schema/procedure-info.md b/...-plugin-content-docs/current/reference/sql/information-schema/procedure-info.md
@@ -0,0 +1,30 @@
+# PROCEDURE_INFO
+
+`PROCEDURE_INFO` 表提供了各种 Procedure 的详细信息。
+
+
+```sql
+DESC TABLE INFORMATION_SCHEMA.PROCEDURE_INFO;
+```
+
+```sql
++----------------+----------------------+------+------+---------+---------------+
+| Column         | Type                 | Key  | Null | Default | Semantic Type |
++----------------+----------------------+------+------+---------+---------------+
+| procedure_id   | String               |      | NO   |         | FIELD         |
+| procedure_type | String               |      | NO   |         | FIELD         |
+| start_time     | TimestampMillisecond |      | YES  |         | FIELD         |
+| end_time       | TimestampMillisecond |      | YES  |         | FIELD         |
+| status         | String               |      | NO   |         | FIELD         |
+| lock_keys      | String               |      | YES  |         | FIELD         |
++----------------+----------------------+------+------+---------+---------------+
+```
+
+`PROCEDURE_INFO` 表中的字段描述如下：
+
+- `procedure`: Procedure 的 ID。
+- `procedure_type`: Procedure 的类型。
+- `start_time`: Procedure 开始的时间戳。
+- `end_time`: Procedure 结束的时间戳。
+- `status`: Procedure 当前的状态。
+- `lock_keys`: Procedure 锁定的键。
diff --git a/...us-plugin-content-docs/version-0.9/reference/sql/information-schema/overview.md b/...us-plugin-content-docs/version-0.9/reference/sql/information-schema/overview.md
@@ -53,4 +53,4 @@
 | [`RUNTIME_METRICS`](./runtime-metrics.md)| 提供了系统运行时指标。|
 | [`CLUSTER_INFO`](./cluster-info.md)| 提供了集群的节点拓扑信息。|
 | [`FLOWS`](./flows.md) | 提供 Flow 相关信息。|
-  
+| [`PROCEDURE_INFO`](./procedure-info.md) | 提供 Procedure 相关信息。|
diff --git a/...gin-content-docs/version-0.9/reference/sql/information-schema/procedure-info.md b/...gin-content-docs/version-0.9/reference/sql/information-schema/procedure-info.md
@@ -0,0 +1,30 @@
+# PROCEDURE_INFO
+
+`PROCEDURE_INFO` 表提供了各种 Procedure 的详细信息。
+
+
+```sql
+DESC TABLE INFORMATION_SCHEMA.PROCEDURE_INFO;
+```
+
+```sql
++----------------+----------------------+------+------+---------+---------------+
+| Column         | Type                 | Key  | Null | Default | Semantic Type |
++----------------+----------------------+------+------+---------+---------------+
+| procedure_id   | String               |      | NO   |         | FIELD         |
+| procedure_type | String               |      | NO   |         | FIELD         |
+| start_time     | TimestampMillisecond |      | YES  |         | FIELD         |
+| end_time       | TimestampMillisecond |      | YES  |         | FIELD         |
+| status         | String               |      | NO   |         | FIELD         |
+| lock_keys      | String               |      | YES  |         | FIELD         |
++----------------+----------------------+------+------+---------+---------------+
+```
+
+`PROCEDURE_INFO` 表中的字段描述如下：
+
+- `procedure`: Procedure 的 ID。
+- `procedure_type`: Procedure 的类型。
+- `start_time`: Procedure 开始的时间戳。
+- `end_time`: Procedure 结束的时间戳。
+- `status`: Procedure 当前的状态。
+- `lock_keys`: Procedure 锁定的键。
diff --git a/versioned_docs/version-0.9/reference/sql/information-schema/overview.md b/versioned_docs/version-0.9/reference/sql/information-schema/overview.md
@@ -55,8 +55,7 @@ There is still lots of work to do for `INFORMATION_SCHEMA`. The tracking [issue]
 | [`RUNTIME_METRICS`](./runtime-metrics.md)| Provides the system runtime metrics.|
 | [`CLUSTER_INFO`](./cluster-info.md)| Provides the topology information of the cluster.|
 | [`FLOWS`](./flows.md) | Provides the flow information.|
-
-
+| [`PROCEDURE_INFO`](./procedure-info.md) | Procedure information.|
 
 
 
diff --git a/versioned_docs/version-0.9/reference/sql/information-schema/procedure-info.md b/versioned_docs/version-0.9/reference/sql/information-schema/procedure-info.md
@@ -0,0 +1,32 @@
+# PROCEDURE_INFO
+The `PROCEDURE_INFO` table provides detailed information about various procedures.
+
+:::tip NOTE
+This table is not available on [GreptimeCloud](https://greptime.cloud/).
+:::
+
+```sql
+DESC TABLE INFORMATION_SCHEMA.PROCEDURE_INFO;
+```
+
+```sql
++----------------+----------------------+------+------+---------+---------------+
+| Column         | Type                 | Key  | Null | Default | Semantic Type |
++----------------+----------------------+------+------+---------+---------------+
+| procedure_id   | String               |      | NO   |         | FIELD         |
+| procedure_type | String               |      | NO   |         | FIELD         |
+| start_time     | TimestampMillisecond |      | YES  |         | FIELD         |
+| end_time       | TimestampMillisecond |      | YES  |         | FIELD         |
+| status         | String               |      | NO   |         | FIELD         |
+| lock_keys      | String               |      | YES  |         | FIELD         |
++----------------+----------------------+------+------+---------+---------------+
+```
+
+Fields in the `PROCEDURE_INFO` table are described as follows:
+
+- `procedure`: The ID of the Procedure.
+- `procedure_type`: The type of the Procedure.
+- `start_time`: Timestamp indicating when the procedure started.
+- `end_time`: Timestamp indicating when the procedure ended.
+- `status`: Current status of the procedure.
+- `lock_keys`: Keys locked by the procedure, if any.