Merge branch 'master' into jts-6160-3-2-cli

jts-6160-3-2-cli
Jason Stirnaman 2025-06-27 18:30:41 -05:00 committed by GitHub
commit 16f79c9549
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 12 additions and 9 deletions

View File

@ -24,8 +24,8 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
## Required parameters
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
- **object-store**: Determines where time series data is stored. _Default is `memory`_.
- **data-dir**: Path for local file storage (required when using `--object-store file`).
- **object-store**: Determines where time series data is stored.
- Other object store parameters depending on the selected `object-store` type.
> [!NOTE]
> `--node-id` supports alphanumeric strings with optional hyphens.

View File

@ -144,7 +144,7 @@ influxdb3 serve
Specifies which object storage to use to store Parquet files.
This option supports the following values:
- `memory` _(default)_
- `memory`
- `memory-throttled`
- `file`
- `s3`
@ -171,7 +171,7 @@ Required when using the `file` [object store](#object-store).
#### node-id
Specifies the node identifier used as a prefix in all object store file paths.
This should be unique for any hosts sharing the same object store
Use a unique node identifier for each host sharing the same object store
configuration--for example, the same bucket.
| influxdb3 serve option | Environment variable |
@ -186,7 +186,7 @@ Limits the number of Parquet files a query can access.
**Default:** `432`
With the default `432` setting and the default [`gen1-duration`](#`gen1-duration`)
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.

View File

@ -27,8 +27,8 @@ influxdb3 serve [OPTIONS] \
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
- **cluster-id**: A unique identifier for your cluster. Must be different from any node-id in your cluster.
- **object-store**: Determines where time series data is stored. _Default is `memory`_.
- **data-dir**: Path for local file storage (required when using `--object-store file`).
- **object-store**: Determines where time series data is stored.
- Other object store parameters depending on the selected `object-store` type.
> [!NOTE]
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.

View File

@ -263,7 +263,7 @@ export DATABASE_NODE=node0 && influxdb3 serve \
Specifies which object storage to use to store Parquet files.
This option supports the following values:
- `memory` _(default)_: Effectively no object persistence
- `memory`: Effectively no object persistence
- `memory-throttled`: Like `memory` but with latency and throughput that somewhat resembles a cloud object store
- `file`: Stores objects in the local filesystem (must also set `--data-dir`)
- `s3`: Amazon S3 (must also set `--bucket`, `--aws-access-key-id`, `--aws-secret-access-key`, and possibly `--aws-default-region`)

View File

@ -44,7 +44,7 @@ Provide the following:
- `--object-store`: Specifies the type of object store to use.
InfluxDB supports the following:
- `file` _(default)_: local file system
- `file`: local file system
- `memory`: in memory _(no object persistence)_
- `memory-throttled`: like `memory` but with latency and throughput that
somewhat resembles a cloud-based object store
@ -52,6 +52,9 @@ Provide the following:
- `google`: Google Cloud Storage
- `azure`: Azure Blob Storage
- Other object store parameters depending on the selected `object-store` type.
For example, if you use `s3`, you must provide the bucket name and credentials.
> [!Note]
> #### Diskless architecture
>