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

add --tls-ca option to influxdb3 commands

influxdb3-cli-updates
Scott Anderson 2025-04-14 19:56:02 -06:00
parent 25bdf6e608
commit ae4d2349e5
25 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/shared/influxdb3-cli/create/_index.md
View File

@ -12,8 +12,8 @@ influxdb3 create <SUBCOMMAND>
## Subcommands ## Subcommands
| Subcommand | Description | | Subcommand | Description |
| :------------------------------------------------------------------------------------- | :---------------------------------------------- | | :---------------------------------------------------------------------------------- | :---------------------------------------------- |
| [database](/influxdb3/version/reference/cli/influxdb3/create/database/) | Create a new database | | [database](/influxdb3/version/reference/cli/influxdb3/create/database/) | Create a new database |
| [file_index](/influxdb3/version/reference/cli/influxdb3/create/file_index/) | Create a new file index for a database or table | | [file_index](/influxdb3/version/reference/cli/influxdb3/create/file_index/) | Create a new file index for a database or table |
| [last_cache](/influxdb3/version/reference/cli/influxdb3/create/last_cache/) | Create a new last value cache | | [last_cache](/influxdb3/version/reference/cli/influxdb3/create/last_cache/) | Create a new last value cache |
@ -22,7 +22,7 @@ influxdb3 create <SUBCOMMAND>
| [table](/influxdb3/version/reference/cli/influxdb3/create/table/) | Create a new table in a database | | [table](/influxdb3/version/reference/cli/influxdb3/create/table/) | Create a new table in a database |
| [token](/influxdb3/version/reference/cli/influxdb3/create/token/) | Create a new authentication token | | [token](/influxdb3/version/reference/cli/influxdb3/create/token/) | Create a new authentication token |
| [trigger](/influxdb3/version/reference/cli/influxdb3/create/trigger/) | Create a new trigger for the processing engine | | [trigger](/influxdb3/version/reference/cli/influxdb3/create/trigger/) | Create a new trigger for the processing engine |
| help | Print command help or the help of a subcommand | | help | Print command help or the help of a subcommand |
## Options ## Options

1
content/shared/influxdb3-cli/create/database.md
View File

@ -23,6 +23,7 @@ influxdb3 create database [OPTIONS] <DATABASE_NAME>
| :----- | :----------- | :--------------------------------------------------------------------------------------- | | :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| | `--token` | Authentication token | | | `--token` | Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/distinct_cache.md
View File

