Skip to content

Commit 4d22388

Browse files
sandersonsanderson
committed
WIP monolith get started, enterprise multi-node, file index docs
1 parent 481d5b8 commit 4d22388

File tree

24 files changed

+998
-604
lines changed

24 files changed

+998
-604
lines changed

‎content/influxdb3/core/get-started/processing-engine.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Process data in {{% product-name %}}
3+
seotitle: Process data | Get started with {{% product-name %}}
4+
description: >
5+
Learn how to use the {{% product-name %}} Processing Engine to process data and
6+
perform various tasks like downsampling, alerting, forecasting, data
7+
normalization, and more.
8+
menu:
9+
influxdb3_core:
10+
name: Process data
11+
identifier: gs-process-data
12+
parent: Get started
13+
weight: 104
14+
related:
15+
- /influxdb3/core/plugins/
16+
- /influxdb3/core/reference/cli/influxdb3/create/plugin/
17+
- /influxdb3/core/reference/cli/influxdb3/create/trigger/
18+
source: /shared/influxdb3-get-started/processing-engine.md
19+
---
20+
21+
<!--
22+
The content of this page is at
23+
// SOURCE content/shared/influxdb3-get-started/query.md
24+
-->

‎content/influxdb3/core/get-started/query.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Query data in {{% product-name %}}
3+
seotitle: Query data | Get started with {{% product-name %}}
4+
description: >
5+
Learn how to get started querying data in {{% product-name %}} using native
6+
SQL or InfluxQL with the `influxdb3` CLI and other tools.
7+
menu:
8+
influxdb3_core:
9+
name: Query data
10+
identifier: gs-query-data
11+
parent: Get started
12+
weight: 103
13+
related:
14+
- /influxdb3/core/query-data/
15+
- /influxdb3/core/reference/sql/
16+
- https://datafusion.apache.org/user-guide/sql/index.html, Apache DataFusion SQL reference
17+
- /influxdb3/core/reference/influxql/
18+
source: /shared/influxdb3-get-started/query.md
19+
---
20+
21+
<!--
22+
The content of this page is at
23+
// SOURCE content/shared/influxdb3-get-started/query.md
24+
-->

‎content/influxdb3/core/get-started/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set up {{% product-name %}}
33
seotitle: Set up InfluxDB | Get started with {{% product-name %}}
44
description: >
5-
....
5+
Install, configure, and set up authorization for {{% product-name %}}.
66
menu:
77
influxdb3_core:
88
name: Set up Core

‎content/influxdb3/core/get-started/write.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Write data to {{% product-name %}}
33
seotitle: Write data | Get started with {{% product-name %}}
44
description: >
5-
....
5+
Learn how to write time series data to {{% product-name %}} using the
6+
`influxdb3` CLI and _line protocol_, an efficient, human-readable write syntax.
67
menu:
78
influxdb3_core:
89
name: Write data

