Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
pull/5846/head
Jason Stirnaman 2025-02-20 12:04:01 -06:00 committed by GitHub
parent 081be27281
commit 3fdd41490b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 9 additions and 13 deletions

View File

@ -1,5 +1,5 @@
---
title: Use the InfluxDB v3 HTTP query API to query data
title: Use the InfluxDB v3 HTTP query API
seotitle: Use SQL or InfluxQL and InfluxDB v3 HTTP query API
list_title: Use the v3 query API
description: >
@ -13,8 +13,6 @@ influxdb3/core/tags: [query, influxql, sql, python]
metadata: [InfluxQL, SQL]
related:
- /influxdb3/core/api-compatibility/v1/
aliases:
- /influxdb3/core/query-data/influxql/execute-queries/influxdb-v1-api/
list_code_example: |
```sh
curl --get http://{{< influxdb/host >}}/api/v3/query_sql \

View File

@ -1,5 +1,5 @@
---
title: Use the InfluxDB v3 HTTP query API to query data
title: Use the InfluxDB v3 HTTP query API
seotitle: Use SQL or InfluxQL and InfluxDB v3 HTTP query API
list_title: Use the v3 query API
description: >
@ -13,8 +13,6 @@ influxdb3/enterprise/tags: [query, influxql, sql, python]
metadata: [InfluxQL, SQL]
related:
- /influxdb3/enterprise/api-compatibility/v1/
aliases:
- /influxdb3/enterprise/query-data/influxql/execute-queries/influxdb-v1-api/
list_code_example: |
```sh
curl --get http://{{< influxdb/host >}}/api/v3/query_sql \

View File

@ -1,5 +1,5 @@
<!--Shortcode-->
{{% product-name %}} stores data related to the database server, queries, and tables in _system tables_ within your cluster.
{{% product-name %}} stores data related to the database server, queries, and tables in _system tables_.
You can query the system tables for information about your running server, databases, and and table schemas.
## Query system tables
@ -36,12 +36,12 @@ Include the following parameters:
#### Examples
> [!Note]
> #### system_ sample data
> #### system\_ sample data
>
> In examples, tables with `"table_name":"system_` are user-created tables for CPU, memory, disk,
> network, and other resource statistics collected and written
> by the user--for example, using the `psutil` Python library or
> [Telegraf](https://docs.influxdata.com/telegraf/v1/get-started/) to collect
> [Telegraf](/telegraf/v1/get-started/) to collect
> and write system metrics to an InfluxDB 3 database.
##### Show tables
@ -133,7 +133,7 @@ curl "http://localhost:8181/api/v3/query_sql" \
}'
```
The output is the following:
The output is similar to the following:
```jsonl
{"id":"cdd63409-1822-4e65-8e3a-d274d553dbb3","phase":"success","issue_time":"2025-01-20T17:01:40.690067","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.032689S","permit_duration":"PT0.000202S","execute_duration":"PT0.000223S","end2end_duration":"PT0.033115S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false}

View File

@ -60,7 +60,7 @@ Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information abo
#### Examples
> [!Note]
> #### system_ sample data
> #### system\_ sample data
>
> In examples, tables with `"table_name":"system_` are user-created tables for CPU, memory, disk,
> network, and other resource statistics collected and written
@ -130,7 +130,7 @@ curl "http://localhost:8181/api/v3/query_sql" \
}'
```
The output is the following:
The output is similar to the following:
```jsonl
{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"free","ordinal_position":0,"is_nullable":"YES","data_type":"UInt64"}
@ -157,7 +157,7 @@ curl "http://localhost:8181/api/v3/query_sql" \
}'
```
The output is the following:
The output is similar to the following:
```jsonl
{"id":"cdd63409-1822-4e65-8e3a-d274d553dbb3","phase":"success","issue_time":"2025-01-20T17:01:40.690067","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.032689S","permit_duration":"PT0.000202S","execute_duration":"PT0.000223S","end2end_duration":"PT0.033115S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false}