diff --git a/content/v2.0/reference/flux/stdlib/experimental/_index.md b/content/v2.0/reference/flux/stdlib/experimental/_index.md index 3b08a4d3e..678830f89 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/_index.md +++ b/content/v2.0/reference/flux/stdlib/experimental/_index.md @@ -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" >}} diff --git a/content/v2.0/reference/flux/stdlib/experimental/addduration.md b/content/v2.0/reference/flux/stdlib/experimental/addduration.md index dd85ca4c0..656e796c2 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/addduration.md +++ b/content/v2.0/reference/flux/stdlib/experimental/addduration.md @@ -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 %}} diff --git a/content/v2.0/reference/flux/stdlib/experimental/bigtable/_index.md b/content/v2.0/reference/flux/stdlib/experimental/bigtable/_index.md index b046221c9..73fa1244d 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/bigtable/_index.md +++ b/content/v2.0/reference/flux/stdlib/experimental/bigtable/_index.md @@ -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: diff --git a/content/v2.0/reference/flux/stdlib/experimental/bigtable/from.md b/content/v2.0/reference/flux/stdlib/experimental/bigtable/from.md index cc7fa15e2..af10c5e2b 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/bigtable/from.md +++ b/content/v2.0/reference/flux/stdlib/experimental/bigtable/from.md @@ -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 diff --git a/content/v2.0/reference/flux/stdlib/experimental/group.md b/content/v2.0/reference/flux/stdlib/experimental/group.md index e20bfc7b2..69c73889c 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/group.md +++ b/content/v2.0/reference/flux/stdlib/experimental/group.md @@ -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 %}} diff --git a/content/v2.0/reference/flux/stdlib/experimental/mqtt/_index.md b/content/v2.0/reference/flux/stdlib/experimental/mqtt/_index.md index 79441f15d..2b80764d6 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/mqtt/_index.md +++ b/content/v2.0/reference/flux/stdlib/experimental/mqtt/_index.md @@ -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: diff --git a/content/v2.0/reference/flux/stdlib/experimental/mqtt/to.md b/content/v2.0/reference/flux/stdlib/experimental/mqtt/to.md index 3610a332b..8b55904da 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/mqtt/to.md +++ b/content/v2.0/reference/flux/stdlib/experimental/mqtt/to.md @@ -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 diff --git a/content/v2.0/reference/flux/stdlib/experimental/objectkeys.md b/content/v2.0/reference/flux/stdlib/experimental/objectkeys.md index 3b5229298..a40b5dd02 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/objectkeys.md +++ b/content/v2.0/reference/flux/stdlib/experimental/objectkeys.md @@ -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 diff --git a/content/v2.0/reference/flux/stdlib/experimental/set.md b/content/v2.0/reference/flux/stdlib/experimental/set.md index c9f6d6f11..33c6ce380 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/set.md +++ b/content/v2.0/reference/flux/stdlib/experimental/set.md @@ -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 diff --git a/content/v2.0/reference/flux/stdlib/experimental/subduration.md b/content/v2.0/reference/flux/stdlib/experimental/subduration.md index 617d2b761..060227568 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/subduration.md +++ b/content/v2.0/reference/flux/stdlib/experimental/subduration.md @@ -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 %}} diff --git a/content/v2.0/reference/flux/stdlib/experimental/to.md b/content/v2.0/reference/flux/stdlib/experimental/to.md index f0863da89..2eece5f3d 100644 --- a/content/v2.0/reference/flux/stdlib/experimental/to.md +++ b/content/v2.0/reference/flux/stdlib/experimental/to.md @@ -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