@ -30,6 +30,7 @@ influxdb3 create distinct_cache [OPTIONS] \
| | `--columns` | _({{< req >}})_ Comma-separated list of columns to cache distinct values for--for example: `col1,col2,col3` (see [Metadata cache hierarchy](#metadata-cache-hierarchy)) | | | `--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-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` | | | `--max-age` | Maximum age of an entry in the cache entered as a human-readable duration--for example: `30d`, `24h` |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/file_index.md
View File

@ -25,6 +25,7 @@ influxdb3 create file_index [OPTIONS] \
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | Table to apply the file index too | | `-t` | `--table` | Table to apply the file index too |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/last_cache.md
View File

@ -26,6 +26,7 @@ influxdb3 create last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
| | `--value-columns` | Comma-separated list of columns to store as values 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 | | | `--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` | | | `--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` |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/plugin.md
View File

@ -28,6 +28,7 @@ influxdb3 create plugin [OPTIONS] \
| | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory | | | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory |
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin | | | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) | | | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/table.md
View File

@ -26,6 +26,7 @@ influxdb3 create table [OPTIONS] \
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--tags` | _({{< req >}})_ Comma-separated list of tag columns to include in the table | | | `--tags` | _({{< req >}})_ Comma-separated list of tag columns to include in the table |
| | `--fields` | Comma-separated list of field columns and their types to include in the table | | | `--fields` | Comma-separated list of field columns and their types to include in the table |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/create/trigger.md
View File

@ -29,6 +29,7 @@ influxdb3 create trigger [OPTIONS] \
| | `--plugin` | Plugin to execute when the trigger fires | | | `--plugin` | Plugin to execute when the trigger fires |
| | `--trigger-spec` | Trigger specification--for example `table:<TABLE_NAME>` or `all_tables` | | | `--trigger-spec` | Trigger specification--for example `table:<TABLE_NAME>` or `all_tables` |
| | `--disabled` | Create the trigger in disabled state | | | `--disabled` | Create the trigger in disabled state |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/database.md
View File

@ -21,6 +21,7 @@ influxdb3 delete database [OPTIONS] <DATABASE_NAME>
| :----- | :----------- | :--------------------------------------------------------------------------------------- | | :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| | `--token` | Authentication token | | | `--token` | Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/distinct_cache.md
View File

@ -24,6 +24,7 @@ influxdb3 delete distinct_cache [OPTIONS] \
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for | | `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/file_index.md
View File

@ -18,6 +18,7 @@ influxdb3 delete file_index [OPTIONS] --database <DATABASE_NAME>
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | Table to delete the file index from | | `-t` | `--table` | Table to delete the file index from |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/last_cache.md
View File

@ -21,6 +21,7 @@ influxdb3 delete last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from | | `-t` | `--table` | _({{< req >}})_ Table to delete the cache from |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/plugin.md
View File

@ -20,6 +20,7 @@ influxdb3 delete plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_NAME>
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-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 | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/table.md
View File

@ -20,6 +20,7 @@ influxdb3 delete table [OPTIONS] --database <DATABASE_NAME> <TABLE_NAME>
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-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 | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/delete/trigger.md
View File

@ -21,6 +21,7 @@ influxdb3 delete trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--force` | Force delete even if the trigger is active | | | `--force` | Force delete even if the trigger is active |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/disable/trigger.md
View File

@ -20,6 +20,7 @@ influxdb3 disable trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-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 | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/enable/trigger.md
View File

@ -20,6 +20,7 @@ influxdb3 enable trigger [OPTIONS] --database <DATABASE_NAME> <TRIGGER_NAME>
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-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 | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/query.md
View File

@ -33,6 +33,7 @@ influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, `parquet`) | | | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, `parquet`) |
| `-o` | `--output` | Output query results to the specified file | | `-o` | `--output` | Output query results to the specified file |
| `-f` | `--file` | A file that contains the query to execute | | `-f` | `--file` | A file that contains the query to execute |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/show/databases.md
View File

@ -18,6 +18,7 @@ influxdb3 show databases [OPTIONS]
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| | `--show-deleted` | Include databases marked as deleted in the output | | | `--show-deleted` | Include databases marked as deleted in the output |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) | | | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/show/system/summary.md
View File

@ -16,6 +16,7 @@ influxdb3 show system --database <DATABASE_NAME> summary [OPTIONS]
| :----- | :----------- | :--------------------------------------------------------------------------------------------- | | :----- | :----------- | :--------------------------------------------------------------------------------------------- |
| `-l` | `--limit` | Maximum number of entries from each table to display (default is `10`, `0` indicates no limit) | | `-l` | `--limit` | Maximum number of entries from each table to display (default is `10`, `0` indicates no limit) |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) | | | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

11
content/shared/influxdb3-cli/show/system/table-list.md
View File

@ -11,11 +11,12 @@ influxdb3 show system --database <DATABASE_NAME> table-list [OPTIONS]
## Options ## Options
| Option | | Description | | Option | | Description |
| :----- | :----------- | :------------------------------------------------------------------------- | | :----- | :----------- | :----------------------------------------------------------------------------------- |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) | | | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
| `-h` | `--help` | Print help information | | | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| | `--help-all` | Print detailed help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information |
## Examples ## Examples

1
content/shared/influxdb3-cli/show/system/table.md
View File

@ -21,6 +21,7 @@ influxdb3 show system --database <DATABASE_NAME> table [OPTIONS] <SYSTEM_TABLE>
| `-o` | `--order-by` | Order by the specified columns | | `-o` | `--order-by` | Order by the specified columns |
| `-s` | `--select` | Select specific columns from the system table | | `-s` | `--select` | Select specific columns from the system table |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) | | | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

6
content/shared/influxdb3-cli/test/_index.md
View File

@ -11,10 +11,10 @@ influxdb3 test <SUBCOMMAND>
## Subcommands ## Subcommands
| Subcommand | Description | | Subcommand | Description |
| :--------------------------------------------------------------------------- | :--------------------------------------------- | | :------------------------------------------------------------------------ | :--------------------------------------------- |
| [wal_plugin](/influxdb3/version/reference/cli/influxdb3/test/wal_plugin/) | Test a write-ahead log (WAL) plugin | | [wal_plugin](/influxdb3/version/reference/cli/influxdb3/test/wal_plugin/) | Test a write-ahead log (WAL) plugin |
| help | Print command help or the help of a subcommand | | help | Print command help or the help of a subcommand |
## Options ## Options

1
content/shared/influxdb3-cli/test/wal_plugin.md
View File

@ -24,6 +24,7 @@ influxdb3 test wal_plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_NAME>
| | `--lp` | Line protocol to use as input | | | `--lp` | Line protocol to use as input |
| | `--file` | Line protocol file 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 | | | `--input-arguments` | Map of string key-value pairs as to use as plugin input arguments |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |

1
content/shared/influxdb3-cli/write.md
View File

@ -31,6 +31,7 @@ influxdb3 write [OPTIONS] --database <DATABASE_NAME> [LINE_PROTOCOL]...
| | `--token` | _({{< req >}})_ Authentication token | | | `--token` | _({{< req >}})_ Authentication token |
| `-f` | `--file` | A file that contains line protocol to write | | `-f` | `--file` | A file that contains line protocol to write |
| | `--accept-partial` | Accept partial writes | | | `--accept-partial` | Accept partial writes |
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information | | | `--help-all` | Print detailed help information |