docs(WIP): updating influxdb enterprise sql section

6406-grafana-configuration-outline-and-draft-documentation
meelahme 2025-10-02 10:31:10 -07:00
parent 2d3fb31e7c
commit b8ea0770cd
2 changed files with 33 additions and 39 deletions

View File

@ -10,6 +10,7 @@ Use [Grafana](https://grafana.com/) to query and visualize data from
- [Install Grafana or login to Grafana Cloud](#install-grafana-or-login-to-grafana-cloud)
- [InfluxDB data source](#influxdb-data-source)
- [Before you begin](#before-you-begin)
- [Create an InfluxDB data source](#create-an-influxdb-data-source)
- [Query InfluxDB with Grafana](#query-influxdb-with-grafana)
- [Build visualizations with Grafana](#build-visualizations-with-grafana)
@ -35,6 +36,14 @@ both SQL and InfluxQL.
> The updated plugin includes **SQL support** for InfluxDB 3-based products such
> as {{< product-name >}}, and the interface dynamically adapts based on your product and query language selections .
## Before you begin
**Prerequisites:**
- Grafana 10.3 or later
- Administrator role in Grafana
- {{% product-name %}} instance and [database token](/influxdb3/version/admin/tokens/#database-tokens)
## Create an InfluxDB data source
1. In your Grafana interface, click **Connections** in the left sidebar
@ -42,6 +51,17 @@ both SQL and InfluxQL.
3. Click **Add new data source**
4. Under **Time series databases**, select **InfluxDB**
The configuration form displays with four numbered sections. Section 2 (Database settings) displays different fields based on your query language selection.
5. **Name**: Enter a descriptive name for your data source
6. **URL**: Enter your {{% product-name %}} cluster URL: `https://{{< influxdb/host >}}`
7. **Product**: From the dropdown, select **InfluxDB Enterprise 3.x**
8. **Query Language**: Select **SQL** or **InfluxQL**
### Configure database settings
The fields in this section change based on your query language selection.
{{< tabs-wrapper >}}
{{% tabs %}}
[SQL](#)
@ -50,29 +70,12 @@ both SQL and InfluxQL.
{{% tab-content %}}
<!--------------------------------- BEGIN SQL --------------------------------->
When creating an InfluxDB data source that uses SQL to query data:
When you select **SQL** as the query language, configure the following:
1. Under **HTTP**:
- **Database**: Your [database](/influxdb3/version/admin/databases/) name
- **Token**: A [database token](/influxdb3/version/admin/tokens/#database-tokens) with read access to the database
- **URL**: Provide your {{% product-name %}} URL:
```
http://{{< influxdb/host >}}
```
> [!Note]
> If you are _not_ using HTTPS, enable the **Insecure Connection** option
> under **InfluxDB Details**.
2. Under **InfluxDB Details**:
- **Database**: Provide a default database name to query.
- **Token**: Provide an arbitrary, non-empty string.
- **Insecure Connection**: If _not_ using HTTPS, enable this option.
3. Click **Save & test**.
{{< img-hd src="/img/influxdb3/influxdb3-grafana-sql.png" alt="Grafana InfluxDB data source for InfluxDB 3 that uses SQL" />}}
{{< img-hd src="/img/influxdb3/enterprise-v3-grafana-product-dropdown-sql.png" alt="Grafana InfluxDB data source for InfluxDB 3 that uses SQL" />}}
<!---------------------------------- END SQL ---------------------------------->
{{% /tab-content %}}

View File

@ -10,6 +10,7 @@ Use [Grafana](https://grafana.com/) to query and visualize data stored in
- [Install Grafana or login to Grafana Cloud](#install-grafana-or-login-to-grafana-cloud)
- [InfluxDB data source](#influxdb-data-source)
- [Before you begin](#before-you-begin)
- [Create an InfluxDB data source](#create-an-influxdb-data-source)
- [Query InfluxDB with Grafana](#query-influxdb-with-grafana)
- [Build visualizations with Grafana](#build-visualizations-with-grafana)
@ -49,26 +50,16 @@ both InfluxQL and SQL.
3. Click **Add new data source**
4. Under **Time series databases**, click **InfluxDB**
The configuration form displays with four numbered sections. Section 2 (Database settings) displays different fields based on your query language selection.
5. **Name**: Enter a descriptive name for your data source
6. **URL**: Enter your {{% product-name %}} cluster URL: `https://{{< influxdb/host >}}`
7. **Product**: From the dropdown, select **InfluxDB Enterprise 3.x**
8. **Query Language**: Select **SQL** or **InfluxQL**
### Configure basic settings
The configuration form is organized into numbered sections. The form dynamically
adapts based on your product and query language selections.
**Configure the following:**
1. **Name**: Enter a descriptive name for your data source
2. **URL**: Enter your {{% show-in "cloud-serverless" %}}[{{< product-name >}} region URL](/influxdb3/version/reference/regions/){{% /show-in %}}{{% hide-in "cloud-serverless" %}}{{% product-name omit=" Clustered" %}} cluster URL{{% /hide-in %}}: https://{{< influxdb/host >}}
3. **Product**: From the dropdown, select:
{{% show-in "cloud-serverless" %}}**InfluxDB Cloud Serverless**{{% /show-in %}}{{% show-in "cloud-dedicated" %}}**InfluxDB Cloud Dedicated**{{% /show-in %}}{{% show-in "clustered" %}}**InfluxDB Clustered**{{% /hide-in %}}
4. **Query Language**: Select the query language for your queries
### Configure database settings
The database configuration fields change based on your product and query language
selections above. Configure the appropriate settings for your setup:
The fields in this section change based on your query language selection.
{{< tabs-wrapper >}}
{{% tabs %}}