added mqtt and bigtable packages to experimental package

pull/469/head
Scott Anderson 2019-09-16 14:52:53 -06:00
parent 8aab6b4ece
commit d772e5096d
5 changed files with 125 additions and 9 deletions

View File

@ -0,0 +1,23 @@
---
title: Flux Experimental package
list_title: Experimental package
description: >
The Flux Experimental package includes experimental functions that perform various tasks.
Experimental functions are subject to change at any time and are not recommended for production use.
menu:
v2_0_ref:
name: Experimental
parent: Flux standard library
weight: 202
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.
{{% /warn %}}
{{< children type="functions" show="pages" >}}
{{< children >}}

View File

@ -0,0 +1,28 @@
---
title: Flux Bigtable package
list_title: Bigtable package
description: >
The Flux Bigtable package provides tools for working with data in Google Cloud Bigtable databases.
Import the `experimental/bigtable` package.
menu:
v2_0_ref:
name: Bigtable
parent: Experimental
weight: 202
v2.0/tags: [functions, bigtable, package, google]
---
The Flux Bigtable package provides tools for working with data in
[Google Cloud Bigtable](https://cloud.google.com/bigtable/) databases.
{{% warn %}}
The Bigtable package is currently experimental and is subject to change at any time.
{{% /warn %}}
Import the `experimental/bigtable` package:
```js
import "experimental/bigtable"
```
{{< children type="functions" show="pages" >}}

View File

@ -0,0 +1,58 @@
---
title: bigtable.from() function
description: >
The `bigtable.from()` function retrieves data from a Google Cloud Bigtable data source.
menu:
v2_0_ref:
name: bigtable.from
parent: Bigtable
weight: 202
---
The `bigtable.from()` function retrieves data from a [Google Cloud Bigtable](https://cloud.google.com/bigtable/)
data source.
_**Function type:** Input_
{{% warn %}}
The `bigtable.from()` function is currently experimental and is subject to change at any time.
{{% /warn %}}
```js
import "experimental/bigtable"
bigtable.from(
token: "mySuPeRseCretTokEn",
project: "exampleProjectID",
instance: "exampleInstanceID",
table: "example-table"
)
```
## Parameters
### token
The Google Cloud IAM token to use to access the Cloud Bigtable database.
_For more information, see the following:_
- [Cloud Bigtable Access Control](https://cloud.google.com/bigtable/docs/access-control)
- [Google Cloud IAM How-to guides](https://cloud.google.com/iam/docs/how-to)
- [Setting Up Authentication for Server to Server Production Applications on Google Cloud](https://cloud.google.com/docs/authentication/production)
_**Data type: String**_
### project
The project ID of the Cloud Bigtable project to retrieve data from.
_**Data type: String**_
### instance
The instance ID of the Cloud Bigtable instance to retrieve data from.
_**Data type: String**_
### table
The name of the Cloud Bigtable table to retrieve data from.
_**Data type: String**_

View File

@ -3,21 +3,25 @@ title: Flux MQTT package
list_title: MQTT package
description: >
The Flux MQTT package provides functions for working with MQTT protocol.
Import the `mqtt` package.
Import the `experimental/mqtt` package.
menu:
v2_0_ref:
name: MQTT
parent: Flux standard library
parent: Experimental
weight: 202
v2.0/tags: [functions, mqtt, package]
draft: true
---
MQTT Flux functions provide tools for working with Message Queuing Telemetry Transport (MQTT) protocol.
Import the `mqtt` package:
Flux MQTT functions provide tools for working with Message Queuing Telemetry Transport (MQTT) protocol.
{{% warn %}}
The MQTT package is currently experimental and is subject to change at any time.
{{% /warn %}}
Import the `experimental/mqtt` package:
```js
import "mqtt"
import "experimental/mqtt"
```
{{< children type="functions" show="pages" >}}

View File

@ -7,15 +7,18 @@ menu:
name: mqtt.to
parent: MQTT
weight: 202
draft: true
---
The `mqtt.to()` function outputs data to an MQTT broker using MQTT protocol.
_**Function type:** Output_
{{% warn %}}
The `mqtt.to()` function is currently experimental and is subject to change at any time.
{{% /warn %}}
```js
import "mqtt"
import "experimental/mqtt"
mqtt.to(
broker: "tcp://localhost:8883",
@ -115,7 +118,7 @@ _**Data type: Array of strings**_
### Send data to an MQTT endpoint
```js
import "mqtt"
import "experimental/mqtt"
from(bucket: "example-bucket")
|> range(start: -5m)