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

Merge branch 'monolith' of github.com:influxdata/docs-v2 into monolith

pull/5749/head
Scott Anderson 2025-01-11 21:12:45 -07:00
parent 944b09b4ef 809af6939b
commit e877568aa5
32 changed files with 2122 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
assets/styles/layouts/article/_tables.scss
View File

@ -67,7 +67,9 @@ table + table {
// Adjust spacing to push long-hand and short-hand columns closer together
#flags:not(.no-shorthand),
#options:not(.no-shorthand),
#global-flags,
#global-options,
.shorthand-flags {
& + table {
td:nth-child(2) code { margin-left: -2rem; }

14
content/influxdb3/enterprise/reference/cli/_index.md Normal file
View File

@ -0,0 +1,14 @@
---
title: Command line tools
description: >
View command line tools used to manage and interact with InfluxDB 3 Enterprise.
menu:
influxdb3_enterprise:
name: CLIs
parent: Reference
weight: 101
---
View command line tools used to run, manage, and interact with InfluxDB 3 Enterprise:
{{< children >}}

125
content/influxdb3/enterprise/reference/cli/influxdb3/_index.md Normal file
View File

@ -0,0 +1,125 @@
---
title: influxdb3 CLI
list_title: influxdb3
description: >
The `influxdb3` CLI runs and interacts with the InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: CLIs
name: influxdb3
weight: 200
---
The `influxdb3` CLI runs and interacts with the InfluxDB 3 Enterprise 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
- [Run the InfluxDB 3 server](#run-the-influxdb-3-server)
- [Display short-form help for all commands](#display-short-form-help-for-all-commands)
- [Display long-form help for all commands](#display-long-form-help-for-all-commands)
- [Run the InfluxDB 3 Enterprise server with extra verbose logging](#run-the-influxdb-3-enterprise-server-with-extra-verbose-logging)
- [Run InfluxDB 3 Enterprise with debug logging using LOG_FILTER](#run-influxdb-3-enterprise-with-debug-logging-using-log_filter)
### Run the InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--host-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 InfluxDB 3 Enterprise server with extra verbose logging
<!--pytest.mark.skip-->
```bash
influxdb3 serve -v \
--object-store file \
--data-dir ~/.influxdb3 \
--host-id my_host_name
```
### Run InfluxDB 3 Enterprise with debug logging using LOG_FILTER
<!--pytest.mark.skip-->
```bash
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--host-id my_host_name
```

42
content/influxdb3/enterprise/reference/cli/influxdb3/create/_index.md Normal file
View File

@ -0,0 +1,42 @@
---
title: influxdb3 create
description: >
The `influxdb3 create` command creates a resource such as a database or
authentication token.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 create
weight: 300
---
The `influxdb3 create` command creates a resource such as a database or
authentication token.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------------------------- | :---------------------------------------------- |
| [database](/influxdb3/enterprise/reference/cli/influxdb3/create/database/) | Create a new database |
| [file_index](/influxdb3/enterprise/reference/cli/influxdb3/create/file_index/) | Create a new file index for a database or table |
| [last_cache](/influxdb3/enterprise/reference/cli/influxdb3/create/last_cache/) | Create a new last value cache |
| [distinct_cache](/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache/) | Create a new distinct value cache |
| [plugin](/influxdb3/enterprise/reference/cli/influxdb3/create/plugin/) | Create a new processing engine plugin |
| [table](/influxdb3/enterprise/reference/cli/influxdb3/create/table/) | Create a new table in a database |
| [token](/influxdb3/enterprise/reference/cli/influxdb3/create/token/) | Create a new authentication token |
| [trigger](/influxdb3/enterprise/reference/cli/influxdb3/create/trigger/) | Create a new trigger for the processing engine |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

77
content/influxdb3/enterprise/reference/cli/influxdb3/create/database.md Normal file
View File

@ -0,0 +1,77 @@
---
title: influxdb3 create database
description: >
The `influxdb3 create database` command creates a new database.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create database
weight: 400
---
The `influxdb3 create database` command creates a new database.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create database [OPTIONS] <DATABASE_NAME>
```
## Arguments
- **DATABASE_NAME**: The name of the database to create.
Valid database names are alphanumeric and start with a letter or number.
Dashes (`-`) and underscores (`_`) are allowed.
Environment variable: `INFLUXDB3_DATABASE_NAME`
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Create a new database](#create-a-new-database)
- [Create a new database while specifying the token inline](#create-a-new-database-while-specifying-the-token-inline)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
### Create a new database
<!--pytest.mark.skip-->
```bash
influxdb3 create database DATABASE_NAME
```
### Create a new database while specifying the token inline
<!--pytest.mark.skip-->
```bash
influxdb3 create database --token AUTH_TOKEN DATABASE_NAME
```
{{% /code-placeholders %}}

62
content/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache.md Normal file
View File

@ -0,0 +1,62 @@
---
title: influxdb3 create distinct_cache
description: >
The `influxdb3 create distinct_cache` command creates a new distinct value cache.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create distinct_cache
weight: 400
---
The `influxdb3 create distinct_cache` command creates a new distinct value cache.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create distinct_cache [OPTIONS] \
--database <DATABASE_NAME> \
--table <TABLE> \
--columns <COLUMNS> \
[CACHE_NAME]
```
## Arguments
- **CACHE_NAME**: _(Optional)_ Name for the cache.
If not provided, the command automatically generates a name.
## Options
| Option | | Description |
| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to create the cache for |
| | `--columns` | _({{< req >}})_ Comma-separated list of columns to cache distinct values for--for example: `col1,col2,col3` (see [Metadata cache hierarchy](#metadata-cache-hierarchy)) |
| | `--max-cardinality` | Maximum number of distinct value combinations to hold in the cache |
| | `--max-age` | Maximum age of an entry in the cache entered as a human-readable duration--for example: `30d`, `24h` |
| `-h` | `--help` | Print help information |
> [!Important]
>
> #### Metadata cache hierarchy
>
> The distinct value cache has a hierarchical structure with a level for each specified column.
> The order specified in the `--columns` option determines the order of levels,
> from top-to-bottom, of the cache hierarchy.
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
<!-- TODO: GET EXAMPLES -->

83
content/influxdb3/enterprise/reference/cli/influxdb3/create/file_index.md Normal file
View File

@ -0,0 +1,83 @@
---
title: influxdb3 create file_index
description: >
The `influxdb3 create file_index` command creates a new file index for a
database or table.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create file_index
weight: 400
---
The `influxdb3 create file_index` command creates a new file index for a
database or table.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
```
## Arguments
- **COLUMNS**: The columns to use for the file index.
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | Table to apply the file index too |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Create a new file index for a database](#create-a-new-file-index-for-a-database)
- [Create a new file index for a specific table](#create-a-new-file-index-for-a-specific-table)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
### Create a new file index for a database
<!--pytest.mark.skip-->
```bash
influxdb3 create file_index \
--database DATABASE_NAME \
column1 column2 column3
```
### Create a new file index for a specific table
<!--pytest.mark.skip-->
```bash
influxdb3 create file_index \
--database DATABASE_NAME \
--table TABLE_NAME \
column1 column2 column3
```
{{% /code-placeholders %}}

51
content/influxdb3/enterprise/reference/cli/influxdb3/create/last_cache.md Normal file
View File

@ -0,0 +1,51 @@
---
title: influxdb3 create last_cache
description: >
The `influxdb3 create last_cache` command creates a new last value cache.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create last_cache
weight: 400
---
The `influxdb3 create last_cache` command creates a new last value cache.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE> [CACHE_NAME]
```
## Arguments
- **CACHE_NAME**: _(Optional)_ Name for the cache.
If not provided, the command automatically generates a name.
## Options
| Option | | Description |
| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to create the cache for |
| | `--key-columns` | Comma-separated list of columns to use as keys in the cache--for example: `foo,bar,baz` |
| | `--value-columns` | Comma-separated list of columns to store as values in the cache--for example: `foo,bar,baz` |
| | `--count` | Number of entries per unique key column combination to store in the cache |
| | `--ttl` | Cache entries' time-to-live (TTL) in [Humantime form](https://docs.rs/humantime/latest/humantime/fn.parse_duration.html)--for example: `10s`, `1min 30sec`, `3 hours` |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
<!-- TODO: GET EXAMPLES -->

52
content/influxdb3/enterprise/reference/cli/influxdb3/create/plugin.md Normal file
View File

@ -0,0 +1,52 @@
---
title: influxdb3 create plugin
description: >
The `influxdb3 create plugin` command creates a new processing engine plugin.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create plugin
weight: 400
---
The `influxdb3 create plugin` command creates a new processing engine plugin.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create plugin [OPTIONS] \
--database <DATABASE_NAME> \
--code-filename <CODE_FILE> \
--entry-point <FUNCTION_NAME> \
<PLUGIN_NAME>
```
## Arguments
- **PLUGIN_NAME**: The name of the plugin to create.
## Options
| Option | | Description |
| :----- | :---------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--code-filename` | _({{< req >}})_ Python file containing the plugin code |
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
<!-- TODO: GET EXAMPLES -->

92
content/influxdb3/enterprise/reference/cli/influxdb3/create/table.md Normal file
View File

@ -0,0 +1,92 @@
---
title: influxdb3 create table
description: >
The `influxdb3 create table` command creates a table in a database.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create table
weight: 400
---
The `influxdb3 create table` command creates a table in a database.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create table [OPTIONS] \
--tags [<TAGS>...] \
--database <DATABASE_NAME> \
<TABLE_NAME>
```
## Arguments
- **TABLE_NAME**: The name of the table to create.
## Options
| Option | | Description |
| :----- | :-------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--tags` | _({{< req >}})_ Space-separated list of tag columns to include in the table |
| | `--fields` | Space-separated list of field columns to include in the table |
| `-h` | `--help` | Print help information |
> [!Important]
>
> #### Tag and field naming requirements
>
> Tag and field keys are alphanumeric and must start with a letter or number.
> They can contain dashes (`-`) and underscores (`_`).
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Create a table](#create-a-table)
- [Create a table with tag and field columns](#create-a-table-with-tag-and-field-columns)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
### Create a table
```bash
influxdb3 create table \
--tags tag1 tag2 tag3 \
--database DATABASE_NAME
TABLE_NAME
```
### Create a table with tag and field columns
<!--pytest.mark.skip-->
```bash
influxdb3 create table \
--tags room sensor_id \
--fields temp:float64 hum:float64 co:int64 \
--database DATABASE_NAME
TABLE_NAME
```
{{% /code-placeholders %}}

26
content/influxdb3/enterprise/reference/cli/influxdb3/create/token.md Normal file
View File

@ -0,0 +1,26 @@
---
title: influxdb3 create token
description: >
The `influxdb3 create token` command creates a new authentication token.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create token
weight: 400
---
The `influxdb3 create token` command creates a new authentication token.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create token
```
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

54
content/influxdb3/enterprise/reference/cli/influxdb3/create/trigger.md Normal file
View File

@ -0,0 +1,54 @@
---
title: influxdb3 create trigger
description: >
The `influxdb3 create trigger` command creates a new trigger for the
processing engine.
menu:
influxdb3_enterprise:
parent: influxdb3 create
name: influxdb3 create trigger
weight: 400
---
The `influxdb3 create trigger` command creates a new trigger for the
processing engine.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 create trigger [OPTIONS] \
--database <DATABASE_NAME> \
--plugin <PLUGIN_NAME> \
--trigger-spec <TRIGGER_SPECIFICATION> \
<TRIGGER_NAME>
```
## Arguments
- **TRIGGER_NAME**: A name for the new trigger.
## Options
| Option | | Description |
| :----- | :--------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--plugin` | Plugin to execute when the trigger fires |
| | `--trigger-spec` | Trigger specification--for example `table:<TABLE_NAME>` or `all_tables` |
| | `--disabled` | Create the trigger in disabled state |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
<!-- TODO: GET EXAMPLES -->

36
content/influxdb3/enterprise/reference/cli/influxdb3/delete/_index.md Normal file
View File

@ -0,0 +1,36 @@
---
title: influxdb3 delete
description: >
The `influxdb3 delete` command deletes a resource such as a database or a table.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 delete
weight: 300
---
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :----------------------------------------------------------------------------- | :--------------------------------------------- |
| [database](/influxdb3/enterprise/reference/cli/influxdb3/delete/database/) | Delete a database |
| [file_index](/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index/) | Delete a file index for a database or table |
| [last_cache](/influxdb3/enterprise/reference/cli/influxdb3/delete/last_cache/) | Delete a last value cache |
| [distinct_cache](/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache/) | Delete a metadata cache |
| [plugin](/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin/) | Delete a processing engine plugin |
| [table](/influxdb3/enterprise/reference/cli/influxdb3/delete/table/) | Delete a table from a database |
| [trigger](/influxdb3/enterprise/reference/cli/influxdb3/delete/trigger/) | Delete a trigger for the processing engine |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

75
content/influxdb3/enterprise/reference/cli/influxdb3/delete/database.md Normal file
View File

@ -0,0 +1,75 @@
---
title: influxdb3 delete database
description: >
The `influxdb3 delete database` command deletes a database.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete database
weight: 400
---
The `influxdb3 delete database` command deletes a database.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete database [OPTIONS] <DATABASE_NAME>
```
## Arguments
- **DATABASE_NAME**: The name of the database to delete.
Environment variable: `INFLUXDB3_DATABASE_NAME`
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Delete a database](#delete-a-new-database)
- [Delete a database while specifying the token inline](#delete-a-new-database-while-specifying-the-token-inline)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
### Delete a database
<!--pytest.mark.skip-->
```bash
influxdb3 delete database DATABASE_NAME
```
### Delete a database while specifying the token inline
<!--pytest.mark.skip-->
```bash
influxdb3 delete database --token AUTH_TOKEN DATABASE_NAME
```
{{% /code-placeholders %}}

73
content/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache.md Normal file
View File

@ -0,0 +1,73 @@
---
title: influxdb3 delete distinct_cache
description: >
The `influxdb3 delete distinct_cache` command deletes a distinct value cache.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete distinct_cache
weight: 400
---
The `influxdb3 delete distinct_cache` command deletes a distinct value cache.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete distinct_cache [OPTIONS] \
--database <DATABASE_NAME> \
--table <TABLE> \
[CACHE_NAME]
```
## Arguments
- **CACHE_NAME**: _(Optional)_ Name of the cache to delete.
## Options
| Option | | Description |
| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
### Delete a distinct value cache
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete distinct_cache \
--database DATABASE_NAME \
--table TABLE_NAME \
CACHE_NAME
```
{{% /code-placeholders %}}
In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:
Name of the distinct value cache to delete

74
content/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index.md Normal file
View File

@ -0,0 +1,74 @@
---
title: influxdb3 delete file_index
description: >
The `influxdb3 delete file_index` command deletes a file index for a
database or table.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete file_index
weight: 400
---
The `influxdb3 delete file_index` command deletes a file index for a
database or table.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index [OPTIONS] --database <DATABASE_NAME>
```
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | Table to delete the file index from |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Delete a file index from a database](#delete-a-file-index-from-a-database)
- [Delete a file index from a specific table](#delete-a-file-index-from-a-specific-table)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
### Delete a file index from a database
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME
```
### Delete a file index from a specific table
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME --table TABLE_NAME
```
{{% /code-placeholders %}}

70
content/influxdb3/enterprise/reference/cli/influxdb3/delete/last_cache.md Normal file
View File

@ -0,0 +1,70 @@
---
title: influxdb3 delete last_cache
description: >
The `influxdb3 delete last_cache` command deletes a last value cache.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete last_cache
weight: 400
---
The `influxdb3 delete last_cache` command deletes a last value cache.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE> [CACHE_NAME]
```
## Arguments
- **CACHE_NAME**: _(Optional)_ Name of the cache to delete.
## Options
| Option | | Description |
| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
### Delete a last value cache
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete last_cache \
--database DATABASE_NAME \
--table TABLE_NAME \
CACHE_NAME
```
{{% /code-placeholders %}}
In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:
Name of the last value cache to delete

64
content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md Normal file
View File

@ -0,0 +1,64 @@
---
title: influxdb3 delete plugin
description: >
The `influxdb3 delete plugin` command deletes a processing engine plugin.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete plugin
weight: 400
---
The `influxdb3 delete plugin` command deletes a processing engine plugin.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_NAME>
```
## Arguments
- **PLUGIN_NAME**: The name of the plugin to delete.
## Options
| Option | | Description |
| :----- | :---------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
### Delete a plugin
{{% code-placeholders "(DATABASE|PLUGIN)_NAME" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete plugin --database DATABASE_NAME PLUGIN_NAME
```
{{% /code-placeholders %}}
In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}:
Name of the plugin to delete

64
content/influxdb3/enterprise/reference/cli/influxdb3/delete/table.md Normal file
View File

@ -0,0 +1,64 @@
---
title: influxdb3 delete table
description: >
The `influxdb3 delete table` command deletes a table from a database.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete table
weight: 400
---
The `influxdb3 delete table` command deletes a table from a database.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete table [OPTIONS] --database <DATABASE_NAME> <TABLE_NAME>
```
## Arguments
- **TABLE_NAME**: The name of the table to delete.
## Options
| Option | | Description |
| :----- | :-------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
### Delete a table
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete table --database DATABASE_NAME TABLE_NAME
```
{{% /code-placeholders %}}
In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Name of the table to delete

76
content/influxdb3/enterprise/reference/cli/influxdb3/delete/trigger.md Normal file
View File

@ -0,0 +1,76 @@
---
title: influxdb3 delete trigger
description: >
The `influxdb3 delete trigger` command deletes a processing engine trigger.
menu:
influxdb3_enterprise:
parent: influxdb3 delete
name: influxdb3 delete trigger
weight: 400
---
The `influxdb3 delete trigger` command deletes a processing engine trigger.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
```
## Arguments
- **TRIGGER_NAME**: The name of the trigger to delete.
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--force` | Force delete even if the trigger is active |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Delete a trigger](#delete-a-trigger)
- [Force delete an active trigger](#force-delete-an-active-trigger)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TRIGGER_NAME`{{% /code-placeholder-key %}}:
Name of the trigger to delete
{{% code-placeholders "(DATABASE|TRIGGER)_NAME" %}}
### Delete a trigger
<!--pytest.mark.skip-->
```bash
influxdb3 delete trigger --database DATABASE_NAME TRIGGER_NAME
```
### Force delete an active trigger
<!--pytest.mark.skip-->
```bash
influxdb3 delete trigger --force --database DATABASE_NAME TRIGGER_NAME
```
{{% /code-placeholders %}}

33
content/influxdb3/enterprise/reference/cli/influxdb3/disable/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
title: influxdb3 disable
description: >
The `influxdb3 disable` command disables resources such as a trigger.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 disable
weight: 300
---
The `influxdb3 disable` command disables resources such as a trigger.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 disable <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------------ | :--------------------------------------------- |
| [trigger](/influxdb3/enterprise/reference/cli/influxdb3/disable/trigger/) | Disables a plugin trigger |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

43
content/influxdb3/enterprise/reference/cli/influxdb3/disable/trigger.md Normal file
View File

@ -0,0 +1,43 @@
---
title: influxdb3 disable trigger
description: >
The `influxdb3 disable trigger` command disables a plugin trigger.
menu:
influxdb3_enterprise:
parent: influxdb3 disable
name: influxdb3 disable trigger
weight: 400
---
The `influxdb3 disable trigger` command disables a plugin trigger.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 disable trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
```
## Arguments:
- **TRIGGER_NAME**: Name of the trigger to disable
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |

33
content/influxdb3/enterprise/reference/cli/influxdb3/enable/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
title: influxdb3 enable
description: >
The `influxdb3 enable` command enables resources such as a trigger.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 enable
weight: 300
---
The `influxdb3 enable` command enables resources such as a trigger.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 enable <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :----------------------------------------------------------------------- | :--------------------------------------------- |
| [trigger](/influxdb3/enterprise/reference/cli/influxdb3/enable/trigger/) | Enable a trigger to enable plugin execution |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

43
content/influxdb3/enterprise/reference/cli/influxdb3/enable/trigger.md Normal file
View File

@ -0,0 +1,43 @@
---
title: influxdb3 enable trigger
description: >
The `influxdb3 enable trigger` command enables a trigger to enable plugin execution.
menu:
influxdb3_enterprise:
parent: influxdb3 enable
name: influxdb3 enable trigger
weight: 400
---
The `influxdb3 enable trigger` command enables a trigger to enable plugin execution.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 enable trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
```
## Arguments:
- **TRIGGER_NAME**: Name of the trigger to enable
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |

107
content/influxdb3/enterprise/reference/cli/influxdb3/query.md Normal file
View File

@ -0,0 +1,107 @@
---
title: influxdb3 query
description: >
The `influxdb3 query` command executes a query against a running InfluxDB 3 server.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 query
weight: 300
---
The `influxdb3 query` command executes a query against a running
{{< product-name >}} server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
```
##### Aliases
`query`, `q`
## Arguments
- **QUERY**: The query string to execute.
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-l` | `--language` | Query language of the query string (`sql` _(default)_ or `influxql`) |
| | `--format` | Output format (`pretty` _(default)_, `json`, `json_lines`, `csv`, `parquet`) |
| `-o` | `--output` | Output query results to the specified file |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Query data using SQL](#query-data-using-sql)
- [Query data using InfluxQL](#query-data-using-influxql)
- [Query data and return JSON-formatted results](#query-data-and-return-json-formatted-results)
- [Query data and write results to a file](#query-data-and-write-results-to-a-file)
In the examples below, replace
{{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
with the name of the database to query.
{{% code-placeholders "DATABASE_NAME" %}}
### Query data using SQL
<!--pytest.mark.skip-->
```bash
influxdb3 query --database DATABASE_NAME 'SELECT * FROM home'
```
### Query data using InfluxQL
<!--pytest.mark.skip-->
```bash
influxdb3 query \
--language influxql \
--database DATABASE_NAME \
'SELECT * FROM home'
```
### Query data and return JSON-formatted results
<!--pytest.mark.skip-->
```bash
influxdb3 query \
--format json \
--database DATABASE_NAME \
'SELECT * FROM home'
```
### Query data and write results to a file
<!--pytest.mark.skip-->
```bash
influxdb3 query \
--output /path/to/results.txt \
--database DATABASE_NAME \
'SELECT * FROM home'
```
{{% /code-placeholders %}}

157
content/influxdb3/enterprise/reference/cli/influxdb3/serve.md Normal file
View File

@ -0,0 +1,157 @@
---
title: influxdb3 serve
description: >
The `influxdb3 serve` command starts the InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 serve
weight: 300
---
The `influxdb3 serve` command starts the InfluxDB 3 Enterprise server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 serve [OPTIONS] --host-id <HOST_IDENTIFIER_PREFIX>
```
## Options
| Option | | Description |
| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
| | `--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)_ |
| | `--aws-access-key-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-access-key-id)_ |
| | `--aws-secret-access-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-secret-access-key)_ |
| | `--aws-default-region` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-default-region)_ |
| | `--aws-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-endpoint)_ |
| | `--aws-session-token` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-session-token)_ |
| | `--aws-allow-http` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-allow-http)_ |
| | `--aws-skip-signature` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-skip-signature)_ |
| | `--google-service-account` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#google-service-account)_ |
| | `--azure-storage-account` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-account)_ |
| | `--azure-storage-access-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-access-key)_ |
| | `--object-store-connection-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-connection-limit)_ |
| | `--object-store-http2-only` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-http2-only)_ |
| | `--object-store-http2-max-frame-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-http2-max-frame-size)_ |
| | `--object-store-max-retries` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-max-retries)_ |
| | `--object-store-retry-timeout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-retry-timeout)_ |
| `-h` | `--help` | Print help information |
| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-cache-endpoint)_ |
| | `--log-filter` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-filter)_ |
| `-v` | `--verbose` | Enable verbose output |
| | `--log-destination` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-destination)_ |
| | `--log-format` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-format)_ |
| | `--traces-exporter` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter)_ |
| | `--traces-exporter-jaeger-agent-host` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-agent-host)_ |
| | `--traces-exporter-jaeger-agent-port` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-agent-port)_ |
| | `--traces-exporter-jaeger-service-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-service-name)_ |
| | `--traces-exporter-jaeger-trace-context-header-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-exporter-jaeger-trace-context-header-name)_ |
| | `--traces-jaeger-debug-name` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-debug-name)_ |
| | `--traces-jaeger-tags` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-tags)_ |
| | `--traces-jaeger-max-msgs-per-second` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-max-msgs-per-second)_ |
| | `--datafusion-num-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-num-threads)_ |
| | `--datafusion-runtime-type` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-type)_ |
| | `--datafusion-runtime-disable-lifo-slot` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-disable-lifo-slot)_ |
| | `--datafusion-runtime-event-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-event-interval)_ |
| | `--datafusion-runtime-global-queue-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-global-queue-interval)_ |
| | `--datafusion-runtime-max-blocking-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-blocking-threads)_ |
| | `--datafusion-runtime-max-io-events-per-tick` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-io-events-per-tick)_ |
| | `--datafusion-runtime-thread-keep-alive` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-keep-alive)_ |
| | `--datafusion-runtime-thread-priority` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-priority)_ |
| | `--datafusion-max-parquet-fanout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-max-parquet-fanout)_ |
| | `--datafusion-use-cached-parquet-loader` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-use-cached-parquet-loader)_ |
| | `--datafusion-config` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-config)_ |
| | `--max-http-request-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#max-http-request-size)_ |
| | `--http-bind` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#http-bind)_ |
| | `--ram-pool-data-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#ram-pool-data-bytes)_ |
| | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#exec-mem-pool-bytes)_ |
| | `--bearer-token` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#bearer-token)_ |
| | `--gen1-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#gen1-duration)_ |
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ |
| | `--wal-snapshot-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-snapshot-size)_ |
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ |
| | `--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 "\*" >}} | `--host-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#host-id)_ |
| | `--mode` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#mode)_ |
| | `--replicas` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replicas)_ |
| | `--replication-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#replication-interval)_ |
| | `--compactor-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compactor-id)_ |
| | `--compaction-hosts` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-hosts)_ |
| | `--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)_ |
| | `--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-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)_ |
| | `--last-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#last-cache-eviction-interval)_ |
| | `--meta-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#meta-cache-eviction-interval)_ |
| | `--plugin-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#plugin-dir)_ |
{{< caption >}}
{{< req text="\* Required options" >}}
{{< /caption >}}
### Option environment variables
You can use environment variables to define most `influxdb3 serve` options.
For more information, see
[Configuration options](/influxdb3/enterprise/reference/config-options/).
## Examples
- [Run the InfluxDB 3 server](#run-the-influxdb-3-server)
- [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_ID`{{% /code-placeholder-key %}}:
with a unique identifier for your {{< product-name >}} server.
{{% code-placeholders "MY_HOST_ID" %}}
### Run the InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--host-id MY_HOST_ID
```
### Run the InfluxDB 3 server with extra verbose logging
<!--pytest.mark.skip-->
```bash
influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--host-id MY_HOST_ID
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
<!--pytest.mark.skip-->
```bash
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--host-id MY_HOST_ID
```
{{% /code-placeholders %}}

