clarified cache guides about using admin tokens

pull/5983/head
Scott Anderson 2025-04-14 20:12:22 -06:00
parent 0bcdb3fb88
commit 0e4be06bfc
6 changed files with 12 additions and 17 deletions

View File

@ -6,7 +6,7 @@ to create a Distinct Value Cache (DVC). Provide the following:
associate the DVC with. You can also use the `INFLUXDB3_DATABASE_NAME` associate the DVC with. You can also use the `INFLUXDB3_DATABASE_NAME`
environment variable to specify the database. environment variable to specify the database.
- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}}
authentication token with write access to the specified table. admin authentication token.
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
the token. the token.
- **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table to - **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table to
@ -74,8 +74,7 @@ Replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database to associate the DVC with the name of the database to associate the DVC with
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
your {{< product-name >}} authentication token with write access to the your {{< product-name >}} admin authentication token
specified database
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
the name of the table to associate the DVC with the name of the table to associate the DVC with
{{% show-in "enterprise" %}} {{% show-in "enterprise" %}}

View File

@ -5,8 +5,8 @@ to delete a Distinct Value Cache (DVC). Provide the following:
- **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database
that the DVC you want to delete is associated with. You can also use the that the DVC you want to delete is associated with. You can also use the
`INFLUXDB3_DATABASE_NAME` environment variable to specify the database. `INFLUXDB3_DATABASE_NAME` environment variable to specify the database.
- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin
authentication token with write access to the specified database. authentication token.
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
the token. the token.
- **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table that the - **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table that the
@ -28,8 +28,7 @@ Replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database that the DVC you want to delete is associated with the name of the database that the DVC you want to delete is associated with
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
your {{< product-name >}} authentication token with write access to the your {{< product-name >}} admin authentication token
specified database
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
the name of the table associated with the DVC you want to delete the name of the table associated with the DVC you want to delete
- {{% code-placeholder-key %}}`DVC_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DVC_NAME`{{% /code-placeholder-key %}}:

View File

@ -65,5 +65,4 @@ In the examples above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database to query system data from the name of the database to query system data from
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
your {{< product-name >}} authentication token with read access to the your {{< product-name >}} admin authentication token
specified database

View File

@ -5,8 +5,8 @@ to create a Last Value Cache (LVC). Provide the following:
- **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database to - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database to
associate the LVC with. You can also use the `INFLUXDB3_DATABASE_NAME` associate the LVC with. You can also use the `INFLUXDB3_DATABASE_NAME`
environment variable to specify the database. environment variable to specify the database.
- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin
authentication token with write access to the specified table. authentication token.
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
the token. the token.
- **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table to - **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table to
@ -85,8 +85,7 @@ Replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database to associate the LVC with the name of the database to associate the LVC with
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
your {{< product-name >}} authentication token with write access to the your {{< product-name >}} admin authentication token
specified database
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
the name of the table to associate the LVC with the name of the table to associate the LVC with
{{% show-in "enterprise" %}} {{% show-in "enterprise" %}}

View File

@ -5,8 +5,8 @@ to delete a Last Value Cache (LVC). Provide the following:
- **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database
that the LVC you want to delete is associated with. You can also use the that the LVC you want to delete is associated with. You can also use the
`INFLUXDB3_DATABASE_NAME` environment variable to specify the database. `INFLUXDB3_DATABASE_NAME` environment variable to specify the database.
- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin
authentication token with write access to the specified database. authentication token.
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
the database. the database.
- **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table that the - **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table that the

View File

@ -64,5 +64,4 @@ In the examples above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
the name of the database to query system data from the name of the database to query system data from
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
your {{< product-name >}} authentication token with read access to the your {{< product-name >}} admin authentication token
specified database