update getting started landing page
Scott Anderson
parent
4d22388bd9
commit
7caa21164d
|
|
@ -1,26 +1,8 @@
|
|||
|
||||
This guide walks through the basic steps of getting started with {{% product-name %}},
|
||||
including the following:
|
||||
|
||||
### What's in this guide
|
||||
|
||||
{{% show-in "enterprise" %}}
|
||||
This guide covers Enterprise as well as InfluxDB 3 Core, including the following topics:
|
||||
{{% /show-in %}}
|
||||
{{% show-in "core" %}}
|
||||
This guide covers InfluxDB 3 Core (the open source release), including the following topics:
|
||||
{{% /show-in %}}
|
||||
|
||||
- [Install and startup](#install-and-startup)
|
||||
- [Authentication and authorization](#authentication-and-authorization)
|
||||
- [Data Model](#data-model)
|
||||
- [Tools to use](#tools-to-use)
|
||||
- [Write data](#write-data)
|
||||
- [Query data](#query-data)
|
||||
- [Last values cache](#last-values-cache)
|
||||
- [Distinct values cache](#distinct-values-cache)
|
||||
- [Python plugins and the processing engine](#python-plugins-and-the-processing-engine)
|
||||
{{% show-in "enterprise" %}}
|
||||
- [Multi-server setups](#multi-server-setup)
|
||||
{{% /show-in %}}
|
||||
{{< children type="ordered-list" >}}
|
||||
|
||||
> [!Tip]
|
||||
> #### Find support for {{% product-name %}}
|
||||
|
|
@ -28,42 +10,59 @@ This guide covers InfluxDB 3 Core (the open source release), including the follo
|
|||
> The [InfluxDB Discord server](https://discord.gg/9zaNCW2PRT) is the best place to find support for {{% product-name %}}.
|
||||
> For other InfluxDB versions, see the [Support and feedback](#bug-reports-and-feedback) options.
|
||||
|
||||
### Data model
|
||||
## Data model
|
||||
|
||||
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.
|
||||
The {{% product-name %}} server contains logical databases; databases contain
|
||||
tables; and tables are comprised of columns.
|
||||
|
||||
In InfluxDB 3, every table has a primary key--the ordered set of tags and the time--for its data.
|
||||
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.
|
||||
Compared to previous versions of InfluxDB, you can think of a database as an
|
||||
InfluxDB v2 `bucket` in v2 or an InfluxDB v1 `db/retention_policy`.
|
||||
A `table` is equivalent to an InfluxDB v1 and v2 `measurement`.
|
||||
|
||||
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.
|
||||
Columns in a table represent time, tags, and fields. Columns can be one of the
|
||||
following types:
|
||||
|
||||
### Tools to use
|
||||
- String dictionary (tag)
|
||||
- `int64` (field)
|
||||
- `float64` (field)
|
||||
- `uint64` (field)
|
||||
- `bool` (field)
|
||||
- `string` (field)
|
||||
- `time` (time with nanosecond precision)
|
||||
|
||||
In {{% product-name %}}, every table has a primary key--the ordered set of tags and the time--for its data.
|
||||
The primary key uniquely identifies each and determines the sort order for all
|
||||
Parquet files related to the table. 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.
|
||||
Although InfluxDB is still a _schema-on-write_ database, the tag column
|
||||
definitions for a table are immutable.
|
||||
|
||||
Tags should hold unique identifying information like `sensor_id`, `building_id`,
|
||||
or `trace_id`. All other data should be stored as fields.
|
||||
|
||||
## Tools to use
|
||||
|
||||
The following table compares tools that you can use to interact with {{% product-name %}}.
|
||||
This tutorial covers many of the recommended tools.
|
||||
|
||||
| Tool | Administration | Write | Query |
|
||||
| :------------------------------------------------------------------------------------------------ | :----------------------: | :----------------------: | :----------------------: |
|
||||
| **`influxdb3` CLI** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| **InfluxDB HTTP API** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| **InfluxDB 3 Explorer** {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | - | **{{< icon "check" >}}** |
|
||||
| [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v2 client libraries](/influxdb3/version/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - |
|
||||
| [InfluxDB v1 client libraries](/influxdb3/version/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB 3 processing engine](#python-plugins-and-the-processing-engine){{< req text="\* " color="magenta" >}} | | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [Telegraf](/telegraf/v1/) | - | **{{< icon "check" >}}** | - |
|
||||
| [Chronograf](/chronograf/v1/) | - | - | - |
|
||||
| <span style="opacity:.5;">`influx` CLI</span> | - | - | - |
|
||||
| <span style="opacity:.5;">`influxctl` CLI</span> | - | - | - |
|
||||
| <span style="opacity:.5;">InfluxDB v2.x user interface</span> | - | - | - |
|
||||
| **Third-party tools** | | | |
|
||||
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
|
||||
| [Grafana](/influxdb3/version/visualize-data/grafana/) | - | - | **{{< icon "check" >}}** |
|
||||
|
||||
{{< caption >}}
|
||||
{{< req type="key" text="Covered in this guide" color="magenta" >}}
|
||||
{{< /caption >}}
|
||||
|
||||
| Tool | Administration | Write | Query |
|
||||
| :-------------------------------------------------------------------------------- | :----------------------: | :----------------------: | :----------------------: |
|
||||
| **[`influxdb3` CLI](/influxdb3/version/reference/cli/influxdb3/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| **[InfluxDB HTTP API](/influxdb3/version/reference/api/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| **[InfluxDB 3 Explorer](/influxdb3/explorer/)** | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v2 client libraries](/influxdb3/version/reference/client-libraries/v2/) | - | **{{< icon "check" >}}** | - |
|
||||
| [InfluxDB v1 client libraries](/influxdb3/version/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB 3 processing engine](#python-plugins-and-the-processing-engine) | | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [Telegraf](/telegraf/v1/) | - | **{{< icon "check" >}}** | - |
|
||||
| [Chronograf](/chronograf/v1/) | - | - | - |
|
||||
| <span style="opacity:.5;">`influx` CLI</span> | - | - | - |
|
||||
| <span style="opacity:.5;">`influxctl` CLI</span> | - | - | - |
|
||||
| <span style="opacity:.5;">InfluxDB v2.x user interface</span> | - | - | - |
|
||||
| **Third-party tools** | | | |
|
||||
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
|
||||
| [Grafana](/influxdb3/version/visualize-data/grafana/) | - | - | **{{< icon "check" >}}** |
|
||||
|
||||
{{< show-in "core" >}}
|
||||
{{< page-nav next="/influxdb3/core/get-started/setup/" nextText="Set up InfluxDB 3 Core" >}}
|
||||
|
|
|
|||
|
|
@ -26,6 +26,12 @@ curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
|||
For detailed installation instructions, including for Windows and Docker,
|
||||
see [Install {{% product-name %}}](/influxdb3/version/install/).
|
||||
|
||||
{{% show-in "enterprise" %}}
|
||||
> [!Note]
|
||||
> For information about setting up a multi-node {{% product-name %}} cluster,
|
||||
> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/).
|
||||
{{% /show-in %}}
|
||||
|
||||
You can also download and install [{{% product-name %}} build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries) directly:
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
|
|
|
|||
Loading…
Reference in New Issue