added risks of using experimental functions with links back
parent
dfabc6fdba
commit
71d8297506
|
@ -15,11 +15,29 @@ v2.0/tags: [functions, experimental, package]
|
|||
The Flux Experimental package includes experimental functions that perform various tasks.
|
||||
|
||||
{{% warn %}}
|
||||
Experimental functions are subject to change at any time and are not recommended for production use.
|
||||
### Use experimental functions at your own risk
|
||||
Experimental functions are subject to change and are **not recommended for production use**.
|
||||
At any time, experimental functions and packages may:
|
||||
|
||||
- be moved or promoted to a permanent location
|
||||
- undergo API changes
|
||||
- stop working with no planned fixes
|
||||
- be removed without warning nor published explanation
|
||||
|
||||
**By using experimental functions and packages, you agree to these risks.**
|
||||
{{% /warn %}}
|
||||
|
||||
## Experimental functions
|
||||
The following functions are part of the base experimental package.
|
||||
To use them, import the `experimental` package.
|
||||
|
||||
```js
|
||||
import "experimental"
|
||||
```
|
||||
|
||||
{{< children type="functions" show="pages" >}}
|
||||
|
||||
## Experimental packages
|
||||
Experimental packages require different import paths than base experimental functions.
|
||||
|
||||
{{< children show="sections" >}}
|
||||
|
|
|
@ -19,6 +19,8 @@ _**Function type:** Transformation_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.addDuration()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
|
||||
This specific function will be removed once duration vectors are implemented.
|
||||
See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413).
|
||||
{{% /warn %}}
|
||||
|
|
|
@ -17,6 +17,7 @@ The Flux Bigtable package provides tools for working with data in
|
|||
|
||||
{{% warn %}}
|
||||
The Bigtable package is currently experimental and is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
Import the `experimental/bigtable` package:
|
||||
|
|
|
@ -16,6 +16,7 @@ _**Function type:** Input_
|
|||
|
||||
{{% warn %}}
|
||||
The `bigtable.from()` function is currently experimental and is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
```js
|
||||
|
|
|
@ -19,6 +19,8 @@ _**Function type:** Transformation_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.group()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
|
||||
This specific function will be removed once the proposed `extend` mode is sufficiently vetted.
|
||||
{{% /warn %}}
|
||||
|
||||
|
|
|
@ -16,6 +16,7 @@ Flux MQTT functions provide tools for working with Message Queuing Telemetry Tra
|
|||
|
||||
{{% warn %}}
|
||||
The MQTT package is currently experimental and is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
Import the `experimental/mqtt` package:
|
||||
|
|
|
@ -15,6 +15,7 @@ _**Function type:** Output_
|
|||
|
||||
{{% warn %}}
|
||||
The `mqtt.to()` function is currently experimental and is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
```js
|
||||
|
|
|
@ -15,6 +15,7 @@ _**Function type:** Transformation_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.objectKeys()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
```js
|
||||
|
|
|
@ -22,6 +22,7 @@ _**Function type:** Transformation_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.set()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
```js
|
||||
|
|
|
@ -19,6 +19,8 @@ _**Function type:** Transformation_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.subDuration()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
|
||||
This specific function will be removed once duration vectors are implemented.
|
||||
See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413).
|
||||
{{% /warn %}}
|
||||
|
|
|
@ -20,6 +20,7 @@ _**Function type:** Output_
|
|||
|
||||
{{% warn %}}
|
||||
The `experimental.to()` function is subject to change at any time.
|
||||
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
|
||||
{{% /warn %}}
|
||||
|
||||
```js
|
||||
|
|
Loading…
Reference in New Issue