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

added auth token to influxdb3 cli examples

influxdb3-cli-updates
Scott Anderson 2025-04-14 17:57:01 -06:00
parent 0bcdb3fb88
commit 3019032b6a
20 changed files with 156 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,6 +8,7 @@ The `influxdb3 create distinct_cache` command creates a new distinct value cache
```bash
influxdb3 create distinct_cache [OPTIONS] \
--database <DATABASE_NAME> \
--token <AUTH_TOKEN>
--table <TABLE> \
--columns <COLUMNS> \
[CACHE_NAME]
@ -24,7 +25,7 @@ influxdb3 create distinct_cache [OPTIONS] \
| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ 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 |

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

@ -7,7 +7,10 @@ database or table.
<!--pytest.mark.skip-->
```bash
influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
influxdb3 create file_index [OPTIONS] \
--database <DATABASE_NAME> \
--token <AUTH_TOKEN> \
<COLUMNS>...
```
## Arguments
@ -20,7 +23,7 @@ influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | Table to apply the file index too |
| `-h` | `--help` | Print help information |
@ -43,10 +46,12 @@ 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-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}
### Create a new file index for a database
@ -55,6 +60,7 @@ In the examples below, replace the following:
```bash
influxdb3 create file_index \
--database DATABASE_NAME \
--token AUTH_TOKEN \
column1 column2 column3
```
@ -65,6 +71,7 @@ influxdb3 create file_index \
```bash
influxdb3 create file_index \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--table TABLE_NAME \
column1 column2 column3
```

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

@ -20,7 +20,7 @@ influxdb3 create last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ 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` |

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

@ -8,6 +8,7 @@ The `influxdb3 create plugin` command creates a new processing engine plugin.
```bash
influxdb3 create plugin [OPTIONS] \
--database <DATABASE_NAME> \
--token <AUTH_TOKEN> \
--filename <PLUGIN_FILENAME> \
--entry-point <FUNCTION_NAME> \
<PLUGIN_NAME>
@ -23,7 +24,7 @@ influxdb3 create plugin [OPTIONS] \
| :----- | :-------------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory |
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |

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

@ -9,6 +9,7 @@ The `influxdb3 create table` command creates a table in a database.
influxdb3 create table [OPTIONS] \
--tags [<TAGS>...] \
--database <DATABASE_NAME> \
--token <AUTH_TOKEN> \
<TABLE_NAME>
```
@ -22,7 +23,7 @@ influxdb3 create table [OPTIONS] \
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| | `--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 |
| `-h` | `--help` | Print help information |
@ -53,6 +54,8 @@ 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-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
@ -64,6 +67,7 @@ In the examples below, replace the following:
influxdb3 create table \
--tags tag1,tag2,tag3 \
--database DATABASE_NAME \
--token AUTH_TOKEN \
TABLE_NAME
```
@ -76,6 +80,7 @@ influxdb3 create table \
--tags room,sensor_id \
--fields temp:float64,hum:float64,co:int64 \
--database DATABASE_NAME \
--token AUTH_TOKEN \
TABLE_NAME
```

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

@ -9,6 +9,7 @@ processing engine.
```bash
influxdb3 create trigger [OPTIONS] \
--database <DATABASE_NAME> \
--token <AUTH_TOKEN> \
--plugin <PLUGIN_NAME> \
--trigger-spec <TRIGGER_SPECIFICATION> \
<TRIGGER_NAME>
@ -24,7 +25,7 @@ influxdb3 create trigger [OPTIONS] \
| :----- | :--------------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ 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 |

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

