Update content for 72 hour limit change (#5806)
* update content for 72 hour limit change * Apply suggestions from code review Co-authored-by: Paul Dix <paul@pauldix.net> * updated query-file-limit content structure --------- Co-authored-by: Paul Dix <paul@pauldix.net>pull/5790/head
Scott Anderson
GitHub
parent
3a398237fa
commit
60a2268b96
|
|
@ -2,8 +2,9 @@
|
|||
title: InfluxDB 3 Core documentation
|
||||
description: >
|
||||
InfluxDB 3 Core is an open source time series database designed and optimized
|
||||
for real-time and recent data (last 72 hours).
|
||||
Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events.
|
||||
for real-time and recent data.
|
||||
Learn how to use and leverage InfluxDB 3 in use cases such as edge data
|
||||
collection, IoT data, and events.
|
||||
menu:
|
||||
influxdb3_core:
|
||||
name: InfluxDB 3 Core
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
title: Get started with InfluxDB 3 Core
|
||||
description: >
|
||||
InfluxDB 3 Core is an open source time series database designed and optimized
|
||||
for real-time and recent data (last 72 hours).
|
||||
Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events.
|
||||
for real-time and recent data.
|
||||
Learn how to use and leverage InfluxDB 3 in use cases such as edge data
|
||||
collection, IoT data, and events.
|
||||
menu:
|
||||
influxdb3_core:
|
||||
name: Get started
|
||||
|
|
|
|||
|
|
@ -90,6 +90,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
|
|||
| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#distinct-cache-eviction-interval)_ |
|
||||
| | `--plugin-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#plugin-dir)_ |
|
||||
| | `--force-snapshot-mem-threshold` | _See [configuration options](/influxdb3/core/reference/config-options/#force-snapshot-mem-threshold)_ |
|
||||
| | `--query-file-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#query-file-limit)_ |
|
||||
|
||||
{{< caption >}}
|
||||
{{< req text="\* Required options" >}}
|
||||
|
|
|
|||
|
|
@ -54,6 +54,7 @@ influxdb3 serve
|
|||
- [object-store](#object-store)
|
||||
- [data-dir](#data-dir)
|
||||
- [node-id](#node-id)
|
||||
- [query-file-limit](#query-file-limit)
|
||||
- [AWS](#aws)
|
||||
- [aws-access-key-id](#aws-access-key-id)
|
||||
- [aws-secret-access-key](#aws-secret-access-key)
|
||||
|
|
@ -134,9 +135,9 @@ influxdb3 serve
|
|||
### General
|
||||
|
||||
- [object-store](#object-store)
|
||||
- [bucket](#bucket)
|
||||
- [data-dir](#data-dir)
|
||||
- [node-id](#node-id)
|
||||
- [query-file-limit](#query-file-limit)
|
||||
|
||||
#### object-store
|
||||
|
||||
|
|
@ -178,6 +179,40 @@ configuration--for example, the same bucket.
|
|||
|
||||
---
|
||||
|
||||
#### query-file-limit
|
||||
|
||||
Limits the number of Parquet files a query can access.
|
||||
|
||||
**Default:** `432`
|
||||
|
||||
With the default `432` setting and the default [`gen1-duration`](#`gen1-duration`)
|
||||
setting of 10 minutes, queries can access up to a 72 hours of data, but
|
||||
potentially less depending on whether all data for a given 10 minute block of
|
||||
time was ingested during the same period.
|
||||
|
||||
You can increase this limit to allow more files to be queried, but be aware of
|
||||
the following side-effects:
|
||||
|
||||
- Degraded query performance for queries that read more Parquet files
|
||||
- Increased memory usage
|
||||
- Your system potentially killing the `influxdb3` process due to Out-of-Memory
|
||||
(OOM) errors
|
||||
- If using object storage to store data, many GET requests to access the data
|
||||
(as many as 2 per file)
|
||||
|
||||
> [!Note]
|
||||
> We recommend keeping the default setting and querying smaller time ranges.
|
||||
> If you need to query longer time ranges or faster query performance on any query
|
||||
> that accesses an hour or more of data, [InfluxDB 3 Enterprise](/influxdb3/enterprise/)
|
||||
> optimizes data storage by compacting and rearranging Parquet files to achieve
|
||||
> faster query performance.
|
||||
|
||||
| influxdb3 serve option | Environment variable |
|
||||
| :--------------------- | :--------------------------- |
|
||||
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
|
||||
|
||||
---
|
||||
|
||||
### AWS
|
||||
|
||||
- [aws-access-key-id](#aws-access-key-id)
|
||||
|
|
|
|||
|
|
@ -219,7 +219,7 @@ InfluxDB is a schema-on-write database. You can start writing data and InfluxDB
|
|||
After a schema is created, InfluxDB validates future write requests against it before accepting the data.
|
||||
Subsequent requests can add new fields on-the-fly, but can't add new tags.
|
||||
|
||||
InfluxDB 3 Core is optimized for recent data only--it accepts writes for data with timestamps from the last 72 hours. It persists that data in Parquet files for access by third-party systems for longer term historical analysis and queries. If you require longer historical queries with a compactor that optimizes data organization, consider using [InfluxDB 3 Enterprise](/influxdb3/enterprise/get-started/).
|
||||
InfluxDB 3 Core is optimized for recent data, but accepts writes from any time period. It persists that data in Parquet files for access by third-party systems for longer term historical analysis and queries. If you require longer historical queries with a compactor that optimizes data organization, consider using [InfluxDB 3 Enterprise](/influxdb3/enterprise/get-started/).
|
||||
|
||||
|
||||
The database has three write API endpoints that respond to HTTP `POST` requests:
|
||||
|
|
@ -320,7 +320,9 @@ influxdb3 create -h
|
|||
|
||||
### Query the database
|
||||
|
||||
InfluxDB 3 now supports native SQL for querying, in addition to InfluxQL, an SQL-like language customized for time series queries.
|
||||
InfluxDB 3 now supports native SQL for querying, in addition to InfluxQL, an
|
||||
SQL-like language customized for time series queries. {{< product-name >}} limits
|
||||
query time ranges to 72 hours (both recent and historical) to ensure query performance.
|
||||
|
||||
> [!Note]
|
||||
> Flux, the language introduced in InfluxDB 2.0, is **not** supported in InfluxDB 3.
|
||||
|
|
|
|||
Loading…
Reference in New Issue