Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5916 from influxdata/jts-fix-5915 

fix-5915 Update influxdb3 serve options
pull/5919/head
Jason Stirnaman 2025-03-19 11:47:18 -05:00 committed by GitHub
parent 44fde6bef4 5a5a291683
commit a9be34364c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 350 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
content/influxdb3/core/reference/cli/influxdb3/_index.md
View File

@ -8,9 +8,120 @@ menu:
parent: CLIs
name: influxdb3
weight: 200
source: /shared/influxdb3-cli/_index.md
---
<!--
The content of this file is at content/shared/influxdb3-cli/_index.md
-->
The `influxdb3` CLI runs and interacts with the {{< product-name >}} server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
```
## Commands
| Command | Description |
| :--------------------------------------------------------------| :---------------------------------- |
| [create](/influxdb3/core/reference/cli/influxdb3/create/) | Create resources |
| [delete](/influxdb3/core/reference/cli/influxdb3/delete/) | Delete resources |
| [disable](/influxdb3/core/reference/cli/influxdb3/disable/) | Disable resources |
| [enable](/influxdb3/core/reference/cli/influxdb3/enable/) | Enable resources |
| [query](/influxdb3/core/reference/cli/influxdb3/query/) | Query {{% product-name %}} |
| [serve](/influxdb3/core/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
| [show](/influxdb3/core/reference/cli/influxdb3/show/) | List resources |
| [test](/influxdb3/core/reference/cli/influxdb3/test/) | Test plugins |
| [write](/influxdb3/core/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
## Global options
| Option | | Description |
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
| | `--num-threads` | Maximum number of IO runtime threads to use |
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
| `-h` | `--help` | Print help information |
| `-V` | `--version` | Print version |
### Option environment variables
You can use the following environment variables to set `influxdb3` global options:
| Environment Variable | Option |
| :-------------------------------------------- | :------------------------------------ |
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
## Examples
In the examples below, replace
{{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
with a unique identifier for your {{< product-name >}} server.
{{% code-placeholders "my-host-01" %}}
### Run the InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
```
### Display short-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 -h
```
### Display long-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 --help
```
### Run the {{< product-name >}} server with extra verbose logging
<!--pytest.mark.skip-->
```bash
influxdb3 serve -v \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
```
### Run {{< product-name >}} with debug logging using LOG_FILTER
<!--pytest.mark.skip-->
```bash
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
```
{{% /code-placeholders %}}

39
content/influxdb3/core/reference/cli/influxdb3/serve.md
View File