@ -18,13 +18,13 @@ influxdb3 delete distinct_cache [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 |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
| `-h` | `--help` | Print help information |
| 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` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
| `-h` | `--help` | Print help information |
### Option environment variables
@ -40,13 +40,14 @@ You can use the following environment variables to set command options:
### Delete a distinct value cache
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME|AUTH_TOKEN" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete distinct_cache \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--table TABLE_NAME \
CACHE_NAME
```
@ -57,6 +58,8 @@ In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:

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

@ -16,8 +16,8 @@ influxdb3 delete file_index [OPTIONS] --database <DATABASE_NAME>
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | Table to delete the file index from |
| `-h` | `--help` | Print help information |
### Option environment variables
@ -39,17 +39,21 @@ 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-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}
### Delete a file index from a database
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME
influxdb3 delete file_index \
--database DATABASE_NAME \
--token AUTH_TOKEN
```
### Delete a file index from a specific table
@ -57,7 +61,10 @@ influxdb3 delete file_index --database DATABASE_NAME
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME --table TABLE_NAME
influxdb3 delete file_index \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--table TABLE_NAME
```
{{% /code-placeholders %}}

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

@ -15,13 +15,13 @@ influxdb3 delete last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
## 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 | | 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` | _({{< req >}})_ Authentication token |
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from |
| `-h` | `--help` | Print help information |
### Option environment variables
@ -37,13 +37,14 @@ You can use the following environment variables to set command options:
### Delete a last value cache
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME|AUTH_TOKEN" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete last_cache \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--table TABLE_NAME \
CACHE_NAME
```
@ -54,6 +55,8 @@ In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:

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

@ -15,12 +15,12 @@ influxdb3 delete plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_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 |
| `-h` | `--help` | Print help information |
| 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` | _({{< req >}})_ Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
@ -36,12 +36,15 @@ You can use the following environment variables to set command options:
### Delete a plugin
{{% code-placeholders "(DATABASE|PLUGIN)_NAME" %}}
{{% code-placeholders "(DATABASE|PLUGIN)_NAME|AUTH_TOKEN" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete plugin --database DATABASE_NAME PLUGIN_NAME
influxdb3 delete plugin \
--database DATABASE_NAME \
--token AUTH_TOKEN \
PLUGIN_NAME
```
{{% /code-placeholders %}}
@ -50,5 +53,7 @@ In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}:
Name of the plugin to delete

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

@ -15,12 +15,12 @@ influxdb3 delete table [OPTIONS] --database <DATABASE_NAME> <TABLE_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 |
| `-h` | `--help` | Print help information |
| 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` | _({{< req >}})_ Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables
@ -36,12 +36,15 @@ You can use the following environment variables to set command options:
### Delete a table
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete table --database DATABASE_NAME TABLE_NAME
influxdb3 delete table \
--database DATABASE_NAME \
--token AUTH_TOKEN \
TABLE_NAME
```
{{% /code-placeholders %}}
@ -50,5 +53,7 @@ In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Name of the table to delete

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

@ -19,7 +19,7 @@ influxdb3 delete 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`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--token` | _({{< req >}})_ Authentication token |
| | `--force` | Force delete even if the trigger is active |
| `-h` | `--help` | Print help information |
@ -42,17 +42,22 @@ 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-placeholder-key %}}`TRIGGER_NAME`{{% /code-placeholder-key %}}:
Name of the trigger to delete
{{% code-placeholders "(DATABASE|TRIGGER)_NAME" %}}
{{% code-placeholders "(DATABASE|TRIGGER)_NAME|AUTH_TOKEN" %}}
### Delete a trigger
<!--pytest.mark.skip-->
```bash
influxdb3 delete trigger --database DATABASE_NAME TRIGGER_NAME
influxdb3 delete trigger \
--database DATABASE_NAME \
--token AUTH_TOKEN \
TRIGGER_NAME
```
### Force delete an active trigger
@ -60,7 +65,11 @@ influxdb3 delete trigger --database DATABASE_NAME TRIGGER_NAME
<!--pytest.mark.skip-->
```bash
influxdb3 delete trigger --force --database DATABASE_NAME TRIGGER_NAME
influxdb3 delete trigger \
--force \
--database DATABASE_NAME \
--token AUTH_TOKEN \
TRIGGER_NAME
```
{{% /code-placeholders %}}

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

@ -19,7 +19,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`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--token` | _({{< req >}})_ Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables

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

@ -11,10 +11,10 @@ influxdb3 enable <SUBCOMMAND>
## Subcommands
| Subcommand | Description |
| :----------------------------------------------------------------------- | :--------------------------------------------- |
| Subcommand | Description |
| :-------------------------------------------------------------------- | :--------------------------------------------- |
| [trigger](/influxdb3/version/reference/cli/influxdb3/enable/trigger/) | Enable a trigger to enable plugin execution |
| help | Print command help or the help of a subcommand |
| help | Print command help or the help of a subcommand |
## Options

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

@ -19,7 +19,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`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--token` | _({{< req >}})_ Authentication token |
| `-h` | `--help` | Print help information |
### Option environment variables

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

@ -28,7 +28,7 @@ influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| `-l` | `--language` | Query language of the query string (`sql` _(default)_ or `influxql`) |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, `parquet`) |
| `-o` | `--output` | Output query results to the specified file |
@ -70,21 +70,29 @@ with the name of the database to query.
<!--pytest.mark.skip-->
```bash
influxdb3 query --database DATABASE_NAME 'SELECT * FROM home'
influxdb3 query \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'SELECT * FROM home'
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!--pytest.mark.skip-->
```bash
influxdb3 query --database DATABASE_NAME --file ./query.sql
influxdb3 query \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./query.sql
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!--pytest.mark.skip-->
```bash
cat ./query.sql | influxdb3 query --database DATABASE_NAME
cat ./query.sql | influxdb3 query \
--database DATABASE_NAME \
--token AUTH_TOKEN \
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
@ -104,6 +112,7 @@ cat ./query.sql | influxdb3 query --database DATABASE_NAME
influxdb3 query \
--language influxql \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'SELECT * FROM home'
```
{{% /code-tab-content %}}
@ -114,6 +123,7 @@ influxdb3 query \
influxdb3 query \
--language influxql \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./query.influxql
```
{{% /code-tab-content %}}
@ -123,7 +133,8 @@ influxdb3 query \
```bash
cat ./query.influxql | influxdb3 query \
--language influxql \
--database DATABASE_NAME
--database DATABASE_NAME \
--token AUTH_TOKEN
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
@ -143,6 +154,7 @@ cat ./query.influxql | influxdb3 query \
influxdb3 query \
--format json \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'SELECT * FROM home'
```
{{% /code-tab-content %}}
@ -153,6 +165,7 @@ influxdb3 query \
influxdb3 query \
--format json \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./query.sql
```
{{% /code-tab-content %}}
@ -162,7 +175,8 @@ influxdb3 query \
```bash
cat ./query.sql | influxdb3 query \
--format json \
--database DATABASE_NAME
--database DATABASE_NAME \
--token AUTH_TOKEN \
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
@ -182,6 +196,7 @@ cat ./query.sql | influxdb3 query \
influxdb3 query \
--output /path/to/results.txt \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'SELECT * FROM home'
```
{{% /code-tab-content %}}
@ -192,6 +207,7 @@ influxdb3 query \
influxdb3 query \
--output /path/to/results.txt \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./query.sql
```
{{% /code-tab-content %}}
@ -201,7 +217,8 @@ influxdb3 query \
```bash
cat ./query.sql | influxdb3 query \
--output /path/to/results.txt \
--database DATABASE_NAME
--database DATABASE_NAME \
--token AUTH_TOKEN
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}

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

@ -16,7 +16,7 @@ influxdb3 show databases [OPTIONS]
| :----- | :--------------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| | `--show-deleted` | Include databases marked as deleted in the output |
| | `--format` | Output format (`pretty` _(default)_, `json`, `jsonl`, `csv`, or `parquet`) |
| `-h` | `--help` | Print help information |

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

@ -15,7 +15,7 @@ influxdb3 show system --database <DATABASE_NAME> summary [OPTIONS]
| Option | | Description |
| :----- | :--------- | :--------------------------------------------------------------------------------------------- |
| `-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`) |
| `-h` | `--help` | Print help information |
## Examples

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

@ -20,7 +20,7 @@ influxdb3 test wal_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`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| | `--token` | _({{< req >}})_ 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 |
@ -48,12 +48,14 @@ 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-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)" %}}
{{% code-placeholders "(DATABASE|PLUGIN)_(NAME|DIR)|AUTH_TOKEN" %}}
### Test a WAL plugin
@ -62,6 +64,7 @@ In the examples below, replace the following:
```bash
influxdb3 test wal_plugin \
--database DATABASE_NAME \
--token AUTH_TOKEN \
PLUGIN_DIR/PLUGIN_NAME.py
```
@ -73,6 +76,7 @@ influxdb3 test wal_plugin \
influxdb3 test wal_plugin \
--lp 'home,room=Kitchen temp=21.0,hum=35.9,co=0i' \
--database DATABASE_NAME \
--token AUTH_TOKEN \
PLUGIN_DIR/PLUGIN_NAME.py
```
@ -84,6 +88,7 @@ influxdb3 test wal_plugin \
influxdb3 test wal_plugin \
--file PLUGIN_DIR/PLUGIN_NAME_test/input-file.lp`
--database DATABASE_NAME \
--token AUTH_TOKEN \
PLUGIN_DIR/PLUGIN_NAME.py
```
@ -95,6 +100,7 @@ influxdb3 test wal_plugin \
influxdb3 test wal_plugin \
--input-arguments arg1=foo,arg2=baz \
--database DATABASE_NAME \
--token AUTH_TOKEN \
PLUGIN_DIR/PLUGIN_NAME.py
```

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

@ -28,7 +28,7 @@ influxdb3 write [OPTIONS] --database <DATABASE_NAME> [LINE_PROTOCOL]...
| :----- | :----------------- | :--------------------------------------------------------------------------------------- |
| `-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 |
| | `--token` | _({{< req >}})_ Authentication token |
| `-f` | `--file` | A file that contains line protocol to write |
| | `--accept-partial` | Accept partial writes |
| `-h` | `--help` | Print help information |
@ -48,11 +48,14 @@ You can use the following environment variables to set command options:
- [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.
In the examples below, replace the following:
{{% code-placeholders "DATABASE_NAME" %}}
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database to query
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
Authentication token
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
### Write line protocol to your InfluxDB 3 server
@ -67,7 +70,9 @@ with the name of the database to query.
<!--pytest.mark.skip-->
```bash
influxdb3 write --database DATABASE_NAME \
influxdb3 write \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000'
```
{{% /influxdb/custom-timestamps %}}
@ -76,14 +81,19 @@ influxdb3 write --database DATABASE_NAME \
<!--pytest.mark.skip-->
```bash
influxdb3 write --database DATABASE_NAME --file ./data.lp
influxdb3 write \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./data.lp
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!--pytest.mark.skip-->
```bash
cat ./data.lp | influxdb3 write --database DATABASE_NAME
cat ./data.lp | influxdb3 write \
--database DATABASE_NAME \
--token AUTH_TOKEN
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
@ -104,6 +114,7 @@ cat ./data.lp | influxdb3 write --database DATABASE_NAME
influxdb3 write \
--accept-partial \
--database DATABASE_NAME \
--token AUTH_TOKEN \
'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000'
```
{{% /influxdb/custom-timestamps %}}
@ -115,6 +126,7 @@ influxdb3 write \
influxdb3 write \
--accept-partial \
--database DATABASE_NAME \
--token AUTH_TOKEN \
--file ./data.lp
```
{{% /code-tab-content %}}
@ -125,6 +137,7 @@ influxdb3 write \
cat ./data.lp | influxdb3 write \
--accept-partial \
--database DATABASE_NAME \
--token AUTH_TOKEN
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}