docs(influxdb3): Use the CLI (influxdb3 --version), /ping endpoint, or /health endpoint to get the actual InfluxDB product version—not the SQL version() function. (#6579)
Summary of Changes 1. content/shared/sql-reference/functions/misc.md (SQL version() function) - Enhanced the description to clarify it returns the DataFusion query engine version - Added a Note callout explicitly stating this is NOT the InfluxDB product version - Added a link to the identify-version page for users who want to find their InfluxDB version - Added an expandable example with the actual query and output: SELECT version() - Output: Apache DataFusion 49.0.2, aarch64 on linux 2. content/shared/identify-version.md (Identify version page) Added a Note callout in three locations: - Core-specific section (show-in "core") - Enterprise-specific section (show-in "enterprise") - General InfluxDB 3 Core and Enterprise section (in the tabs) Replaced hardcoded patch version with latest-version shortcodepull/6582/head^2
parent
ec70614a4e
commit
b95e608d07
|
|
@ -70,7 +70,7 @@ curl -i http://localhost:8181/ping
|
|||
|
||||
Look for:
|
||||
|
||||
- `x-influxdb-version`: Version number (for example, `3.6.0`)
|
||||
- `x-influxdb-version`: Version number (for example, {{% latest-patch %}})
|
||||
- `x-influxdb-build`: `Core`
|
||||
|
||||
{{% /show-in %}}
|
||||
|
|
@ -99,9 +99,10 @@ curl -i http://localhost:8181/ping
|
|||
|
||||
Look for:
|
||||
|
||||
- `x-influxdb-version`: Version number (for example, `3.6.0`)
|
||||
- `x-influxdb-version`: Version number (for example, {{% latest-patch %}})
|
||||
- `x-influxdb-build`: `Enterprise`
|
||||
|
||||
|
||||
{{% /show-in %}}
|
||||
|
||||
{{% show-in "clustered" %}}
|
||||
|
|
@ -155,6 +156,17 @@ influxctl cluster list
|
|||
|
||||
{{% /show-in %}}
|
||||
|
||||
{{% hide-in "v2,cloud,v1" %}}
|
||||
> [!Note]
|
||||
>
|
||||
> #### SQL version() function
|
||||
>
|
||||
> The SQL `version()` function returns the
|
||||
> [DataFusion](https://datafusion.apache.org/) query engine version, not the
|
||||
> InfluxDB product version. Use the methods above to identify your InfluxDB
|
||||
> version.
|
||||
{{% /hide-in %}}
|
||||
|
||||
{{% show-in "v2" %}}
|
||||
|
||||
### InfluxDB OSS v2 detection
|
||||
|
|
@ -272,6 +284,15 @@ Look for:
|
|||
- `x-influxdb-version`: Version number (for example, `3.6.0`)
|
||||
- `x-influxdb-build`: `Core` or `Enterprise`
|
||||
|
||||
> [!Note]
|
||||
>
|
||||
> #### SQL version() function
|
||||
>
|
||||
> The SQL `version()` function returns the
|
||||
> [DataFusion](https://datafusion.apache.org/) query engine version, not the
|
||||
> InfluxDB product version. Use the methods above to identify your InfluxDB
|
||||
> version.
|
||||
|
||||
{{% /tab-content %}}
|
||||
|
||||
{{< /tabs-wrapper >}}
|
||||
|
|
|
|||
|
|
@ -268,8 +268,30 @@ GROUP BY _time, room
|
|||
|
||||
## version
|
||||
|
||||
Returns the version of DataFusion.
|
||||
Returns the version of [DataFusion](https://datafusion.apache.org/) used by the query engine.
|
||||
|
||||
> [!Note]
|
||||
>
|
||||
> The `version()` function returns the DataFusion query engine version, not the
|
||||
> InfluxDB product version.
|
||||
> To identify your InfluxDB version, see [Identify version](/influxdb3/version/admin/identify-version/).
|
||||
|
||||
```sql
|
||||
version()
|
||||
```
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
{{% expand "View `version` query example" %}}
|
||||
|
||||
```sql
|
||||
SELECT version()
|
||||
```
|
||||
|
||||
| version() |
|
||||
| :----------------------------------------- |
|
||||
| Apache DataFusion 49.0.2, aarch64 on linux |
|
||||
|
||||
The output includes the DataFusion version, CPU architecture, and operating system.
|
||||
|
||||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
|
|
|||
Loading…
Reference in New Issue