Skip to content

Commit 5e714ee

Browse files
authored
Apply suggestions from code review
1 parent 8478d7b commit 5e714ee

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

content/influxdb3/enterprise/reference/config-options.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ influxdb3 serve \
3030
--license-email example@email.com \
3131
--object-store file \
3232
--data-dir ~/.influxdb3 \
33-
--log-filter info \
33+
--log-filter info
3434
```
3535

3636
##### Example environment variables
@@ -239,13 +239,21 @@ configuration--for example, the same bucket.
239239
#### node-id-from-env
240240

241241
Specifies the node identifier used as a prefix in all object store file paths.
242-
Defines this node identified from the specificed environment variable;
243-
this cannot be used with the `--node-id` option also specified.
242+
Takes the name of an environment variable as an argument and uses the value of that environment variable as the node identifier.
243+
This option cannot be used with the `--node-id` option.
244244

245245
| influxdb3 serve option | Environment variable |
246246
| :--------------------- | :----------------------------------- |
247247
| `--node-id-from-env` | `INFLUXDB3_NODE_IDENTIFIER_FROM_ENV` |
248248

249+
##### Example using --node-id-from-env
250+
251+
```bash
252+
export DATABASE_NODE=node0 && influxdb3 serve \
253+
--node-id-from-env DATABASE_NODE \
254+
--cluster-id cluster0 \
255+
--object-store file \
256+
--data-dir ~/.influxdb3/data
249257
---
250258

251259
#### object-store
@@ -278,7 +286,7 @@ The path to a key file for TLS to be enabled.
278286

279287
#### tls-cert
280288

281-
To a cert file for TLS to be enabled.
289+
The path to a cert file for TLS to be enabled.
282290

283291
| influxdb3 serve option | Environment variable |
284292
| :--------------------- | :--------------------- |
@@ -289,7 +297,8 @@ To a cert file for TLS to be enabled.
289297
#### tls-minimum-version
290298

291299
The minimum version for TLS.
292-
Valid values are `tls-1.2` or `tls-1.3` default is tls-1.2
300+
Valid values are `tls-1.2` or `tls-1.3`.
301+
Default is `tls-1.2`.
293302

294303
| influxdb3 serve option | Environment variable |
295304
| :---------------------- | :----------------------- |
@@ -299,8 +308,8 @@ Valid values are `tls-1.2` or `tls-1.3` default is tls-1.2
299308

300309
#### without-auth
301310

302-
Starts the database with authentication disabled. All requests will be served without any
303-
token or authentication required.
311+
Disables authentication for all server actions (CLI commands and API requests).
312+
The server processes all requests without requiring tokens or authentication.
304313

305314
---
306315

@@ -1121,10 +1130,19 @@ Sets the interval to check if the in-memory Parquet cache needs to be pruned.
11211130
11221131
#### parquet-mem-cache-query-path-duration
11231132
1124-
Specifies the duration to check if Parquet files pulled in query path
1125-
require caching, expressed as a human-readable duration (starting from _now_)--for example: `5h`, `3d`.
1133+
A [duration](/influxdb3/enterprise/reference/glossary/#duration) that specifies
1134+
the time window for caching recent Parquet files in memory. Default is `5h`.
1135+
1136+
Only files containing data with a timestamp between `now` and `now - duration`
1137+
are cached when accessed during queries--for example, with the default `5h` setting:
1138+
1139+
- Current time: `2024-06-10 15:00:00`
1140+
- Cache window: Last 5 hours (`2024-06-10 10:00:00` to now)
1141+
1142+
If a query requests data from `2024-06-09` (old) and `2024-06-10 14:00` (recent):
11261143
1127-
**Default:** `5h`
1144+
- **Cached**: Parquet files with data from `2024-06-10 14:00` (within 5-hour window)
1145+
- **Not cached**: Parquet files with data from `2024-06-09` (outside 5-hour window)
11281146
11291147
| influxdb3 serve option | Environment variable |
11301148
| :---------------------------- | :------------------------------------ |
@@ -1157,8 +1175,8 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11571175
11581176
#### last-value-cache-disable-from-history
11591177
1160-
Disable populating the Last-N-Value cache from historical data.
1161-
When disabled, the cache will still be populated with data from the WAL.
1178+
Disables populating the last-N-value cache from historical data.
1179+
If disabled, the cache is still populated with data from the write-ahead log (WAL).
11621180
11631181
| influxdb3 serve option | Environment variable |
11641182
| :---------------------------------------- | :------------------------------------------------ |
@@ -1181,8 +1199,8 @@ expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11811199
11821200
#### distinct-value-cache-disable-from-history
11831201
1184-
Disable populating the Distinct Value cache from historical data.
1185-
When disabled, the cache will still be populated with data from the WAL.
1202+
Disables populating the distinct value cache from historical data.
1203+
If disabled, the cache is still populated with data from the write-ahead log (WAL).
11861204
11871205
| influxdb3 serve option | Environment variable |
11881206
| :-------------------------------------------- | :---------------------------------------------------- |
@@ -1192,7 +1210,7 @@ When disabled, the cache will still be populated with data from the WAL.
11921210
#### query-file-limit
11931211
11941212
Limits the number of Parquet files a query can access.
1195-
If a query attempts to read more than this limit, InfluxDB returns an error.
1213+
If a query attempts to read more than this limit, {{% product-name %}} returns an error.
11961214
11971215
| influxdb3 serve option | Environment variable |
11981216
| :--------------------- | :--------------------------- |

0 commit comments

Comments
 (0)