V3 summarize tools (#5191)
* feat(v3): add table summarizing tools for each platform * Update content/influxdb/cloud-dedicated/get-started/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/clustered/get-started/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>pull/5192/head
parent
008aeb21e6
commit
4f838adb38
|
@ -10,9 +10,9 @@ weight: 3
|
|||
influxdb/cloud-dedicated/tags: [get-started]
|
||||
---
|
||||
|
||||
InfluxDB Cloud Dedicated is the platform purpose-built to collect, store, and
|
||||
{{% product-name %}} is the platform purpose-built to collect, store, and
|
||||
query time series data.
|
||||
It is powered by the InfluxDB IOx storage engine which provides a number of
|
||||
It is powered by the InfluxDB 3.0 storage engine which provides a number of
|
||||
benefits including nearly unlimited series cardinality, improved query performance,
|
||||
and interoperability with widely used data processing tools and platforms.
|
||||
|
||||
|
@ -28,8 +28,8 @@ Examples of time series data include:
|
|||
- Rainfall measurements
|
||||
- Stock prices
|
||||
|
||||
This multi-part tutorial walks you through writing time series data to
|
||||
your dedicated InfluxDB Cloud cluster, querying, and then visualizing that data.
|
||||
This multi-part tutorial walks you through writing time series data to {{% product-name %}},
|
||||
querying, and then visualizing that data.
|
||||
|
||||
## Key concepts before you get started
|
||||
|
||||
|
@ -43,8 +43,10 @@ throughout this documentation.
|
|||
|
||||
### Data organization
|
||||
|
||||
The InfluxDB Cloud Dedicated data model organizes time series data into databases
|
||||
and measurements. A database can contain multiple measurements.
|
||||
The {{% product-name %}} data model organizes time series data into databases
|
||||
and measurements.
|
||||
|
||||
A database can contain multiple measurements.
|
||||
Measurements contain multiple tags and fields.
|
||||
|
||||
- **Database**: Named location where time series data is stored.
|
||||
|
@ -86,24 +88,65 @@ The following definitions are important to understand when using InfluxDB:
|
|||
|
||||
## Tools to use
|
||||
|
||||
Throughout this tutorial, there are multiple tools you can use to manage and
|
||||
interact with your InfluxDB Cloud Dedicated cluster.
|
||||
Examples are provided for each of the following:
|
||||
The following table compares tools that you can use to interact with {{% product-name %}}.
|
||||
This tutorial covers many of the recommended tools.
|
||||
|
||||
<!-- TODO: Define tooling -->
|
||||
| Tool | Administration | Write | Query |
|
||||
|:--------------------------------- |:---------------:|:-------:|:-------:|
|
||||
| [Chronograf](/chronograf/v1/) | - | - | **{{< icon "check" >}}** |
|
||||
| <span style="color:gray">`influx` CLI</span> | - | - | - |
|
||||
| [`influx3` data CLI](#influx3-data-cli){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [`influxctl` admin CLI](#influxctl-admin-cli) | **{{< icon "check" >}}** | - | - |
|
||||
| [InfluxDB HTTP API](#influxdb-http-api) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| <span style="color:gray">InfluxDB user interface</span> | - | - | - |
|
||||
| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v1 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v2 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v2/) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - |
|
||||
| Telegraf | - | **{{< icon "check" >}}** | - |
|
||||
| **Third-party tools** |
|
||||
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
|
||||
| [Grafana](/influxdb/cloud-dedicated/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Superset](/influxdb/cloud-dedicated/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Tableau](/influxdb/cloud-dedicated/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** |
|
||||
|
||||
{{% note %}}
|
||||
#### InfluxDB client libraries
|
||||
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
|
||||
|
||||
[InfluxDB v1 and v2 client libraries](/influxdb/cloud/api-guide/client-libraries/)
|
||||
are language-specific clients that interact with the InfluxDB HTTP v1 and v2 API.
|
||||
Examples for client libraries are not provided in this tutorial, but these can
|
||||
be used to perform actions outlined in this tutorial.
|
||||
{{% /note %}}
|
||||
{{% warn %}}
|
||||
Avoid using the `influx` CLI with {{% product-name %}}.
|
||||
While it may coincidentally work, it isn't supported.
|
||||
{{% /warn %}}
|
||||
|
||||
### `influxctl` admin CLI
|
||||
|
||||
The [`influxctl` command line interface (CLI)](/influxdb/cloud-dedicated/reference/cli/influxctl/) performs administrative tasks, such as managing databases and authorization tokens in a cluster.
|
||||
|
||||
### `influx3` data CLI
|
||||
|
||||
The [`influx3` data CLI](/influxdb/cloud-dedicated/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line.
|
||||
It uses the HTTP API to write data and uses Flight gRPC to query data.
|
||||
|
||||
### InfluxDB HTTP API
|
||||
|
||||
The [InfluxDB HTTP API](/influxdb/v2/reference/api/) provides a simple way to let you manage {{% product-name %}} and write and query data using HTTP(S) clients.
|
||||
Examples in this tutorial use cURL, but any HTTP(S) client will work.
|
||||
|
||||
The `/write` and `/query` v1-compatible endpoints work with the username/password authentication schemes and existing InfluxDB 1.x tools and code.
|
||||
The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB 2.x tools and code.
|
||||
|
||||
### InfluxDB client libraries
|
||||
|
||||
InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs.
|
||||
|
||||
[InfluxDB v3 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}.
|
||||
They use the HTTP API to write data and use Flight gRPC to query data.
|
||||
|
||||
[InfluxDB v2 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}.
|
||||
|
||||
[InfluxDB v1 client libraries](/influxdb/cloud-dedicated/reference/client-libraries/v1/) can write data to {{% product-name %}}.
|
||||
|
||||
## Authorization
|
||||
|
||||
**InfluxDB Cloud Dedicated requires authentication** using
|
||||
**{{% product-name %}} requires authentication** using
|
||||
[tokens](/influxdb/cloud-dedicated/admin/tokens/).
|
||||
|
||||
There are two types of tokens:
|
||||
|
@ -111,8 +154,8 @@ There are two types of tokens:
|
|||
- **Database token**: A token that grants read and write access to InfluxDB
|
||||
databases.
|
||||
- **Management token**: A short-lived (1 hour) [Auth0 token](#) used to
|
||||
administer your InfluxDB Cloud Dedicated cluster.
|
||||
These are generated by the `influxctl` and do not require any direct management.
|
||||
administer your InfluxDB cluster.
|
||||
These are generated by the `influxctl` CLI and do not require any direct management.
|
||||
Management tokens authorize a user to perform tasks related to:
|
||||
|
||||
- Account management
|
||||
|
@ -120,5 +163,4 @@ There are two types of tokens:
|
|||
- Database token management
|
||||
- Pricing
|
||||
<!-- - Infrastructure management -->
|
||||
|
||||
{{< page-nav next="/influxdb/cloud-dedicated/get-started/setup/" >}}
|
||||
|
|
|
@ -52,6 +52,13 @@ The examples in this section of the tutorial query the
|
|||
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/)
|
||||
- [Chronograf](/chronograf/v1/)
|
||||
|
||||
{{% warn %}}
|
||||
#### /api/v2/query not supported
|
||||
|
||||
The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.
|
||||
|
||||
{{% /warn %}}
|
||||
|
||||
## SQL query basics
|
||||
|
||||
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
|
|
|
@ -12,7 +12,7 @@ influxdb/cloud-serverless/tags: [get-started]
|
|||
|
||||
InfluxDB {{< current-version >}} is the platform purpose-built to collect, store,
|
||||
process and visualize time series data.
|
||||
The InfluxDB IOx storage engine provides a number of benefits including nearly
|
||||
The InfluxDB v3.0 storage engine provides a number of benefits including nearly
|
||||
unlimited series cardinality, improved query performance, and interoperability
|
||||
with widely used data processing tools and platforms.
|
||||
|
||||
|
@ -43,7 +43,7 @@ throughout this documentation.
|
|||
|
||||
### Data organization
|
||||
|
||||
The InfluxDB data model organizes time series data into buckets and measurements.
|
||||
The {{% product-name %}} data model organizes time series data into buckets and measurements.
|
||||
A bucket can contain multiple measurements. Measurements contain multiple
|
||||
tags and fields.
|
||||
|
||||
|
@ -89,42 +89,77 @@ The following definitions are important to understand when using InfluxDB:
|
|||
|
||||
## Tools to use
|
||||
|
||||
Throughout this tutorial, there are multiple tools you can use to interact with
|
||||
InfluxDB {{< current-version >}}. Examples are provided for each of the following:
|
||||
The following table compares tools that you can use to interact with {{% product-name %}}.
|
||||
This tutorial covers many of the recommended tools.
|
||||
|
||||
- [InfluxDB user interface](#influxdb-user-interface)
|
||||
- [`influx` CLI](#influx-cli)
|
||||
- [InfluxDB HTTP API](#influxdb-http-api)
|
||||
| Tool | Administration | Write | Query |
|
||||
|:--------------------------------- |:---------------:|:-------:|:-------:|
|
||||
| [Chronograf](/chronograf/v1/) | - | - | **{{< icon "check" >}}** |
|
||||
| [`influx` CLI](#influx-cli) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - |
|
||||
| [`influx3` data CLI](#influx3-data-cli){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| <span style="color:gray">`influxctl` CLI</span> | - | - | - |
|
||||
| [InfluxDB HTTP API](#influxdb-http-api) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB user interface](#influxdb-user-interface) {{< req text="\* " color="magenta" >}} | **{{< icon "check" >}}** | - | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v1 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v2 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v2/) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - |
|
||||
| Telegraf | - | **{{< icon "check" >}}** | - |
|
||||
| **Third-party tools** |
|
||||
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
|
||||
| [Grafana](/influxdb/cloud-serverless/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Superset](/influxdb/cloud-serverless/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Tableau](/influxdb/cloud-serverless/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** |
|
||||
|
||||
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
The `influxctl` admin CLI isn't available for {{% product-name %}}.
|
||||
It only works with InfluxDB Cloud Dedicated and InfluxDB Clustered.
|
||||
|
||||
{{% /warn %}}
|
||||
|
||||
### InfluxDB user interface
|
||||
|
||||
The InfluxDB user interface (UI) provides a web-based visual interface for interacting with and managing InfluxDB.
|
||||
To access the InfluxDB Cloud Serverless UI, [log into your InfluxDB Cloud account](https://cloud2.influxdata.com).
|
||||
To access the {{% product-name %}} UI, [log into your InfluxDB Cloud account](https://cloud2.influxdata.com).
|
||||
|
||||
### `influx` CLI
|
||||
|
||||
The `influx` CLI lets you interact with and manage InfluxDB Cloud Serverless from a command line.
|
||||
The `influx` CLI lets you manage {{% product-name %}} and write data from a command line.
|
||||
Querying {{% product-name %}} isn't supported.
|
||||
|
||||
For detailed CLI installation instructions, see
|
||||
the [`influx` CLI reference](/influxdb/cloud-serverless/reference/cli/influx/).
|
||||
|
||||
### `influx3` data CLI
|
||||
|
||||
The [`influx3` data CLI](/influxdb/cloud-serverless/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line.
|
||||
It uses the HTTP API to write data and uses Flight gRPC to query data.
|
||||
|
||||
### InfluxDB HTTP API
|
||||
|
||||
The [InfluxDB API](/influxdb/v2/reference/api/) provides a simple way to
|
||||
interact with the InfluxDB {{< current-version >}} using HTTP(S) clients.
|
||||
The [InfluxDB HTTP API](/influxdb/v2/reference/api/) provides a simple way to let you manage {{% product-name %}} and write and query data using HTTP(S) clients.
|
||||
Examples in this tutorial use cURL, but any HTTP(S) client will work.
|
||||
|
||||
{{% note %}}
|
||||
#### InfluxDB client libraries
|
||||
The `/write` and `/query` v1-compatible endpoints work with the username/password authentication schemes and existing InfluxDB 1.x tools and code.
|
||||
The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB 2.x tools and code.
|
||||
|
||||
[InfluxDB client libraries](/influxdb/v2/api-guide/client-libraries/) are
|
||||
language-specific clients that interact with the InfluxDB HTTP API.
|
||||
Examples for client libraries are not provided in this tutorial, but these can
|
||||
be used to perform all the actions outlined in this tutorial.
|
||||
{{% /note %}}
|
||||
### InfluxDB client libraries
|
||||
|
||||
InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs.
|
||||
|
||||
[InfluxDB v3 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}.
|
||||
They use the HTTP API to write data and use Flight gRPC to query data.
|
||||
|
||||
[InfluxDB v2 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}.
|
||||
|
||||
[InfluxDB v1 client libraries](/influxdb/cloud-serverless/reference/client-libraries/v1/) can write data to {{% product-name %}}.
|
||||
|
||||
## Authorization
|
||||
|
||||
**InfluxDB {{< current-version >}} requires authentication** using [API tokens](/influxdb/v2/security/tokens/).
|
||||
**{{% product-name %}} requires authentication** using [API tokens](/influxdb/cloud-serverless/admin/tokens/).
|
||||
Each API token is associated with a user and a specific set of permissions for InfluxDB resources.
|
||||
You can use administration tools such as the InfluxDB UI, the `influx` CLI, or the InfluxDB HTTP API to create and manage API tokens.
|
||||
|
||||
{{< page-nav next="/influxdb/cloud-serverless/get-started/setup/" >}}
|
||||
|
|
|
@ -53,6 +53,14 @@ The examples in this section of the tutorial query the [**get-started** bucket](
|
|||
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/cloud-serverless/query-data/execute-queries/influxdb-v1-api/)
|
||||
- [Chronograf](/chronograf/v1/)
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
#### Avoid using /api/v2/query
|
||||
|
||||
Avoid using the `/api/v2/query` API endpoint and associated tooling, such as the `influx query` CLI command and InfluxDB v2 client libraries, with {{% product-name %}}.
|
||||
|
||||
{{% /warn %}}
|
||||
|
||||
## SQL query basics
|
||||
|
||||
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
|
@ -171,9 +179,18 @@ Get started with one of the following tools for querying data stored in an {{% p
|
|||
|
||||
- **InfluxDB UI**: View your schema, build queries using the query editor, and generate data visualizations.
|
||||
- **InfluxDB v3 client libraries**: Use language-specific (Python, Go, etc.) clients to execute queries in your terminal or custom code.
|
||||
- **influx3 CLI**: Send queries from your terminal command-line.
|
||||
- **influx3 data CLI**: Send queries from your terminal command-line.
|
||||
- **Grafana**: Use the [FlightSQL Data Source plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/), to query, connect, and visualize data.
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
#### Avoid using /api/v2/query
|
||||
|
||||
Avoid using the `/api/v2/query` API endpoint in {{% product-name %}} and associated tooling, such as the `influx query` CLI command and InfluxDB v2 client libraries.
|
||||
You can't use SQL or InfluxQL with these tools.
|
||||
|
||||
{{% /warn %}}
|
||||
|
||||
For this example, use the following query to select all the data written to the
|
||||
**get-started** bucket between
|
||||
{{% influxdb/custom-timestamps-span %}}
|
||||
|
|
|
@ -10,7 +10,7 @@ weight: 3
|
|||
influxdb/clustered/tags: [get-started]
|
||||
---
|
||||
|
||||
InfluxDB Clustered is a highly available InfluxDB 3.0 cluster hosted and
|
||||
{{% product-name %}} is a highly available InfluxDB cluster hosted and
|
||||
managed on your own infrastructure and is the platform purpose-built to collect,
|
||||
store, and query time series data.
|
||||
It is powered by the InfluxDB 3.0 storage engine which provides a number of
|
||||
|
@ -44,8 +44,10 @@ throughout this documentation.
|
|||
|
||||
### Data organization
|
||||
|
||||
The InfluxDB Clustered data model organizes time series data into databases
|
||||
and measurements. A database can contain multiple measurements.
|
||||
The {{% product-name %}} data model organizes time series data into databases
|
||||
and measurements.
|
||||
|
||||
A database can contain multiple measurements.
|
||||
Measurements contain multiple tags and fields.
|
||||
|
||||
- **Database**: Named location where time series data is stored.
|
||||
|
@ -87,24 +89,65 @@ The following definitions are important to understand when using InfluxDB:
|
|||
|
||||
## Tools to use
|
||||
|
||||
Throughout this tutorial, there are multiple tools you can use to manage and
|
||||
interact with your InfluxDB cluster.
|
||||
Examples are provided for each of the following:
|
||||
The following table compares tools that you can use to interact with {{% product-name %}}.
|
||||
This tutorial covers many of the recommended tools.
|
||||
|
||||
<!-- TODO: Define tooling -->
|
||||
| Tool | Administration | Write | Query |
|
||||
|:--------------------------------- |:---------------:|:-------:|:-------:|
|
||||
| [Chronograf](/chronograf/v1/) | - | - | **{{< icon "check" >}}** |
|
||||
| <span style="color:gray">`influx` CLI</span> | - | - | - |
|
||||
| [`influx3` data CLI](#influx3-data-cli){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [`influxctl` admin CLI](#influxctl-admin-cli) | **{{< icon "check" >}}** | - | - |
|
||||
| [InfluxDB HTTP API](#influxdb-http-api) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| <span style="color:gray">InfluxDB user interface</span> | - | - | - |
|
||||
| [InfluxDB v3 client libraries](#influxdb-v3-client-libraries){{< req text="\* " color="magenta" >}} | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v1 client libraries](/influxdb/clustered/reference/client-libraries/v1/) | - | **{{< icon "check" >}}** | **{{< icon "check" >}}** |
|
||||
| [InfluxDB v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) | **{{< icon "check" >}}** | **{{< icon "check" >}}** | - |
|
||||
| Telegraf | - | **{{< icon "check" >}}** | - |
|
||||
| **Third-party tools** |
|
||||
| Flight SQL clients | - | - | **{{< icon "check" >}}** |
|
||||
| [Grafana](/influxdb/clustered/query-data/sql/execute-queries/grafana/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Superset](/influxdb/clustered/query-data/sql/execute-queries/superset/) | - | - | **{{< icon "check" >}}** |
|
||||
| [Tableau](/influxdb/clustered/process-data/visualize/tableau/) | - | - | **{{< icon "check" >}}** |
|
||||
|
||||
{{% note %}}
|
||||
#### InfluxDB client libraries
|
||||
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
|
||||
|
||||
[InfluxDB v1 and v2 client libraries](/influxdb/cloud/api-guide/client-libraries/)
|
||||
are language-specific clients that interact with the InfluxDB HTTP v1 and v2 API.
|
||||
Examples for client libraries are not provided in this tutorial, but these can
|
||||
be used to perform actions outlined in this tutorial.
|
||||
{{% /note %}}
|
||||
{{% warn %}}
|
||||
Avoid using the `influx` CLI with {{% product-name %}}.
|
||||
While it may coincidentally work, it isn't supported.
|
||||
{{% /warn %}}
|
||||
|
||||
### `influxctl` admin CLI
|
||||
|
||||
The [`influxctl` command line interface (CLI)](/influxdb/cloud-dedicated/reference/cli/influxctl/) performs administrative tasks, such as managing databases and authorization tokens in a cluster.
|
||||
|
||||
### `influx3` data CLI
|
||||
|
||||
The [`influx3` data CLI](/influxdb/clustered/get-started/query/?t=influx3+CLI#execute-an-sql-query) is a community-maintained tool that lets you write and query data in {{% product-name %}} from a command line.
|
||||
It uses the HTTP API to write data and uses Flight gRPC to query data.
|
||||
|
||||
### InfluxDB HTTP API
|
||||
|
||||
The [InfluxDB HTTP API](/influxdb/v2/reference/api/) provides a simple way to let you manage {{% product-name %}} and write and query data using HTTP(S) clients.
|
||||
Examples in this tutorial use cURL, but any HTTP(S) client will work.
|
||||
|
||||
The `/write` and `/query` v1-compatible endpoints work with the username/password authentication schemes and existing InfluxDB 1.x tools and code.
|
||||
The `/api/v2/write` v2-compatible endpoint works with existing InfluxDB 2.x tools and code.
|
||||
|
||||
### InfluxDB client libraries
|
||||
|
||||
InfluxDB client libraries are community-maintained, language-specific clients that interact with InfluxDB APIs.
|
||||
|
||||
[InfluxDB v3 client libraries](/influxdb/clustered/reference/client-libraries/v3/) are the recommended client libraries for writing and querying data {{% product-name %}}.
|
||||
They use the HTTP API to write data and use Flight gRPC to query data.
|
||||
|
||||
[InfluxDB v2 client libraries](/influxdb/clustered/reference/client-libraries/v2/) can use `/api/v2` HTTP endpoints to manage resources such as buckets and API tokens, and write data in {{% product-name %}}.
|
||||
|
||||
[InfluxDB v1 client libraries](/influxdb/clustered/reference/client-libraries/v1/) can write data to {{% product-name %}}.
|
||||
|
||||
## Authorization
|
||||
|
||||
**InfluxDB Clustered requires authentication** using
|
||||
**{{% product-name %}} requires authentication** using
|
||||
[tokens](/influxdb/clustered/admin/tokens/).
|
||||
|
||||
There are two types of tokens:
|
||||
|
@ -113,7 +156,7 @@ There are two types of tokens:
|
|||
databases.
|
||||
- **Management token**: A short-lived (1 hour) [Auth0 token](#) used to
|
||||
administer your InfluxDB cluster.
|
||||
These are generated by the `influxctl` and do not require any direct management.
|
||||
These are generated by the `influxctl` CLI and do not require any direct management.
|
||||
Management tokens authorize a user to perform tasks related to:
|
||||
|
||||
- Account management
|
||||
|
|
|
@ -52,6 +52,15 @@ The examples in this section of the tutorial query the
|
|||
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb/clustered/query-data/execute-queries/influxdb-v1-api/)
|
||||
- [Chronograf](/chronograf/v1/)
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
#### /api/v2/query not supported
|
||||
|
||||
The InfluxDB API `/api/v2/query` endpoint can't query an {{% product-name omit=" Clustered" %}} cluster.
|
||||
The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.
|
||||
|
||||
{{% /warn %}}
|
||||
|
||||
## SQL query basics
|
||||
|
||||
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
|
||||
|
|
Loading…
Reference in New Issue