Skip to content

Commit 43efe0c

Browse files
Add new influxdb3 show system commands (#5812)
* add new show system table commands * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * Update content/shared/influxdb3-cli/show/system/summary.md Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent 80a523d commit 43efe0c

File tree

14 files changed

+351
-4
lines changed

14 files changed

+351
-4
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: influxdb3 show system
3+
description: >
4+
The `influxdb3 show system` command displays data from {{< product-name >}}
5+
system tables.
6+
menu:
7+
influxdb3_core:
8+
parent: influxdb3 show
9+
name: influxdb3 show system
10+
weight: 400
11+
source: /shared/influxdb3-cli/show/system/_index.md
12+
---
13+
14+
<!--
15+
The content for this page is at content/shared/influxdb3-cli/show/system/_index.md
16+
-->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: influxdb3 show system summary
3+
description: >
4+
The `influxdb3 show system summary` command returns a summary various types of
5+
system table data.
6+
menu:
7+
influxdb3_core:
8+
parent: influxdb3 show system
9+
name: influxdb3 show system summary
10+
weight: 401
11+
source: /shared/influxdb3-cli/show/system/summary.md
12+
---
13+
14+
<!--
15+
The content for this page is at content/shared/influxdb3-cli/show/system/summary.md
16+
-->
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 show system table-list
3+
description: >
4+
The `influxdb3 show system table-list` command lists available system tables.
5+
menu:
6+
influxdb3_core:
7+
parent: influxdb3 show system
8+
name: influxdb3 show system table-list
9+
weight: 401
10+
source: /shared/influxdb3-cli/show/system/table-list.md
11+
---
12+
13+
<!--
14+
The content for this page is at content/shared/influxdb3-cli/show/system/table-list.md
15+
-->
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 show system table
3+
description: >
4+
The `influxdb3 show system table` command queries data from a system table.
5+
menu:
6+
influxdb3_core:
7+
parent: influxdb3 show system
8+
name: influxdb3 show system table
9+
weight: 401
10+
source: /shared/influxdb3-cli/show/system/table.md
11+
---
12+
13+
<!--
14+
The content for this page is at content/shared/influxdb3-cli/show/system/table.md
15+
-->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: influxdb3 show system
3+
description: >
4+
The `influxdb3 show system` command displays data from {{< product-name >}}
5+
system tables.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: influxdb3 show
9+
name: influxdb3 show system
10+
weight: 400
11+
source: /shared/influxdb3-cli/show/system/_index.md
12+
---
13+
14+
<!--
15+
The content for this page is at content/shared/influxdb3-cli/show/system/_index.md
16+
-->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: influxdb3 show system summary
3+
description: >
4+
The `influxdb3 show system summary` command returns a summary various types of
5+
system table data.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: influxdb3 show system
9+
name: influxdb3 show system summary
10+
weight: 401
11+
source: /shared/influxdb3-cli/show/system/summary.md
12+
---
13+
14+
<!--
15+
The content for this page is at content/shared/influxdb3-cli/show/system/summary.md
16+
-->
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 show system table-list
3+
description: >
4+
The `influxdb3 show system table-list` command lists available system tables.
5+
menu:
6+
influxdb3_enterprise:
7+
parent: influxdb3 show system
8+
name: influxdb3 show system table-list
9+
weight: 401
10+
source: /shared/influxdb3-cli/show/system/table-list.md
11+
---
12+
13+
<!--
14+
The content for this page is at content/shared/influxdb3-cli/show/system/table-list.md
15+
-->
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 show system table
3+
description: >
4+
The `influxdb3 show system table` command queries data from a system table.
5+
menu:
6+
influxdb3_enterprise:
7+
parent: influxdb3 show system
8+
name: influxdb3 show system table
9+
weight: 401
10+
source: /shared/influxdb3-cli/show/system/table.md
11+
---
12+
13+
<!--
14+
The content for this page is at content/shared/influxdb3-cli/show/system/table.md
15+
-->

content/shared/influxdb3-cli/show/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ influxdb3 show <SUBCOMMAND>
1111

1212
## Subcommands
1313

14-
| Subcommand | Description |
15-
| :------------------------------------------------------------------------- | :--------------------------------------------- |
14+
| Subcommand | Description |
15+
| :---------------------------------------------------------------------- | :--------------------------------------------- |
1616
| [databases](/influxdb3/version/reference/cli/influxdb3/show/databases/) | List database |
17-
| help | Print command help or the help of a subcommand |
17+
| [system](/influxdb3/version/reference/cli/influxdb3/show/system/) | Display system table data |
18+
| help | Print command help or the help of a subcommand |
1819

1920
## Options
2021

content/shared/influxdb3-cli/show/databases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ influxdb3 show databases [OPTIONS]
1818
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
1919
| | `--token` | Authentication token |
2020
| | `--show-deleted` | Include databases marked as deleted in the output |
21-
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, or `csv`) |
21+
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
2222
| `-h` | `--help` | Print help information |
2323

2424
### Option environment variables

0 commit comments

Comments
 (0)