From cbdaaa0247e9358cefe578b4d0b5fe0b1932b7e0 Mon Sep 17 00:00:00 2001 From: meelahme Date: Wed, 30 Jul 2025 14:39:02 -0700 Subject: [PATCH 01/69] feat: Add complete GET /query endpoint --- .../v1-compatibility/swaggerV1Compat.yml | 135 ++++++++++++++++++ 1 file changed, 135 insertions(+) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 744692e6d..b43a670cf 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -136,6 +136,141 @@ paths: schema: $ref: '#/components/schemas/Error' /query: + get: + operationId: GetV1ExecuteQuery + tags: + - Query + summary: Query using the InfluxDB v1 HTTP API + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: Defines the influxql query to run. + required: true + schema: + type: string + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - name: epoch + description: | + Formats timestamps as unix (epoch) timestamps with the specified precision + instead of RFC3339 timestamps with nanosecond precision. + in: query + schema: + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + examples: + influxql-chunk_size_2: + value: | + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]} + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]} + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' post: operationId: PostQueryV1 tags: From 9117e7ab3515fdde1aa18cc0230d2a1669d38236 Mon Sep 17 00:00:00 2001 From: meelahme Date: Wed, 30 Jul 2025 14:48:52 -0700 Subject: [PATCH 02/69] feat: Add complete GET /query endpoint to cluster, dedicated, and serverless --- .../v1-compatibility/swaggerV1Compat.yml | 135 ++++++++++++++++++ .../v1-compatibility/swaggerV1Compat.yml | 135 ++++++++++++++++++ 2 files changed, 270 insertions(+) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 55f91d971..ba5a4dff2 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -137,6 +137,141 @@ paths: schema: $ref: '#/components/schemas/Error' /query: + get: + operationId: GetV1ExecuteQuery + tags: + - Query + summary: Query using the InfluxDB v1 HTTP API + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: Defines the influxql query to run. + required: true + schema: + type: string + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - name: epoch + description: | + Formats timestamps as unix (epoch) timestamps with the specified precision + instead of RFC3339 timestamps with nanosecond precision. + in: query + schema: + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + examples: + influxql-chunk_size_2: + value: | + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]} + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]} + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' post: operationId: PostQueryV1 tags: diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 36c3e08b0..b822af222 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -136,6 +136,141 @@ paths: schema: $ref: '#/components/schemas/Error' /query: + get: + operationId: GetV1ExecuteQuery + tags: + - Query + summary: Query using the InfluxDB v1 HTTP API + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: Defines the influxql query to run. + required: true + schema: + type: string + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - name: epoch + description: | + Formats timestamps as unix (epoch) timestamps with the specified precision + instead of RFC3339 timestamps with nanosecond precision. + in: query + schema: + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + examples: + influxql-chunk_size_2: + value: | + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]} + {"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]} + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' post: operationId: PostQueryV1 tags: From dbcd8dde73519e23cac4604bc7d7352df7cf93eb Mon Sep 17 00:00:00 2001 From: meelahme Date: Wed, 30 Jul 2025 15:34:42 -0700 Subject: [PATCH 03/69] docs(api): enhance POST /query with JSON chunk parameter support --- .../v1-compatibility/swaggerV1Compat.yml | 32 +++++++++++++++++++ .../v1-compatibility/swaggerV1Compat.yml | 32 +++++++++++++++++++ .../v1-compatibility/swaggerV1Compat.yml | 32 +++++++++++++++++++ 3 files changed, 96 insertions(+) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index ba5a4dff2..45dcee9e6 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -283,6 +283,38 @@ paths: text/plain: schema: type: string + application/json: + schema: + type: object + properties: + db: + type: string + description: Bucket to query. + q: + description: Defines the influxql query to run. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: | + A unix timestamp precision. + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/AuthUserV1' diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index b43a670cf..16ac580f3 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -282,6 +282,38 @@ paths: text/plain: schema: type: string + application/json: + schema: + type: object + properties: + db: + type: string + description: Bucket to query. + q: + description: Defines the influxql query to run. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: | + A unix timestamp precision. + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/AuthUserV1' diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index b822af222..08f4a617e 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -282,6 +282,38 @@ paths: text/plain: schema: type: string + application/json: + schema: + type: object + properties: + db: + type: string + description: Bucket to query. + q: + description: Defines the influxql query to run. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: | + A unix timestamp precision. + type: string + enum: + - h + - m + - s + - ms + - u + - µ + - ns parameters: - $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/AuthUserV1' From 05e74088bf7f575276092e05fb0df58a4f17d3f2 Mon Sep 17 00:00:00 2001 From: Gary Fowler <97983559+garylfowler@users.noreply.github.com> Date: Wed, 30 Jul 2025 14:41:45 -1000 Subject: [PATCH 04/69] Update get-started.md Since we now allow other types of keys than Open AI, removing the word Open from this page. --- content/influxdb3/explorer/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb3/explorer/get-started.md b/content/influxdb3/explorer/get-started.md index 244191130..863ecbfec 100644 --- a/content/influxdb3/explorer/get-started.md +++ b/content/influxdb3/explorer/get-started.md @@ -86,7 +86,7 @@ To use {{% product-name %}} to query data from InfluxDB 3, navigate to The _Data Explorer_ lets you explore the schema of your database and automatically builds SQL queries by either selecting columns in the _Schema Browser_ or by using _Natural Language_ with -the {{% product-name %}} OpenAI integration. +the {{% product-name %}} AI integration. For this getting started guide, use the Schema Browser to build a SQL query that returns data from the newly written sample data set. From 67c2d19e727c601a6f8a8fa7f020bd0585bae097 Mon Sep 17 00:00:00 2001 From: meelahme Date: Thu, 31 Jul 2025 11:56:20 -0700 Subject: [PATCH 05/69] docs(api): adding api examples to DVC and LVC --- .../distinct-value-cache/create.md | 53 ++++++++++++++++++ .../distinct-value-cache/query.md | 32 +++++++++++ .../distinct-value-cache/show.md | 39 +++++++++++++ .../last-value-cache/create.md | 55 ++++++++++++++++++- .../last-value-cache/delete.md | 26 +++++++++ .../influxdb3-admin/last-value-cache/show.md | 38 +++++++++++++ 6 files changed, 242 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/create.md b/content/shared/influxdb3-admin/distinct-value-cache/create.md index c897c0dbf..a11489f63 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/create.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/create.md @@ -69,6 +69,59 @@ influxdb3 create distinct_cache \ {{% /show-in %}} +## Use the HTTP API + +You can also create a Distinct Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/configure/distinct_cache` endpoint. + +{{% code-placeholders "(DATABASE|TABLE|DVC)_NAME|AUTH_TOKEN|COLUMNS|MAX_(CARDINALITY|AGE)" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/configure/distinct_cache" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "table": "TABLE_NAME", + "name": "DVC_NAME", + "columns": ["COLUMNS"], + "max_cardinality": MAX_CARDINALITY, + "max_age": MAX_AGE + }' +``` + +{{% /code-placeholders %}} + +### Example + +```bash +curl -X POST "https://localhost:8181/api/v3/configure/distinct_cache" \ + -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "example-db", + "table": "wind_data", + "name": "windDistinctCache", + "columns": ["country", "county", "city"], + "max_cardinality": 10000, + "max_age": 86400 + }' +``` + +**Response codes:** + +- `201` : Success. The distinct cache has been created. +- `204` : Not created. A distinct cache with this configuration already exists. +- `400` : Bad request. + + +> [!Note] +> #### API parameter differences +> +> - **Columns format**: The API uses a JSON array (`["country", "county", "city"]`) +> instead of the CLI's comma-delimited format (`country,county,city`). +> - **Maximum age format**: The API uses seconds (`86400`) instead of the CLI's +> [humantime format](https://docs.rs/humantime/latest/humantime/fn.parse_duration.html) (`24h`, `1 day`). + Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: diff --git a/content/shared/influxdb3-admin/distinct-value-cache/query.md b/content/shared/influxdb3-admin/distinct-value-cache/query.md index 55e0ce4d0..4fbd41e97 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/query.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/query.md @@ -31,3 +31,35 @@ FROM WHERE country = 'Spain' ``` + +## Use the HTTP API + +You can query cached data using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|TABLE_NAME|CACHE_NAME" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "q": "SELECT * FROM last_cache('\''TABLE_NAME'\'', '\''CACHE_NAME'\'')", + "format": "json" + }' +``` + +{{% /code-placeholders %}} + +## Example with WHERE clause + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "example-db", + "q": "SELECT room, temp FROM last_cache('\''home'\'', '\''homeCache'\'') WHERE room = '\''Kitchen'\''", + "format": "json" + }' +``` diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index 0de0e2ac0..cc778fcf2 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -67,3 +67,42 @@ In the examples above, replace the following: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{< product-name >}} {{% show-in "enterprise" %}}admin {{% /show-in %}} authentication token + +## Use the HTTP API + +You can query cache information using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. + +### Query all caches + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "q": "SELECT * FROM system.last_caches", + "format": "json" + }' + ``` + +{{% /code-placeholders %}} + +## Query specific cache details + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|CACHE_NAME" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "q": "SELECT * FROM system.last_caches WHERE name = '\''CACHE_NAME'\''", + "format": "json" + }' +``` + +{{% /code-placeholders %}} + diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index febc66f83..873e64214 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -80,6 +80,59 @@ influxdb3 create last_cache \ {{% /show-in %}} +## Use the HTTP API + +You can also create a Last Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/configure/last_cache` endpoint. + +{{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN|(KEY|VALUE)_COLUMNS|COUNT|TTL" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/configure/last_cache" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "table": "TABLE_NAME", + "name": "LVC_NAME", + "key_columns": ["KEY_COLUMNS"], + "value_columns": ["VALUE_COLUMNS"], + "count": COUNT, + "ttl": TTL + }' + ``` + + {{% /code-placeholders %}} + + ### Example + +```bash + curl -X POST "https://localhost:8181/api/v3/configure/last_cache" \ + -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "example-db", + "table": "home", + "name": "homeLastCache", + "key_columns": ["room", "wall"], + "value_columns": ["temp", "hum", "co"], + "count": 5, + "ttl": 14400 + }' +``` + +**Response codes:** + +- `201` : Success. Last cache created. +- `400` : Bad request. +- `401` : Unauthorized. +- `404` : Cache not found. +- `409` : Cache already exists. + +> [!Note] +> #### API parameter differences +> Column format: The API uses JSON arrays (["room", "wall"]) instead of the CLI's comma-delimited format (room,wall). +> TTL format: The API uses seconds (14400) instead of the CLI's humantime format (4h, 4 hours). + Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: @@ -116,4 +169,4 @@ The cache imports the distinct values from the table and starts caching them. > > The LVC is stored in memory, so it's important to consider the size and persistence > of the cache. For more information, see -> [Important things to know about the Last Value Cache](/influxdb3/version/admin/last-value-cache/#important-things-to-know-about-the-last-value-cache). +> [Important things to know about the Last Value Cache](/influxdb3/version/admin/last-value-cache/#important-things-to-know-about-the-last-value-cache) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index b06ba5eb9..3ea2261aa 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -23,6 +23,32 @@ influxdb3 delete last_cache \ ``` {{% /code-placeholders %}} +## Use the HTTP API + +You can also delete a Last Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `DELETE` request to the `/api/v3/configure/last_cache` endpoint with query parameters. + +{{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN" %}} + +```bash +curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=DATABASE_NAME&table=TABLE_NAME&name=LVC_NAME" \ + -H "Authorization: Bearer AUTH_TOKEN" +{{% /code-placeholders %}} +``` + +## Example + +```bash +curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=example-db&table=home&name=homeLastCache" \ + -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" +``` + +**Response codes:** + +- `200` : Success. The last cache has been deleted. +- `400` : Bad request. +- `401` : Unauthorized. +- `404` : Cache not found. + Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: diff --git a/content/shared/influxdb3-admin/last-value-cache/show.md b/content/shared/influxdb3-admin/last-value-cache/show.md index cf0aa7019..c9838a9f9 100644 --- a/content/shared/influxdb3-admin/last-value-cache/show.md +++ b/content/shared/influxdb3-admin/last-value-cache/show.md @@ -66,3 +66,41 @@ In the examples above, replace the following: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{< product-name >}} {{% show-in "enterprise" %}}admin {{% /show-in %}} authentication token + +## Use the HTTP API + +You can query cache information using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. + +### Query all caches + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "q": "SELECT * FROM system.last_caches", + "format": "json" + }' + ``` + +{{% /code-placeholders %}} + +## Query specific cache details + +{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|CACHE_NAME" %}} + +```bash +curl -X POST "https://localhost:8181/api/v3/query_sql" \ + -H "Authorization: Bearer AUTH_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{ + "db": "DATABASE_NAME", + "q": "SELECT * FROM system.last_caches WHERE name = '\''CACHE_NAME'\''", + "format": "json" + }' +``` + +{{% /code-placeholders %}} \ No newline at end of file From 8a74c7da12f4c9427d2cd25ef46154620e6aefec Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 12:02:28 -0700 Subject: [PATCH 06/69] Update content/shared/influxdb3-admin/distinct-value-cache/show.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/shared/influxdb3-admin/distinct-value-cache/show.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index cc778fcf2..f02229d14 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -82,7 +82,7 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ -H "Content-Type: application/json" \ -d '{ "db": "DATABASE_NAME", - "q": "SELECT * FROM system.last_caches", + "q": "SELECT * FROM system.distinct_caches", "format": "json" }' ``` From d2904df598feacecffc8f7b1547dbac9af149feb Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 12:02:40 -0700 Subject: [PATCH 07/69] Update content/shared/influxdb3-admin/distinct-value-cache/show.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/shared/influxdb3-admin/distinct-value-cache/show.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index f02229d14..306ad3099 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -99,7 +99,7 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ -H "Content-Type: application/json" \ -d '{ "db": "DATABASE_NAME", - "q": "SELECT * FROM system.last_caches WHERE name = '\''CACHE_NAME'\''", + "q": "SELECT * FROM system.distinct_caches WHERE name = '\''CACHE_NAME'\''", "format": "json" }' ``` From faa973a86c29efc02542fab6cfb10a5c42ea8027 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 12:02:52 -0700 Subject: [PATCH 08/69] Update content/shared/influxdb3-admin/last-value-cache/delete.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/shared/influxdb3-admin/last-value-cache/delete.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index 3ea2261aa..dbd090fe1 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -32,8 +32,6 @@ You can also delete a Last Value Cache using the [InfluxDB v3 HTTP API](/influxd ```bash curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=DATABASE_NAME&table=TABLE_NAME&name=LVC_NAME" \ -H "Authorization: Bearer AUTH_TOKEN" -{{% /code-placeholders %}} -``` ## Example From 5419f10fa5f59884fa187352043a620f5cc34ed9 Mon Sep 17 00:00:00 2001 From: meelahme Date: Thu, 31 Jul 2025 12:47:15 -0700 Subject: [PATCH 09/69] fix(docs): close code-placeholders shortcode in LVC delete guide --- content/shared/influxdb3-admin/last-value-cache/create.md | 2 +- content/shared/influxdb3-admin/last-value-cache/delete.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index 873e64214..db892cea6 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -169,4 +169,4 @@ The cache imports the distinct values from the table and starts caching them. > > The LVC is stored in memory, so it's important to consider the size and persistence > of the cache. For more information, see -> [Important things to know about the Last Value Cache](/influxdb3/version/admin/last-value-cache/#important-things-to-know-about-the-last-value-cache) +> [Important things to know about the Last Value Cache.](/influxdb3/version/admin/last-value-cache/#important-things-to-know-about-the-last-value-cache) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index dbd090fe1..23e0765cd 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -28,10 +28,11 @@ influxdb3 delete last_cache \ You can also delete a Last Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `DELETE` request to the `/api/v3/configure/last_cache` endpoint with query parameters. {{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN" %}} - ```bash curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=DATABASE_NAME&table=TABLE_NAME&name=LVC_NAME" \ -H "Authorization: Bearer AUTH_TOKEN" +``` +{{% /code-placeholders %}} ## Example From 105a06b73bf3e22a6efa7081c9ad75c4d31650b5 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:21:23 -0700 Subject: [PATCH 10/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 08f4a617e..dfba93fa6 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -196,7 +196,7 @@ paths: default: false - in: query name: q - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. required: true schema: type: string From ed7fa9016dcca75936cd1ab21c08bd7a9fd58167 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:21:31 -0700 Subject: [PATCH 11/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index dfba93fa6..751b96ea9 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -290,7 +290,7 @@ paths: type: string description: Bucket to query. q: - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. type: string chunked: description: | From aa766edd7037656b972f2202c42d67fbec30ff49 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:21:38 -0700 Subject: [PATCH 12/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 16ac580f3..cdbcf785a 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -196,7 +196,7 @@ paths: default: false - in: query name: q - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. required: true schema: type: string From e9bbdf1823bad2af01ddbda7174c185fe5936f4f Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:21:50 -0700 Subject: [PATCH 13/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index cdbcf785a..858effb50 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -290,7 +290,7 @@ paths: type: string description: Bucket to query. q: - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. type: string chunked: description: | From e7723172a5af617c589de83efed3719f59b15c9e Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:21:58 -0700 Subject: [PATCH 14/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 45dcee9e6..fdf030435 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -197,7 +197,7 @@ paths: default: false - in: query name: q - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. required: true schema: type: string From 33ace566326678fdcd45ce262c05d4be44226b25 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 31 Jul 2025 23:22:06 -0700 Subject: [PATCH 15/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index fdf030435..9c843ef9f 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -291,7 +291,7 @@ paths: type: string description: Bucket to query. q: - description: Defines the influxql query to run. + description: Defines the InfluxQL query to run. type: string chunked: description: | From 7140e46f45901b608d2eff3b368a907ac7959fd4 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:17:27 -0700 Subject: [PATCH 16/69] Update content/shared/influxdb3-admin/distinct-value-cache/query.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/query.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/query.md b/content/shared/influxdb3-admin/distinct-value-cache/query.md index 4fbd41e97..d6656fa9b 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/query.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/query.md @@ -44,7 +44,7 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ -H "Content-Type: application/json" \ -d '{ "db": "DATABASE_NAME", - "q": "SELECT * FROM last_cache('\''TABLE_NAME'\'', '\''CACHE_NAME'\'')", + "q": "SELECT * FROM distinct_cache('\''TABLE_NAME'\'', '\''CACHE_NAME'\'')", "format": "json" }' ``` From 0e58bb864ac9c4ca837724e0862b09850d087665 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:18:11 -0700 Subject: [PATCH 17/69] Update content/shared/influxdb3-admin/distinct-value-cache/query.md Co-authored-by: Jason Stirnaman --- .../shared/influxdb3-admin/distinct-value-cache/query.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/query.md b/content/shared/influxdb3-admin/distinct-value-cache/query.md index d6656fa9b..63349341b 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/query.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/query.md @@ -34,7 +34,11 @@ WHERE ## Use the HTTP API -You can query cached data using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. +To use the HTTP API to query cached data, send a `GET` or `POST` request to the `/api/v3/query_sql` endpoint and include the [`distinct_cache()`](/influxdb3/version/reference/sql/functions/cache/#distinct_cache) function in your query. + +{{% api-endpoint method="GET" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/GetExecuteQuerySQL" %}} + +{{% api-endpoint method="POST" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/PostExecuteQuerySQL" %}} {{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|TABLE_NAME|CACHE_NAME" %}} From f39af3f15a10bd1929593fc9289314eff78eb0d5 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:18:24 -0700 Subject: [PATCH 18/69] Update content/shared/influxdb3-admin/distinct-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/show.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index 306ad3099..2541d606a 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -70,7 +70,11 @@ In the examples above, replace the following: ## Use the HTTP API -You can query cache information using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. +To use the HTTP API to query and output cache information from the system table, send a `GET` or `POST` request to the `/api/v3/query_sql` endpoint. + +{{% api-endpoint method="GET" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/GetExecuteQuerySQL" %}} + +{{% api-endpoint method="POST" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/PostExecuteQuerySQL" %}} ### Query all caches From 0f5056e239df597958a9540e1bb7aceec6a63518 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:18:32 -0700 Subject: [PATCH 19/69] Update content/shared/influxdb3-admin/last-value-cache/create.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/create.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index db892cea6..720963e79 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -82,7 +82,9 @@ influxdb3 create last_cache \ ## Use the HTTP API -You can also create a Last Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/configure/last_cache` endpoint. +To use the HTTP API to create a Last Value Cache, send a `POST` request to the `/api/v3/configure/last_cache` endpoint. + +{{% api-endpoint method="POST" endpoint="/api/v3/configure/last_cache" api-ref="/influxdb3/version/api/v3/#operation/PostConfigureLastCache" %}} {{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN|(KEY|VALUE)_COLUMNS|COUNT|TTL" %}} From 99715ce70dc08469570261257a19e097b66c20b3 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:18:46 -0700 Subject: [PATCH 20/69] Update content/shared/influxdb3-admin/last-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/show.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/show.md b/content/shared/influxdb3-admin/last-value-cache/show.md index c9838a9f9..9fe027e86 100644 --- a/content/shared/influxdb3-admin/last-value-cache/show.md +++ b/content/shared/influxdb3-admin/last-value-cache/show.md @@ -77,9 +77,8 @@ You can query cache information using the [InfluxDB v3 SQL query API](/influxdb3 ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "q": "SELECT * FROM system.last_caches", "format": "json" From 9c9f2c69995e9c8db32779758e991803e47e866b Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:18:56 -0700 Subject: [PATCH 21/69] Update content/shared/influxdb3-admin/last-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/show.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/show.md b/content/shared/influxdb3-admin/last-value-cache/show.md index 9fe027e86..27289a6db 100644 --- a/content/shared/influxdb3-admin/last-value-cache/show.md +++ b/content/shared/influxdb3-admin/last-value-cache/show.md @@ -93,9 +93,8 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "q": "SELECT * FROM system.last_caches WHERE name = '\''CACHE_NAME'\''", "format": "json" From c281a6e10191ab4d681edfe63e99c2192b3f5bf7 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:19:14 -0700 Subject: [PATCH 22/69] Update content/shared/influxdb3-admin/distinct-value-cache/create.md Co-authored-by: Jason Stirnaman --- .../shared/influxdb3-admin/distinct-value-cache/create.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/create.md b/content/shared/influxdb3-admin/distinct-value-cache/create.md index a11489f63..229fd665a 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/create.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/create.md @@ -95,9 +95,8 @@ curl -X POST "https://localhost:8181/api/v3/configure/distinct_cache" \ ```bash curl -X POST "https://localhost:8181/api/v3/configure/distinct_cache" \ - -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + --json '{ "db": "example-db", "table": "wind_data", "name": "windDistinctCache", From a4023bae6dcad70a715e9376a32aee94793aeab8 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:19:25 -0700 Subject: [PATCH 23/69] Update content/shared/influxdb3-admin/distinct-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/show.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index 2541d606a..3326a8467 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -99,9 +99,8 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "q": "SELECT * FROM system.distinct_caches WHERE name = '\''CACHE_NAME'\''", "format": "json" From aad8d899aea7d2e9061b4c0ebf79162cd3eabf1f Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:19:40 -0700 Subject: [PATCH 24/69] Update content/shared/influxdb3-admin/distinct-value-cache/query.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/query.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/query.md b/content/shared/influxdb3-admin/distinct-value-cache/query.md index 63349341b..952ce9d39 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/query.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/query.md @@ -59,9 +59,8 @@ curl -X POST "https://localhost:8181/api/v3/query_sql" \ ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + --json '{ "db": "example-db", "q": "SELECT room, temp FROM last_cache('\''home'\'', '\''homeCache'\'') WHERE room = '\''Kitchen'\''", "format": "json" From 866ee9b11d26acfea5bcfe6e2ffdb31f72cfa8bc Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:21:05 -0700 Subject: [PATCH 25/69] Update content/shared/influxdb3-admin/distinct-value-cache/create.md Co-authored-by: Jason Stirnaman --- .../shared/influxdb3-admin/distinct-value-cache/create.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/create.md b/content/shared/influxdb3-admin/distinct-value-cache/create.md index 229fd665a..d0e89dc92 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/create.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/create.md @@ -77,9 +77,8 @@ You can also create a Distinct Value Cache using the [InfluxDB v3 HTTP API](/inf ```bash curl -X POST "https://localhost:8181/api/v3/configure/distinct_cache" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "table": "TABLE_NAME", "name": "DVC_NAME", From 0384cad10091c6841438ee84b7e5eeff507ed006 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:24:38 -0700 Subject: [PATCH 26/69] Update content/shared/influxdb3-admin/distinct-value-cache/query.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/query.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/query.md b/content/shared/influxdb3-admin/distinct-value-cache/query.md index 952ce9d39..9ec48d4ee 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/query.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/query.md @@ -44,9 +44,8 @@ To use the HTTP API to query cached data, send a `GET` or `POST` request to the ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "q": "SELECT * FROM distinct_cache('\''TABLE_NAME'\'', '\''CACHE_NAME'\'')", "format": "json" From 057de1230b225ef0fd5b287433ea26d21bc79320 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:24:48 -0700 Subject: [PATCH 27/69] Update content/shared/influxdb3-admin/distinct-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/show.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index 3326a8467..fd825711d 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -82,9 +82,8 @@ To use the HTTP API to query and output cache information from the system table, ```bash curl -X POST "https://localhost:8181/api/v3/query_sql" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "q": "SELECT * FROM system.distinct_caches", "format": "json" From 419fda92b5b0b95d39a97d23872b3ff14f938d28 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:25:19 -0700 Subject: [PATCH 28/69] Update content/shared/influxdb3-admin/last-value-cache/create.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/create.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index 720963e79..209aefcf7 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -90,9 +90,8 @@ To use the HTTP API to create a Last Value Cache, send a `POST` request to the ` ```bash curl -X POST "https://localhost:8181/api/v3/configure/last_cache" \ - -H "Authorization: Bearer AUTH_TOKEN" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer AUTH_TOKEN" \ + --json '{ "db": "DATABASE_NAME", "table": "TABLE_NAME", "name": "LVC_NAME", From a5c19e60cde28af2aea0747b4f2cb50436da4c4e Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:26:14 -0700 Subject: [PATCH 29/69] Update content/shared/influxdb3-admin/last-value-cache/create.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/create.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index 209aefcf7..5e57de077 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -108,9 +108,8 @@ curl -X POST "https://localhost:8181/api/v3/configure/last_cache" \ ```bash curl -X POST "https://localhost:8181/api/v3/configure/last_cache" \ - -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ - -H "Content-Type: application/json" \ - -d '{ + --header "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" \ + --json '{ "db": "example-db", "table": "home", "name": "homeLastCache", From 5ea874998c24601145606e9353e387136b0bb0b5 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:26:27 -0700 Subject: [PATCH 30/69] Update content/shared/influxdb3-admin/last-value-cache/delete.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/delete.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index 23e0765cd..ba3d55b9b 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -25,7 +25,9 @@ influxdb3 delete last_cache \ ## Use the HTTP API -You can also delete a Last Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `DELETE` request to the `/api/v3/configure/last_cache` endpoint with query parameters. +To use the HTTP API to delete a Last Value Cache, send a `DELETE` request to the `/api/v3/configure/last_cache` endpoint with query parameters. + +{{% api-endpoint method="DELETE" endpoint="/api/v3/configure/last_cache" api-ref="/influxdb3/core/api/v3/#operation/DeleteConfigureLastCache" %}} {{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN" %}} ```bash From 5e465a412163c25843fd1314bdbb082874d985ea Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:26:40 -0700 Subject: [PATCH 31/69] Update content/shared/influxdb3-admin/last-value-cache/delete.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/delete.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index ba3d55b9b..4b7563084 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -32,7 +32,7 @@ To use the HTTP API to delete a Last Value Cache, send a `DELETE` request to the {{% code-placeholders "(DATABASE|TABLE|LVC)_NAME|AUTH_TOKEN" %}} ```bash curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=DATABASE_NAME&table=TABLE_NAME&name=LVC_NAME" \ - -H "Authorization: Bearer AUTH_TOKEN" + --header "Authorization: Bearer AUTH_TOKEN" ``` {{% /code-placeholders %}} From 61fe70ad8ed698e56ab6dc24da1209da527e6435 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:26:50 -0700 Subject: [PATCH 32/69] Update content/shared/influxdb3-admin/last-value-cache/delete.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/delete.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index 4b7563084..8f61adaa6 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -40,7 +40,7 @@ curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=DATABASE_N ```bash curl -X DELETE "https://localhost:8181/api/v3/configure/last_cache?db=example-db&table=home&name=homeLastCache" \ - -H "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" + --header "Authorization: Bearer 00xoXX0xXXx0000XxxxXx0Xx0xx0" ``` **Response codes:** From 0f46f108cacddcee695b31829dd19aa875cadcea Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:27:00 -0700 Subject: [PATCH 33/69] Update content/shared/influxdb3-admin/last-value-cache/show.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/last-value-cache/show.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/shared/influxdb3-admin/last-value-cache/show.md b/content/shared/influxdb3-admin/last-value-cache/show.md index 27289a6db..623e1c57f 100644 --- a/content/shared/influxdb3-admin/last-value-cache/show.md +++ b/content/shared/influxdb3-admin/last-value-cache/show.md @@ -69,9 +69,13 @@ In the examples above, replace the following: ## Use the HTTP API -You can query cache information using the [InfluxDB v3 SQL query API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/query_sql` endpoint. +To use the HTTP API to query and output cache information from the system table, send a `GET` or `POST` request to the `/api/v3/query_sql` endpoint. -### Query all caches +{{% api-endpoint method="GET" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/GetExecuteQuerySQL" %}} + +{{% api-endpoint method="POST" endpoint="/api/v3/query_sql" api-ref="/influxdb3/version/api/v3/#operation/PostExecuteQuerySQL" %}} + +### Query all last value caches {{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}} From 36085a80ea90b218210113a1016c16c356d9f1a1 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:42:13 -0700 Subject: [PATCH 34/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 9c843ef9f..024ecaaf6 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -289,7 +289,7 @@ paths: properties: db: type: string - description: Bucket to query. + description: Database to query from. q: description: Defines the InfluxQL query to run. type: string From 7cc0c38df6be582540f0da7cd656e6197df3ae40 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:42:28 -0700 Subject: [PATCH 35/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 024ecaaf6..7c661ce47 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -290,6 +290,10 @@ paths: db: type: string description: Database to query from. + rp: + description: | + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). + type: string q: description: Defines the InfluxQL query to run. type: string From 6ba77d4808f9a413b5f065abed19144ae4f78951 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:42:36 -0700 Subject: [PATCH 36/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 7c661ce47..c2fd7a753 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -138,7 +138,7 @@ paths: $ref: '#/components/schemas/Error' /query: get: - operationId: GetV1ExecuteQuery + operationId: GetQueryV1 tags: - Query summary: Query using the InfluxDB v1 HTTP API From 6efb013714df8e42bdd0d6707ffecb2a539ab5c4 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:43:13 -0700 Subject: [PATCH 37/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index c2fd7a753..d8c5df5f9 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -187,7 +187,7 @@ paths: schema: type: string required: true - description: Bucket to query. + description: Database to query from. - in: query name: pretty description: | From 6a20bb037218f175a1858551903fd7c17365ff9e Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:43:22 -0700 Subject: [PATCH 38/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 858effb50..bf1029d56 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -186,7 +186,7 @@ paths: schema: type: string required: true - description: Bucket to query. + description: The database to query from. - in: query name: pretty description: | From 3b738ec6180849c506508d7ec6a6e48b4632cd78 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:43:29 -0700 Subject: [PATCH 39/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 751b96ea9..0c89e064e 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -186,7 +186,7 @@ paths: schema: type: string required: true - description: Bucket to query. + description: The database to query from. - in: query name: pretty description: | From 13087e49d0ab60d221a9db34498d84ef4df56dda Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:46:56 -0700 Subject: [PATCH 40/69] Update content/shared/influxdb3-admin/distinct-value-cache/create.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-admin/distinct-value-cache/create.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/create.md b/content/shared/influxdb3-admin/distinct-value-cache/create.md index d0e89dc92..560208c34 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/create.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/create.md @@ -71,7 +71,9 @@ influxdb3 create distinct_cache \ ## Use the HTTP API -You can also create a Distinct Value Cache using the [InfluxDB v3 HTTP API](/influxdb3/version/api/v3/). Send a `POST` request to the `/api/v3/configure/distinct_cache` endpoint. +To use the HTTP API to create a Distinct Value Cache, send a `POST` request to the `/api/v3/configure/distinct_cache` endpoint. + +{{% api-endpoint method="POST" endpoint="/api/v3/configure/distinct_cache" api-ref="/influxdb3/version/api/v3/#operation/PostConfigureDistinctCache" %}} {{% code-placeholders "(DATABASE|TABLE|DVC)_NAME|AUTH_TOKEN|COLUMNS|MAX_(CARDINALITY|AGE)" %}} From 76af7669ee3378c980903b6f80db29da0a2190b7 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 1 Aug 2025 16:45:45 -0700 Subject: [PATCH 41/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index bf1029d56..43b84af62 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -288,7 +288,7 @@ paths: properties: db: type: string - description: Bucket to query. + description: The database to query from. q: description: Defines the InfluxQL query to run. type: string From 7436f0fbd862e9e70e1d2b040a3739fe8473ef4c Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Mon, 4 Aug 2025 14:37:18 -0700 Subject: [PATCH 42/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index d8c5df5f9..e76225b56 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -294,6 +294,10 @@ paths: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). type: string + rp: + description: | + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). + type: string q: description: Defines the InfluxQL query to run. type: string From c6a11dbb089ed40d4d0d4ccab01bd2062f7a5bf0 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Mon, 4 Aug 2025 14:37:47 -0700 Subject: [PATCH 43/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index e76225b56..db77d64f1 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -298,6 +298,10 @@ paths: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). type: string + rp: + description: | + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). + type: string q: description: Defines the InfluxQL query to run. type: string From 3b60c7f253a2765a718a7ba6f70b42e92cfbd7bc Mon Sep 17 00:00:00 2001 From: meelahme Date: Tue, 5 Aug 2025 13:21:16 -0700 Subject: [PATCH 44/69] docs: updating swaggerVwith rp, operationID, and bucket changed to database --- .../v1-compatibility/swaggerV1Compat.yml | 14 +++----------- .../v1-compatibility/swaggerV1Compat.yml | 8 ++++++-- .../clustered/v1-compatibility/swaggerV1Compat.yml | 8 ++++++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index db77d64f1..16491b315 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -66,7 +66,7 @@ paths: schema: type: string required: true - description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. - in: query name: rp schema: @@ -187,7 +187,7 @@ paths: schema: type: string required: true - description: Database to query from. + description: The database to query from. - in: query name: pretty description: | @@ -294,14 +294,6 @@ paths: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). type: string - rp: - description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). - type: string - rp: - description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). - type: string q: description: Defines the InfluxQL query to run. type: string @@ -363,7 +355,7 @@ paths: schema: type: string required: true - description: Bucket to query. + description: Database to query. - in: query name: rp schema: diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 43b84af62..e599a77ce 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -65,7 +65,7 @@ paths: schema: type: string required: true - description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. - in: query name: rp schema: @@ -137,7 +137,7 @@ paths: $ref: '#/components/schemas/Error' /query: get: - operationId: GetV1ExecuteQuery + operationId: GetQueryV1 tags: - Query summary: Query using the InfluxDB v1 HTTP API @@ -289,6 +289,10 @@ paths: db: type: string description: The database to query from. + rp: + description: | + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). + type: string q: description: Defines the InfluxQL query to run. type: string diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 0c89e064e..a189e53f9 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -65,7 +65,7 @@ paths: schema: type: string required: true - description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. - in: query name: rp schema: @@ -137,7 +137,7 @@ paths: $ref: '#/components/schemas/Error' /query: get: - operationId: GetV1ExecuteQuery + operationId: GetQueryV1 tags: - Query summary: Query using the InfluxDB v1 HTTP API @@ -289,6 +289,10 @@ paths: db: type: string description: Bucket to query. + rp: + description: | + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). + type: string q: description: Defines the InfluxQL query to run. type: string From 3c2f475751be06c628863b785698a0fc32d03d3b Mon Sep 17 00:00:00 2001 From: meelahme Date: Tue, 5 Aug 2025 13:39:31 -0700 Subject: [PATCH 45/69] dox: fixing wrong indentation --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index a189e53f9..c8a797bb7 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -289,7 +289,7 @@ paths: db: type: string description: Bucket to query. - rp: + rp: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). type: string From 4a6cbb38dd712b53eec9938c378c373549e040ce Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 5 Aug 2025 13:43:53 -0700 Subject: [PATCH 46/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index c8a797bb7..ffe39b4fc 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -288,7 +288,7 @@ paths: properties: db: type: string - description: Bucket to query. + description: Database to query. rp: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). From 7f17176865fc6f980bdce71d26aac8be2d877389 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 5 Aug 2025 13:44:08 -0700 Subject: [PATCH 47/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-dedicated/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 16491b315..d3d067a62 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -289,7 +289,7 @@ paths: properties: db: type: string - description: Database to query from. + description: The database to query from. rp: description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). From 5ef4d2e1e4fe0e2199f49e0b058fc854ecb30894 Mon Sep 17 00:00:00 2001 From: meelahme Date: Tue, 5 Aug 2025 13:52:18 -0700 Subject: [PATCH 48/69] docs: updating rp for cluster and serverless --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index c8a797bb7..d6f473311 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -291,7 +291,7 @@ paths: description: Bucket to query. rp: description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). + The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). type: string q: description: Defines the InfluxQL query to run. From ae96f0154ede3ab81b76229286256f5e23b86941 Mon Sep 17 00:00:00 2001 From: meelahme Date: Tue, 5 Aug 2025 14:02:39 -0700 Subject: [PATCH 49/69] docs: updates to clous-serveless rp --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index e599a77ce..c3fc9f285 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -291,7 +291,7 @@ paths: description: The database to query from. rp: description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-serverless/admin/databases/create/#influxql-dbrp-naming-convention). + The retention policy to query data from. type: string q: description: Defines the InfluxQL query to run. From a2157763c9d589c3c94fabe5c6548ae452ffe3f9 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 5 Aug 2025 14:38:10 -0700 Subject: [PATCH 50/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index c3fc9f285..9b65dfd27 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -288,7 +288,7 @@ paths: properties: db: type: string - description: The database to query from. + description: Database to query. rp: description: | The retention policy to query data from. From 65e80cad92e53f3c9c999b60fc2925297ad8917a Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 5 Aug 2025 14:38:21 -0700 Subject: [PATCH 51/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../cloud-serverless/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 9b65dfd27..b1bcb5e09 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -290,7 +290,7 @@ paths: type: string description: Database to query. rp: - description: | + description: | The retention policy to query data from. type: string q: From 9ee11d3d41ba64421d97f548dc1043efa3294906 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 5 Aug 2025 14:38:30 -0700 Subject: [PATCH 52/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 9741acb5a..2b6305f4c 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -290,7 +290,7 @@ paths: type: string description: Database to query. rp: - description: | + description: | The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). type: string q: From 6fb6454aa26437349ab7153f643dee69301f643d Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:54:12 -0700 Subject: [PATCH 53/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index d3d067a62..c429fc406 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -205,7 +205,26 @@ paths: name: rp schema: type: string - description: Retention policy name. + description: | + The retention policy name for InfluxQL compatibility + + Optional parameter that, when combined with the db parameter, forms the complete database name to query. In InfluxDB Cloud Dedicated, databases can be named using the + database_name/retention_policy_name convention for InfluxQL compatibility. + + When a request specifies both `db` and `rp`, Cloud Dedicated combines them as `db/rp` to target the database--for example: + + - If `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen` + - If only `db=mydb` is provided (no `rp`), the query targets the database named `mydb` + + Unlike InfluxDB v1 and Cloud Serverless, Cloud Dedicated does not use DBRP mappings or separate retention policy objects. This parameter exists solely for v1 API + compatibility and database naming conventions. + + _Note: The retention policy name does not control data retention in Cloud Dedicated. Data retention is determined by the database's **retention period** setting._ + + ### Related + + - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention) + - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences) - name: epoch description: | Formats timestamps as unix (epoch) timestamps with the specified precision From ce5d9292c542d85cc1261595e35571fc234d8220 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:54:39 -0700 Subject: [PATCH 54/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index c429fc406..f4e16bc45 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -66,7 +66,22 @@ paths: schema: type: string required: true - description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. + description: | + The database to write to. + + **Database targeting:** In Cloud Dedicated, databases can be named using the `database_name/retention_policy_name` convention for InfluxQL compatibility. Cloud Dedicated does not use DBRP mappings. The db and rp parameters are used to construct the target database name following this naming convention. + + **Auto-creation behavior:** Cloud Dedicated requires databases to be created before writing data. The v1 `/write` API does not automatically create databases. If the specified + database does not exist, the write request will fail. + + Authentication: Requires a valid API token with _write_ permissions for the target database. + + ### Related + + - [Write data to InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/write-data/) + - [Manage databases in InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/admin/databases/) + - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention) + - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences) - in: query name: rp schema: From 89db6cdd51ba67439d109e22276a011dde20c65c Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:55:09 -0700 Subject: [PATCH 55/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index f4e16bc45..6a9750253 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -326,7 +326,26 @@ paths: description: The database to query from. rp: description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). + The retention policy name for InfluxQL compatibility + + Optional parameter that, when combined with the db parameter, forms the complete database name to query. In InfluxDB Cloud Dedicated, databases can be named using the + database_name/retention_policy_name convention for InfluxQL compatibility. + + When a request specifies both `db` and `rp`, Cloud Dedicated combines them as `db/rp` to target the database--for example: + + - If `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen` + - If only `db=mydb` is provided (no `rp`), the query targets the database named `mydb` + + Unlike InfluxDB v1 and Cloud Serverless, Cloud Dedicated does not use DBRP mappings or separate retention policy objects. This parameter exists solely for v1 API + compatibility and database naming conventions. + + _Note: The retention policy name does not control data retention in Cloud Dedicated. Data retention is determined by the database's **retention period** setting._ + + ### Related + + - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention) + - [Migrate data from InfluxDB 1.x to Cloud Dedicated](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/) + - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences) type: string q: description: Defines the InfluxQL query to run. From bc890e4d6d71783e6e3c4d119ceffb15c7a9bcbf Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:55:21 -0700 Subject: [PATCH 56/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index b1bcb5e09..db48db47f 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -186,7 +186,32 @@ paths: schema: type: string required: true - description: The database to query from. + description: | + The database name for InfluxQL queries + + Required parameter that specifies the database to query via DBRP (Database Retention Policy) mapping. In Cloud Serverless, this parameter is used together with DBRP + mappings to identify which bucket to query. + + The `db` parameter (optionally combined with `rp`) must have an existing DBRP mapping that points to a bucket. Without a valid DBRP mapping, queries will fail with an + authorization error. + + **DBRP mapping requirements:** + - A DBRP mapping must exist before querying + - Mappings can be created automatically when writing data with the v1 API (if your token has permissions) + - Mappings can be created manually using the InfluxDB CLI or API + + ### Examples + - `db=mydb` - uses the default DBRP mapping for `mydb` + - `db=mydb` with `rp=weekly` - uses the DBRP mapping for `mydb/weekly` + + _Note: Unlike the v1 `/write` endpoint which can auto-create buckets and mappings, the `/query` endpoint requires pre-existing DBRP mappings. The actual data is stored in and + queried from the bucket that the DBRP mapping points to._ + + ### Related + + - [Use the InfluxDB v1 query API and InfluxQL in Cloud Serverless](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/) + - [Map v1 databases and retention policies to buckets in Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) + - [Migrate from InfluxDB 1.x to Cloud Serverless](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/) - in: query name: pretty description: | From a69fea8a007e2dae25af25593c365f3201e1d0ef Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:55:33 -0700 Subject: [PATCH 57/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index db48db47f..1e18adbf7 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -313,7 +313,32 @@ paths: properties: db: type: string - description: Database to query. + description: | + The database name for InfluxQL queries + + Required parameter that specifies the database to query via DBRP (Database Retention Policy) mapping. In Cloud Serverless, this parameter is used together with DBRP + mappings to identify which bucket to query. + + The `db` parameter (optionally combined with `rp`) must have an existing DBRP mapping that points to a bucket. Without a valid DBRP mapping, queries will fail with an + authorization error. + + **DBRP mapping requirements:** + - A DBRP mapping must exist before querying + - Mappings can be created automatically when writing data with the v1 API (if your token has permissions) + - Mappings can be created manually using the InfluxDB CLI or API + + ### Examples + - `db=mydb` - uses the default DBRP mapping for `mydb` + - `db=mydb` with `rp=weekly` - uses the DBRP mapping for `mydb/weekly` + + _Note: Unlike the v1 `/write` endpoint which can auto-create buckets and mappings, the `/query` endpoint requires pre-existing DBRP mappings. The actual data is stored in and + queried from the bucket that the DBRP mapping points to._ + + ### Related + + - [Execute InfluxQL queries using the v1 API](/influxdb3/cloud-serverless/query-data/execute-queries/influxql/api/v1-http/) + - [Map v1 databases and retention policies to buckets in Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) + - [Manage DBRP mappings in Cloud Serverless](/influxdb3/cloud-serverless/admin/dbrp/) rp: description: | The retention policy to query data from. From c6bd7bb726208d45c65893791997f4262065f9f5 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:55:44 -0700 Subject: [PATCH 58/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 1e18adbf7..08a07ef8b 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -341,7 +341,27 @@ paths: - [Manage DBRP mappings in Cloud Serverless](/influxdb3/cloud-serverless/admin/dbrp/) rp: description: | - The retention policy to query data from. + The retention policy name for InfluxQL queries + + Optional parameter that specifies the retention policy to use when querying data with InfluxQL. In Cloud Serverless, this parameter works with DBRP (Database Retention + Policy) mappings to identify the target bucket. + + When provided together with the `db` parameter, Cloud Serverless uses the DBRP mapping to determine which bucket to query. The combination of `db` and `rp` must have an + existing DBRP mapping that points to a bucket. If no `rp` is specified, Cloud Serverless uses the default retention policy mapping for the database. + + Requirements: A DBRP mapping must exist for the db/rp combination before you can query data. DBRP mappings can be created: + - Automatically when writing data with the v1 API (if your token has sufficient permissions) + - Manually using the InfluxDB CLI or API + + Example: If `db=mydb` and `rp=weekly`, the query uses the DBRP mapping for `mydb/weekly` to determine which bucket to query. + + _Note: The retention policy name is used only for DBRP mapping. Actual data retention is controlled by the target bucket's retention period setting, not by the retention policy name._ + + ### Related + + - [Execute InfluxQL queries using the v1 API](/influxdb3/cloud-serverless/query-data/execute-queries/influxql/api/v1-http/) + - [Map v1 databases and retention policies to buckets in Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) + - [Manage DBRP mappings in Cloud Serverless](/influxdb3/cloud-serverless/admin/dbrp/) type: string q: description: Defines the InfluxQL query to run. From 4d77cde02ea4f0fa0f4ced8669d5d35ab7350266 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:55:55 -0700 Subject: [PATCH 59/69] Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index 6a9750253..128021d19 100644 --- a/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -323,7 +323,29 @@ paths: properties: db: type: string - description: The database to query from. + description: | + The database name for InfluxQL queries. + + Required parameter that specifies the database to query. + In InfluxDB Cloud Dedicated, this can be either: + - A simple database name (for example, `mydb`) + - The database portion of a `database_name/retention_policy_name` naming convention (used together with the `rp` parameter) + + When used alone, `db` specifies the complete database name to query. When used with the `rp` parameter, they combine to form the full database name as `db/rp`--for example, if `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen`. + + Unlike InfluxDB Cloud Serverless, Cloud Dedicated does not use DBRP mappings. The database name directly corresponds to an existing database in your Cloud Dedicated cluster. + + Examples: + - `db=mydb` - queries the database named `mydb` + - `db=mydb` with `rp=autogen` - queries the database named `mydb/autogen` + + _Note: The specified database must exist in your Cloud Dedicated cluster. Queries will fail if the database does not exist._ + + ### Related + + - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention) + - [Migrate data from InfluxDB 1.x to Cloud Dedicated](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/) + - [InfluxQL data retention policy mapping differences between InfluxDB Cloud Dedicated and Cloud Serverless](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences) rp: description: | The retention policy name for InfluxQL compatibility From 33cae0b3e2154587d92959eebad9c362c82353ac Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:56:05 -0700 Subject: [PATCH 60/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 2b6305f4c..2fb6d81fc 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -291,7 +291,29 @@ paths: description: Database to query. rp: description: | - The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). + The retention policy name for InfluxQL compatibility + + Optional parameter that, when combined with the db parameter, forms the complete database name to query. In InfluxDB Clustered, databases can be named using the + database_name/retention_policy_name convention for InfluxQL compatibility. + + When a request specifies both `db` and `rp`, InfluxDB Clustered combines them as `db/rp` to target the database--for example: + + - If `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen` + - If only `db=mydb` is provided (no `rp`), the query targets the database named `mydb` + + Unlike InfluxDB v1 and Cloud Serverless, InfluxDB Clustered does not use DBRP mappings or separate retention policy objects. This parameter exists solely for v1 API + compatibility and database naming conventions. + + Note: The retention policy name does not control data retention in InfluxDB Clustered. Data retention is determined by the database's _retention period_ setting. + + ### Related + + - [Use the v1 query API and InfluxQL to query data in InfluxDB Clustered](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) + - [Use the InfluxDB v1 API with InfluxDB Clustered](/influxdb3/clustered/guides/api-compatibility/v1/) + - [Manage databases in InfluxDB Clustered](/influxdb3/clustered/admin/databases/) + - [InfluxQL DBRP naming convention in InfluxDB Clustered](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention) + - [Migrate data from InfluxDB v1 to InfluxDB Clustered](/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered/) + ``` type: string q: description: Defines the InfluxQL query to run. From 4f0a7181efa34a4705560c9114da09c91f1fbe26 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Wed, 6 Aug 2025 09:56:21 -0700 Subject: [PATCH 61/69] Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 2fb6d81fc..a2f8693c9 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -65,7 +65,23 @@ paths: schema: type: string required: true - description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. + description: | + The database to write to. + + **Database targeting:** In InfluxDB Clustered, databases can be named using the `database_name/retention_policy_name` convention for InfluxQL compatibility. InfluxDB Clustered does not use DBRP mappings. The db and rp parameters are used to construct the target database name following this naming convention. + + **Auto-creation behavior:** InfluxDB Clustered requires databases to be created before writing data. The v1 `/write` API does not automatically create databases. If the specified + database does not exist, the write request will fail. + + Authentication: Requires a valid API token with _write_ permissions for the target database. + + ### Related + + - [Write data to InfluxDB Clustered](/influxdb3/clustered/write-data/) + - [Use the InfluxDB v1 API with InfluxDB Clustered](/influxdb3/clustered/guides/api-compatibility/v1/) + - [Manage databases in InfluxDB Clustered](/influxdb3/clustered/admin/databases/) + - [InfluxQL DBRP naming convention in InfluxDB Clustered](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention) + - [Migrate data from InfluxDB v1 to InfluxDB Clustered](/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered/) - in: query name: rp schema: From beb7bb2261ea0ce49279747b802a450a466c4c15 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 7 Aug 2025 13:13:56 -0700 Subject: [PATCH 62/69] Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Co-authored-by: Jason Stirnaman --- .../v1-compatibility/swaggerV1Compat.yml | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 08a07ef8b..2ff111180 100644 --- a/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -229,7 +229,29 @@ paths: name: rp schema: type: string - description: Retention policy name. + description: | + The retention policy name for InfluxQL queries + + Optional parameter that specifies the retention policy to use when querying data with InfluxQL. In Cloud Serverless, this parameter works with DBRP (Database Retention + Policy) mappings to identify the target bucket. + + When provided together with the `db` parameter, Cloud Serverless uses the DBRP mapping to determine which bucket to query. The combination of `db` and `rp` must have an + existing DBRP mapping that points to a bucket. If no `rp` is specified, Cloud Serverless uses the default retention policy mapping for the database. + + Requirements: A DBRP mapping must exist for the db/rp combination before you can query data. DBRP mappings can be created: + - Automatically when writing data with the v1 API (if your token has sufficient permissions) + - Manually using the InfluxDB CLI or API + + Example: If `db=mydb` and `rp=weekly`, the query uses the DBRP mapping for `mydb/weekly` to determine which bucket to query. + + _Note: The retention policy name is used only for DBRP mapping. Actual data retention is controlled by the target bucket's retention period setting, not by the retention + policy name._ + + ### Related + + - [Use the InfluxDB v1 query API and InfluxQL in Cloud Serverless](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/) + - [Map v1 databases and retention policies to buckets in Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets) + - [Migrate from InfluxDB 1.x to Cloud Serverless](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/) - name: epoch description: | Formats timestamps as unix (epoch) timestamps with the specified precision From 963d0a8d218cd2cb7a5cd90f89b87fb5d327df09 Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:29:44 -0400 Subject: [PATCH 63/69] docs: add usage telemetry documentation --- content/influxdb3/core/reference/telemetry.md | 18 ++++ .../enterprise/reference/telemetry.md | 18 ++++ content/shared/influxdb3-admin/telemetry.md | 97 +++++++++++++++++++ 3 files changed, 133 insertions(+) create mode 100644 content/influxdb3/core/reference/telemetry.md create mode 100644 content/influxdb3/enterprise/reference/telemetry.md create mode 100644 content/shared/influxdb3-admin/telemetry.md diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md new file mode 100644 index 000000000..fae9427e3 --- /dev/null +++ b/content/influxdb3/core/reference/telemetry.md @@ -0,0 +1,18 @@ +--- +title: Usage telemetry +seotitle: InfluxDB Core usage telemetry +description: > + InfluxDB Core can collect and send usage telemetry data to help improve the + product. +menu: + influxdb3_core: + parent: Reference +weight: 108 +influxdb3/core/tags: [telemetry, monitoring, metrics, observability] +source: /shared/influxdb3-admin/telemetry.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md new file mode 100644 index 000000000..779896464 --- /dev/null +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -0,0 +1,18 @@ +--- +title: Usage telemetry +seotitle: InfluxDB Enterprise usage telemetry +description: > + InfluxDB Enterprise can collect and send usage telemetry data to help improve the + product. +menu: + influxdb3_enterprise: + parent: Reference +weight: 108 +influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability] +source: /shared/influxdb3-admin/telemetry.md +--- + + \ No newline at end of file diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-admin/telemetry.md new file mode 100644 index 000000000..90639f993 --- /dev/null +++ b/content/shared/influxdb3-admin/telemetry.md @@ -0,0 +1,97 @@ +InfluxDB 3 can collect and send usage telemetry data to help improve the product. This page describes what telemetry data is collected, when it's collected, how it's transmitted, and how to disable it. + +## What data is collected + +{{< product-name >}} collects the following telemetry data: + +### System metrics + +- **CPU utilization**: Process-specific CPU usage (min, max, average) +- **Memory usage**: Process memory consumption in MB (min, max, average) +- **Cores**: Number of CPU cores in use +- **OS**: Operating system information +- **Version**: {{< product-name >}} version +- **Uptime**: Server uptime in seconds + +### Write metrics + +- **Write requests**: Number of write operations (min, max, average, hourly sum) +- **Write lines**: Number of lines written (min, max, average, hourly sum) +- **Write bytes**: Amount of data written in MB (min, max, average, hourly sum) + +### Query metrics + +- **Query requests**: Number of query operations (min, max, average, hourly sum) + +### Storage metrics + +- **Parquet file count**: Number of Parquet files (when available) +- **Parquet file size**: Total size of Parquet files in MB (when available) +- **Parquet row count**: Total number of rows in Parquet files (when available) + +### Processing engine metrics + +- **WAL triggers**: Write-Ahead Log trigger counts (when available) +- **Schedule triggers**: Scheduled processing trigger counts (when available) +- **Request triggers**: Request-based processing trigger counts (when available) + +### Instance information + +- **Instance ID**: Unique identifier for the server instance +- **Cluster UUID**: Unique identifier for the cluster (same as catalog UUID) +- **Storage type**: Type of object storage being used +{{% show-in "core" %}} +- **Product type**: "Core" +{{% /show-in %}} +{{% show-in "enterprise" %}} +- **Product type**: "Enterprise" +{{% /show-in %}} + +## Collection frequency + +- **System metrics** (CPU, memory): Collected every 60 seconds +- **Write and query metrics**: Collected per operation, rolled up every 60 seconds +- **Storage and processing engine metrics**: Collected at snapshot time (when available) +- **Instance information**: Static data collected once + +Telemetry data is transmitted once per hour. + +## Disable telemetry + +Disables sending telemetry data to InfluxData. + +**Default:** `false` + +| influxdb3 flag | Environment variable | +| :------------- | :------------------- | +| `--disable-telemetry-upload` | `INFLUXDB3_TELEMETRY_DISABLE_UPLOAD` | + +#### Command line flag +```sh +influxdb3 serve --disable-telemetry-upload +``` + +#### Environment variable +```sh +export INFLUXDB3_TELEMETRY_DISABLE_UPLOAD=true +``` + +When telemetry is disabled, no usage data is collected or transmitted. + +## Data handling + +The telemetry data is used by InfluxData to: + +- Understand product usage patterns +- Improve product performance and reliability +- Prioritize feature development +- Identify and resolve issues + +No personally identifiable information (PII) is collected. + +## Privacy and security + +- All telemetry data is transmitted securely via HTTPS +- No database contents, queries, or user data is collected +- Only operational metrics and system information is transmitted +- Data collection follows InfluxData's privacy policy \ No newline at end of file From 32cdfb533c85b6ea9575f2f140e23ed2ac4f74fe Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:44:25 -0400 Subject: [PATCH 64/69] fix: small clarity changes and easier reading --- content/shared/influxdb3-admin/telemetry.md | 42 +++++++++------------ 1 file changed, 17 insertions(+), 25 deletions(-) diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-admin/telemetry.md index 90639f993..09a4bd10a 100644 --- a/content/shared/influxdb3-admin/telemetry.md +++ b/content/shared/influxdb3-admin/telemetry.md @@ -6,8 +6,8 @@ InfluxDB 3 can collect and send usage telemetry data to help improve the product ### System metrics -- **CPU utilization**: Process-specific CPU usage (min, max, average) -- **Memory usage**: Process memory consumption in MB (min, max, average) +- **CPU utilization**: Process-specific CPU usage +- **Memory usage**: Process memory consumption in MB - **Cores**: Number of CPU cores in use - **OS**: Operating system information - **Version**: {{< product-name >}} version @@ -15,30 +15,30 @@ InfluxDB 3 can collect and send usage telemetry data to help improve the product ### Write metrics -- **Write requests**: Number of write operations (min, max, average, hourly sum) -- **Write lines**: Number of lines written (min, max, average, hourly sum) -- **Write bytes**: Amount of data written in MB (min, max, average, hourly sum) +- **Write requests**: Number of write operations +- **Write lines**: Number of lines written +- **Write bytes**: Amount of data written in MB ### Query metrics -- **Query requests**: Number of query operations (min, max, average, hourly sum) +- **Query requests**: Number of query operations ### Storage metrics -- **Parquet file count**: Number of Parquet files (when available) -- **Parquet file size**: Total size of Parquet files in MB (when available) -- **Parquet row count**: Total number of rows in Parquet files (when available) +- **Parquet file count**: Number of Parquet files +- **Parquet file size**: Total size of Parquet files in MB +- **Parquet row count**: Total number of rows in Parquet files ### Processing engine metrics -- **WAL triggers**: Write-Ahead Log trigger counts (when available) -- **Schedule triggers**: Scheduled processing trigger counts (when available) -- **Request triggers**: Request-based processing trigger counts (when available) +- **WAL triggers**: Write-Ahead Log trigger counts +- **Schedule triggers**: Scheduled processing trigger counts +- **Request triggers**: Request-based processing trigger counts ### Instance information - **Instance ID**: Unique identifier for the server instance -- **Cluster UUID**: Unique identifier for the cluster (same as catalog UUID) +- **Cluster UUID**: Unique identifier for the cluster - **Storage type**: Type of object storage being used {{% show-in "core" %}} - **Product type**: "Core" @@ -80,18 +80,10 @@ When telemetry is disabled, no usage data is collected or transmitted. ## Data handling -The telemetry data is used by InfluxData to: - -- Understand product usage patterns -- Improve product performance and reliability -- Prioritize feature development -- Identify and resolve issues - -No personally identifiable information (PII) is collected. +The telemetry data is used by InfluxData to understand product usage patterns, improve product performance and reliability, prioritize feature development, and identify/resolve issues. No personally identifiable information (PII) is collected. ## Privacy and security -- All telemetry data is transmitted securely via HTTPS -- No database contents, queries, or user data is collected -- Only operational metrics and system information is transmitted -- Data collection follows InfluxData's privacy policy \ No newline at end of file +All telemetry data is transmitted securely via HTTPS. No database contents, queries, or user data is collected; only operational metrics and system information is transmitted. + +All data collection follows InfluxData's privacy policy. \ No newline at end of file From 4d5d5092347b1cbaf59dd1e70bf12b4491e874d8 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 23 Jul 2025 15:17:43 -0600 Subject: [PATCH 65/69] fix(monolith): add configurable db, table, and column limits to enterprise --- .../enterprise/reference/config-options.md | 2 +- .../influxdb3-admin/databases/_index.md | 29 +++++++---- .../influxdb3-admin/databases/create.md | 5 ++ .../shared/influxdb3-cli/config-options.md | 50 ++++++++++++++++--- 4 files changed, 69 insertions(+), 17 deletions(-) diff --git a/content/influxdb3/enterprise/reference/config-options.md b/content/influxdb3/enterprise/reference/config-options.md index cab8a5a77..313ceb3f4 100644 --- a/content/influxdb3/enterprise/reference/config-options.md +++ b/content/influxdb3/enterprise/reference/config-options.md @@ -13,4 +13,4 @@ source: /shared/influxdb3-cli/config-options.md \ No newline at end of file +--> diff --git a/content/shared/influxdb3-admin/databases/_index.md b/content/shared/influxdb3-admin/databases/_index.md index 73d148aae..f3f59aef7 100644 --- a/content/shared/influxdb3-admin/databases/_index.md +++ b/content/shared/influxdb3-admin/databases/_index.md @@ -13,7 +13,7 @@ stored. Each database can contain multiple tables. > **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, > _database_ and _bucket_ are synonymous. - +The _maximum_ retention period is infinite (`none`) meaning data does not expire +and will never be removed by the retention enforcement service. +{{% /show-in %}} ## Database, table, and column limits @@ -40,9 +39,11 @@ never be removed by the retention enforcement service. **Maximum number of tables across all databases**: {{% influxdb3/limit "table" %}} {{< product-name >}} limits the number of tables you can have across _all_ -databases to {{% influxdb3/limit "table" %}}. There is no specific limit on how -many tables you can have in an individual database, as long as the total across -all databases is below the limit. +databases to {{% influxdb3/limit "table" %}}{{% show-in "enterprise" %}} by default{{% /show-in %}}. +{{% show-in "enterprise" %}}You can configure the table limit using the +[`--num-table-limit` configuration option](/influxdb3/enterprise/reference/config-options/#num-table-limit).{{% /show-in %}} +InfluxDB doesn't limit how many tables you can have in an individual database, +as long as the total across all databases is below the limit. Having more tables affects your {{% product-name %}} installation in the following ways: @@ -64,7 +65,8 @@ persists data to Parquet files. Each `PUT` request incurs a monetary cost and increases the operating cost of {{< product-name >}}. {{% /expand %}} -{{% expand "**More work for the compactor** _(Enterprise only)_ View more info" %}} +{{% show-in "enterprise" %}} +{{% expand "**More work for the compactor** View more info" %}} To optimize storage over time, InfluxDB 3 Enterprise has a compactor that routinely compacts Parquet files. @@ -72,6 +74,7 @@ With more tables and Parquet files to compact, the compactor may need to be scal to keep up with demand, adding to the operating cost of InfluxDB 3 Enterprise. {{% /expand %}} +{{% /show-in %}} {{< /expand-wrapper >}} ### Column limit @@ -80,11 +83,17 @@ to keep up with demand, adding to the operating cost of InfluxDB 3 Enterprise. Each row must include a time column, with the remaining columns representing tags and fields. -As a result, a table can have one time column and up to {{% influxdb3/limit "column" -1 %}} +As a result,{{% show-in "enterprise" %}} by default,{{% /show-in %}} a table can +have one time column and up to {{% influxdb3/limit "column" -1 %}} _combined_ field and tag columns. If you attempt to write to a table and exceed the column limit, the write request fails and InfluxDB returns an error. +{{% show-in "enterprise" %}} +You can configure the maximum number of columns per +table using the [`num-total-columns-per-table-limit` configuration option](/influxdb3/enterprise/reference/config-options/#num-total-columns-per-table-limit). +{{% /show-in %}} + Higher numbers of columns has the following side-effects: {{< expand-wrapper >}} diff --git a/content/shared/influxdb3-admin/databases/create.md b/content/shared/influxdb3-admin/databases/create.md index bbac8fa26..fd9546174 100644 --- a/content/shared/influxdb3-admin/databases/create.md +++ b/content/shared/influxdb3-admin/databases/create.md @@ -130,7 +130,12 @@ database_name/retention_policy_name ## Database limit +{{% show-in "enterprise" %}} +**Default maximum number of databases**: {{% influxdb3/limit "database" %}} +{{% /show-in %}} +{{% show-in "core" %}} **Maximum number of databases**: {{% influxdb3/limit "database" %}} +{{% /show-in %}} _For more information about {{< product-name >}} database, table, and column limits, see [Database, table, and column limits](/influxdb3/version/admin/databases/#database-table-and-column-limits)._ diff --git a/content/shared/influxdb3-cli/config-options.md b/content/shared/influxdb3-cli/config-options.md index 268b3ac93..13d98106c 100644 --- a/content/shared/influxdb3-cli/config-options.md +++ b/content/shared/influxdb3-cli/config-options.md @@ -53,6 +53,10 @@ influxdb3 serve - [tls-minimum-versions](#tls-minimum-version) - [without-auth](#without-auth) - [disable-authz](#disable-authz) +{{% show-in "enterprise" %}} + - [num-database-limit](#num-database-limit) + - [num-table-limit](#num-table-limit) + - [num-total-columns-per-table-limit](#num-total-columns-per-table-limit){{% /show-in %}} - [AWS](#aws) - [aws-access-key-id](#aws-access-key-id) - [aws-secret-access-key](#aws-secret-access-key) @@ -204,7 +208,7 @@ This value must be different than the [`--node-id`](#node-id) value. #### data-dir -For the `file` object store, defines the location InfluxDB 3 uses to store files locally. +For the `file` object store, defines the location {{< product-name >}} uses to store files locally. Required when using the `file` [object store](#object-store). | influxdb3 serve option | Environment variable | @@ -216,7 +220,7 @@ Required when using the `file` [object store](#object-store). {{% show-in "enterprise" %}} #### license-email -Specifies the email address to associate with your InfluxDB 3 Enterprise license +Specifies the email address to associate with your {{< product-name >}} license and automatically responds to the interactive email prompt when the server starts. This option is mutually exclusive with [license-file](#license-file). @@ -228,7 +232,7 @@ This option is mutually exclusive with [license-file](#license-file). #### license-file -Specifies the path to a license file for InfluxDB 3 Enterprise. When provided, the license +Specifies the path to a license file for {{< product-name >}}. When provided, the license file's contents are used instead of requesting a new license. This option is mutually exclusive with [license-email](#license-email). @@ -361,10 +365,44 @@ The server processes all requests without requiring tokens or authentication. Optionally disable authz by passing in a comma separated list of resources. Valid values are `health`, `ping`, and `metrics`. -| influxdb3 serve option | Environment variable | -| :--------------------- | :----------------------- | -| `--disable-authz` | `INFLUXDB3_DISABLE_AUTHZ`| +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------ | +| `--disable-authz` | `INFLUXDB3_DISABLE_AUTHZ` | +{{% show-in "enterprise" %}} +--- + +#### num-database-limit + +Limits the total number of active databases. +Default is {{% influxdb3/limit "database" %}}. + +| influxdb3 serve option | Environment variable | +| :---------------------- | :---------------------------------------- | +| `--num-database-limit` | `INFLUXDB3_ENTERPRISE_NUM_DATABASE_LIMIT` | + +--- + +#### num-table-limit + +Limits the total number of active tables across all databases. +Default is {{% influxdb3/limit "table" %}}. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------------------- | +| `--num-table-limit` | `INFLUXDB3_ENTERPRISE_NUM_TABLE_LIMIT` | + +--- + +#### num-total-columns-per-table-limit + +Limits the total number of columns per table. +Default is {{% influxdb3/limit "column" %}}. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :------------------------------------------------------- | +| `--num-total-columns-per-table-limit` | `INFLUXDB3_ENTERPRISE_NUM_TOTAL_COLUMNS_PER_TABLE_LIMIT` | +{{% /show-in %}} --- ### AWS From 5492ba9eef7eef1bbee0912acbcbcc49d872bfa6 Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:52:59 -0400 Subject: [PATCH 66/69] fix: remember the 3 --- content/influxdb3/core/reference/telemetry.md | 4 ++-- content/influxdb3/enterprise/reference/telemetry.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md index fae9427e3..14eb0692e 100644 --- a/content/influxdb3/core/reference/telemetry.md +++ b/content/influxdb3/core/reference/telemetry.md @@ -1,8 +1,8 @@ --- title: Usage telemetry -seotitle: InfluxDB Core usage telemetry +seotitle: InfluxDB 3 Core usage telemetry description: > - InfluxDB Core can collect and send usage telemetry data to help improve the + InfluxDB 3 Core can collect and send usage telemetry data to help improve the product. menu: influxdb3_core: diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md index 779896464..3b3fef879 100644 --- a/content/influxdb3/enterprise/reference/telemetry.md +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -1,8 +1,8 @@ --- title: Usage telemetry -seotitle: InfluxDB Enterprise usage telemetry +seotitle: InfluxDB 3 Enterprise usage telemetry description: > - InfluxDB Enterprise can collect and send usage telemetry data to help improve the + InfluxDB 3 Enterprise can collect and send usage telemetry data to help improve the product. menu: influxdb3_enterprise: From f23026982b681658d658f8a50719a2a7f98e591d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 14 Aug 2025 14:41:05 -0500 Subject: [PATCH 67/69] chore(monolith): Move telemetry reference to shared/influxdb3-reference. Revise description, disable, and product names. --- content/influxdb3/core/reference/telemetry.md | 9 +++++---- content/influxdb3/enterprise/reference/telemetry.md | 9 +++++---- .../telemetry.md | 8 ++++++-- 3 files changed, 16 insertions(+), 10 deletions(-) rename content/shared/{influxdb3-admin => influxdb3-reference}/telemetry.md (83%) diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md index 14eb0692e..91002fb2c 100644 --- a/content/influxdb3/core/reference/telemetry.md +++ b/content/influxdb3/core/reference/telemetry.md @@ -2,17 +2,18 @@ title: Usage telemetry seotitle: InfluxDB 3 Core usage telemetry description: > - InfluxDB 3 Core can collect and send usage telemetry data to help improve the - product. + InfluxData collects telemetry data to help improve the {{< product-name >}}. + Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and + how you can opt out. menu: influxdb3_core: parent: Reference weight: 108 influxdb3/core/tags: [telemetry, monitoring, metrics, observability] -source: /shared/influxdb3-admin/telemetry.md +source: /shared/influxdb3-reference/telemetry.md --- \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md index 3b3fef879..6ebb4ac6b 100644 --- a/content/influxdb3/enterprise/reference/telemetry.md +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -2,17 +2,18 @@ title: Usage telemetry seotitle: InfluxDB 3 Enterprise usage telemetry description: > - InfluxDB 3 Enterprise can collect and send usage telemetry data to help improve the - product. + InfluxData collects telemetry data to help improve the {{< product-name >}}. + Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and + how you can opt out. menu: influxdb3_enterprise: parent: Reference weight: 108 influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability] -source: /shared/influxdb3-admin/telemetry.md +source: /shared/influxdb3-reference/telemetry.md --- \ No newline at end of file diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-reference/telemetry.md similarity index 83% rename from content/shared/influxdb3-admin/telemetry.md rename to content/shared/influxdb3-reference/telemetry.md index 09a4bd10a..4f8a5589f 100644 --- a/content/shared/influxdb3-admin/telemetry.md +++ b/content/shared/influxdb3-reference/telemetry.md @@ -1,4 +1,6 @@ -InfluxDB 3 can collect and send usage telemetry data to help improve the product. This page describes what telemetry data is collected, when it's collected, how it's transmitted, and how to disable it. +InfluxData collects information, or _telemetry data_, about the usage of {{% product-name %}} to help improve the product. +Learn what data {{% product-name %}} collects and sends to InfluxData, how it's used, and +how you can opt out. ## What data is collected @@ -58,7 +60,9 @@ Telemetry data is transmitted once per hour. ## Disable telemetry -Disables sending telemetry data to InfluxData. +To "opt-out" of collecting and sending {{% product-name %}} telemetry data, +include the `--disable-telemetry-upload` flag or set the `INFLUXDB3_TELEMETRY_DISABLE_UPLOAD` environment variable +when starting {{% product-name %}}. **Default:** `false` From 144de5785c78d95f4825ca9571b386dae6a3f2e8 Mon Sep 17 00:00:00 2001 From: meelahme Date: Thu, 14 Aug 2025 14:58:03 -0700 Subject: [PATCH 68/69] minor updates to requestBody to fix Ci build error --- .../influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index a2f8693c9..7735c655d 100644 --- a/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -329,10 +329,10 @@ paths: - [Manage databases in InfluxDB Clustered](/influxdb3/clustered/admin/databases/) - [InfluxQL DBRP naming convention in InfluxDB Clustered](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention) - [Migrate data from InfluxDB v1 to InfluxDB Clustered](/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered/) - ``` type: string q: - description: Defines the InfluxQL query to run. + description: | + Defines the InfluxQL query to run. type: string chunked: description: | From 34416a1d37734a188f7b8e46ed60757c43cedf30 Mon Sep 17 00:00:00 2001 From: Jakub Bednar Date: Fri, 15 Aug 2025 08:42:39 +0200 Subject: [PATCH 69/69] Release Chronograf v1.10.8 --- content/chronograf/v1/about_the_project/release-notes.md | 6 ++++++ data/products.yml | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/content/chronograf/v1/about_the_project/release-notes.md b/content/chronograf/v1/about_the_project/release-notes.md index 5cc972a4f..eae49effd 100644 --- a/content/chronograf/v1/about_the_project/release-notes.md +++ b/content/chronograf/v1/about_the_project/release-notes.md @@ -10,6 +10,12 @@ aliases: - /chronograf/v1/about_the_project/release-notes-changelog/ --- +## v1.10.8 {date="2025-08-15"} + +### Bug Fixes + +- Fix missing retention policies on the Databases page. + ## v1.10.7 {date="2025-04-15"} ### Bug Fixes diff --git a/data/products.yml b/data/products.yml index 44b530c43..e707fd718 100644 --- a/data/products.yml +++ b/data/products.yml @@ -157,7 +157,7 @@ chronograf: versions: [v1] latest: v1.10 latest_patches: - v1: 1.10.7 + v1: 1.10.8 ai_sample_questions: - How do I configure Chronograf for InfluxDB v1? - How do I create a dashboard in Chronograf?