From 0e4be06bfc701f7ece89273e8d6b3c27f09f4047 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 14 Apr 2025 20:12:22 -0600 Subject: [PATCH] clarified cache guides about using admin tokens --- .../shared/influxdb3-admin/distinct-value-cache/create.md | 5 ++--- .../shared/influxdb3-admin/distinct-value-cache/delete.md | 7 +++---- .../shared/influxdb3-admin/distinct-value-cache/show.md | 3 +-- content/shared/influxdb3-admin/last-value-cache/create.md | 7 +++---- content/shared/influxdb3-admin/last-value-cache/delete.md | 4 ++-- content/shared/influxdb3-admin/last-value-cache/show.md | 3 +-- 6 files changed, 12 insertions(+), 17 deletions(-) diff --git a/content/shared/influxdb3-admin/distinct-value-cache/create.md b/content/shared/influxdb3-admin/distinct-value-cache/create.md index 3166d7171..99918ce7d 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/create.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/create.md @@ -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` environment variable to specify the database. - **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 the token. - **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 %}}: the name of the database to associate the DVC with - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - your {{< product-name >}} authentication token with write access to the - specified database + your {{< product-name >}} admin authentication token - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the name of the table to associate the DVC with {{% show-in "enterprise" %}} diff --git a/content/shared/influxdb3-admin/distinct-value-cache/delete.md b/content/shared/influxdb3-admin/distinct-value-cache/delete.md index a90fc793d..3336eb288 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/delete.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/delete.md @@ -5,8 +5,8 @@ to delete a Distinct Value Cache (DVC). Provide the following: - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database that the DVC you want to delete is associated with. You can also use the `INFLUXDB3_DATABASE_NAME` environment variable to specify the database. -- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - authentication token with write access to the specified database. +- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin + authentication token. You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify the token. - **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 %}}: the name of the database that the DVC you want to delete is associated with - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - your {{< product-name >}} authentication token with write access to the - specified database + your {{< product-name >}} admin authentication token - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the name of the table associated with the DVC you want to delete - {{% code-placeholder-key %}}`DVC_NAME`{{% /code-placeholder-key %}}: diff --git a/content/shared/influxdb3-admin/distinct-value-cache/show.md b/content/shared/influxdb3-admin/distinct-value-cache/show.md index 2a20bf6d5..20f1ede3e 100644 --- a/content/shared/influxdb3-admin/distinct-value-cache/show.md +++ b/content/shared/influxdb3-admin/distinct-value-cache/show.md @@ -65,5 +65,4 @@ In the examples above, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the database to query system data from - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - your {{< product-name >}} authentication token with read access to the - specified database + your {{< product-name >}} admin authentication token diff --git a/content/shared/influxdb3-admin/last-value-cache/create.md b/content/shared/influxdb3-admin/last-value-cache/create.md index 91c38f203..79250f3ee 100644 --- a/content/shared/influxdb3-admin/last-value-cache/create.md +++ b/content/shared/influxdb3-admin/last-value-cache/create.md @@ -5,8 +5,8 @@ to create a Last Value Cache (LVC). Provide the following: - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database to associate the LVC with. You can also use the `INFLUXDB3_DATABASE_NAME` environment variable to specify the database. -- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - authentication token with write access to the specified table. +- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin + authentication token. You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify the token. - **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 %}}: the name of the database to associate the LVC with - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - your {{< product-name >}} authentication token with write access to the - specified database + your {{< product-name >}} admin authentication token - {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: the name of the table to associate the LVC with {{% show-in "enterprise" %}} diff --git a/content/shared/influxdb3-admin/last-value-cache/delete.md b/content/shared/influxdb3-admin/last-value-cache/delete.md index 6cfccc021..7994e1680 100644 --- a/content/shared/influxdb3-admin/last-value-cache/delete.md +++ b/content/shared/influxdb3-admin/last-value-cache/delete.md @@ -5,8 +5,8 @@ to delete a Last Value Cache (LVC). Provide the following: - **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database that the LVC you want to delete is associated with. You can also use the `INFLUXDB3_DATABASE_NAME` environment variable to specify the database. -- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} - authentication token with write access to the specified database. +- **Token** (`--token`): _({{< req >}})_ Your {{< product-name >}} admin + authentication token. You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify the database. - **Table** (`-t`, `--table`): _({{< req >}})_ The name of the table that the diff --git a/content/shared/influxdb3-admin/last-value-cache/show.md b/content/shared/influxdb3-admin/last-value-cache/show.md index e4100ca89..7bf1c70a3 100644 --- a/content/shared/influxdb3-admin/last-value-cache/show.md +++ b/content/shared/influxdb3-admin/last-value-cache/show.md @@ -64,5 +64,4 @@ In the examples above, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the name of the database to query system data from - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: - your {{< product-name >}} authentication token with read access to the - specified database + your {{< product-name >}} admin authentication token