Merge branch 'master' into docs/generalize-grafana-multinode

pull/6107/head
Jameelah Mercer 2025-05-30 01:36:34 +09:00 committed by GitHub
commit 1ac1c8dbd3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 42 additions and 25 deletions

View File

@ -25,7 +25,7 @@ types of demo data that let you explore and familiarize yourself with InfluxDB C
{{% note %}} {{% note %}}
#### Free to use and read-only #### Free to use and read-only
- InfluxDB Cloud demo data buckets are **free to use** and are **_not_ subject to - InfluxDB Cloud demo data buckets are **free to use** and are **_not_ subject to
[Free Plan rate limits](influxdb/cloud/account-management/limits/#free-plan-rate-limits) rate limits**. [Free Plan rate limits](/influxdb/cloud/account-management/limits/#free-plan-rate-limits) rate limits**.
- Demo data buckets are **read-only**. You cannot write data into demo data buckets. - Demo data buckets are **read-only**. You cannot write data into demo data buckets.
{{% /note %}} {{% /note %}}

View File

@ -16,4 +16,5 @@ source: /shared/influxdb3-admin/distinct-value-cache/_index.md
--- ---
<!-- The content for this page is located at <!-- The content for this page is located at
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/_index.md --> // SOURCE content/shared/influxdb3-admin/distinct-value-cache/_index.md
-->

View File

@ -17,4 +17,5 @@ source: /shared/influxdb3-admin/last-value-cache/_index.md
--- ---
<!-- The content for this page is located at <!-- The content for this page is located at
// SOURCE content/shared/influxdb3-admin/last-value-cache/_index.md --> // SOURCE content/shared/influxdb3-admin/last-value-cache/_index.md
-->

View File

@ -11,9 +11,9 @@ menu:
name: Admin tokens name: Admin tokens
weight: 101 weight: 101
influxdb3/core/tags: [tokens] influxdb3/core/tags: [tokens]
source: /shared/influxdb3-admin/tokens/admin.md source: /shared/influxdb3-admin/tokens/admin/_index.md
--- ---
<!-- The content for this page is at <!-- The content for this page is at
// SOURCE content/shared/influxdb3-admin/tokens/admin.md // SOURCE content/shared/influxdb3-admin/tokens/admin/_index.md
--> -->

View File

@ -8,7 +8,6 @@ in a table. When you create a DVC, you can specify what columns' distinct
values to cache, the maximum number of distinct value combinations to cache, and values to cache, the maximum number of distinct value combinations to cache, and
the maximum age of cached values. A DVC is associated with a table, which can the maximum age of cached values. A DVC is associated with a table, which can
have multiple DVCs. have multiple DVCs.
Caches import historical data when first created and reload data on restart.
{{< children type="anchored-list" >}} {{< children type="anchored-list" >}}
- [Important things to know about the Distinct Value Cache](#important-things-to-know-about-the-distinct-value-cache) - [Important things to know about the Distinct Value Cache](#important-things-to-know-about-the-distinct-value-cache)
@ -69,11 +68,17 @@ similar to this:
DVCs are stored in memory; the larger the cache, the more memory your InfluxDB 3 DVCs are stored in memory; the larger the cache, the more memory your InfluxDB 3
node requires to maintain it. Consider the following: node requires to maintain it. Consider the following:
- [Cache data loading](#cache-data-loading)
- [High cardinality limits](#high-cardinality-limits) - [High cardinality limits](#high-cardinality-limits)
{{% show-in "core" %}} {{% show-in "core" %}}
- [Distinct Value Caches are flushed when the server stops](#distinct-value-caches-are-flushed-when-the-server-stops) - [Distinct Value Caches are flushed when the server stops](#distinct-value-caches-are-flushed-when-the-server-stops)
{{% /show-in %}} {{% /show-in %}}
## Cache data loading
On cache creation, {{% product-name %}} loads historical data into the cache.
On restart, the server automatically reloads cache data.
### High cardinality limits ### High cardinality limits
“Cardinality” refers to the number of unique key column combinations in your “Cardinality” refers to the number of unique key column combinations in your

View File

@ -10,8 +10,6 @@ what fields to cache, what tags to use to identify each series, and the
number of values to cache for each unique series. number of values to cache for each unique series.
An LVC is associated with a table, which can have multiple LVCs. An LVC is associated with a table, which can have multiple LVCs.
Caches import historical data when first created and reload data on restart.
{{< children type="anchored-list" >}} {{< children type="anchored-list" >}}
- [Important things to know about the Last Value Cache](#important-things-to-know-about-the-last-value-cache) - [Important things to know about the Last Value Cache](#important-things-to-know-about-the-last-value-cache)
- [High cardinality key columns](#high-cardinality-key-columns) - [High cardinality key columns](#high-cardinality-key-columns)
@ -83,11 +81,17 @@ similar to the following:
LVCs are stored in memory; the larger the cache, the more memory your InfluxDB 3 node requires to LVCs are stored in memory; the larger the cache, the more memory your InfluxDB 3 node requires to
maintain it. Consider the following: maintain it. Consider the following:
- [Cache data loading](#cache-data-loading)
- [High cardinality key columns](#high-cardinality-key-columns) - [High cardinality key columns](#high-cardinality-key-columns)
- [Value count](#value-count) - [Value count](#value-count)
{{% show-in "core" %}} {{% show-in "core" %}}
- [Last Value Caches are flushed when the server stops](#last-value-caches-are-flushed-when-the-server-stops) - [Last Value Caches are flushed when the server stops](#last-value-caches-are-flushed-when-the-server-stops)
{{% /show-in %}}lue-columns) {{% /show-in %}}
## Cache data loading
On cache creation, {{% product-name %}} loads historical data into the cache.
On restart, the server automatically reloads cache data.
### High cardinality key columns ### High cardinality key columns

View File

@ -3,6 +3,7 @@ Manage tokens to authenticate and authorize access to server actions, resources,
## Provide your token ## Provide your token
If you start the {{< product-name >}} server with authentication enabled (the default), future server actions (CLI commands and HTTP API requests) require a valid token for authorization. If you start the {{< product-name >}} server with authentication enabled (the default), future server actions (CLI commands and HTTP API requests) require a valid token for authorization.
The first admin token you create is the _operator_ token (named `_admin`), which has full administrative privileges. The first admin token you create is the _operator_ token (named `_admin`), which has full administrative privileges.
You can use the operator token to authenticate your requests and manage additional authorization tokens. You can use the operator token to authenticate your requests and manage additional authorization tokens.
@ -15,7 +16,22 @@ The mechanism for providing your token depends on the client you use to interact
{{% /tabs %}} {{% /tabs %}}
{{% tab-content %}} {{% tab-content %}}
When using the `influxdb3` CLI, you can use the `--token` option to provide your authorization token. When using the `influxdb3` CLI, you can set the `INFLUXDB3_AUTH_TOKEN` environment variable to automatically provide your
authorization token to all `influxdb3` commands--for example:
{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash
# Export your token as an environment variable
export INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN
# Run an influxdb3 command
influxdb3 query \
--database DATABASE_NAME \
"SELECT * FROM 'DATABASE_NAME' WHERE time > now() - INTERVAL '10 minutes'"
```
{{% /code-placeholders %}}
To specify a token in the command and override the environment variable, pass the `--token` option with your authorization token--for example:
{{% code-placeholders "YOUR_AUTH_TOKEN" %}} {{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash ```bash
@ -30,19 +46,7 @@ influxdb3 query \
You can also set the `INFLUXDB3_AUTH_TOKEN` environment variable to automatically provide your You can also set the `INFLUXDB3_AUTH_TOKEN` environment variable to automatically provide your
authorization token to all `influxdb3` commands. authorization token to all `influxdb3` commands.
{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash
# Export your token as an environment variable
export INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN
# Run an influxdb3 command without the --token option
influxdb3 query \
--database DATABASE_NAME \
"SELECT * FROM 'DATABASE_NAME' WHERE time > now() - INTERVAL '10 minutes'"
```
{{% /code-placeholders %}}
{{% /tab-content %}} {{% /tab-content %}}
{{% tab-content %}} {{% tab-content %}}
{{% code-placeholders "YOUR_AUTH_TOKEN" %}} {{% code-placeholders "YOUR_AUTH_TOKEN" %}}
@ -57,6 +61,7 @@ curl "http://{{< influxdb/host >}}/api/v3/query_sql" \
{{% /tab-content %}} {{% /tab-content %}}
{{< /tabs-wrapper >}} {{< /tabs-wrapper >}}
Replace the following with your values: Replace the following with your values:
- {{% code-placeholder-key %}}`YOUR_AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link %}} - {{% code-placeholder-key %}}`YOUR_AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link %}}

View File

@ -1,4 +1,5 @@
<!-- --> <!--
-->
Manage {{< product-name omit="Clustered" >}} admin tokens to authorize server actions, `influxdb3` CLI commands, and HTTP API endpoints for your {{< product-name omit="Clustered" >}} instance. Manage {{< product-name omit="Clustered" >}} admin tokens to authorize server actions, `influxdb3` CLI commands, and HTTP API endpoints for your {{< product-name omit="Clustered" >}} instance.
Administrative (_admin_) tokens provide full system access and management capabilities for your {{< product-name omit="Clustered" >}} instance. Administrative (_admin_) tokens provide full system access and management capabilities for your {{< product-name omit="Clustered" >}} instance.
{{% show-in "core" %}} {{% show-in "core" %}}

View File

@ -910,7 +910,7 @@ _You can create a last values cache per time series, but be mindful of high card
#### Query a last values cache #### Query a last values cache
To query data from the LVC, use the [`last_cache()`](influxdb3/version/reference/sql/functions/cache/#last_cache) function in your query--for example: To query data from the LVC, use the [`last_cache()`](/influxdb3/version/reference/sql/functions/cache/#last_cache) function in your query--for example:
```bash ```bash
influxdb3 query \ influxdb3 query \

View File

@ -951,7 +951,7 @@ _You can create a last values cache per time series, but be mindful of high card
#### Query a last values cache #### Query a last values cache
To query data from the LVC, use the [`last_cache()`](influxdb3/version/reference/sql/functions/cache/#last_cache) function in your query--for example: To query data from the LVC, use the [`last_cache()`](/influxdb3/version/reference/sql/functions/cache/#last_cache) function in your query--for example:
```bash ```bash
influxdb3 query \ influxdb3 query \