Skip to content

Commit 25bdf6e

Browse files
sandersonsanderson
committed
add --help-all flag to influxdb3 commands
1 parent 3019032 commit 25bdf6e

35 files changed

+76
-42
lines changed

‎content/influxdb3/core/reference/cli/influxdb3/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
3939
| Option | | Description |
4040
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
4141
| | `--num-threads` | Maximum number of IO runtime threads to use |
42-
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
42+
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
4343
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
4444
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
4545
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
@@ -48,6 +48,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
4848
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
4949
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
5050
| `-h` | `--help` | Print help information |
51+
| | `--help-all` | Print detailed help information |
5152
| `-V` | `--version` | Print version |
5253

5354
### Option environment variables

‎content/influxdb3/core/reference/cli/influxdb3/serve.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
5555
| | `--object-store-retry-timeout` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-retry-timeout)_ |
5656
| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-cache-endpoint)_ |
5757
| `-h` | `--help` | Print help information |
58+
| | `--help-all` | Print detailed help information |
5859
| | `--log-filter` | _See [configuration options](/influxdb3/core/reference/config-options/#log-filter)_ |
5960
| `-v` | `--verbose` | Enable verbose output |
6061
| | `--log-destination` | _See [configuration options](/influxdb3/core/reference/config-options/#log-destination)_ |
@@ -90,7 +91,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
9091
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-max-write-buffer-size)_ |
9192
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
9293
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
93-
| | `--parquet-mem-cache-size` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size)_ |
94+
| | `--parquet-mem-cache-size` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size)_ |
9495
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
9596
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ |
9697
| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-parquet-mem-cache)_ |

‎content/influxdb3/enterprise/reference/cli/influxdb3/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
3939
| Option | | Description |
4040
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
4141
| | `--num-threads` | Maximum number of IO runtime threads to use |
42-
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
42+
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
4343
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
4444
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
4545
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
@@ -48,6 +48,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
4848
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
4949
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
5050
| `-h` | `--help` | Print help information |
51+
| | `--help-all` | Print detailed help information |
5152
| `-V` | `--version` | Print version |
5253

5354
### Option environment variables

‎content/influxdb3/enterprise/reference/cli/influxdb3/serve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ influxdb3 serve [OPTIONS] \
5959
| | `--object-store-max-retries` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-max-retries)_ |
6060
| | `--object-store-retry-timeout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-retry-timeout)_ |
6161
| `-h` | `--help` | Print help information |
62+
| | `--help-all` | Print detailed help information |
6263
| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#object-store-cache-endpoint)_ |
6364
| | `--log-filter` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#log-filter)_ |
6465
| `-v` | `--verbose` | Enable verbose output |

‎content/shared/influxdb3-cli/create/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ influxdb3 create <SUBCOMMAND>
2626

2727
## Options
2828

29-
| Option | | Description |
30-
| :----- | :------- | :--------------------- |
31-
| `-h` | `--help` | Print help information |
29+
| Option | | Description |
30+
| :----- | :----------- | :------------------------------ |
31+
| `-h` | `--help` | Print help information |
32+
| | `--help-all` | Print detailed help information |

‎content/shared/influxdb3-cli/create/database.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ influxdb3 create database [OPTIONS] <DATABASE_NAME>
2424
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2525
| | `--token` | Authentication token |
2626
| `-h` | `--help` | Print help information |
27+
| | `--help-all` | Print detailed help information |
2728

2829
### Option environment variables
2930

‎content/shared/influxdb3-cli/create/distinct_cache.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ influxdb3 create distinct_cache [OPTIONS] \
3131
| | `--max-cardinality` | Maximum number of distinct value combinations to hold in the cache |
3232
| | `--max-age` | Maximum age of an entry in the cache entered as a human-readable duration--for example: `30d`, `24h` |
3333
| `-h` | `--help` | Print help information |
34+
| | `--help-all` | Print detailed help information |
3435

3536
> [!Important]
3637
>

‎content/shared/influxdb3-cli/create/file_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ influxdb3 create file_index [OPTIONS] \
2323
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
2424
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2525
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
26-
| | `--token` | _({{< req >}})_ Authentication token |
26+
| | `--token` | _({{< req >}})_ Authentication token |
2727
| `-t` | `--table` | Table to apply the file index too |
2828
| `-h` | `--help` | Print help information |
29+
| | `--help-all` | Print detailed help information |
2930

3031
### Option environment variables
3132

‎content/shared/influxdb3-cli/create/last_cache.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ influxdb3 create last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
2727
| | `--count` | Number of entries per unique key column combination to store in the cache |
2828
| | `--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` |
2929
| `-h` | `--help` | Print help information |
30+
| | `--help-all` | Print detailed help information |
3031

3132
### Option environment variables
3233

‎content/shared/influxdb3-cli/create/plugin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ influxdb3 create plugin [OPTIONS] \
2929
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
3030
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |
3131
| `-h` | `--help` | Print help information |
32+
| | `--help-all` | Print detailed help information |
3233

3334
### Option environment variables
3435

0 commit comments

Comments
 (0)