Skip to content

Commit 7caa211

Browse files
sandersonsanderson
committed
update getting started landing page
1 parent 4d22388 commit 7caa211

File tree

2 files changed

+54
-49
lines changed

2 files changed

+54
-49
lines changed

‎content/shared/influxdb3-get-started/_index.md

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,68 @@
11

2+
This guide walks through the basic steps of getting started with {{% product-name %}},
3+
including the following:
24

3-
### What's in this guide
4-
5-
{{% show-in "enterprise" %}}
6-
This guide covers Enterprise as well as InfluxDB 3 Core, including the following topics:
7-
{{% /show-in %}}
8-
{{% show-in "core" %}}
9-
This guide covers InfluxDB 3 Core (the open source release), including the following topics:
10-
{{% /show-in %}}
11-
12-
- [Install and startup](#install-and-startup)
13-
- [Authentication and authorization](#authentication-and-authorization)
14-
- [Data Model](#data-model)
15-
- [Tools to use](#tools-to-use)
16-
- [Write data](#write-data)
17-
- [Query data](#query-data)
18-
- [Last values cache](#last-values-cache)
19-
- [Distinct values cache](#distinct-values-cache)
20-
- [Python plugins and the processing engine](#python-plugins-and-the-processing-engine)
21-
{{% show-in "enterprise" %}}
22-
- [Multi-server setups](#multi-server-setup)
23-
{{% /show-in %}}
5+
{{< children type="ordered-list" >}}
246

257
> [!Tip]
268
> #### Find support for {{% product-name %}}
279
>
2810
> The [InfluxDB Discord server](https://discord.gg/9zaNCW2PRT) is the best place to find support for {{% product-name %}}.
2911
> For other InfluxDB versions, see the [Support and feedback](#bug-reports-and-feedback) options.
3012
31-
### Data model
13+
## Data model
3214

33-
The database server contains logical databases, which have tables, which have columns. Compared to previous versions of InfluxDB you can think of a database as a `bucket` in v2 or as a `db/retention_policy` in v1. A `table` is equivalent to a `measurement`, which has columns that can be of type `tag` (a string dictionary), `int64`, `float64`, `uint64`, `bool`, or `string` and finally every table has a `time` column that is a nanosecond precision timestamp.
15+
The {{% product-name %}} server contains logical databases; databases contain
16+
tables; and tables are comprised of columns.
3417

35-
In InfluxDB 3, every table has a primary key--the ordered set of tags and the time--for its data.
36-
This is the sort order used for all Parquet files that get created. When you create a table, either through an explicit call or by writing data into a table for the first time, it sets the primary key to the tags in the order they arrived. This is immutable. Although InfluxDB is still a _schema-on-write_ database, the tag column definitions for a table are immutable.
18+
Compared to previous versions of InfluxDB, you can think of a database as an
19+
InfluxDB v2 `bucket` in v2 or an InfluxDB v1 `db/retention_policy`.
20+
A `table` is equivalent to an InfluxDB v1 and v2 `measurement`.
3721

38-
Tags should hold unique identifying information like `sensor_id`, or `building_id` or `trace_id`. All other data should be kept in fields. You will be able to add fast last N value and distinct value lookups later for any column, whether it is a field or a tag.
22+
Columns in a table represent time, tags, and fields. Columns can be one of the
23+
following types:
3924

40-
### Tools to use
25+
- String dictionary (tag)
26+
- `int64` (field)
27+
- `float64` (field)
28+
- `uint64` (field)
29+
- `bool` (field)
30+
- `string` (field)
31+
- `time` (time with nanosecond precision)
4132

42-
The following table compares tools that you can use to interact with {{% product-name %}}.
43-
This tutorial covers many of the recommended tools.
33+
In {{% product-name %}}, every table has a primary key--the ordered set of tags and the time--for its data.
34+
The primary key uniquely identifies each and determines the sort order for all
35+
Parquet files related to the table. When you create a table, either through an
36+
explicit call or by writing data into a table for the first time, it sets the
37+
primary key to the tags in the order they arrived.
38+
Although InfluxDB is still a _schema-on-write_ database, the tag column
39+
definitions for a table are immutable.
4440

45-
| Tool | Administration | Write | Query |
46-
| :------------------------------------------------------------------------------------------------ | :----------------------: | :----------------------: | :----------------------: |
47-
| **`influxdb3` CLI** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
48-
| **InfluxDB HTTP API** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
49-
| **InfluxDB 3 Explorer** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | - | **{{< icon "check" >}}** |
50-
| [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
51-
| [InfluxDB v2 client libraries](/influxdb3/version/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - |
52-
| [InfluxDB v1 client libraries](/influxdb3/version/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
53-
| [InfluxDB 3 processing engine](#python-plugins-and-the-processing-engine){{< req text="\* " color="magenta" >}} | | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
54-
| [Telegraf](/telegraf/v1/) | - | **{{< icon "check" >}}** | - |
55-
| [Chronograf](/chronograf/v1/) | - | - | - |
56-
| <span style="opacity:.5;">`influx` CLI</span> | - | - | - |
57-
| <span style="opacity:.5;">`influxctl` CLI</span> | - | - | - |
58-
| <span style="opacity:.5;">InfluxDB v2.x user interface</span> | - | - | - |
59-
| **Third-party tools** | | | |
60-
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
61-
| [Grafana](/influxdb3/version/visualize-data/grafana/) | - | - | **{{< icon "check" >}}** |
41+
Tags should hold unique identifying information like `sensor_id`, `building_id`,
42+
or `trace_id`. All other data should be stored as fields.
6243

63-
{{< caption >}}
64-
{{< req type="key" text="Covered in this guide" color="magenta" >}}
65-
{{< /caption >}}
44+
## Tools to use
45+
46+
The following table compares tools that you can use to interact with {{% product-name %}}.
47+
This tutorial covers many of the recommended tools.
6648

49+
| Tool | Administration | Write | Query |
50+
| :-------------------------------------------------------------------------------- | :----------------------: | :----------------------: | :----------------------: |
51+
| **[`influxdb3` CLI](/influxdb3/version/reference/cli/influxdb3/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
52+
| **[InfluxDB HTTP API](/influxdb3/version/reference/api/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
53+
| **[InfluxDB 3 Explorer](/influxdb3/explorer/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
54+
| [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
55+
| [InfluxDB v2 client libraries](/influxdb3/version/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - |
56+
| [InfluxDB v1 client libraries](/influxdb3/version/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
57+
| [InfluxDB 3 processing engine](#python-plugins-and-the-processing-engine) | | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
58+
| [Telegraf](/telegraf/v1/) | - | **{{< icon "check" >}}** | - |
59+
| [Chronograf](/chronograf/v1/) | - | - | - |
60+
| <span style="opacity:.5;">`influx` CLI</span> | - | - | - |
61+
| <span style="opacity:.5;">`influxctl` CLI</span> | - | - | - |
62+
| <span style="opacity:.5;">InfluxDB v2.x user interface</span> | - | - | - |
63+
| **Third-party tools** | | | |
64+
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
65+
| [Grafana](/influxdb3/version/visualize-data/grafana/) | - | - | **{{< icon "check" >}}** |
6766

6867
{{< show-in "core" >}}
6968
{{< page-nav next="/influxdb3/core/get-started/setup/" nextText="Set up InfluxDB 3 Core" >}}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ curl -O https://www.influxdata.com/d/install_influxdb3.sh \
2626
For detailed installation instructions, including for Windows and Docker,
2727
see [Install {{% product-name %}}](/influxdb3/version/install/).
2828

29+
{{% show-in "enterprise" %}}
30+
> [!Note]
31+
> For information about setting up a multi-node {{% product-name %}} cluster,
32+
> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/).
33+
{{% /show-in %}}
34+
2935
You can also download and install [{{% product-name %}} build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries) directly:
3036

3137
{{< expand-wrapper >}}

0 commit comments

Comments
 (0)