Skip to content

Commit 3019032

Browse files
sandersonsanderson
committed
added auth token to influxdb3 cli examples
1 parent 0bcdb3f commit 3019032

File tree

20 files changed

+156
-73
lines changed

20 files changed

+156
-73
lines changed

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

Lines changed: 2 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,7 +25,7 @@ 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 |

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

Lines changed: 10 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,7 +23,7 @@ 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 |
2528
| `-h` | `--help` | Print help information |
2629

@@ -43,10 +46,12 @@ In the examples below, replace the following:
4346

4447
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
4548
Database name
49+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
50+
Authentication token
4651
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
4752
Table name
4853

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

5156
### Create a new file index for a database
5257

@@ -55,6 +60,7 @@ In the examples below, replace the following:
5560
```bash
5661
influxdb3 create file_index \
5762
--database DATABASE_NAME \
63+
--token AUTH_TOKEN \
5864
column1 column2 column3
5965
```
6066

@@ -65,6 +71,7 @@ influxdb3 create file_index \
6571
```bash
6672
influxdb3 create file_index \
6773
--database DATABASE_NAME \
74+
--token AUTH_TOKEN \
6875
--table TABLE_NAME \
6976
column1 column2 column3
7077
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ 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` |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The `influxdb3 create plugin` command creates a new processing engine plugin.
88
```bash
99
influxdb3 create plugin [OPTIONS] \
1010
--database <DATABASE_NAME> \
11+
--token <AUTH_TOKEN> \
1112
--filename <PLUGIN_FILENAME> \
1213
--entry-point <FUNCTION_NAME> \
1314
<PLUGIN_NAME>
@@ -23,7 +24,7 @@ influxdb3 create plugin [OPTIONS] \
2324
| :----- | :-------------- | :--------------------------------------------------------------------------------------- |
2425
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2526
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
26-
| | `--token` | Authentication token |
27+
| | `--token` | _({{< req >}})_ Authentication token |
2728
| | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory |
2829
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
2930
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The `influxdb3 create table` command creates a table in a database.
99
influxdb3 create table [OPTIONS] \
1010
--tags [<TAGS>...] \
1111
--database <DATABASE_NAME> \
12+
--token <AUTH_TOKEN> \
1213
<TABLE_NAME>
1314
```
1415

@@ -22,7 +23,7 @@ influxdb3 create table [OPTIONS] \
2223
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
2324
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
2425
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
25-
| | `--token` | Authentication token |
26+
| | `--token` | _({{< req >}})_ Authentication token |
2627
| | `--tags` | _({{< req >}})_ Comma-separated list of tag columns to include in the table |
2728
| | `--fields` | Comma-separated list of field columns and their types to include in the table |
2829
| `-h` | `--help` | Print help information |
@@ -53,6 +54,8 @@ In the examples below, replace the following:
5354

5455
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
5556
Database name
57+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
58+
Authentication token
5659
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
5760
Table name
5861

