Skip to content

Commit a5b9b56

Browse files
sandersonsanderson
authored
Manage InfluxDB 3 Distinct Value Caches (#5977)
* add distinct value cache management docs * updated references to last values in dvc guides
1 parent c37b5b5 commit a5b9b56

File tree

17 files changed

+648
-1
lines changed

17 files changed

+648
-1
lines changed

‎content/influxdb3/core/admin/distinct-value-cache/_index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Manage the Distinct Value Cache
3+
seotitle: Manage the Distinct Value Cache in {{< product-name >}}
4+
description: >
5+
The {{< product-name >}} Distinct Value Cache (DVC) lets you cache distinct
6+
values of one or more columns in a table, improving the performance of
7+
queries that return distinct tag and field values.
8+
menu:
9+
influxdb3_core:
10+
parent: Administer InfluxDB
11+
weight: 105
12+
influxdb3/core/tags: [cache]
13+
related:
14+
- /influxdb3/core/reference/sql/functions/cache/#distinct_cache, distinct_cache SQL function
15+
source: /shared/influxdb3-admin/distinct-value-cache/_index.md
16+
---
17+
18+
<!-- The content for this page is located at
19+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/_index.md -->

‎content/influxdb3/core/admin/distinct-value-cache/create.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Create a Distinct Value Cache
3+
description: |
4+
Use the [`influxdb3 create distinct_cache` command](/influxdb3/core/reference/cli/influxdb3/create/distinct_cache/)
5+
to create a Distinct Value Cache.
6+
menu:
7+
influxdb3_core:
8+
parent: Manage the Distinct Value Cache
9+
weight: 201
10+
influxdb3/core/tags: [cache]
11+
related:
12+
- /influxdb3/core/reference/cli/influxdb3/create/distinct_cache/
13+
list_code_example: |
14+
{{% show-in "core" %}}
15+
<!--pytest.mark.skip-->
16+
17+
```bash
18+
influxdb3 create distinct_cache \
19+
--database example-db \
20+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
21+
--table wind_data \
22+
--columns country,county,city \
23+
--max-cardinality 10000 \
24+
--max-age 24h \
25+
windDistinctCache
26+
```
27+
{{% /show-in %}}
28+
29+
{{% show-in "enterprise" %}}
30+
<!--pytest.mark.skip-->
31+
32+
```bash
33+
influxdb3 create distinct_cache \
34+
--database example-db \
35+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
36+
--table home \
37+
--node-spec node-01,node-02 \
38+
--columns country,county,city \
39+
--max-cardinality 10000 \
40+
--max-age 24h \
41+
windDistinctCache
42+
```
43+
{{% /show-in %}}
44+
source: /shared/influxdb3-admin/distinct-value-cache/create.md
45+
---
46+
47+
<!-- The content for this page is located at
48+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/create.md -->

‎content/influxdb3/core/admin/distinct-value-cache/delete.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Delete a Distinct Value Cache
3+
description: |
4+
Use the [`influxdb3 delete distinct_cache` command](/influxdb3/core/reference/cli/influxdb3/delete/distinct_cache/)
5+
to delete a Distinct Value Cache.
6+
menu:
7+
influxdb3_core:
8+
parent: Manage the Distinct Value Cache
9+
weight: 204
10+
influxdb3/core/tags: [cache]
11+
list_code_example: |
12+
<!--pytest.mark.skip-->
13+
14+
```bash
15+
influxdb3 delete distinct_cache \
16+
--database example-db \
17+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
18+
--table wind_data \
19+
windDistinctCache
20+
```
21+
related:
22+
- /influxdb3/core/reference/cli/influxdb3/delete/distinct_cache/
23+
source: /shared/influxdb3-admin/distinct-value-cache/delete.md
24+
---
25+
26+
<!-- The content for this page is located at
27+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/delete.md -->

‎content/influxdb3/core/admin/distinct-value-cache/query.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Query a Distinct Value Cache
3+
description: |
4+
Use the [`distinct_cache()` SQL function](/influxdb3/core/reference/sql/functions/cache/#distinct_cache)
5+
in the `FROM` clause of an SQL `SELECT` statement to query data from the
6+
Distinct Value Cache.
7+
menu:
8+
influxdb3_core:
9+
parent: Manage the Distinct Value Cache
10+
weight: 202
11+
influxdb3/core/tags: [cache]
12+
list_code_example: |
13+
```sql
14+
SELECT * FROM distinct_cache('table-name', 'cache-name')
15+
```
16+
17+
> [!Important]
18+
> You must use SQL to query the DVC.
19+
> InfluxQL does not support the `distinct_cache()` function.
20+
related:
21+
- /influxdb3/core/reference/sql/functions/cache/#distinct_cache, distinct_cache SQL function
22+
source: /shared/influxdb3-admin/distinct-value-cache/query.md
23+
---
24+
25+
<!-- The content for this page is located at
26+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/query.md -->

‎content/influxdb3/core/admin/distinct-value-cache/show.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Show information about Distinct Value Caches
3+
description: |
4+
Use the `influxdb3 show system table` command to query and output Distinct Value
5+
Cache information from the `distinct_caches` system table.
6+
menu:
7+
influxdb3_core:
8+
parent: Manage the Distinct Value Cache
9+
name: Show Distinct Value Caches
10+
weight: 203
11+
influxdb3/core/tags: [cache]
12+
list_code_example: |
13+
<!-- pytest.mark.skip -->
14+
15+
```bash
16+
influxdb3 show system \
17+
--database example-db \
18+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
19+
table distinct_caches
20+
```
21+
source: /shared/influxdb3-admin/distinct-value-cache/show.md
22+
---
23+
24+
<!-- The content for this page is located at
25+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/show.md -->

‎content/influxdb3/enterprise/admin/distinct-value-cache/_index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Manage the Distinct Value Cache
3+
seotitle: Manage the Distinct Value Cache in {{< product-name >}}
4+
description: >
5+
The {{< product-name >}} Distinct Value Cache (DVC) lets you cache distinct
6+
values of one or more columns in a table, improving the performance of
7+
queries that return distinct tag and field values.
8+
menu:
9+
influxdb3_enterprise:
10+
parent: Administer InfluxDB
11+
weight: 105
12+
influxdb3/enterprise/tags: [cache]
13+
related:
14+
- /influxdb3/enterprise/reference/sql/functions/cache/#distinct_cache, distinct_cache SQL function
15+
source: /shared/influxdb3-admin/distinct-value-cache/_index.md
16+
---
17+
18+
<!-- The content for this page is located at
19+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/_index.md -->

‎content/influxdb3/enterprise/admin/distinct-value-cache/create.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Create a Distinct Value Cache
3+
description: |
4+
Use the [`influxdb3 create distinct_cache` command](/influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache/)
5+
to create a Distinct Value Cache.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: Manage the Distinct Value Cache
9+
weight: 201
10+
influxdb3/enterprise/tags: [cache]
11+
related:
12+
- /influxdb3/enterprise/reference/cli/influxdb3/create/distinct_cache/
13+
list_code_example: |
14+
{{% show-in "core" %}}
15+
<!--pytest.mark.skip-->
16+
17+
```bash
18+
influxdb3 create distinct_cache \
19+
--database example-db \
20+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
21+
--table wind_data \
22+
--columns country,county,city \
23+
--max-cardinality 10000 \
24+
--max-age 24h \
25+
windDistinctCache
26+
```
27+
{{% /show-in %}}
28+
29+
{{% show-in "enterprise" %}}
30+
<!--pytest.mark.skip-->
31+
32+
```bash
33+
influxdb3 create distinct_cache \
34+
--database example-db \
35+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
36+
--table home \
37+
--node-spec node-01,node-02 \
38+
--columns country,county,city \
39+
--max-cardinality 10000 \
40+
--max-age 24h \
41+
windDistinctCache
42+
```
43+
{{% /show-in %}}
44+
source: /shared/influxdb3-admin/distinct-value-cache/create.md
45+
---
46+
47+
<!-- The content for this page is located at
48+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/create.md -->

‎content/influxdb3/enterprise/admin/distinct-value-cache/delete.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Delete a Distinct Value Cache
3+
description: |
4+
Use the [`influxdb3 delete distinct_cache` command](/influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache/)
5+
to delete a Distinct Value Cache.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: Manage the Distinct Value Cache
9+
weight: 204
10+
influxdb3/enterprise/tags: [cache]
11+
list_code_example: |
12+
<!--pytest.mark.skip-->
13+
14+
```bash
15+
influxdb3 delete distinct_cache \
16+
--database example-db \
17+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
18+
--table wind_data \
19+
windDistinctCache
20+
```
21+
related:
22+
- /influxdb3/enterprise/reference/cli/influxdb3/delete/distinct_cache/
23+
source: /shared/influxdb3-admin/distinct-value-cache/delete.md
24+
---
25+
26+
<!-- The content for this page is located at
27+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/delete.md -->

‎content/influxdb3/enterprise/admin/distinct-value-cache/query.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Query a Distinct Value Cache
3+
description: |
4+
Use the [`distinct_cache()` SQL function](/influxdb3/enterprise/reference/sql/functions/cache/#distinct_cache)
5+
in the `FROM` clause of an SQL `SELECT` statement to query data from the
6+
Distinct Value Cache.
7+
menu:
8+
influxdb3_enterprise:
9+
parent: Manage the Distinct Value Cache
10+
weight: 202
11+
influxdb3/enterprise/tags: [cache]
12+
list_code_example: |
13+
```sql
14+
SELECT * FROM distinct_cache('table-name', 'cache-name')
15+
```
16+
17+
> [!Important]
18+
> You must use SQL to query the DVC.
19+
> InfluxQL does not support the `distinct_cache()` function.
20+
related:
21+
- /influxdb3/enterprise/reference/sql/functions/cache/#distinct_cache, distinct_cache SQL function
22+
source: /shared/influxdb3-admin/distinct-value-cache/query.md
23+
---
24+
25+
<!-- The content for this page is located at
26+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/query.md -->

‎content/influxdb3/enterprise/admin/distinct-value-cache/show.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Show information about Distinct Value Caches
3+
description: |
4+
Use the `influxdb3 show system table` command to query and output Distinct Value
5+
Cache information from the `distinct_caches` system table.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: Manage the Distinct Value Cache
9+
name: Show Distinct Value Caches
10+
weight: 203
11+
influxdb3/enterprise/tags: [cache]
12+
list_code_example: |
13+
<!-- pytest.mark.skip -->
14+
15+
```bash
16+
influxdb3 show system \
17+
--database example-db \
18+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
19+
table distinct_caches
20+
```
21+
source: /shared/influxdb3-admin/distinct-value-cache/show.md
22+
---
23+
24+
<!-- The content for this page is located at
25+
// SOURCE content/shared/influxdb3-admin/distinct-value-cache/show.md -->

0 commit comments

Comments
 (0)