Skip to content

Commit 0c25585

Browse files
jstirnamanjstirnaman
authored
Merge pull request #5979 from influxdata/influxdb3-cli-updates
Influxdb3 GA CLI updates
2 parents 221a3ba + ae4d234 commit 0c25585

35 files changed

+259
-119
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: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ influxdb3 create <SUBCOMMAND>
1212

1313
## Subcommands
1414

15-
| Subcommand | Description |
16-
| :------------------------------------------------------------------------------------- | :---------------------------------------------- |
15+
| Subcommand | Description |
16+
| :---------------------------------------------------------------------------------- | :---------------------------------------------- |
1717
| [database](/influxdb3/version/reference/cli/influxdb3/create/database/) | Create a new database |
1818
| [file_index](/influxdb3/version/reference/cli/influxdb3/create/file_index/) | Create a new file index for a database or table |
1919
| [last_cache](/influxdb3/version/reference/cli/influxdb3/create/last_cache/) | Create a new last value cache |
@@ -22,10 +22,11 @@ influxdb3 create <SUBCOMMAND>
2222
| [table](/influxdb3/version/reference/cli/influxdb3/create/table/) | Create a new table in a database |
2323
| [token](/influxdb3/version/reference/cli/influxdb3/create/token/) | Create a new authentication token |
2424
| [trigger](/influxdb3/version/reference/cli/influxdb3/create/trigger/) | Create a new trigger for the processing engine |
25-
| help | Print command help or the help of a subcommand |
25+
| help | Print command help or the help of a 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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ influxdb3 create database [OPTIONS] <DATABASE_NAME>
2323
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
2424
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2525
| | `--token` | Authentication token |
26+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
2627
| `-h` | `--help` | Print help information |
28+
| | `--help-all` | Print detailed help information |
2729

2830
### Option environment variables
2931

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The `influxdb3 create distinct_cache` command creates a new distinct value cache
88
```bash
99
influxdb3 create distinct_cache [OPTIONS] \
1010
--database <DATABASE_NAME> \
11+
--token <AUTH_TOKEN>
1112
--table <TABLE> \
1213
--columns <COLUMNS> \
1314
[CACHE_NAME]
@@ -24,12 +25,14 @@ influxdb3 create distinct_cache [OPTIONS] \
2425
| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2526
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2627
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
27-
| | `--token` | Authentication token |
28+
| | `--token` | _({{< req >}})_ Authentication token |
2829
| `-t` | `--table` | _({{< req >}})_ Table to create the cache for |
2930
| | `--columns` | _({{< req >}})_ Comma-separated list of columns to cache distinct values for--for example: `col1,col2,col3` (see [Metadata cache hierarchy](#metadata-cache-hierarchy)) |
3031
| | `--max-cardinality` | Maximum number of distinct value combinations to hold in the cache |
3132
| | `--max-age` | Maximum age of an entry in the cache entered as a human-readable duration--for example: `30d`, `24h` |
33+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
3234
| `-h` | `--help` | Print help information |
35+
| | `--help-all` | Print detailed help information |
3336

3437
> [!Important]
3538
>

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ database or table.
77
<!--pytest.mark.skip-->
88

99
```bash
10-
influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
10+
influxdb3 create file_index [OPTIONS] \
11+
--database <DATABASE_NAME> \
12+
--token <AUTH_TOKEN> \
13+
<COLUMNS>...
1114
```
1215

1316
## Arguments
@@ -20,9 +23,11 @@ influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
2023
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
2124
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2225
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
23-
| | `--token` | Authentication token |
26+
| | `--token` | _({{< req >}})_ Authentication token |
2427
| `-t` | `--table` | Table to apply the file index too |
28+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
2529
| `-h` | `--help` | Print help information |
30+
| | `--help-all` | Print detailed help information |
2631

2732
### Option environment variables
2833

@@ -43,10 +48,12 @@ In the examples below, replace the following:
4348

4449
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
4550
Database name
51+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
52+
Authentication token
4653
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
4754
Table name
4855

49-
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
56+
{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}
5057

5158
### Create a new file index for a database
5259

@@ -55,6 +62,7 @@ In the examples below, replace the following:
5562
```bash
5663
influxdb3 create file_index \
5764
--database DATABASE_NAME \
65+
--token AUTH_TOKEN \
5866
column1 column2 column3
5967
```
6068

@@ -65,6 +73,7 @@ influxdb3 create file_index \
6573
```bash
6674
influxdb3 create file_index \
6775
--database DATABASE_NAME \
76+
--token AUTH_TOKEN \
6877
--table TABLE_NAME \
6978
column1 column2 column3
7079
```

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ influxdb3 create last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
2020
| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2121
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2222
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
23-
| | `--token` | Authentication token |
23+
| | `--token` | _({{< req >}})_ Authentication token |
2424
| `-t` | `--table` | _({{< req >}})_ Table to create the cache for |
2525
| | `--key-columns` | Comma-separated list of columns to use as keys in the cache--for example: `foo,bar,baz` |
2626
| | `--value-columns` | Comma-separated list of columns to store as values in the cache--for example: `foo,bar,baz` |
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` |
29+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
2930
| `-h` | `--help` | Print help information |
31+
| | `--help-all` | Print detailed help information |
3032

3133
### Option environment variables
3234

0 commit comments

Comments
 (0)