From 4de50d59cdf9d2f923fded66ef4aa44349e0a78f Mon Sep 17 00:00:00 2001 From: Paul Dix Date: Mon, 20 Jan 2025 12:33:00 -0500 Subject: [PATCH 01/14] Add page for HTTP Query API for Core and Enterprise --- .../core/http-query-api-system-tables.md | 14 ++++ content/influxdb3/core/plugins.md | 2 +- .../http-query-api-system-tables.md | 14 ++++ content/influxdb3/enterprise/plugins.md | 2 +- .../_index.md | 79 +++++++++++++++++++ 5 files changed, 109 insertions(+), 2 deletions(-) create mode 100644 content/influxdb3/core/http-query-api-system-tables.md create mode 100644 content/influxdb3/enterprise/http-query-api-system-tables.md create mode 100644 content/shared/v3-core-http-query-api-system-tables/_index.md diff --git a/content/influxdb3/core/http-query-api-system-tables.md b/content/influxdb3/core/http-query-api-system-tables.md new file mode 100644 index 000000000..bcf99be86 --- /dev/null +++ b/content/influxdb3/core/http-query-api-system-tables.md @@ -0,0 +1,14 @@ +--- +title: HTTP SQL API and System Tables +description: Guide for the HTTP SQL query API and the system tables in InfluxDB 3 +menu: + influxdb3_core: + name: HTTP Query API & System Tables +weight: 3 +influxdb3/core/tags: [] +source: /shared/v3-core-http-query-api-system-tables/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/core/plugins.md b/content/influxdb3/core/plugins.md index 154c8574d..86579fe90 100644 --- a/content/influxdb3/core/plugins.md +++ b/content/influxdb3/core/plugins.md @@ -4,7 +4,7 @@ description: Use the Python processing engine to trigger and execute custom code menu: influxdb3_core: name: Processing Engine and Python Plugins -weight: 2 +weight: 4 influxdb3/core/tags: [] source: /shared/v3-core-plugins/_index.md --- diff --git a/content/influxdb3/enterprise/http-query-api-system-tables.md b/content/influxdb3/enterprise/http-query-api-system-tables.md new file mode 100644 index 000000000..714ce7fd0 --- /dev/null +++ b/content/influxdb3/enterprise/http-query-api-system-tables.md @@ -0,0 +1,14 @@ +--- +title: HTTP SQL API and System Tables +description: Guide for the HTTP SQL query API and the system tables in InfluxDB 3 +menu: + influxdb3_enterprise: + name: HTTP Query API & System Tables +weight: 3 +influxdb3/enterprise/tags: [] +source: /shared/v3-core-http-query-api-system-tables/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/plugins.md b/content/influxdb3/enterprise/plugins.md index 4d3f3e45d..b9a15185f 100644 --- a/content/influxdb3/enterprise/plugins.md +++ b/content/influxdb3/enterprise/plugins.md @@ -4,7 +4,7 @@ description: Use the Python processing engine to trigger and execute custom code menu: influxdb3_enterprise: name: Processing Engine and Python Plugins -weight: 2 +weight: 4 influxdb3/enterprise/tags: [] source: /shared/v3-core-plugins/_index.md --- diff --git a/content/shared/v3-core-http-query-api-system-tables/_index.md b/content/shared/v3-core-http-query-api-system-tables/_index.md new file mode 100644 index 000000000..b3baf4b42 --- /dev/null +++ b/content/shared/v3-core-http-query-api-system-tables/_index.md @@ -0,0 +1,79 @@ +This guide shows some of the capabilities of the HTTP API API for querying and accessing useful information from system tables. + +The HTTP API for querying is reached via either a `GET` or `POST` to the endpoint `/api/v3/query_sql`. There is also an endpoint for InfluxQL at `/api/v3/query_influxql` but this guide will focus on just the SQL endpoint. + +The `POST` endpoint is there for when the query is too large to fit in a URL. The `GET` endpoint is useful for quick queries that can be easily encoded in a URL. + +The HTTP Query API takes the following parameters: +- `q` - The SQL query to execute +- `db` - The database to execute the query against +- `params` - A JSON object containing parameters to be used in the query (for parameterize SQL) +- `format` - The format of the response. Can be `json`, `jsonl`, `csv`, `pretty`, or `parquet`. JSONL is the preferred format as it will stream the results back to the client. Pretty is for human-readable output. + +For example, running the `show tables` query, which will show all user created tables (listed as `table_schema` of `iox`), system tables, and information schema tables. Here's the command: + +```shell +curl "http://localhost:8181/api/v3/query_sql?db=mydb&format=jsonl&q=show%20tables" +``` + +Returns the following JSONL output + +```jsonl +{"table_catalog":"public","table_schema":"iox","table_name":"system_cpu","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_cpu_cores","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_memory","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_memory_faults","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_usage","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_io","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_performance","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_network","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"distinct_caches","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"last_caches","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"parquet_files","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"processing_engine_plugins","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"processing_engine_triggers","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"queries","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"tables","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"views","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"columns","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"df_settings","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"schemata","table_type":"VIEW"} +``` + +The `iox` tables are all those created by the user of the database. The `system` tables +are all the system tables that are used by the system to show information about +the running of the database server. Some of these tables show stored information like +configurations, while others keep ephemeral state in memory like the `queries` table. + +The `information_schema` tables are views that show information about the schema of the +tables in the database. Here's the output of querying the information schema of the `system_swap` +table + +```SQL +SELECT * FROM information_schema.columns where table_schema = 'iox' AND table_name = 'system_cpu' +``` + +And the response shows the schema of our example `system_cpu` table: + +```jsonl +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"free","ordinal_position":0,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"host","ordinal_position":1,"is_nullable":"NO","data_type":"Dictionary(Int32, Utf8)"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"percent","ordinal_position":2,"is_nullable":"YES","data_type":"Float64","numeric_precision":24,"numeric_precision_radix":2} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"sin","ordinal_position":3,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"sout","ordinal_position":4,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"time","ordinal_position":5,"is_nullable":"NO","data_type":"Timestamp(Nanosecond, None)"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"total","ordinal_position":6,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"used","ordinal_position":7,"is_nullable":"YES","data_type":"UInt64"} +``` + +And here's query against the `queries` system table to see what queries we've recently executed: + +```SQL +SELECT * FROM system.queries LIMIT 2 +``` + +```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} +{"id":"47f8d312-5e75-4db2-837a-6fcf94c09927","phase":"success","issue_time":"2025-01-20T17:02:32.627782","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.000583S","permit_duration":"PT0.000015S","execute_duration":"PT0.000063S","end2end_duration":"PT0.000662S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false} +``` \ No newline at end of file From c5ea74b396703b1bc909033e0ad3edb37d288a7d Mon Sep 17 00:00:00 2001 From: Paul Dix Date: Fri, 31 Jan 2025 10:08:21 -0500 Subject: [PATCH 02/14] Update content/shared/v3-core-http-query-api-system-tables/_index.md Co-authored-by: Jason Stirnaman --- content/shared/v3-core-http-query-api-system-tables/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/v3-core-http-query-api-system-tables/_index.md b/content/shared/v3-core-http-query-api-system-tables/_index.md index b3baf4b42..77e67bc27 100644 --- a/content/shared/v3-core-http-query-api-system-tables/_index.md +++ b/content/shared/v3-core-http-query-api-system-tables/_index.md @@ -1,4 +1,4 @@ -This guide shows some of the capabilities of the HTTP API API for querying and accessing useful information from system tables. +Learn how to use the HTTP API to query and access information about the database server and table schemas. The HTTP API for querying is reached via either a `GET` or `POST` to the endpoint `/api/v3/query_sql`. There is also an endpoint for InfluxQL at `/api/v3/query_influxql` but this guide will focus on just the SQL endpoint. From d86e7a4d357f116d8cf024a5eec5eb722c95d76f Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 19 Feb 2025 19:58:05 -0600 Subject: [PATCH 03/14] chore(monolith): Style and formatting of the HTTP query API and system tables guide --- .../core/http-query-api-system-tables.md | 10 ++- .../http-query-api-system-tables.md | 10 ++- .../_index.md | 84 +++++++++++++------ 3 files changed, 72 insertions(+), 32 deletions(-) diff --git a/content/influxdb3/core/http-query-api-system-tables.md b/content/influxdb3/core/http-query-api-system-tables.md index bcf99be86..d61535ad9 100644 --- a/content/influxdb3/core/http-query-api-system-tables.md +++ b/content/influxdb3/core/http-query-api-system-tables.md @@ -1,11 +1,13 @@ --- -title: HTTP SQL API and System Tables -description: Guide for the HTTP SQL query API and the system tables in InfluxDB 3 +title: Use the HTTP API to access server information and system tables +description: | + Use the HTTP SQL query API to retrieve information about your database server + and table schemas in {{% product-name %}}. menu: influxdb3_core: - name: HTTP Query API & System Tables + name: HTTP query API & system tables weight: 3 -influxdb3/core/tags: [] +influxdb3/core/tags: [query, api] source: /shared/v3-core-http-query-api-system-tables/_index.md --- diff --git a/content/influxdb3/enterprise/http-query-api-system-tables.md b/content/influxdb3/enterprise/http-query-api-system-tables.md index 714ce7fd0..50a0873b9 100644 --- a/content/influxdb3/enterprise/http-query-api-system-tables.md +++ b/content/influxdb3/enterprise/http-query-api-system-tables.md @@ -1,11 +1,13 @@ --- -title: HTTP SQL API and System Tables -description: Guide for the HTTP SQL query API and the system tables in InfluxDB 3 +title: Use the HTTP API to access server information and system tables +description: | + Use the HTTP SQL query API to retrieve information about your database server + and table schemas in {{% product-name %}}. menu: influxdb3_enterprise: - name: HTTP Query API & System Tables + name: HTTP query API & system tables weight: 3 -influxdb3/enterprise/tags: [] +influxdb3/enterprise/tags: [query, api] source: /shared/v3-core-http-query-api-system-tables/_index.md --- diff --git a/content/shared/v3-core-http-query-api-system-tables/_index.md b/content/shared/v3-core-http-query-api-system-tables/_index.md index 77e67bc27..acb696c03 100644 --- a/content/shared/v3-core-http-query-api-system-tables/_index.md +++ b/content/shared/v3-core-http-query-api-system-tables/_index.md @@ -1,22 +1,46 @@ -Learn how to use the HTTP API to query and access information about the database server and table schemas. +Use the HTTP query API to access and view information about your database server and table schemas in {{% product-name %}}. -The HTTP API for querying is reached via either a `GET` or `POST` to the endpoint `/api/v3/query_sql`. There is also an endpoint for InfluxQL at `/api/v3/query_influxql` but this guide will focus on just the SQL endpoint. +## Query using SQL -The `POST` endpoint is there for when the query is too large to fit in a URL. The `GET` endpoint is useful for quick queries that can be easily encoded in a URL. +{{% product-name %}} provides the HTTP API `/api/v3/query_sql` endpoint for querying +data, database server information, and system tables. -The HTTP Query API takes the following parameters: -- `q` - The SQL query to execute -- `db` - The database to execute the query against -- `params` - A JSON object containing parameters to be used in the query (for parameterize SQL) -- `format` - The format of the response. Can be `json`, `jsonl`, `csv`, `pretty`, or `parquet`. JSONL is the preferred format as it will stream the results back to the client. Pretty is for human-readable output. +> [!Note] +> {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. +> Both endpoints support the same parameters. +> +> For more information about using InfluxQL, see [Query data with InfluxQL](/influxdb3/version/query-data/influxql/). -For example, running the `show tables` query, which will show all user created tables (listed as `table_schema` of `iox`), system tables, and information schema tables. Here's the command: +To execute a query, send a `GET` request or a `POST` request to the endpoint: -```shell -curl "http://localhost:8181/api/v3/query_sql?db=mydb&format=jsonl&q=show%20tables" +- `GET`: Pass parameters in the URL query string. + Use for quickly exploring your data and for queries that you can easily encode in a URL. +- `POST`: Pass parameters in a JSON object. + Use for longer, complex + queries, queries you can't easily URL-encode, and for better readability in + in your code. + +and include the following parameters: + +- `q`: _({{< req >}})_ The SQL query to execute. +- `db`: _({{< req >}})_ The database to execute the query against. +- `params`: A JSON object containing parameters to be used in a _parameterized query_. +- `format`: The format of the response (`json`, `jsonl`, `csv`, `pretty`, or `parquet`). + JSONL (`jsonl`) is preferred because it streams results back to the client. + `pretty` is for human-readable output. Default is `json`. + +### Example: show tables + +The following example sends a `GET` request that executes a `show tables` query +to retrieve all user-created +tables (`"table_schema":"iox"`), system tables, and information schema tables +for a database: + +```bash +curl "http://{{< influxdb/host >}}/api/v3/query_sql?db=mydb&format=jsonl&q=show%20tables" ``` -Returns the following JSONL output +The response body contains the following JSONL: ```jsonl {"table_catalog":"public","table_schema":"iox","table_name":"system_cpu","table_type":"BASE TABLE"} @@ -41,20 +65,32 @@ Returns the following JSONL output {"table_catalog":"public","table_schema":"information_schema","table_name":"schemata","table_type":"VIEW"} ``` -The `iox` tables are all those created by the user of the database. The `system` tables -are all the system tables that are used by the system to show information about -the running of the database server. Some of these tables show stored information like -configurations, while others keep ephemeral state in memory like the `queries` table. +A table has one of the following `table_schema` values: -The `information_schema` tables are views that show information about the schema of the -tables in the database. Here's the output of querying the information schema of the `system_swap` -table +- `iox`: tables created by the user of the database. +- `system`: tables used by the system to show information about the running database server. + Some of these tables show stored information such as configurations, + while others, such as the `queries` table, hold ephemeral state in memory. +- `information_schema`: views that show schema information for tables in the database. -```SQL -SELECT * FROM information_schema.columns where table_schema = 'iox' AND table_name = 'system_cpu' +### Example: view column information for a table + +The following query sends a `POST` request that executes an SQL query to +retrieve information about columns in the sample `system_swap` table schema: + +_Note: when sending a query in JSON, escape the single quotes around database field names._ + +```bash +curl "http://localhost:8181/api/v3/query_sql" \ + --header "Content-Type: application/json" \ + --json '{ + "db": "cpu", + "q": "SELECT * FROM information_schema.columns WHERE table_schema = '"'iox'"' AND table_name = '"'system_swap'"'", + "format": "jsonl" + }' ``` -And the response shows the schema of our example `system_cpu` table: +The output is 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"} @@ -67,7 +103,7 @@ And the response shows the schema of our example `system_cpu` table: {"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"used","ordinal_position":7,"is_nullable":"YES","data_type":"UInt64"} ``` -And here's query against the `queries` system table to see what queries we've recently executed: +To view recently executed queries, query the `queries` system table: ```SQL SELECT * FROM system.queries LIMIT 2 @@ -76,4 +112,4 @@ SELECT * FROM system.queries LIMIT 2 ```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} {"id":"47f8d312-5e75-4db2-837a-6fcf94c09927","phase":"success","issue_time":"2025-01-20T17:02:32.627782","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.000583S","permit_duration":"PT0.000015S","execute_duration":"PT0.000063S","end2end_duration":"PT0.000662S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false} -``` \ No newline at end of file +``` From 7271869e894a09c1f6cc348b7d276284c3add4c7 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 19 Feb 2025 23:50:30 -0600 Subject: [PATCH 04/14] feat(monolith): Query system data for Core and Enterprise - Revises Paul's draft for using /api/v3/query_sql to query system data. - Copies the existing structure for Ded. and Clustered - Adds an explicit POST example for a longer query. --- content/influxdb3/core/admin/_index.md | 3 +- .../core/admin/query-system-data/_index.md | 23 +++++++++++++ content/influxdb3/core/get-started/_index.md | 5 ++- .../core/http-query-api-system-tables.md | 16 --------- .../admin/query-system-data/_index.md | 23 +++++++++++++ .../enterprise/get-started/_index.md | 5 ++- .../http-query-api-system-tables.md | 16 --------- .../query-system-data}/_index.md | 34 +++++++++++-------- 8 files changed, 75 insertions(+), 50 deletions(-) create mode 100644 content/influxdb3/core/admin/query-system-data/_index.md delete mode 100644 content/influxdb3/core/http-query-api-system-tables.md create mode 100644 content/influxdb3/enterprise/admin/query-system-data/_index.md delete mode 100644 content/influxdb3/enterprise/http-query-api-system-tables.md rename content/shared/{v3-core-http-query-api-system-tables => influxdb3-admin/query-system-data}/_index.md (85%) diff --git a/content/influxdb3/core/admin/_index.md b/content/influxdb3/core/admin/_index.md index b0bda9eb6..cfd96a399 100644 --- a/content/influxdb3/core/admin/_index.md +++ b/content/influxdb3/core/admin/_index.md @@ -11,5 +11,6 @@ source: /shared/influxdb3-admin/_index.md --- diff --git a/content/influxdb3/core/admin/query-system-data/_index.md b/content/influxdb3/core/admin/query-system-data/_index.md new file mode 100644 index 000000000..5f7ac3afb --- /dev/null +++ b/content/influxdb3/core/admin/query-system-data/_index.md @@ -0,0 +1,23 @@ +--- +title: Query system data +description: | + Query system tables to see data related + to the server, queries, and tables in an {{% product-name %}} instance. + Use the HTTP SQL query API to retrieve information about your database server + and table schemas. +menu: + influxdb3_core: + name: Query system data + parent: Administer InfluxDB +weight: 3 +influxdb3/core/tags: [query, api, system information, schemas] +related: + - /influxdb3/core/query-data/sql/ + - /influxdb3/core/query-data/execute-queries/ +source: /shared/influxdb3-admin/query-system-data/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/core/get-started/_index.md b/content/influxdb3/core/get-started/_index.md index 4f8a41738..b715d6ddc 100644 --- a/content/influxdb3/core/get-started/_index.md +++ b/content/influxdb3/core/get-started/_index.md @@ -9,9 +9,12 @@ menu: influxdb3_core: name: Get started weight: 3 +related: + - /influxdb3/core/admin/query-system-data/ source: /shared/v3-core-get-started/_index.md --- diff --git a/content/influxdb3/core/http-query-api-system-tables.md b/content/influxdb3/core/http-query-api-system-tables.md deleted file mode 100644 index d61535ad9..000000000 --- a/content/influxdb3/core/http-query-api-system-tables.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Use the HTTP API to access server information and system tables -description: | - Use the HTTP SQL query API to retrieve information about your database server - and table schemas in {{% product-name %}}. -menu: - influxdb3_core: - name: HTTP query API & system tables -weight: 3 -influxdb3/core/tags: [query, api] -source: /shared/v3-core-http-query-api-system-tables/_index.md ---- - - \ No newline at end of file diff --git a/content/influxdb3/enterprise/admin/query-system-data/_index.md b/content/influxdb3/enterprise/admin/query-system-data/_index.md new file mode 100644 index 000000000..5ba273837 --- /dev/null +++ b/content/influxdb3/enterprise/admin/query-system-data/_index.md @@ -0,0 +1,23 @@ +--- +title: Query system data +description: | + Query system tables to see data related + to the server, queries, and tables in an {{% product-name %}} instance. + Use the HTTP SQL query API to retrieve information about your database server + and table schemas. +menu: + influxdb3_enterprise: + name: Query system data + parent: Administer InfluxDB +weight: 3 +influxdb3/enterprise/tags: [query, api, system information, schemas] +related: + - /influxdb3/enterprise/query-data/sql/ + - /influxdb3/enterprise/query-data/execute-queries/ +source: /shared/influxdb3-admin/query-system-data/_index.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/get-started/_index.md b/content/influxdb3/enterprise/get-started/_index.md index 0fc055df3..55f130949 100644 --- a/content/influxdb3/enterprise/get-started/_index.md +++ b/content/influxdb3/enterprise/get-started/_index.md @@ -9,9 +9,12 @@ menu: influxdb3_enterprise: name: Get started weight: 3 +related: + - /influxdb3/enterprise/admin/query-system-data/ source: /shared/v3-enterprise-get-started/_index.md --- diff --git a/content/influxdb3/enterprise/http-query-api-system-tables.md b/content/influxdb3/enterprise/http-query-api-system-tables.md deleted file mode 100644 index 50a0873b9..000000000 --- a/content/influxdb3/enterprise/http-query-api-system-tables.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Use the HTTP API to access server information and system tables -description: | - Use the HTTP SQL query API to retrieve information about your database server - and table schemas in {{% product-name %}}. -menu: - influxdb3_enterprise: - name: HTTP query API & system tables -weight: 3 -influxdb3/enterprise/tags: [query, api] -source: /shared/v3-core-http-query-api-system-tables/_index.md ---- - - \ No newline at end of file diff --git a/content/shared/v3-core-http-query-api-system-tables/_index.md b/content/shared/influxdb3-admin/query-system-data/_index.md similarity index 85% rename from content/shared/v3-core-http-query-api-system-tables/_index.md rename to content/shared/influxdb3-admin/query-system-data/_index.md index acb696c03..0a32e68d1 100644 --- a/content/shared/v3-core-http-query-api-system-tables/_index.md +++ b/content/shared/influxdb3-admin/query-system-data/_index.md @@ -1,9 +1,16 @@ -Use the HTTP query API to access and view information about your database server and table schemas in {{% product-name %}}. + +{{% product-name %}} stores data related to the database server, queries, and tables in _system tables_ within your cluster. +You can query the system tables for information about your running server, databases, and and table schemas. -## Query using SQL +## Query system tables -{{% product-name %}} provides the HTTP API `/api/v3/query_sql` endpoint for querying -data, database server information, and system tables. +- [Use the HTTP query API](#use-the-http-query-api) + - [Example: show tables](#example-show-tables) + - [Example: view column information for a table](#example-view-column-information-for-a-table) + +### Use the HTTP query API + +Use the HTTP API `/api/v3/query_sql` endpoint to retrieve and system information about your database server and table schemas in {{% product-name %}}. > [!Note] > {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. @@ -11,16 +18,12 @@ data, database server information, and system tables. > > For more information about using InfluxQL, see [Query data with InfluxQL](/influxdb3/version/query-data/influxql/). -To execute a query, send a `GET` request or a `POST` request to the endpoint: +To execute a query, send a `GET` or `POST` request to the endpoint: -- `GET`: Pass parameters in the URL query string. - Use for quickly exploring your data and for queries that you can easily encode in a URL. -- `POST`: Pass parameters in a JSON object. - Use for longer, complex - queries, queries you can't easily URL-encode, and for better readability in - in your code. +- `GET`: Pass parameters in the URL query string (for simple queries) +- `POST`: Pass parameters in a JSON object (for complex queries and readability in your code) -and include the following parameters: +Include the following parameters: - `q`: _({{< req >}})_ The SQL query to execute. - `db`: _({{< req >}})_ The database to execute the query against. @@ -29,7 +32,7 @@ and include the following parameters: JSONL (`jsonl`) is preferred because it streams results back to the client. `pretty` is for human-readable output. Default is `json`. -### Example: show tables +#### Example: show tables The following example sends a `GET` request that executes a `show tables` query to retrieve all user-created @@ -73,12 +76,13 @@ A table has one of the following `table_schema` values: while others, such as the `queries` table, hold ephemeral state in memory. - `information_schema`: views that show schema information for tables in the database. -### Example: view column information for a table +#### Example: view column information for a table The following query sends a `POST` request that executes an SQL query to retrieve information about columns in the sample `system_swap` table schema: -_Note: when sending a query in JSON, escape the single quotes around database field names._ +_Note: when you send a query in JSON, you must escape single quotes +that surround field names._ ```bash curl "http://localhost:8181/api/v3/query_sql" \ From faa6901f1a915d0dc5717e6e677d0be01d59fe1a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 19 Feb 2025 23:51:22 -0600 Subject: [PATCH 05/14] fix: SQL reference typo --- content/shared/sql-reference/join.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/sql-reference/join.md b/content/shared/sql-reference/join.md index 4911237fd..f2f288a08 100644 --- a/content/shared/sql-reference/join.md +++ b/content/shared/sql-reference/join.md @@ -241,7 +241,7 @@ ORDER BY ### Ambiguous reference to unqualified field -If a column exists on both sides of the join and is used in in the `SELECT`, +If a column exists on both sides of the join and is used in the `SELECT`, `ON`, `WHERE`, `HAVING`, `GROUP BY`, or `ORDER BY` clause, you must use a [fully-qualified reference](#fully-qualified-reference). For example, if both sides of the join have a `time` column and you want to explicitly select a From 7ce4497da1c8023219f481b49d4cb4c80a24131b Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 00:46:33 -0600 Subject: [PATCH 06/14] feat(mono): Query system data: convert the example query to an API request --- .../query-system-data/_index.md | 36 +++++++++++++++---- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/content/shared/influxdb3-admin/query-system-data/_index.md b/content/shared/influxdb3-admin/query-system-data/_index.md index 0a32e68d1..3c95f0b4f 100644 --- a/content/shared/influxdb3-admin/query-system-data/_index.md +++ b/content/shared/influxdb3-admin/query-system-data/_index.md @@ -5,8 +5,9 @@ You can query the system tables for information about your running server, datab ## Query system tables - [Use the HTTP query API](#use-the-http-query-api) - - [Example: show tables](#example-show-tables) - - [Example: view column information for a table](#example-view-column-information-for-a-table) + - [Examples](#examples) + - [Show tables](#show-tables) + - [View column information for a table](#view-column-information-for-a-table) ### Use the HTTP query API @@ -32,7 +33,18 @@ Include the following parameters: JSONL (`jsonl`) is preferred because it streams results back to the client. `pretty` is for human-readable output. Default is `json`. -#### Example: show tables +#### Examples + +> [!Note] +> #### 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 +> and write system metrics to an InfluxDB 3 database. + +##### Show tables The following example sends a `GET` request that executes a `show tables` query to retrieve all user-created @@ -76,7 +88,7 @@ A table has one of the following `table_schema` values: while others, such as the `queries` table, hold ephemeral state in memory. - `information_schema`: views that show schema information for tables in the database. -#### Example: view column information for a table +#### View column information for a table The following query sends a `POST` request that executes an SQL query to retrieve information about columns in the sample `system_swap` table schema: @@ -88,7 +100,7 @@ that surround field names._ curl "http://localhost:8181/api/v3/query_sql" \ --header "Content-Type: application/json" \ --json '{ - "db": "cpu", + "db": "mydb", "q": "SELECT * FROM information_schema.columns WHERE table_schema = '"'iox'"' AND table_name = '"'system_swap'"'", "format": "jsonl" }' @@ -107,12 +119,22 @@ The output is the following: {"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"used","ordinal_position":7,"is_nullable":"YES","data_type":"UInt64"} ``` +#### Recently executed queries + To view recently executed queries, query the `queries` system table: -```SQL -SELECT * FROM system.queries LIMIT 2 +```bash +curl "http://localhost:8181/api/v3/query_sql" \ + --header "Content-Type: application/json" \ + --json '{ + "db": "mydb", + "q": "SELECT * FROM system.queries LIMIT 2", + "format": "jsonl" + }' ``` +The output is 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} {"id":"47f8d312-5e75-4db2-837a-6fcf94c09927","phase":"success","issue_time":"2025-01-20T17:02:32.627782","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.000583S","permit_duration":"PT0.000015S","execute_duration":"PT0.000063S","end2end_duration":"PT0.000662S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false} From 081be272811d69a878a5802ae15b2efcb48f2e30 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 10:56:29 -0600 Subject: [PATCH 07/14] feat(mono): Query using the HTTP API - Adds Execute queries guide for SQL and InfluxQL query endpoints. - Fixes. --- .../execute-queries/influxdb-v3-api.md | 31 +++ .../execute-queries/influxdb-v1-api.md | 2 +- .../execute-queries/influxdb-v3-api.md | 31 +++ .../query-system-data/_index.md | 2 +- .../execute-queries/influxdb3-api.md | 198 ++++++++++++++++++ 5 files changed, 262 insertions(+), 2 deletions(-) create mode 100644 content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md create mode 100644 content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md create mode 100644 content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md diff --git a/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md b/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md new file mode 100644 index 000000000..bd7a479d7 --- /dev/null +++ b/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md @@ -0,0 +1,31 @@ +--- +title: Use the InfluxDB v3 HTTP query API to query data +seotitle: Use SQL or InfluxQL and InfluxDB v3 HTTP query API +list_title: Use the v3 query API +description: > + Use SQL or InfluxQL and the InfluxDB v3 HTTP query API to query data in {{< product-name >}}. +weight: 301 +menu: + influxdb3_core: + parent: Execute queries + name: Use the v3 query API +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 \ + --header "Authorization: Token DATABASE_TOKEN" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=SELECT * FROM home" + ``` +source: /shared/influxdb3-query-guides/execute-queries/influxdb3-api.md +--- + + diff --git a/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api.md b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api.md index 0c40fafc5..f91e0c6c8 100644 --- a/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api.md +++ b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api.md @@ -5,7 +5,7 @@ list_title: Use the v1 query API and InfluxQL description: > Use the InfluxDB v1 HTTP query API to query data in {{< product-name >}} with InfluxQL. -weight: 302 +weight: 303 menu: influxdb3_enterprise: parent: Execute queries diff --git a/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md new file mode 100644 index 000000000..072a0b372 --- /dev/null +++ b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md @@ -0,0 +1,31 @@ +--- +title: Use the InfluxDB v3 HTTP query API to query data +seotitle: Use SQL or InfluxQL and InfluxDB v3 HTTP query API +list_title: Use the v3 query API +description: > + Use SQL or InfluxQL and the InfluxDB v3 HTTP query API to query data in {{< product-name >}}. +weight: 301 +menu: + influxdb3_enterprise: + parent: Execute queries + name: Use the v3 query API +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 \ + --header "Authorization: Token DATABASE_TOKEN" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=SELECT * FROM home" + ``` +source: /shared/influxdb3-query-guides/execute-queries/influxdb3-api.md +--- + + diff --git a/content/shared/influxdb3-admin/query-system-data/_index.md b/content/shared/influxdb3-admin/query-system-data/_index.md index 3c95f0b4f..dce0a62fb 100644 --- a/content/shared/influxdb3-admin/query-system-data/_index.md +++ b/content/shared/influxdb3-admin/query-system-data/_index.md @@ -11,7 +11,7 @@ You can query the system tables for information about your running server, datab ### Use the HTTP query API -Use the HTTP API `/api/v3/query_sql` endpoint to retrieve and system information about your database server and table schemas in {{% product-name %}}. +Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information about your database server and table schemas in {{% product-name %}}. > [!Note] > {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. diff --git a/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md new file mode 100644 index 000000000..a4f89abde --- /dev/null +++ b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md @@ -0,0 +1,198 @@ + +Use the InfluxDB 3 HTTP query API to query data in {{< product-name >}}. +The API provides `GET` and `POST` endpoints for querying data and system information using SQL or InfluxQL. + +> [!Note] +> #### Query using gRPC or HTTP +> +> InfluxDB 3 supports HTTP and Flight (gRPC) query APIs. +> For more information about using Flight, see the [InfluxDB 3 (`influxdb3-`) client libraries](https://github.com/InfluxCommunity/). + +The examples below use **cURL** to send HTTP requests to the InfluxDB 3 HTTP API, +but you can use any HTTP client. + +- [Query using SQL and the HTTP API](#query-using-sql-and-the-http-api) +- [Query using InfluxQL and the HTTP API](#query-using-influxql-and-the-http-api) + +## Query using SQL and the HTTP API + +Use the `/api/v3/query_sql` endpoint with the `GET` or `POST` request methods. + +- `GET`: Pass parameters in the URL query string (for simple queries) +- `POST`: Pass parameters in a JSON object (for complex queries and readability in your code) + +Include the following parameters: + +- `q`: _({{< req >}})_ The **SQL** query to execute. +- `db`: _({{< req >}})_ The database to execute the query against. +- `params`: A JSON object containing parameters to be used in a _parameterized query_. +- `format`: The format of the response (`json`, `jsonl`, `csv`, `pretty`, or `parquet`). + JSONL (`jsonl`) is preferred because it streams results back to the client. + `pretty` is for human-readable output. Default is `json`. + +### Example: Query passing URL-encoded parameters + +The following example sends an HTTP `GET` request with a URL-encoded SQL query: + +```bash +curl -v "http://{{< influxdb/host >}}/api/v3/query_sql?db=servers&q=select+*+from+cpu+limit+5" +``` + +### Example: Query passing JSON parameters + +The following example sends an HTTP `POST` request with parameters in a JSON payload: + +```bash +curl http://{{< influxdb/host >}}/api/v3/query_sql \ + --data '{"db": "server", "q": "select * from cpu limit 5"}' +``` + +### Query system information + +Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information about your database server and table schemas in {{% product-name %}}. + +> [!Note] +> {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. +> Both endpoints support the same parameters. +> +> For more information about using InfluxQL, see [Query data with InfluxQL](/influxdb3/version/query-data/influxql/). + +#### Examples + +> [!Note] +> #### 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 +> and write system metrics to an InfluxDB 3 database. + +##### Show tables + +The following example sends a `GET` request that executes a `show tables` query +to retrieve all user-created +tables (`"table_schema":"iox"`), system tables, and information schema tables +for a database: + +```bash +curl "http://{{< influxdb/host >}}/api/v3/query_sql?db=mydb&format=jsonl&q=show%20tables" +``` + +The response body contains the following JSONL: + +```jsonl +{"table_catalog":"public","table_schema":"iox","table_name":"system_cpu","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_cpu_cores","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_memory","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_memory_faults","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_usage","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_io","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_disk_performance","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_network","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"distinct_caches","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"last_caches","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"parquet_files","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"processing_engine_plugins","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"processing_engine_triggers","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"system","table_name":"queries","table_type":"BASE TABLE"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"tables","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"views","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"columns","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"df_settings","table_type":"VIEW"} +{"table_catalog":"public","table_schema":"information_schema","table_name":"schemata","table_type":"VIEW"} +``` + +A table has one of the following `table_schema` values: + +- `iox`: tables created by the user of the database. +- `system`: tables used by the system to show information about the running database server. + Some of these tables show stored information such as configurations, + while others, such as the `queries` table, hold ephemeral state in memory. +- `information_schema`: views that show schema information for tables in the database. + +#### View column information for a table + +The following query sends a `POST` request that executes an SQL query to +retrieve information about columns in the sample `system_swap` table schema: + +_Note: when you send a query in JSON, you must escape single quotes +that surround field names._ + +```bash +curl "http://localhost:8181/api/v3/query_sql" \ + --header "Content-Type: application/json" \ + --json '{ + "db": "mydb", + "q": "SELECT * FROM information_schema.columns WHERE table_schema = '"'iox'"' AND table_name = '"'system_swap'"'", + "format": "jsonl" + }' +``` + +The output is 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"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"host","ordinal_position":1,"is_nullable":"NO","data_type":"Dictionary(Int32, Utf8)"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"percent","ordinal_position":2,"is_nullable":"YES","data_type":"Float64","numeric_precision":24,"numeric_precision_radix":2} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"sin","ordinal_position":3,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"sout","ordinal_position":4,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"time","ordinal_position":5,"is_nullable":"NO","data_type":"Timestamp(Nanosecond, None)"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"total","ordinal_position":6,"is_nullable":"YES","data_type":"UInt64"} +{"table_catalog":"public","table_schema":"iox","table_name":"system_swap","column_name":"used","ordinal_position":7,"is_nullable":"YES","data_type":"UInt64"} +``` + +#### Recently executed queries + +To view recently executed queries, query the `queries` system table: + +```bash +curl "http://localhost:8181/api/v3/query_sql" \ + --header "Content-Type: application/json" \ + --json '{ + "db": "mydb", + "q": "SELECT * FROM system.queries LIMIT 2", + "format": "jsonl" + }' +``` + +The output is 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} +{"id":"47f8d312-5e75-4db2-837a-6fcf94c09927","phase":"success","issue_time":"2025-01-20T17:02:32.627782","query_type":"sql","query_text":"show tables","partitions":0,"parquet_files":0,"plan_duration":"PT0.000583S","permit_duration":"PT0.000015S","execute_duration":"PT0.000063S","end2end_duration":"PT0.000662S","compute_duration":"P0D","max_memory":0,"success":true,"running":false,"cancelled":false} +``` + +## Query using InfluxQL and the HTTP API + +Use the `/api/v3/query_influxql` endpoint with the `GET` or `POST` request methods. + +- `GET`: Pass parameters in the URL query string (for simple queries) +- `POST`: Pass parameters in a JSON object (for complex queries and readability in your code) + +Include the following parameters: + +- `q`: _({{< req >}})_ The **InfluxQL** query to execute. +- `db`: _({{< req >}})_ The database to execute the query against. +- `params`: A JSON object containing parameters to be used in a _parameterized query_. +- `format`: The format of the response (`json`, `jsonl`, `csv`, `pretty`, or `parquet`). + JSONL (`jsonl`) is preferred because it streams results back to the client. + `pretty` is for human-readable output. Default is `json`. + +### Example: Query passing URL-encoded parameters + +The following example sends an HTTP `GET` request with a URL-encoded InfluxQL query: + +```bash +curl -v "http://{{< influxdb/host >}}/api/v3/query_influxql?db=servers&q=select+*+from+cpu+limit+5" +``` + +### Example: Query passing JSON parameters + +The following example sends an HTTP `POST` request with parameters in a JSON payload: + +```bash +curl http://{{< influxdb/host >}}/api/v3/query_influxql \ + --data '{"db": "server", "q": "select * from cpu limit 5"}' +``` \ No newline at end of file From bdf32c35c13fd8b838d74a38ea8d075ae523c8e4 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 20 Feb 2025 10:08:09 -0700 Subject: [PATCH 08/14] hotfix: fix robots.txt for staging --- layouts/robots.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/robots.txt b/layouts/robots.txt index 3965018d4..1c6ecf933 100644 --- a/layouts/robots.txt +++ b/layouts/robots.txt @@ -1,5 +1,5 @@ User-agent: * -{{- if eq .Site.Params.environment "staging" }}Disallow: / +{{ if eq .Site.Params.environment "staging" }}Disallow: / {{- else }}{{ range where .Site.Pages ".Params.noindex" true }} Disallow: {{ .RelPermalink }} {{ end -}} From 3fdd41490b4811eb952c33609d440b6d0ae30d45 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 12:04:01 -0600 Subject: [PATCH 09/14] Apply suggestions from code review Co-authored-by: Scott Anderson --- .../core/query-data/execute-queries/influxdb-v3-api.md | 4 +--- .../query-data/execute-queries/influxdb-v3-api.md | 4 +--- .../shared/influxdb3-admin/query-system-data/_index.md | 8 ++++---- .../execute-queries/influxdb3-api.md | 6 +++--- 4 files changed, 9 insertions(+), 13 deletions(-) diff --git a/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md b/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md index bd7a479d7..d9757a790 100644 --- a/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md +++ b/content/influxdb3/core/query-data/execute-queries/influxdb-v3-api.md @@ -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 \ diff --git a/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md index 072a0b372..e32290cb4 100644 --- a/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md +++ b/content/influxdb3/enterprise/query-data/execute-queries/influxdb-v3-api.md @@ -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 \ diff --git a/content/shared/influxdb3-admin/query-system-data/_index.md b/content/shared/influxdb3-admin/query-system-data/_index.md index dce0a62fb..540ecade0 100644 --- a/content/shared/influxdb3-admin/query-system-data/_index.md +++ b/content/shared/influxdb3-admin/query-system-data/_index.md @@ -1,5 +1,5 @@ -{{% 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} diff --git a/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md index a4f89abde..513e78ec4 100644 --- a/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md +++ b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md @@ -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} From e61990b6b2b62a52d247dc821bdb32863194815e Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 12:04:35 -0600 Subject: [PATCH 10/14] Update content/shared/influxdb3-admin/query-system-data/_index.md --- content/shared/influxdb3-admin/query-system-data/_index.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/content/shared/influxdb3-admin/query-system-data/_index.md b/content/shared/influxdb3-admin/query-system-data/_index.md index 540ecade0..508cdc34b 100644 --- a/content/shared/influxdb3-admin/query-system-data/_index.md +++ b/content/shared/influxdb3-admin/query-system-data/_index.md @@ -13,11 +13,6 @@ You can query the system tables for information about your running server, datab Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information about your database server and table schemas in {{% product-name %}}. -> [!Note] -> {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. -> Both endpoints support the same parameters. -> -> For more information about using InfluxQL, see [Query data with InfluxQL](/influxdb3/version/query-data/influxql/). To execute a query, send a `GET` or `POST` request to the endpoint: From 99f52cbadacebc10a9e3a309458ecd79bf8f8ce6 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 12:14:28 -0600 Subject: [PATCH 11/14] fix(mono): Remove note from query system context--suggests equivalence for querying system information. --- .../execute-queries/influxdb3-api.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md index 513e78ec4..a8ab9d018 100644 --- a/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md +++ b/content/shared/influxdb3-query-guides/execute-queries/influxdb3-api.md @@ -49,13 +49,8 @@ curl http://{{< influxdb/host >}}/api/v3/query_sql \ ### Query system information -Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information about your database server and table schemas in {{% product-name %}}. - -> [!Note] -> {{% product-name %}} uses separate API endpoints for SQL and InfluxQL queries. -> Both endpoints support the same parameters. -> -> For more information about using InfluxQL, see [Query data with InfluxQL](/influxdb3/version/query-data/influxql/). +Use the HTTP API `/api/v3/query_sql` endpoint to retrieve system information +about your database server and table schemas in {{% product-name %}}. #### Examples From 140223c87c9b68ef191e987dec2b5539db7b7f65 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 12:44:15 -0600 Subject: [PATCH 12/14] hotfix(v2): update SHA256 for darwin_amd64 package, fix lint typo error --- .../influxdb/v2/api-guide/influxdb-1x/query.md | 2 -- .../influxdb/v2/api-guide/influxdb-1x/write.md | 2 -- content/influxdb/v2/install/_index.md | 16 +++++++--------- content/influxdb/v2/reference/config-options.md | 4 +--- 4 files changed, 8 insertions(+), 16 deletions(-) diff --git a/content/influxdb/v2/api-guide/influxdb-1x/query.md b/content/influxdb/v2/api-guide/influxdb-1x/query.md index 5c8b30e2d..de5da77ae 100644 --- a/content/influxdb/v2/api-guide/influxdb-1x/query.md +++ b/content/influxdb/v2/api-guide/influxdb-1x/query.md @@ -150,7 +150,6 @@ The following precisions are available: ##### Query a non-default retention policy ```sh diff --git a/content/influxdb/v2/api-guide/influxdb-1x/write.md b/content/influxdb/v2/api-guide/influxdb-1x/write.md index eb9df477f..8e626383e 100644 --- a/content/influxdb/v2/api-guide/influxdb-1x/write.md +++ b/content/influxdb/v2/api-guide/influxdb-1x/write.md @@ -123,7 +123,6 @@ The following precisions are available: ##### Write data using basic authentication {{% oss-only %}} diff --git a/content/influxdb/v2/install/_index.md b/content/influxdb/v2/install/_index.md index 245cc44aa..d81e6fe8c 100644 --- a/content/influxdb/v2/install/_index.md +++ b/content/influxdb/v2/install/_index.md @@ -66,7 +66,7 @@ To use the SHA checksum to verify the downloaded file, do the following: the **SHA256:** checksum value. 2. Compute the SHA checksum of the downloaded file and compare it to the - published checksum--for example, enter the following command in your terminal. + published checksum--for example, enter the following command in your terminal: -{{% code-placeholders "9cb54d3940c37a8c2a908458543e629412505cc71db55094147fd39088b99c6c" %}} +{{% code-placeholders "8d7872013cad3524fb728ca8483d0adc30125ad1af262ab826dcf5d1801159cf" %}} ```bash # Use 2 spaces to separate the checksum from the filename -echo "9cb54d3940c37a8c2a908458543e629412505cc71db55094147fd39088b99c6c influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" \ +echo "8d7872013cad3524fb728ca8483d0adc30125ad1af262ab826dcf5d1801159cf influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" \ | sha256sum --check - ``` @@ -89,7 +89,7 @@ echo "9cb54d3940c37a8c2a908458543e629412505cc71db55094147fd39088b99c6c influxdb Replace the following: -- {{% code-placeholder-key %}}`9cb54d3940c37a8c2a908458543e629412505cc71db55094147fd39088b99c6c`{{% /code-placeholder-key %}}: +- {{% code-placeholder-key %}}`8d7872013cad3524fb728ca8483d0adc30125ad1af262ab826dcf5d1801159cf`{{% /code-placeholder-key %}}: the **SHA256:** checksum value that you copied from the downloads page If the checksums match, the output is the following; otherwise, an error message. @@ -162,12 +162,10 @@ gpg: key 7C3D57159FC2F927: public key "InfluxData Package Signing Key }}_darwin_amd64.tar.gz" \ ``` - --> ```sh @@ -252,11 +250,11 @@ brew install influxdb 2. {{< req text="Recommended:" color="magenta" >}}: Verify the integrity of the download--for example, enter the following command in your terminal: -{{% code-placeholders "964e1de641a43a0e1743aa5ead243e935a05631ba0bc570fb8bff486542173c1" %}} +{{% code-placeholders "224926fd77736a364cf28128f18927dda00385f0b6872a108477246a1252ae1b" %}} ```sh # Use 2 spaces to separate the checksum from the filename -echo "964e1de641a43a0e1743aa5ead243e935a05631ba0bc570fb8bff486542173c1 influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \ +echo "224926fd77736a364cf28128f18927dda00385f0b6872a108477246a1252ae1b influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \ | shasum --algorithm 256 --quiet --check - ``` @@ -264,7 +262,7 @@ echo "964e1de641a43a0e1743aa5ead243e935a05631ba0bc570fb8bff486542173c1 influxdb Replace the following: -- {{% code-placeholder-key %}}`964e1de641a43a0e1743aa5ead243e935a05631ba0bc570fb8bff486542173c1`{{% /code-placeholder-key %}}: the SHA checksum from the [downloads page](https://www.influxdata.com/downloads/#telegraf) +- {{% code-placeholder-key %}}`224926fd77736a364cf28128f18927dda00385f0b6872a108477246a1252ae1b`{{% /code-placeholder-key %}}: the SHA checksum from the [downloads page](https://www.influxdata.com/downloads/#telegraf) 3. Unpackage the InfluxDB binary. diff --git a/content/influxdb/v2/reference/config-options.md b/content/influxdb/v2/reference/config-options.md index b5a6a2479..312094e86 100644 --- a/content/influxdb/v2/reference/config-options.md +++ b/content/influxdb/v2/reference/config-options.md @@ -35,7 +35,6 @@ Use the [`influx server-config` command](/influxdb/v2/reference/cli/influx/serve to retrieve your runtime server configuration. ```sh @@ -2748,7 +2746,7 @@ storage-wal-max-concurrent-writes = 0 ### storage-wal-max-write-delay Maximum amount of time a write request to the WAL directory will wait when the -the [maximum number of concurrent active writes to the WAL directory](#storage-wal-max-concurrent-writes) +[maximum number of concurrent active writes to the WAL directory](#storage-wal-max-concurrent-writes) has been met. Set to `0` to disable the timeout. **Default:** `10m` From 9d699e5af7ae9c304e387e7d68abd95d0f37dee3 Mon Sep 17 00:00:00 2001 From: Jamie Strandboge Date: Thu, 20 Feb 2025 13:17:52 -0600 Subject: [PATCH 13/14] fix: influxdb3 no longer has MUSL builds (#5849) * fix: influxdb3 no longer has MUSL builds Reference: - https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#why-not-just-statically-link-with-eg-musl * remove musl builds from shared getting started docs --------- Co-authored-by: Scott Anderson --- content/influxdb3/core/install.md | 8 -------- content/influxdb3/enterprise/install.md | 8 -------- content/shared/v3-core-get-started/_index.md | 6 ------ content/shared/v3-enterprise-get-started/_index.md | 6 ------ 4 files changed, 28 deletions(-) diff --git a/content/influxdb3/core/install.md b/content/influxdb3/core/install.md index b2d497271..84855e40e 100644 --- a/content/influxdb3/core/install.md +++ b/content/influxdb3/core/install.md @@ -93,18 +93,10 @@ source ~/.zshrc • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Core • Linux (x86) • MUSL](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-musl.tar.gz.sha256) - - [InfluxDB 3 Core • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Core • Linux (ARM) • MUSL](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-musl.tar.gz) - {{% /tab-content %}} diff --git a/content/influxdb3/enterprise/install.md b/content/influxdb3/enterprise/install.md index e0302c9bd..152a521b2 100644 --- a/content/influxdb3/enterprise/install.md +++ b/content/influxdb3/enterprise/install.md @@ -93,18 +93,10 @@ source ~/.zshrc • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Enterprise • Linux (x86) • MUSL](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-musl.tar.gz.sha256) - - [InfluxDB 3 Enterprise • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Enterprise • Linux (ARM) • MUSL](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-musl.tar.gz) - {{% /tab-content %}} diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md index 789f8d73d..28c26d3bf 100644 --- a/content/shared/v3-core-get-started/_index.md +++ b/content/shared/v3-core-get-started/_index.md @@ -75,15 +75,9 @@ curl -O https://www.influxdata.com/d/install_influxdb3.sh \ Or, download and install [build artifacts](/influxdb3/core/install/#download-influxdb-3-core-binaries): -- [Linux | x86 | musl](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-musl.tar.gz.sha256) - [Linux | x86 | gnu](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [Linux | ARM | musl](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-musl.tar.gz.sha256) - [Linux | ARM | gnu](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz.sha256) diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md index 800bc270f..c881c893c 100644 --- a/content/shared/v3-enterprise-get-started/_index.md +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -69,15 +69,9 @@ Or, download and install [build artifacts](/influxdb3/enterprise/install/#downlo - [Linux | x86_64 | GNU](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [Linux | x86_64 | MUSL](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-musl.tar.gz.sha256) - [Linux | ARM64 | GNU](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz.sha256) -- [Linux | ARM64 | MUSL](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-musl.tar.gz) - • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-musl.tar.gz.sha256) - [macOS | ARM64](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-apple-darwin.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-apple-darwin.tar.gz.sha256) From 5872d8c6fa4ad546219cfaf5da4ec9bbf662962d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 20 Feb 2025 15:26:56 -0600 Subject: [PATCH 14/14] chore(mono): Update architectures for Docker images. --- content/influxdb3/core/install.md | 22 ++++++++++++++++- content/influxdb3/enterprise/install.md | 24 +++++++++++++++++-- content/shared/v3-core-get-started/_index.md | 7 ++++-- .../v3-enterprise-get-started/_index.md | 7 ++++-- 4 files changed, 53 insertions(+), 7 deletions(-) diff --git a/content/influxdb3/core/install.md b/content/influxdb3/core/install.md index 84855e40e..36034fd60 100644 --- a/content/influxdb3/core/install.md +++ b/content/influxdb3/core/install.md @@ -44,7 +44,8 @@ Use the InfluxDB 3 quick install script to install {{< product-name >}} on {{< product-name >}} package on your local machine: ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh + curl -O https://www.influxdata.com/d/install_influxdb3.sh \ + && sh install_influxdb3.sh ``` 2. Verify that installation completed successfully: @@ -131,9 +132,28 @@ source ~/.zshrc Use the `influxdb3-core` Docker image to deploy {{< product-name >}} in a Docker container. +The image is available for x86_64 (AMD64) and ARM64 architectures. ```bash docker pull quay.io/influxdb/influxdb3-core:latest ``` +Docker automatically pulls the appropriate image for your system architecture. + +You can also explicitly specify the architecture by using platform-specific tags: + +```bash +# For x86_64/AMD64 +docker pull \ +--platform linux/amd64 \ +quay.io/influxdb/influxdb3-core:latest +``` + +```bash +# For ARM64 +docker pull \ +--platform linux/arm64 \ +quay.io/influxdb/influxdb3-core:latest +``` + {{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} diff --git a/content/influxdb3/enterprise/install.md b/content/influxdb3/enterprise/install.md index 152a521b2..71626d535 100644 --- a/content/influxdb3/enterprise/install.md +++ b/content/influxdb3/enterprise/install.md @@ -44,7 +44,8 @@ Use the InfluxDB 3 quick install script to install {{< product-name >}} on {{< product-name >}} package on your local machine: ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh && sh install_influxdb3.sh enterprise + curl -O https://www.influxdata.com/d/install_influxdb3.sh \ + && sh install_influxdb3.sh enterprise ``` 2. Verify that installation completed successfully: @@ -131,9 +132,28 @@ source ~/.zshrc Use the `influxdb3-enterprise` Docker image to deploy {{< product-name >}} in a Docker container. +The image is available for x86_64 (AMD64) and ARM64 architectures. ```bash docker pull quay.io/influxdb/influxdb3-enterprise:latest ``` -{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} +Docker automatically pulls the appropriate image for your system architecture. + +You can also explicitly specify the architecture by using platform-specific tags: + +```bash +# For x86_64/AMD64 +docker pull \ +--platform linux/amd64 \ +quay.io/influxdb/influxdb3-enterprise:latest +``` + +```bash +# For ARM64 +docker pull \ +--platform linux/arm64 \ +quay.io/influxdb/influxdb3-enterprise:latest +``` + +{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md index 28c26d3bf..c216759bb 100644 --- a/content/shared/v3-core-get-started/_index.md +++ b/content/shared/v3-core-get-started/_index.md @@ -62,7 +62,7 @@ This guide covers InfluxDB 3 Core (the open source release), including the follo {{% tabs %}} [Linux or macOS](#linux-or-macos) [Windows](#windows) -[Docker (x86)](#docker-x86) +[Docker](#docker) {{% /tabs %}} {{% tab-content %}} @@ -101,7 +101,10 @@ Download and install the {{% product-name %}} [Windows (x86) binary](https://dl. {{% tab-content %}} -Pull the [`influxdb3-core` image](https://quay.io/repository/influxdb/influxdb3-core?tab=tags&tag=latest): +The [`influxdb3-core` image](https://quay.io/repository/influxdb/influxdb3-core?tab=tags&tag=latest) +is available for x86_64 (AMD64) and ARM64 architectures. + +Pull the image: ```bash docker pull quay.io/influxdb/influxdb3-core:latest diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md index c881c893c..4743dbf59 100644 --- a/content/shared/v3-enterprise-get-started/_index.md +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -53,7 +53,7 @@ This guide covers Enterprise as well as InfluxDB 3 Core, including the following {{% tabs %}} [Linux or macOS](#linux-or-macos) [Windows](#windows) -[Docker (x86)](#docker-x86) +[Docker](#docker) {{% /tabs %}} {{% tab-content %}} @@ -92,7 +92,10 @@ Download and install the {{% product-name %}} [Windows (x86) binary](https://dl. {{% tab-content %}} -Pull the [`influxdb3-enterprise` image](https://quay.io/repository/influxdb/influxdb3-enterprise?tab=tags&tag=latest): +The [`influxdb3-enterprise` image](https://quay.io/repository/influxdb/influxdb3-enterprise?tab=tags&tag=latest) +is available for x86_64 (AMD64) and ARM64 architectures. + +Pull the image: ```bash docker pull quay.io/influxdb/influxdb3-enterprise:latest