33
content/influxdb3/enterprise/reference/cli/influxdb3/show/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
title: influxdb3 show
description: >
The `influxdb3 show` command lists resources in your InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 show
weight: 300
---
The `influxdb3 show` command lists resources in your InfluxDB 3 Enterprise server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 show <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------------- | :--------------------------------------------- |
| [databases](/influxdb3/enterprise/reference/cli/influxdb3/show/databases/) | List database |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

73
content/influxdb3/enterprise/reference/cli/influxdb3/show/databases.md Normal file
View File

@ -0,0 +1,73 @@
---
title: influxdb3 show databases
description: >
The `influxdb3 show databases` command lists databases in your
InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: influxdb3 show
name: influxdb3 show databases
weight: 400
---
The `influxdb3 show databases` command lists databases in your
InfluxDB 3 Enterprise server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 show databases [OPTIONS]
```
## Options
| Option | | Description |
| :----- | :--------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--show-deleted` | Include databases marked as deleted in the output |
| | `--format` | Output format (`pretty` _(default)_, `json`, `json_lines`, or `csv`) |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [List all databases](#list-all-databases)
- [List all databases, including deleted databases](#list-all-databases-including-deleted-databases)
- [List databases in JSON-formatted output](#list-databases-in-json-formatted-output)
### List all databases
<!--pytest.mark.skip-->
```bash
influxdb3 show databases
```
### List all databases, including deleted databases
<!--pytest.mark.skip-->
```bash
influxdb3 show databases --show-deleted
```
### List databases in JSON-formatted output
<!--pytest.mark.skip-->
```bash
influxdb3 show databases --format json
```

33
content/influxdb3/enterprise/reference/cli/influxdb3/test/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
title: influxdb3 test
description: >
The `influxdb3 test` command tests InfluxDB 3 resources, such as plugins.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 test
weight: 300
---
The `influxdb3 test` command tests InfluxDB 3 resources, such as plugins.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 test <SUBCOMMAND>
```
## Subcommands
| Subcommand | Description |
| :--------------------------------------------------------------------------- | :--------------------------------------------- |
| [wal_plugin](/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin/) | Test a write-ahead log (WAL) plugin |
| help | Print command help or the help of a subcommand |
## Options
| Option | | Description |
| :----- | :------- | :--------------------- |
| `-h` | `--help` | Print help information |

111
content/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin.md Normal file
View File

@ -0,0 +1,111 @@
---
title: influxdb3 test wal_plugin
description: >
The `influxdb3 test wal_plugin` command tests a write-ahead log (WAL) plugin.
menu:
influxdb3_enterprise:
parent: influxdb3 test
name: influxdb3 test wal_plugin
weight: 400
---
The `influxdb3 test wal_plugin` command tests a write-ahead log (WAL) plugin.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 test wal_plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_NAME>
```
## Arguments
- **PLUGIN_NAME**: The name of the plugin file on the server--for example:
`<plugin-dir>/<plugin-file-name>.py`
## Options
| Option | | Description |
| :----- | :------------------ | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--lp` | Line protocol to use as input |
| | `--file` | Line protocol file to use as input |
| | `--input-arguments` | Map of string key-value pairs as to use as plugin input arguments |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Test a WAL plugin](#test-a-wal-plugin)
- [Test a WAL plugin with a line protocol string](#test-a-wal-plugin-with-a-line-protocol-string)
- [Test a WAL plugin with a file containing line protocol](#test-a-wal-plugin-with-a-file-containing-line-protocol)
- [Test a WAL plugin using input arguments](#test-a-wal-plugin-using-input-arguments)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`PLUGIN_DIR`{{% /code-placeholder-key %}}:
Plugin directory name
- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}:
Plugin file name
{{% code-placeholders "(DATABASE|PLUGIN)_(NAME|DIR)" %}}
### Test a WAL plugin
<!--pytest.mark.skip-->
```bash
influxdb3 test wal_plugin \
--database DATABASE_NAME \
PLUGIN_DIR/PLUGIN_NAME.py
```
### Test a WAL plugin with a line protocol string
<!--pytest.mark.skip-->
```bash
influxdb3 test wal_plugin \
--lp 'home,room=Kitchen temp=21.0,hum=35.9,co=0i' \
--database DATABASE_NAME \
PLUGIN_DIR/PLUGIN_NAME.py
```
### Test a WAL plugin with a file containing line protocol
<!--pytest.mark.skip-->
```bash
influxdb3 test wal_plugin \
--file PLUGIN_DIR/PLUGIN_NAME_test/input-file.lp`
--database DATABASE_NAME \
PLUGIN_DIR/PLUGIN_NAME.py
```
### Test a WAL plugin using input arguments
<!--pytest.mark.skip-->
```bash
influxdb3 test wal_plugin \
--input-arguments arg1=foo,arg2=baz \
--database DATABASE_NAME \
PLUGIN_DIR/PLUGIN_NAME.py
```
{{% /code-placeholders %}}

77
content/influxdb3/enterprise/reference/cli/influxdb3/write.md Normal file
View File

@ -0,0 +1,77 @@
---
title: influxdb3 write
description: >
The `influxdb3 write` command writes data to your InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: influxdb3
name: influxdb3 write
weight: 300
---
The `influxdb3 write` command writes data to your InfluxDB 3 Enterprise server.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 write [OPTIONS] --database <DATABASE_NAME> --file <FILE_PATH>
```
##### Aliases
`write`, `w`
## Options
| Option | | Description |
| :----- | :----------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-f` | `--file` | _({{< req >}})_ Line protocol file to use to write data |
| | `--accept-partial` | Accept partial writes |
| `-h` | `--help` | Print help information |
### Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
| :------------------------ | :----------- |
| `INFLUXDB3_HOST_URL` | `--host` |
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
## Examples
- [Write line protocol to your InfluxDB 3 server](#write-line-protocol-to-your-influxdb-3-server)
- [Write line protocol and accept partial writes](#write-line-protocol-and-accept-partial-writes)
In the examples below, replace
{{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
with the name of the database to query.
{{% code-placeholders "DATABASE_NAME" %}}
### Write line protocol to your InfluxDB 3 server
<!--pytest.mark.skip-->
```bash
influxdb3 write --database DATABASE_NAME --file /path/to/data.lp
```
### Write line protocol and accept partial writes
<!--pytest.mark.skip-->
```bash
influxdb3 write \
--accept-partial \
--database DATABASE_NAME \
--file /path/to/data.lp
```
{{% /code-placeholders %}}

167
content/influxdb3/enterprise/reference/config-options.md Normal file
View File

@ -0,0 +1,167 @@
---
title: InfluxDB 3 Enterprise configuration options
description: >
Use InfluxDB 3 configuration options to configure your InfluxDB 3 Enterprise server.
menu:
influxdb3_enterprise:
parent: Reference
name: Configuration options
weight: 100
draft: true
---
<!-- This is just a draft to contain notes for future work -->
## Global configuration options
## Server configuration options
Options:
--object-store <object-store>
Which object storage to use. If not specified, defaults to memory. [env: INFLUXDB3_OBJECT_STORE=] [possible values: memory, memory-throttled, file, s3, google, azure]
--bucket <bucket>
Name of the bucket to use for the object store. Must also set `--object-store` to a cloud object storage to have any effect [env: INFLUXDB3_BUCKET=]
--data-dir <data-dir>
The location InfluxDB 3 Enterprise will use to store files locally [env: INFLUXDB3_DB_DIR=]
--aws-access-key-id <aws-access-key-id>
When using Amazon S3 as the object store, set this to an access key that has permission to read from and write to the specified S3 bucket [env: AWS_ACCESS_KEY_ID=] [default: ]
--aws-secret-access-key <aws-secret-access-key>
When using Amazon S3 as the object store, set this to the secret access key that goes with the specified access key ID [env: AWS_SECRET_ACCESS_KEY=] [default: ]
--aws-default-region <aws-default-region>
When using Amazon S3 as the object store, set this to the region that goes with the specified bucket if different from the fallback value [env: AWS_DEFAULT_REGION=] [default: us-east-1]
--aws-endpoint <aws-endpoint>
When using Amazon S3 compatibility storage service, set this to the endpoint [env: AWS_ENDPOINT=]
--aws-session-token <aws-session-token>
When using Amazon S3 as an object store, set this to the session token. This is handy when using a federated login / SSO and you fetch credentials via the UI [env: AWS_SESSION_TOKEN=]
--aws-allow-http
Allow unencrypted HTTP connection to AWS [env: AWS_ALLOW_HTTP=]
--aws-skip-signature
If enabled, S3 stores will not fetch credentials and will not sign requests [env: AWS_SKIP_SIGNATURE=]
--google-service-account <google-service-account>
When using Google Cloud Storage as the object store, set this to the path to the JSON file that contains the Google credentials [env: GOOGLE_SERVICE_ACCOUNT=]
--azure-storage-account <azure-storage-account>
When using Microsoft Azure as the object store, set this to the name you see when going to All Services > Storage accounts > `[name]` [env: AZURE_STORAGE_ACCOUNT=]
--azure-storage-access-key <azure-storage-access-key>
When using Microsoft Azure as the object store, set this to one of the Key values in the Storage account's Settings > Access keys [env: AZURE_STORAGE_ACCESS_KEY=]
--object-store-connection-limit <object-store-connection-limit>
When using a network-based object store, limit the number of connection to this value [env: OBJECT_STORE_CONNECTION_LIMIT=] [default: 16]
--object-store-http2-only
Force HTTP/2 connection to network-based object stores [env: OBJECT_STORE_HTTP2_ONLY=]
--object-store-http2-max-frame-size <object-store-http2-max-frame-size>
Set max frame size (in bytes/octets) for HTTP/2 connection [env: OBJECT_STORE_HTTP2_MAX_FRAME_SIZE=]
--object-store-max-retries <object-store-max-retries>
The maximum number of times to retry a request [env: OBJECT_STORE_MAX_RETRIES=]
--object-store-retry-timeout <object-store-retry-timeout>
The maximum length of time from the initial request after which no further retries will be attempted [env: OBJECT_STORE_RETRY_TIMEOUT=]
-h, --help
Print help information
--object-store-cache-endpoint <object-store-cache-endpoint>
Endpoint of an S3 compatible, HTTP/2 enabled object store cache [env: OBJECT_STORE_CACHE_ENDPOINT=]
--log-filter <LOG_FILTER>
Logs: filter directive [env: LOG_FILTER=]
-v, --verbose...
Logs: filter short-hand
--log-destination <LOG_DESTINATION>
Logs: destination [env: LOG_DESTINATION=] [default: stdout]
--log-format <LOG_FORMAT>
Logs: message format [env: LOG_FORMAT=] [default: full]
--traces-exporter <TRACES_EXPORTER>
Tracing: exporter type [env: TRACES_EXPORTER=] [default: none]
--traces-exporter-jaeger-agent-host <TRACES_EXPORTER_JAEGER_AGENT_HOST>
Tracing: Jaeger agent network hostname [env: TRACES_EXPORTER_JAEGER_AGENT_HOST=] [default: 0.0.0.0]
--traces-exporter-jaeger-agent-port <TRACES_EXPORTER_JAEGER_AGENT_PORT>
Tracing: Jaeger agent network port [env: TRACES_EXPORTER_JAEGER_AGENT_PORT=] [default: 6831]
--traces-exporter-jaeger-service-name <TRACES_EXPORTER_JAEGER_SERVICE_NAME>
Tracing: Jaeger service name [env: TRACES_EXPORTER_JAEGER_SERVICE_NAME=] [default: iox-conductor]
--traces-exporter-jaeger-trace-context-header-name <TRACES_JAEGER_TRACE_CONTEXT_HEADER_NAME>
Tracing: specifies the header name used for passing trace context [env: TRACES_EXPORTER_JAEGER_TRACE_CONTEXT_HEADER_NAME=] [default: uber-trace-id]
--traces-jaeger-debug-name <TRACES_JAEGER_DEBUG_NAME>
Tracing: specifies the header name used for force sampling [env: TRACES_EXPORTER_JAEGER_DEBUG_NAME=] [default: jaeger-debug-id]
--traces-jaeger-tags <TRACES_JAEGER_TAGS>
Tracing: set of key=value pairs to annotate tracing spans with [env: TRACES_EXPORTER_JAEGER_TAGS=]
--traces-jaeger-max-msgs-per-second <TRACES_JAEGER_MAX_MSGS_PER_SECOND>
Tracing: Maximum number of message sent to a Jaeger service, per second [env: TRACES_JAEGER_MAX_MSGS_PER_SECOND=] [default: 1000]
--datafusion-num-threads <datafusion_runtime_num_threads>
Set the maximum number of Datafusion runtime threads to use [env: INFLUXDB3_DATAFUSION_NUM_THREADS=]
--datafusion-runtime-type <datafusion_runtime_type>
Datafusion tokio runtime type [env: INFLUXDB3_DATAFUSION_RUNTIME_TYPE=] [default: multi-thread] [possible values: current-thread, multi-thread, multi-thread-alt]
--datafusion-runtime-disable-lifo-slot <datafusion_runtime_disable_lifo>
Disable LIFO slot of Datafusion runtime [env: INFLUXDB3_DATAFUSION_RUNTIME_DISABLE_LIFO_SLOT=] [possible values: true, false]
--datafusion-runtime-event-interval <datafusion_runtime_event_interval>
Sets the number of scheduler ticks after which the scheduler of the Datafusiontokio runtime will poll for external events (timers, I/O, and so on) [env: INFLUXDB3_DATAFUSION_RUNTIME_EVENT_INTERVAL=]
--datafusion-runtime-global-queue-interval <datafusion_runtime_global_queue_interval>
Sets the number of scheduler ticks after which the scheduler of the Datafusion runtime will poll the global task queue [env: INFLUXDB3_DATAFUSION_RUNTIME_GLOBAL_QUEUE_INTERVAL=]
--datafusion-runtime-max-blocking-threads <datafusion_runtime_max_blocking_threads>
Specifies the limit for additional threads spawned by the Datafusion runtime [env: INFLUXDB3_DATAFUSION_RUNTIME_MAX_BLOCKING_THREADS=]
--datafusion-runtime-max-io-events-per-tick <datafusion_runtime_max_io_events_per_tick>
Configures the max number of events to be processed per tick by the tokio Datafusion runtime [env: INFLUXDB3_DATAFUSION_RUNTIME_MAX_IO_EVENTS_PER_TICK=]
--datafusion-runtime-thread-keep-alive <datafusion_runtime_thread_keep_alive>
Sets a custom timeout for a thread in the blocking pool of the tokio Datafusion runtime [env: INFLUXDB3_DATAFUSION_RUNTIME_THREAD_KEEP_ALIVE=]
--datafusion-runtime-thread-priority <datafusion_runtime_thread_priority>
Set thread priority tokio Datafusion runtime workers [env: INFLUXDB3_DATAFUSION_RUNTIME_THREAD_PRIORITY=] [default: 10]
--datafusion-max-parquet-fanout <MAX_PARQUET_FANOUT>
When multiple parquet files are required in a sorted way (e.g. for de-duplication), we have two options: [env: INFLUXDB3_DATAFUSION_MAX_PARQUET_FANOUT=] [default: 1000]
--datafusion-use-cached-parquet-loader
Use a cached parquet loader when reading parquet files from object store [env: INFLUXDB3_DATAFUSION_USE_CACHED_PARQUET_LOADER=]
--datafusion-config <DATAFUSION_CONFIG>
Provide custom configuration to DataFusion as a comma-separated list of key:value pairs [env: INFLUXDB3_DATAFUSION_CONFIG=] [default: ]
--max-http-request-size <MAX_HTTP_REQUEST_SIZE>
Maximum size of HTTP requests [env: INFLUXDB3_MAX_HTTP_REQUEST_SIZE=] [default: 10485760]
--http-bind <HTTP_BIND_ADDRESS>
The address on which InfluxDB will serve HTTP API requests [env: INFLUXDB3_HTTP_BIND_ADDR=] [default: 0.0.0.0:8181]
--ram-pool-data-bytes <RAM_POOL_DATA_BYTES>
Size of the RAM cache used to store data in bytes [env: INFLUXDB3_RAM_POOL_DATA_BYTES=] [default: 1073741824]
--exec-mem-pool-bytes <EXEC_MEM_POOL_BYTES>
Size of memory pool used during query exec, in bytes [env: INFLUXDB3_EXEC_MEM_POOL_BYTES=] [default: 8589934592]
--bearer-token <BEARER_TOKEN>
bearer token to be set for requests [env: INFLUXDB3_BEARER_TOKEN=]
--gen1-duration <GEN1_DURATION>
Duration that the Parquet files get arranged into. The data timestamps will land each row into a file of this duration. 1m, 5m, and 10m are supported. These are known as "generation 1" files. The compactor in Pro can compact these into larger and longer generations [env: INFLUXDB3_GEN1_DURATION=] [default: 10m]
--wal-flush-interval <WAL_FLUSH_INTERVAL>
Interval to flush buffered data to a wal file. Writes that wait for wal confirmation will take as long as this interval to complete [env: INFLUXDB3_WAL_FLUSH_INTERVAL=] [default: 1s]
--wal-snapshot-size <WAL_SNAPSHOT_SIZE>
The number of WAL files to attempt to remove in a snapshot. This times the interval will determine how often snapshot is taken [env: INFLUXDB3_WAL_SNAPSHOT_SIZE=] [default: 600]
--wal-max-write-buffer-size <WAL_MAX_WRITE_BUFFER_SIZE>
The maximum number of writes requests that can be buffered before a flush must be run and succeed [env: INFLUXDB3_WAL_MAX_WRITE_BUFFER_SIZE=] [default: 100000]
--query-log-size <QUERY_LOG_SIZE>
The size of the query log. Up to this many queries will remain in the log before old queries are evicted to make room for new ones [env: INFLUXDB3_QUERY_LOG_SIZE=] [default: 1000]
--buffer-mem-limit-mb <BUFFER_MEM_LIMIT_MB>
The size limit of the buffered data. If this limit is passed a snapshot will be forced [env: INFLUXDB3_BUFFER_MEM_LIMIT_MB=] [default: 5000]
--host-id <HOST_IDENTIFIER_PREFIX>
The host idendifier used as a prefix in all object store file paths. This should be unique for any hosts that share the same object store configuration, i.e., the same bucket [env: INFLUXDB3_HOST_IDENTIFIER_PREFIX=]
--mode <MODE>
The mode to start the server in [env: INFLUXDB3_ENTERPRISE_MODE=] [default: read_write] [possible values: read, read_write, compactor]
--replicas <REPLICAS>
Comma-separated list of host identifier prefixes to replicate [env: INFLUXDB3_ENTERPRISE_REPLICAS=]
--replication-interval <REPLICATION_INTERVAL>
The interval at which each replica specified in the `replicas` option will be replicated [env: INFLUXDB3_ENTERPRISE_REPLICATION_INTERVAL=] [default: 250ms]
--compactor-id <COMPACTOR_ID>
The prefix in object store where all compacted data will be written to. Only provide this option if this server should be running compaction for its own write buffer and any replicas it is managing [env: INFLUXDB3_ENTERPRISE_COMPACTOR_ID=]
--compaction-hosts <COMPACTION_HOSTS>
Comma-separated list of host identifier prefixes to compact data from [env: INFLUXDB3_ENTERPRISE_COMPACTION_HOSTS=]
--run-compactions
This tells the server to run compactions. Only a single server should ever be running compactions for a given compactor_id. All other servers can read from that compactor id to pick up compacted files. This option is only applicable if a compactor-id is set. Set this flag if this server should be running compactions [env: INFLUXDB3_ENTERPRISE_RUN_COMPACTIONS=]
--compaction-row-limit <COMPACTION_ROW_LIMIT>
The limit to the number of rows per file that the compactor will write. This is a soft limit and the compactor may write more rows than this limit [env: INFLUXDB3_ENTERPRISE_COMPACTION_ROW_LIMIT=] [default: 1000000]
--compaction-max-num-files-per-plan <COMPACTION_MAX_NUM_FILES_PER_PLAN>
Set the maximum number of files that will be included in any compaction plan [env: INFLUXDB3_ENTERPRISE_COMPACTION_MAX_NUM_FILES_PER_PLAN=] [default: 500]
--compaction-gen2-duration <COMPACTION_GEN2_DURATION>
This is the duration of the first level of compaction (gen2). Later levels of compaction will be multiples of this duration. This number should be equal to or greater than the gen1 duration. The default is 20m, which is 2x the default gen1 duration of 10m [env: INFLUXDB3_ENTERPRISE_COMPACTION_GEN2_DURATION=] [default: 20m]
--compaction-multipliers <COMPACTION_MULTIPLIERS>
This comma-separated list of multiples specifies the duration of each level of compaction. The number of elements in this list will also determine the number of levels of compaction. The first element in the list will be the duration of the first level of compaction (gen3). Each subsequent level will be a multiple of the previous level [env: INFLUXDB3_ENTERPRISE_COMPACTION_MULTIPLIERS=] [default: 3,4,6,5]
--preemptive-cache-age <PREEMPTIVE_CACHE_AGE>
The interval to prefetch into parquet cache when compacting [env: INFLUXDB3_PREEMPTIVE_CACHE_AGE=] [default: 3d]
--parquet-mem-cache-size-mb <PARQUET_MEM_CACHE_SIZE>
The size of the in-memory Parquet cache in megabytes (MB) [env: INFLUXDB3_PARQUET_MEM_CACHE_SIZE_MB=] [default: 1000]
--parquet-mem-cache-prune-percentage <PARQUET_MEM_CACHE_PRUNE_PERCENTAGE>
The percentage of entries to prune during a prune operation on the in-memory Parquet cache [env: INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_PERCENTAGE=] [default: 0.1]
--parquet-mem-cache-prune-interval <PARQUET_MEM_CACHE_PRUNE_INTERVAL>
The interval on which to check if the in-memory Parquet cache needs to be pruned [env: INFLUXDB3_PARQUET_MEM_CACHE_PRUNE_INTERVAL=] [default: 1s]
--disable-parquet-mem-cache
Disable the in-memory Parquet cache. By default, the cache is enabled [env: INFLUXDB3_DISABLE_PARQUET_MEM_CACHE=]
--last-cache-eviction-interval <LAST_CACHE_EVICTION_INTERVAL>
The interval on which to evict expired entries from the Last-N-Value cache, expressed as a human-readable time, e.g., "20s", "1m", "1h" [env: INFLUXDB3_LAST_CACHE_EVICTION_INTERVAL=] [default: 10s]
--meta-cache-eviction-interval <META_CACHE_EVICTION_INTERVAL>
The interval on which to evict expired entries from the Last-N-Value cache, expressed as a human-readable time, e.g., "20s", "1m", "1h" [env: INFLUXDB3_META_CACHE_EVICTION_INTERVAL=] [default: 10s]
--plugin-dir <PLUGIN_DIR>
The local directory that has python plugins and their test files [env: INFLUXDB3_PLUGIN_DIR=]