Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add doc for procedure_info table #1252

Merged
merged 2 commits into from
Oct 31, 2024
Merged

docs: add doc for procedure_info table #1252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af1daaf
docs: add doc for procedure_info table
WenyXu Oct 30, 2024
fdca1f4
Apply suggestions from code review
WenyXu Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions docs/reference/sql/information-schema/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.|
32 changes: 32 additions & 0 deletions docs/reference/sql/information-schema/procedure-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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_id`: 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.
2 changes: 1 addition & 1 deletion ...saurus-plugin-content-docs/current/reference/sql/information-schema/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@
| [`RUNTIME_METRICS`](./runtime-metrics.md)| 提供了系统运行时指标。|
| [`CLUSTER_INFO`](./cluster-info.md)| 提供了集群的节点拓扑信息。|
| [`FLOWS`](./flows.md) | 提供 Flow 相关信息。|
| [`PROCEDURE_INFO`](./procedure-info.md) | 提供 Procedure 相关信息。|
32 changes: 32 additions & 0 deletions ...-plugin-content-docs/current/reference/sql/information-schema/procedure-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# PROCEDURE_INFO

`PROCEDURE_INFO` 表提供了各种 Procedure 的详细信息。
:::tip NOTE
该表在 [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 |
+----------------+----------------------+------+------+---------+---------------+
```

`PROCEDURE_INFO` 表中的字段描述如下：

- `procedure_id`: Procedure 的 ID。
- `procedure_type`: Procedure 的类型。
- `start_time`: Procedure 开始的时间戳。
- `end_time`: Procedure 结束的时间戳。
- `status`: Procedure 当前的状态。
- `lock_keys`: Procedure 锁定的键。
2 changes: 1 addition & 1 deletion ...us-plugin-content-docs/version-0.9/reference/sql/information-schema/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@
| [`RUNTIME_METRICS`](./runtime-metrics.md)| 提供了系统运行时指标。|
| [`CLUSTER_INFO`](./cluster-info.md)| 提供了集群的节点拓扑信息。|
| [`FLOWS`](./flows.md) | 提供 Flow 相关信息。|
| [`PROCEDURE_INFO`](./procedure-info.md) | 提供 Procedure 相关信息。|
32 changes: 32 additions & 0 deletions ...gin-content-docs/version-0.9/reference/sql/information-schema/procedure-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# PROCEDURE_INFO

`PROCEDURE_INFO` 表提供了各种 Procedure 的详细信息。
:::tip NOTE
该表在 [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 |
+----------------+----------------------+------+------+---------+---------------+
```

`PROCEDURE_INFO` 表中的字段描述如下：

- `procedure_id`: Procedure 的 ID。
- `procedure_type`: Procedure 的类型。
- `start_time`: Procedure 开始的时间戳。
- `end_time`: Procedure 结束的时间戳。
- `status`: Procedure 当前的状态。
- `lock_keys`: Procedure 锁定的键。
3 changes: 1 addition & 2 deletions versioned_docs/version-0.9/reference/sql/information-schema/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.|



32 changes: 32 additions & 0 deletions versioned_docs/version-0.9/reference/sql/information-schema/procedure-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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_id`: 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.
Loading