@ -21,10 +21,20 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
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`).
> [!NOTE]
> `--node-id` supports alphanumeric strings with optional hyphens.
## Options
| Option | | Description |
| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
| | `--object-store` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store)_ |
| | `--bucket` | _See [configuration options](/influxdb3/core/reference/config-options/#bucket)_ |
| | `--data-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#data-dir)_ |
@ -80,9 +90,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-max-write-buffer-size)_ |
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ |
| | `--parquet-mem-cache-size` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size)_ |
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ |
| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-parquet-mem-cache)_ |
@ -102,7 +110,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
You can use environment variables to define most `influxdb3 serve` options.
For more information, see
[Configuration options](/influxdb3/core/reference/config-options/).
[Configuration options](/influxdb3/enterprise/reference/config-options/).
## Examples
@ -111,10 +119,10 @@ For more information, see
- [Run InfluxDB 3 with debug logging using LOG_FILTER](#run-influxdb-3-with-debug-logging-using-log_filter)
In the examples below, replace
{{% code-placeholder-key %}}`MY_HOST_ID`{{% /code-placeholder-key %}}:
with a unique identifier for your {{< product-name >}} server.
{{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
with a unique string that identifies your {{< product-name >}} server.
{{% code-placeholders "MY_HOST_ID" %}}
{{% code-placeholders "my-host-01" %}}
### Run the InfluxDB 3 server
@ -124,7 +132,7 @@ with a unique identifier for your {{< product-name >}} server.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_ID
--node-id my-host-01
```
### Run the InfluxDB 3 server with extra verbose logging
@ -136,7 +144,7 @@ influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_ID
--node-id my-host-01
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
@ -147,7 +155,18 @@ influxdb3 serve \
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_ID
--node-id my-host-01
```
{{% /code-placeholders %}}
## Troubleshooting
### Common Issues
- **Error: "Failed to connect to object store"**
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
- **Permission errors when using S3, Google Cloud, or Azure storage**
Check that your authentication credentials are correct and have sufficient permissions.

2
content/influxdb3/core/reference/config-options.md
View File

@ -27,7 +27,7 @@ environment variables.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host \
--node-id NODE_ID \
--log-filter info \
--max-http-request-size 20971520 \
--aws-allow-http

126
content/influxdb3/enterprise/reference/cli/influxdb3/_index.md
View File

@ -8,9 +8,127 @@ menu:
parent: CLIs
name: influxdb3
weight: 200
source: /shared/influxdb3-cli/_index.md
---
<!--
The content of this file is at content/shared/influxdb3-cli/_index.md
-->
The `influxdb3` CLI runs and interacts with the {{< product-name >}} server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
```
## Commands
| Command | Description |
| :--------------------------------------------------------------| :---------------------------------- |
| [create](/influxdb3/enterprise/reference/cli/influxdb3/create/) | Create resources |
| [delete](/influxdb3/enterprise/reference/cli/influxdb3/delete/) | Delete resources |
| [disable](/influxdb3/enterprise/reference/cli/influxdb3/disable/) | Disable resources |
| [enable](/influxdb3/enterprise/reference/cli/influxdb3/enable/) | Enable resources |
| [query](/influxdb3/enterprise/reference/cli/influxdb3/query/) | Query {{% product-name %}} |
| [serve](/influxdb3/enterprise/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
| [show](/influxdb3/enterprise/reference/cli/influxdb3/show/) | List resources |
| [test](/influxdb3/enterprise/reference/cli/influxdb3/test/) | Test plugins |
| [write](/influxdb3/enterprise/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
## Global options
| Option | | Description |
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
| | `--num-threads` | Maximum number of IO runtime threads to use |
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
| `-h` | `--help` | Print help information |
| `-V` | `--version` | Print version |
### Option environment variables
You can use the following environment variables to set `influxdb3` global options:
| Environment Variable | Option |
| :-------------------------------------------- | :------------------------------------ |
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
## Examples
In the examples below, replace the following:
- {{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
a unique identifier for your {{< product-name >}} server.
- {{% code-placeholder-key %}}`my-cluster-01`{{% /code-placeholder-key %}}:
a unique identifier for your {{< product-name >}} cluster.
The value you use must be different from `--node-id` values in the cluster.
{{% code-placeholders "my-host-01|my-cluster-01" %}}
### Run the InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
```
### Display short-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 -h
```
### Display long-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 --help
```
### Run the {{< product-name >}} server with extra verbose logging
<!--pytest.mark.skip-->
```bash
influxdb3 serve -v \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
```
### Run {{< product-name >}} with debug logging using LOG_FILTER
<!--pytest.mark.skip-->
```bash
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
```
{{% /code-placeholders %}}

89
content/influxdb3/enterprise/reference/cli/influxdb3/serve.md
View File

@ -7,6 +7,8 @@ menu:
parent: influxdb3
name: influxdb3 serve
weight: 300
related:
- /influxdb3/enterprise/reference/config-options/
---
The `influxdb3 serve` command starts the {{< product-name >}} server.
@ -16,13 +18,28 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
<!--pytest.mark.skip-->
```bash
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
influxdb3 serve [OPTIONS] \
--node-id <NODE_IDENTIFIER_PREFIX> \
--cluster-id <CLUSTER_IDENTIFIER_PREFIX>
```
## Required parameters
- **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`).
> [!NOTE]
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.
## Options
| Option | | Description |
| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
| {{< req "\*" >}} | `--cluster-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#cluster-id)_ |
| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ |
| | `--object-store` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store)_ |
| | `--bucket` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#bucket)_ |
| | `--data-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#data-dir)_ |
@ -78,21 +95,14 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ |
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#snapshotted-wal-files-to-keep)_ |
| | `--query-log-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-log-size)_ |
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#buffer-mem-limit-mb)_ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ |
| | `--read-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#read-from-node-ids)_ |
| | `--replication-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replication-interval)_ |
| | `--compactor-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compactor-id)_ |
| | `--compact-from-node-ids` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compact-from-node-ids)_ |
| | `--run-compactions` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#run-compactions)_ |
| | `--compaction-row-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-row-limit)_ |
| | `--compaction-max-num-files-per-plan` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-max-num-files-per-plan)_ |
| | `--compaction-gen2-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-gen2-duration)_ |
| | `--compaction-multipliers` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-multipliers)_ |
| | `--license-email` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#license-email)_ |
| | `--preemptive-cache-age` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#preemptive-cache-age)_ |
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-size-mb)_ |
| | `--parquet-mem-cache-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-size)_ |
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-interval)_ |
| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#disable-parquet-mem-cache)_ |
@ -121,11 +131,15 @@ For more information, see
- [Run the InfluxDB 3 server with extra verbose logging](#run-the-influxdb-3-server-with-extra-verbose-logging)
- [Run InfluxDB 3 with debug logging using LOG_FILTER](#run-influxdb-3-with-debug-logging-using-log_filter)
In the examples below, replace
{{% code-placeholder-key %}}`MY_HOST_NAME`{{% /code-placeholder-key %}}:
with a unique identifier for your {{< product-name >}} server.
In the examples below, replace the following:
{{% code-placeholders "MY_HOST_NAME" %}}
- {{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
a unique string that identifies your {{< product-name >}} server.
- {{% code-placeholder-key %}}`my-cluster-01`{{% /code-placeholder-key %}}:
a unique string that identifies your {{< product-name >}} cluster.
The value you use must be different from `--node-id` values in the cluster.
{{% code-placeholders "my-host-01|my-cluster-01" %}}
### Run the InfluxDB 3 server
@ -135,7 +149,34 @@ with a unique identifier for your {{< product-name >}} server.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_NAME
--node-id my-host-01 \
--cluster-id my-cluster-01
```
### Run a server in specific modes
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01 \
--mode ingest,query,process
```
### Run a server specifically for compacting data
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01 \
--mode compact
```
### Run the InfluxDB 3 server with extra verbose logging
@ -147,7 +188,8 @@ influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_NAME
--node-id my-host-01 \
--cluster-id my-cluster-01
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
@ -158,7 +200,22 @@ influxdb3 serve \
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id MY_HOST_NAME
--node-id my-host-01 \
--cluster-id my-cluster-01
```
{{% /code-placeholders %}}
## Troubleshooting
### Common Issues
- **Error: "cluster-id cannot match any node-id in the cluster"**
Ensure your `--cluster-id` value is different from all `--node-id` values in your cluster.
- **Error: "Failed to connect to object store"**
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
- **Permission errors when using S3, Google Cloud, or Azure storage**
Check that your authentication credentials are correct and have sufficient permissions.

20
content/influxdb3/enterprise/reference/config-options.md
View File

@ -27,7 +27,8 @@ environment variables.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host \
--node-id NODE_ID \
--cluster-id my-cluster-01 \
--log-filter info \
--max-http-request-size 20971520 \
--aws-allow-http
@ -202,7 +203,7 @@ This value must be different than the [`--node-id`](#node-id) value.
| influxdb3 serve option | Environment variable |
| :--------------------- | :--------------------------------- |
| `--cluster-id` | `INFLUXDB3_ENTERPRISE_CLUSTER_ID` |
| `--cluster-id` | `INFLUXDB3_ENTERPRISE_my-cluster-01` |
---
@ -212,11 +213,13 @@ Sets the mode to start the server in.
This option supports the following values:
- `all` _(default)_
- `ingest`
- `query`
- `compact`
- `process`
- `all` _(default)_: Enables all server modes
- `ingest`: Enables only data ingest capabilities
- `query`: Enables only query capabilities
- `compact`: Enables only compaction processes
- `process`: Enables only data processing capabilities
You can specify multiple modes using a comma-delimited list (for example, `ingest,query`).
**Default:** `all`
@ -979,9 +982,6 @@ Defines the interval at which each replica specified in the
- [compaction-cleanup-wait](#compaction-cleanup-wait)
- [gen1-duration](#gen1-duration)
#### compaction-row-limit
Specifies the soft limit for the number of rows per file that the compactor

108
content/shared/influxdb3-cli/_index.md
View File

@ -1,108 +0,0 @@
The `influxdb3` CLI runs and interacts with the {{< product-name >}} server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
```
## Commands
| Command | Description |
| :---------------------------------------------------------------- | :---------------------------------- |
| [create](/influxdb3/version/reference/cli/influxdb3/create/) | Create resources |
| [delete](/influxdb3/version/reference/cli/influxdb3/delete/) | Delete resources |
| [disable](/influxdb3/version/reference/cli/influxdb3/disable/) | Disable resources |
| [enable](/influxdb3/version/reference/cli/influxdb3/enable/) | Enable resources |
| [query](/influxdb3/version/reference/cli/influxdb3/query/) | Query {{% product-name %}} |
| [serve](/influxdb3/version/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
| [show](/influxdb3/version/reference/cli/influxdb3/show/) | List resources |
| [test](/influxdb3/version/reference/cli/influxdb3/test/) | Test plugins |
| [write](/influxdb3/version/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
## Global options
| Option | | Description |
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
| | `--num-threads` | Maximum number of IO runtime threads to use |
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
| `-h` | `--help` | Print help information |
| `-V` | `--version` | Print version |
### Option environment variables
You can use the following environment variables to set `influxdb3` global options:
| Environment Variable | Option |
| :-------------------------------------------- | :------------------------------------ |
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
## Examples
### Run the InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
```
### Display short-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 -h
```
### Display long-form help for all commands
<!--pytest.mark.skip-->
```bash
influxdb3 --help
```
### Run the {{< product-name >}} server with extra verbose logging
<!--pytest.mark.skip-->
```bash
influxdb3 serve -v \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
```
### Run {{< product-name >}} with debug logging using LOG_FILTER
<!--pytest.mark.skip-->
```bash
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_NAME
```