@@ -64,6 +67,7 @@ In the examples below, replace the following:
6467
influxdb3 create table \
6568
--tags tag1,tag2,tag3 \
6669
--database DATABASE_NAME \
70+
--token AUTH_TOKEN \
6771
TABLE_NAME
6872
```
6973

@@ -76,6 +80,7 @@ influxdb3 create table \
7680
--tags room,sensor_id \
7781
--fields temp:float64,hum:float64,co:int64 \
7882
--database DATABASE_NAME \
83+
--token AUTH_TOKEN \
7984
TABLE_NAME
8085
```
8186

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ processing engine.
99
```bash
1010
influxdb3 create trigger [OPTIONS] \
1111
--database <DATABASE_NAME> \
12+
--token <AUTH_TOKEN> \
1213
--plugin <PLUGIN_NAME> \
1314
--trigger-spec <TRIGGER_SPECIFICATION> \
1415
<TRIGGER_NAME>
@@ -24,7 +25,7 @@ influxdb3 create trigger [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
| | `--plugin` | Plugin to execute when the trigger fires |
2930
| | `--trigger-spec` | Trigger specification--for example `table:<TABLE_NAME>` or `all_tables` |
3031
| | `--disabled` | Create the trigger in disabled state |

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ influxdb3 delete distinct_cache [OPTIONS] \
1818

1919
## Options
2020

21-
| Option | | Description |
22-
| :----- | :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23-
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
24-
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
25-
| | `--token` | Authentication token |
26-
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
27-
| `-h` | `--help` | Print help information |
21+
| Option | | Description |
22+
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
23+
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
24+
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
25+
| | `--token` | _({{< req >}})_ Authentication token |
26+
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache for |
27+
| `-h` | `--help` | Print help information |
2828

2929
### Option environment variables
3030

@@ -40,13 +40,14 @@ You can use the following environment variables to set command options:
4040

4141
### Delete a distinct value cache
4242

43-
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
43+
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME|AUTH_TOKEN" %}}
4444

4545
<!--pytest.mark.skip-->
4646

4747
```bash
4848
influxdb3 delete distinct_cache \
4949
--database DATABASE_NAME \
50+
--token AUTH_TOKEN \
5051
--table TABLE_NAME \
5152
CACHE_NAME
5253
```
@@ -57,6 +58,8 @@ In the example above, replace the following:
5758

5859
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
5960
Database name
61+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
62+
Authentication token
6063
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
6164
Table name
6265
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ influxdb3 delete file_index [OPTIONS] --database <DATABASE_NAME>
1616
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
1717
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
1818
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
19-
| | `--token` | Authentication token |
20-
| `-t` | `--table` | Table to delete the file index from |
19+
| | `--token` | _({{< req >}})_ Authentication token |
20+
| `-t` | `--table` | Table to delete the file index from |
2121
| `-h` | `--help` | Print help information |
2222

2323
### Option environment variables
@@ -39,25 +39,32 @@ In the examples below, replace the following:
3939

4040
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
4141
Database name
42+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
43+
Authentication token
4244
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
4345
Table name
4446

45-
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
47+
{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}
4648

4749
### Delete a file index from a database
4850

4951
<!--pytest.mark.skip-->
5052

5153
```bash
52-
influxdb3 delete file_index --database DATABASE_NAME
54+
influxdb3 delete file_index \
55+
--database DATABASE_NAME \
56+
--token AUTH_TOKEN
5357
```
5458

5559
### Delete a file index from a specific table
5660

5761
<!--pytest.mark.skip-->
5862

5963
```bash
60-
influxdb3 delete file_index --database DATABASE_NAME --table TABLE_NAME
64+
influxdb3 delete file_index \
65+
--database DATABASE_NAME \
66+
--token AUTH_TOKEN \
67+
--table TABLE_NAME
6168
```
6269

6370
{{% /code-placeholders %}}

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ influxdb3 delete last_cache [OPTIONS] --database <DATABASE_NAME> --table <TABLE>
1515

1616
## Options
1717

18-
| Option | | Description |
19-
| :----- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20-
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
21-
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
22-
| | `--token` | Authentication token |
23-
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from |
24-
| `-h` | `--help` | Print help information |
18+
| Option | | Description |
19+
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
20+
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
21+
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
22+
| | `--token` | _({{< req >}})_ Authentication token |
23+
| `-t` | `--table` | _({{< req >}})_ Table to delete the cache from |
24+
| `-h` | `--help` | Print help information |
2525

2626
### Option environment variables
2727

@@ -37,13 +37,14 @@ You can use the following environment variables to set command options:
3737

3838
### Delete a last value cache
3939

40-
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME" %}}
40+
{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME|AUTH_TOKEN" %}}
4141

4242
<!--pytest.mark.skip-->
4343

4444
```bash
4545
influxdb3 delete last_cache \
4646
--database DATABASE_NAME \
47+
--token AUTH_TOKEN \
4748
--table TABLE_NAME \
4849
CACHE_NAME
4950
```
@@ -54,6 +55,8 @@ In the example above, replace the following:
5455

5556
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
5657
Database name
58+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
59+
Authentication token
5760
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
5861
Table name
5962
- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}:

0 commit comments

Comments
 (0)