‎content/influxdb3/core/reference/cli/influxdb3/create/file_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎content/influxdb3/core/reference/cli/influxdb3/delete/file_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎content/influxdb3/enterprise/admin/file-index/_index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Manage file indexes
3+
seotitle: Manage file indexes in {{< product-name >}}
4+
description: >
5+
Customize the indexing strategy of a database or table in {{% product-name %}}
6+
to optimize the performance of single-series queries.
7+
menu:
8+
influxdb3_enterprise:
9+
parent: Administer InfluxDB
10+
weight: 106
11+
influxdb3/enterprise/tags: [indexing]
12+
---
13+
14+
{{% product-name %}} lets you customize how your data is indexed to help
15+
optimize query performance for your specific workload, especially workloads that
16+
include single-series queries. Indexes help the InfluxDB query engine quickly
17+
identify the physical location of files that contain the queried data.
18+
19+
By default, InfluxDB indexes on the primary key—`time` and tag columns. However,
20+
if your schema includes tags that you don't specifically use when querying, you
21+
can define a custom indexing strategy to only index on `time` and columns
22+
important to your query workload.
23+
24+
For example, if your schema includes the following columns:
25+
26+
- country
27+
- state_province
28+
- county
29+
- city
30+
- postal_code
31+
32+
And in your query workload, you only query based on country, state or province,
33+
and city, you can create a custom file indexing strategy that only indexes on
34+
`time` and these specific columns. This makes your index more efficient and
35+
improves the performance of your single-series queries.
36+
37+
> [!Note]
38+
> File indexes can use any string column, including both tags and fields.
39+
40+
- [Indexing life cycle](#indexing-life-cycle)
41+
- [Create a custom file index](#create-a-custom-file-index)
42+
- [Delete a custom file index](#delete-a-custom-file-index)
43+
44+
## Indexing life cycle
45+
46+
{{% product-name %}} builds indexes as it compacts data. Compaction is the
47+
process that organizes and optimizes Parquet files in storage and occurs in
48+
multiple phases or generations. Generation 1 (gen1) data is un-compacted and
49+
is not indexed. Generation 2 (gen2) data and beyond is all indexed.
50+
51+
{{< children hlevel="h2" >}}

‎content/influxdb3/enterprise/admin/file-index/create.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Create a custom file index
3+
seotitle: Create a custom file index in {{< product-name >}}
4+
description: >
5+
Use the [`influxdb3 create file_index` command](/influxdb3/enterprise/reference/cli/influxdb3/create/file_index/)
6+
to create a custom file indexing strategy for a database or a table.
7+
menu:
8+
influxdb3_enterprise:
9+
parent: Manage file indexes
10+
weight: 106
11+
influxdb3/enterprise/tags: [indexing]
12+
related:
13+
- /influxdb3/enterprise/reference/cli/influxdb3/create/file_index/
14+
list_code_example: |
15+
<!--pytest.mark.skip-->
16+
```bash
17+
influxdb3 create file_index \
18+
--database example-db \
19+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
20+
--table wind_data \
21+
country,city
22+
```
23+
---
24+
25+
Use the [`influxdb3 create file_index` command](/influxdb3/enterprise/reference/cli/influxdb3/create/file_index/)
26+
to create a custom file indexing strategy for a database or table.
27+
28+
Provide the following:
29+
30+
- **Token** (`--token`): _({{< req >}})_ Your {{% token-link "admin" %}}.
31+
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
32+
the token.
33+
- **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database to
34+
apply the index to. You can also use the `INFLUXDB3_DATABASE_NAME`
35+
environment variable to specify the database.
36+
- **Table** (`-t`, `--table`): The name of the table to apply the index to.
37+
If no table is specified, the indexing strategy applies to all tables in the
38+
specified database.
39+
- **Columns**: _({{< req >}})_ A comma-separated list of string columns to
40+
index on. These are typically tag columns but can also be string fields.
41+
42+
{{% code-placeholders "AUTH_TOKEN|DATABASE|TABLE|COLUMNS" %}}
43+
<!--pytest.mark.skip-->
44+
```bash
45+
influxdb3 create file_index \
46+
--token AUTH_TOKEN \
47+
--database DATABASE_NAME \
48+
--table TABLE_NAME \
49+
COLUMNS
50+
```
51+
{{% /code-placeholders %}}
52+
53+
Replace the following placeholders with your values:
54+
55+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
56+
your {{% token-link "admin" %}}
57+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
58+
the name of the database to create the file index in
59+
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
60+
the name of the table to create the file index in
61+
- {{% code-placeholder-key %}}`COLUMNS`{{% /code-placeholder-key %}}:
62+
a comma-separated list of columns to index on--for example: `host,application`

‎content/influxdb3/enterprise/admin/file-index/delete.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Delete a custom file index
3+
seotitle: Delete a custom file index in {{< product-name >}}
4+
description: >
5+
Use the [`influxdb3 delete file_index` command](/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index/)
6+
to delete a custom file indexing strategy from a database or a table and revert
7+
to the default indexing strategy.
8+
menu:
9+
influxdb3_enterprise:
10+
parent: Manage file indexes
11+
weight: 106
12+
influxdb3/enterprise/tags: [indexing]
13+
related:
14+
- /influxdb3/enterprise/reference/cli/influxdb3/delete/file_index/
15+
list_code_example: |
16+
<!--pytest.mark.skip-->
17+
```bash
18+
influxdb3 delete file_index \
19+
--database example-db \
20+
--token 00xoXX0xXXx0000XxxxXx0Xx0xx0 \
21+
--table wind_data
22+
```
23+
---
24+
25+
Use the [`influxdb3 delete file_index` command](/influxdb3/enterprise/reference/cli/influxdb3/delete/file_index/)
26+
to delete a custom file indexing strategy from a database or a table and revert
27+
to the default indexing strategy.
28+
29+
Provide the following:
30+
31+
- **Token** (`--token`): _({{< req >}})_ Your {{% token-link "admin" %}}.
32+
You can also use the `INFLUXDB3_AUTH_TOKEN` environment variable to specify
33+
the token.
34+
- **Database** (`-d`, `--database`): _({{< req >}})_ The name of the database to
35+
apply remove the custom index from. You can also use the `INFLUXDB3_DATABASE_NAME`
36+
environment variable to specify the database.
37+
- **Table** (`-t`, `--table`): The name of the table to remove the custom index from.
38+
If no table is specified, the custom indexing strategy is removed from all
39+
tables in the specified database.
40+
41+
{{% code-placeholders "AUTH_TOKEN|DATABASE|TABLE|COLUMNS" %}}
42+
43+
```bash
44+
influxdb3 delete file_index \
45+
--host http://localhost:8585 \
46+
--database DATABASE_NAME \
47+
--table TABLE_NAME \
48+
```
49+
{{% /code-placeholders %}}
50+
51+
Replace the following placeholders with your values:
52+
53+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
54+
your {{% token-link "admin" %}}
55+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
56+
the name of the database to remove the custom file index from
57+
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
58+
the name of the table to remove the custom file index from

0 commit comments

Comments
 (0)