Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Flux v0.123 (#2880) 

* Flux 0.123.0 updates (#2878)

* add note about flux sleep function being removed

* update description of createEmpty param on aggregateWindow

* more updates to aggregateWindow

* removed aggregateWindow function definition

* Flux 0.123.0 release notes (#2877)

* Flux sample package (#2876)

* added flux influxdb sample data package

* WIP update sample data doc

* WIP sample data updates

* updated sample package and sample data instructions, closes #2845

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* updates to address PR feedback

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
pull/2881/head
Scott Anderson 2021-07-21 13:53:25 -06:00 committed by GitHub
parent 91289380e1
commit 5cc36be1e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
62 changed files with 597 additions and 470 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
assets/styles/layouts/article/_buttons.scss
View File

@ -40,4 +40,11 @@ a.btn {
margin-right: .5rem; margin-right: .5rem;
font-size: 1.1rem; font-size: 1.1rem;
} }
&.github:before {
content: "\eab0";
font-family: "icomoon";
margin-right: .5rem;
font-size: 1.1rem;
}
} }

16
assets/styles/layouts/article/_captions.scss
View File

@ -13,3 +13,19 @@
margin-top: -2.75rem; margin-top: -2.75rem;
} }
} }
p {
& + .caption {
padding: 0;
margin: -.75rem 0 0;
opacity: 1;
}
}
h2,h3,h4,h5,h6 {
& + .caption {
padding: 0;
margin: 0;
opacity: 1;
}
}

48
content/influxdb/cloud/reference/flux/stdlib/built-in/misc/sleep.md
View File

@ -3,53 +3,7 @@ title: sleep() function
description: The `sleep()` function delays execution by a specified duration. description: The `sleep()` function delays execution by a specified duration.
aliases: aliases:
- /influxdb/cloud/reference/flux/functions/built-in/misc/sleep/ - /influxdb/cloud/reference/flux/functions/built-in/misc/sleep/
menu:
influxdb_cloud_ref:
name: sleep
parent: built-in-misc
weight: 401 weight: 401
--- ---
The `sleep()` function delays execution by a specified duration. {{< duplicate-oss >}}
_**Function type:** Miscellaneous_
```js
sleep(
v: x,
duration: 10s
)
```
## Parameters
### v
Defines input tables.
`sleep()` accepts piped-forward data and passes it on unmodified after the
specified [duration](#duration).
If data is not piped-forward into `sleep()`, set `v` to specify a stream of tables.
The examples [below](#examples) illustrate how.
_**Data type:** Record_
### duration
The length of time to delay execution.
_**Data type:** Duration_
## Examples
### Delay execution in a chained query
```js
from(bucket: "example-bucket")
|> range(start: -1h)
|> sleep(duration: 10s)
```
### Delay execution using a stream variable
```js
x = from(bucket: "example-bucket")
|> range(start: -1h)
sleep(v: x, duration: 10s)
```

135
content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/aggregates/aggregatewindow.md
View File

@ -15,137 +15,4 @@ related:
- /{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-group-by-clause, InfluxQL – GROUP BY time() - /{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-group-by-clause, InfluxQL – GROUP BY time()
--- ---
The `aggregateWindow()` function applies an aggregate or selector function {{< duplicate-oss >}}
(any function with a `column` parameter) to fixed windows of time.
_**Function type:** Aggregate_
```js
aggregateWindow(
every: 1m,
fn: mean,
column: "_value",
timeSrc: "_stop",
timeDst: "_time",
createEmpty: true
)
```
As data is windowed into separate tables and processed, the `_time` column is dropped from each group key.
This function copies the timestamp from a remaining column into the `_time` column.
View the [function definition](#function-definition).
`aggregateWindow()` restores the original `_start` and `_stop` values of input data
and, by default, uses `_stop` to set the `_time` value for each aggregated window.
Each row in the output of `aggregateWindow` represents an aggregated window ending at `_time`.
## Parameters
{{% note %}}
Make sure `fn` parameter names match each specified parameter. To learn why, see [Match parameter names](/influxdb/cloud/reference/flux/language/data-model/#match-parameter-names).
{{% /note %}}
### every
The duration of windows.
{{% note %}}
#### Calendar months and years
`every` supports all [valid duration units](/influxdb/cloud/reference/flux/language/types/#duration-types),
including **calendar months (`1mo`)** and **years (`1y`)**.
{{% /note %}}
_**Data type:** Duration_
### fn
The [aggregate function](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/aggregates) used in the operation.
_**Data type:** Function_
{{% note %}}
Only aggregate and selector functions with a `column` parameter (singular) work with `aggregateWindow()`.
{{% /note %}}
### column
The column on which to operate.
Defaults to `"_value"`.
_**Data type:** String_
### timeSrc
The time column from which time is copied for the aggregate record.
Defaults to `"_stop"`.
_**Data type:** String_
### timeDst
The "time destination" column to which time is copied for the aggregate record.
Defaults to `"_time"`.
_**Data type:** String_
### createEmpty
For windows without data, this will create an empty window and fill
it with a `null` aggregate value.
Defaults to `true`.
_**Data type:** Boolean_
## Examples
The examples below use a `data` variable to represent a filtered data set.
```js
data = from(bucket: "example-bucket")
|> range(start: -1h)
|> filter(fn: (r) =>
r._measurement == "mem" and
r._field == "used_percent")
```
##### Use an aggregate function with default parameters
The following example uses the default parameters of the
[`mean()` function](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/aggregates/mean/)
to aggregate time-based windows:
```js
data
|> aggregateWindow(
every: 5m,
fn: mean
)
```
##### Specify parameters of the aggregate function
To use functions that don't provide defaults for required parameters with `aggregateWindow()`,
define an anonymous function with `column` and `tables` parameters that pipes-forward
tables into the aggregate or selector function with all required parameters defined:
```js
data
|> aggregateWindow(
column: "_value",
every: 5m,
fn: (column, tables=<-) => tables |> quantile(q: 0.99, column:column)
)
```
##### Window and aggregate by calendar month
```js
data
|> aggregateWindow(every: 1mo, fn: mean)
```
## Function definition
```js
aggregateWindow = (every, fn, column="_value", timeSrc="_stop", timeDst="_time", tables=<-) =>
tables
|> window(every:every)
|> fn(column:column)
|> duplicate(column:timeSrc, as:timeDst)
|> window(every:inf, timeColumn:timeDst)
```

16
content/influxdb/cloud/reference/flux/stdlib/influxdb-sample/_index.md Normal file
View File

@ -0,0 +1,16 @@
---
title: Flux InfluxDB sample package
list_title: InfluxDB sample package
description: >
The Flux InfluxDB sample package provides functions for downloading and outputting InfluxDB sample data.
Import the `influxdata/influxdb/sample` package.
menu:
influxdb_cloud_ref:
name: InfluxDB Sample
parent: Flux standard library
weight: 202
influxdb/v2.0/tags: [functions, sample, package]
introduced: 0.123.0
---
{{< duplicate-oss >}}

15
content/influxdb/cloud/reference/flux/stdlib/influxdb-sample/data.md Normal file
View File

@ -0,0 +1,15 @@
---
title: sample.data() function
description: >
The `sample.data()` function downloads and outputs an InfluxDB sample dataset.
menu:
influxdb_cloud_ref:
name: sample.data
parent: InfluxDB Sample
weight: 301
related:
- /influxdb/cloud/reference/sample-data/
introduced: 0.123.0
---
{{< duplicate-oss >}}

15
content/influxdb/cloud/reference/flux/stdlib/influxdb-sample/list.md Normal file
View File

@ -0,0 +1,15 @@
---
title: sample.list() function
description: >
The `sample.list()` function outputs information about available InfluxDB sample datasets.
menu:
influxdb_cloud_ref:
name: sample.list
parent: InfluxDB Sample
weight: 301
related:
- /influxdb/cloud/reference/sample-data/
introduced: 0.123.0
---
{{< duplicate-oss >}}

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/_index.md
View File

@ -8,7 +8,7 @@ aliases:
- /influxdb/cloud/reference/flux/functions/influxdb-v1/ - /influxdb/cloud/reference/flux/functions/influxdb-v1/
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: InfluxDB Schema name: InfluxDB schema
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, schema, package] influxdb/v2.0/tags: [functions, schema, package]

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/fieldkeys.md
View File

@ -4,7 +4,7 @@ description: The `schema.fieldKeys()` function returns field keys in a bucket.
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.fieldKeys name: schema.fieldKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [fields] influxdb/v2.0/tags: [fields]
aliases: aliases:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/fieldsascols.md
View File

@ -9,7 +9,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.fieldsAsCols name: schema.fieldsAsCols
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
introduced: 0.88.0 introduced: 0.88.0
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/measurementfieldkeys.md
View File

@ -4,7 +4,7 @@ description: The `schema.measurementFieldKeys()` function returns a list of fiel
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.measurementFieldKeys name: schema.measurementFieldKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [fields] influxdb/v2.0/tags: [fields]
aliases: aliases:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/measurements.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.measurements name: schema.measurements
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [measurements] influxdb/v2.0/tags: [measurements]
related: related:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/measurementtagkeys.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.measurementTagKeys name: schema.measurementTagKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/measurementtagvalues.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.measurementTagValues name: schema.measurementTagValues
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/tagkeys.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.tagKeys name: schema.tagKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-schema/tagvalues.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: schema.tagValues name: schema.tagValues
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

12
content/influxdb/cloud/reference/flux/stdlib/influxdb-tasks/_index.md
View File

@ -1,15 +1,15 @@
--- ---
title: Flux InfluxDB Tasks package title: Flux InfluxDB tasks package
list_title: InfluxDB Tasks package list_title: InfluxDB tasks package
description: > description: >
The Flux InfluxDB Tasks package provides options and functions for working with The Flux InfluxDB tasks package provides options and functions for working with
[InfluxDB tasks](/influxdb/cloud/process-data/get-started/). [InfluxDB tasks](/influxdb/cloud/process-data/get-started/).
Import the `influxdata/influxdb/tasks` package. Import the `influxdata/influxdb/tasks` package.
aliases: aliases:
- /influxdb/cloud/reference/flux/functions/influxdb-v1/ - /influxdb/cloud/reference/flux/functions/influxdb-v1/
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: InfluxDB Tasks name: InfluxDB tasks
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, tasks, package] influxdb/v2.0/tags: [functions, tasks, package]
@ -17,7 +17,7 @@ related:
- /influxdb/cloud/process-data/get-started/ - /influxdb/cloud/process-data/get-started/
--- ---
The Flux InfluxDB Tasks package provides options and functions for working with The Flux InfluxDB tasks package provides options and functions for working with
[InfluxDB tasks](/influxdb/cloud/process-data/get-started/). [InfluxDB tasks](/influxdb/cloud/process-data/get-started/).
Import the `influxdata/influxdb/tasks` package: Import the `influxdata/influxdb/tasks` package:
@ -26,7 +26,7 @@ import "influxdata/influxdb/tasks"
``` ```
## Options ## Options
The InfluxDB Tasks package provides the following options: The InfluxDB tasks package provides the following options:
#### lastSuccessTime #### lastSuccessTime
Define the time of the last successful task run. Define the time of the last successful task run.

2
content/influxdb/cloud/reference/flux/stdlib/influxdb-tasks/lastsuccess.md
View File

@ -4,7 +4,7 @@ description: The `tasks.lastSuccess()` function returns ...
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: tasks.lastSuccess name: tasks.lastSuccess
parent: InfluxDB Tasks parent: InfluxDB tasks
weight: 301 weight: 301
--- ---

6
content/influxdb/cloud/reference/flux/stdlib/monitor/_index.md
View File

@ -1,6 +1,6 @@
--- ---
title: Flux InfluxDB Monitor package title: Flux InfluxDB monitor package
list_title: InfluxDB Monitor package list_title: InfluxDB monitor package
description: > description: >
The Flux Monitor package provides tools for monitoring and alerting with InfluxDB. The Flux Monitor package provides tools for monitoring and alerting with InfluxDB.
Import the `influxdata/influxdb/monitor` package. Import the `influxdata/influxdb/monitor` package.
@ -8,7 +8,7 @@ aliases:
- /influxdb/cloud/reference/flux/functions/monitor/ - /influxdb/cloud/reference/flux/functions/monitor/
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: InfluxDB Monitor name: InfluxDB monitor
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, monitor, alerts, package] influxdb/v2.0/tags: [functions, monitor, alerts, package]

2
content/influxdb/cloud/reference/flux/stdlib/monitor/check.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.check name: monitor.check
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/deadman.md
View File

@ -7,7 +7,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.deadman name: monitor.deadman
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
cloud_all: true cloud_all: true
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/from.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.from name: monitor.from
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/logs.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.logs name: monitor.logs
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/notify.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.notify name: monitor.notify
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/statechanges.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.stateChanges name: monitor.stateChanges
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/monitor/statechangesonly.md
View File

@ -6,7 +6,7 @@ description: >
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: monitor.stateChangesOnly name: monitor.stateChangesOnly
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/cloud/reference/flux/stdlib/secrets/_index.md
View File

@ -8,7 +8,7 @@ aliases:
- /influxdb/cloud/reference/flux/functions/secrets/ - /influxdb/cloud/reference/flux/functions/secrets/
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: InfluxDB Secrets name: InfluxDB secrets
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, secrets, package] influxdb/v2.0/tags: [functions, secrets, package]

2
content/influxdb/cloud/reference/flux/stdlib/secrets/get.md
View File

@ -7,7 +7,7 @@ aliases:
menu: menu:
influxdb_cloud_ref: influxdb_cloud_ref:
name: secrets.get name: secrets.get
parent: InfluxDB Secrets parent: InfluxDB secrets
weight: 202 weight: 202
--- ---

222
content/influxdb/cloud/reference/sample-data.md
View File

@ -10,12 +10,18 @@ menu: influxdb_cloud_ref
weight: 7 weight: 7
--- ---
Use sample data to familiarize yourself with time series data and InfluxDB. Use **demo data** and **sample data** to familiarize yourself with time series data and InfluxDB Cloud.
InfluxData provides many sample time series datasets to use with **InfluxDB Cloud**. InfluxDB Cloud lets you access **Demo data buckets** that contain real-time time
series data without having to write data to InfluxDB.
Sample datasets are also available for download and can be written to InfluxDB
or loaded at query time.
- [InfluxDB Cloud demo data](#influxdb-cloud-demo-data)
- [Sample datasets](#sample-datasets)
## InfluxDB Cloud demo data ## InfluxDB Cloud demo data
Use [InfluxDB Cloud demo data buckets](/influxdb/cloud/reference/sample-data/#influxdb-cloud-demo-data) for quick, Use [InfluxDB Cloud demo data buckets](/influxdb/cloud/reference/sample-data/#influxdb-cloud-demo-data) for quick,
free access to different types of sample data. free access to different time series datasets.
{{< youtube GSaByPC1Bdc >}} {{< youtube GSaByPC1Bdc >}}
@ -24,46 +30,115 @@ Demo data is not available for use with third-party integrations such as Grafana
{{% /note %}} {{% /note %}}
## Sample datasets ## Sample datasets
The following sample data sets are used as examples in [InfluxDB query guides](/influxdb/cloud/query-data/flux).
- [Air sensor sample data](#air-sensor-sample-data) - [Air sensor sample data](#air-sensor-sample-data)
- [Bird migration sample data](#bird-migration-sample-data) - [Bird migration sample data](#bird-migration-sample-data)
- [NOAA sample data](#noaa-sample-data)
- [NOAA NDBC data](#noaa-ndbc-data)
- [NOAA water sample data](#noaa-water-sample-data) - [NOAA water sample data](#noaa-water-sample-data)
- [USGS earthquake data](#usgs-earthquake-data) - [USGS Earthquake data](#usgs-earthquake-data)
### Air sensor sample data ### Air sensor sample data
{{% caption %}}
**Size**: ~600 KB • **Updated**: every 15m
{{% /caption %}}
Air sensor sample data represents an "Internet of Things" (IoT) use case by simulating Air sensor sample data represents an "Internet of Things" (IoT) use case by simulating
temperature, humidity, and carbon monoxide levels for multiple rooms in a building. temperature, humidity, and carbon monoxide levels for multiple rooms in a building.
The dataset also includes a relational SQL dataset with meta information about sensors in each room.
<a class="btn" href="https://github.com/influxdata/influxdb2-sample-data/tree/master/air-sensor-data" target="\_blank"> To download and output the air sensor sample dataset, use the
<span class="icon-github"></span> View air sensor sample data [`sample.data()` function](/influxdb/cloud/reference/flux/stdlib/influxdb-sample/data/).
</a>
_Used in [Query SQL data sources](/influxdb/cloud/query-data/flux/sql/)._ ```js
import "influxdata/influxdb/sample"
sample.data(set: "airSensor")
```
#### Companion SQL sensor data
The air sensor sample dataset is paired with a relational SQL dataset with meta
information about sensors in each room.
These two sample datasets are used to demonstrate
[how to join time series data and relational data with Flux](/influxdb/cloud/query-data/flux/sql/#join-sql-data-with-data-in-influxdb)
in the [Query SQL data sources](/influxdb/cloud/query-data/flux/sql/) guide.
<a class="btn download" href="https://influx-testdata.s3.amazonaws.com/sample-sensor-info.csv" download>Download SQL air sensor data</a>
### Bird migration sample data ### Bird migration sample data
Bird migration data is adapted from the
[Movebank: Animal Tracking data set on Kaggle](https://www.kaggle.com/pulkit8595/movebank-animal-tracking) {{% caption %}}
**Size**: ~1.2 MB • **Updated**: N/A
{{% /caption %}}
Bird migration sample data is adapted from the
[Movebank: Animal Tracking data set](https://www.kaggle.com/pulkit8595/movebank-animal-tracking)
and represents animal migratory movements throughout 2019. and represents animal migratory movements throughout 2019.
Use the [Flux Geo package](/influxdb/cloud/reference/flux/stdlib/experimental/geo/#geo-schema-requirements)
to query and analyze the geo-temporal data in this sample data set.
<a class="btn" href="https://github.com/influxdata/influxdb2-sample-data/tree/master/bird-migration-data" target="\_blank"> To download and output the bird migration sample dataset, use the
<span class="icon-github"></span> View bird migration sample data [`sample.data()` function](/influxdb/cloud/reference/flux/stdlib/influxdb-sample/data/).
</a>
_Used in [Work with geo-temporal data](/influxdb/cloud/query-data/flux/geo/)._ ```js
import "influxdata/influxdb/sample"
### NOAA water sample data sample.data(set: "birdMigration")
```
This data set is publicly available data from the [National Oceanic and Atmospheric Administration’s (NOAA) Center for Operational Oceanographic Products and Services](http://tidesandcurrents.noaa.gov/stations.html). The bird migration sample dataset is used in the [Work with geo-temporal data](/influxdb/cloud/query-data/flux/geo/)
guide to demonstrate how to query and analyze geo-temporal data.
[The CSV data](https://influx-testdata.s3.amazonaws.com/noaa.csv) includes 15,258 ### NOAA sample data
observations of water levels (ft) collected every six minutes at two stations
The following two National Oceanic and Atmospheric Administration (NOAA) datasets are
available to use with InfluxDB.
- [NOAA NDBC data](#noaa-ndbc-data)
- [NOAA water sample data](#noaa-water-sample-data)
#### NOAA NDBC data
{{% caption %}}
**Size**: ~1.3 MB • **Updated**: every 15m
{{% /caption %}}
The **NOAA National Data Buoy Center (NDBC)** dataset provides observations (updated every 15 minutes) from the NOAA NDBC network of buoys throughout the world.
To download and output the most recent NOAA NDBC observations, use the
[`sample.data()` function](/influxdb/cloud/reference/flux/stdlib/influxdb-sample/data/).
```js
import "influxdata/influxdb/sample"
sample.data(set: "noaa")
```
{{% note %}}
##### Store historical NOAA NDBC data
The **NOAA NDBC sample dataset** only returns the most recent observations;
not historical observations.
To regularly query and store NOAA NDBC observations, add the following as an
[InfluxDB task](/inflxudb/v2.0/process-data/manage-tasks/).
Replace `example-org` and `example-bucket` with your organization name and the
name of the bucket to store data in.
{{% get-shared-text "flux/noaa-ndbc-sample-task.md" %}}
{{% /note %}}
#### NOAA water sample data
{{% caption %}}
**Size**: ~10 MB • **Updated**: N/A
{{% /caption %}}
The **NOAA water sample dataset** is static dataset extracted from
[NOAA Center for Operational Oceanographic Products and Services](http://tidesandcurrents.noaa.gov/stations.html) data.
The sample dataset includes 15,258 observations of water levels (ft) collected every six minutes at two stations
(Santa Monica, CA (ID 9410840) and Coyote Creek, CA (ID 9414575)) over the period (Santa Monica, CA (ID 9410840) and Coyote Creek, CA (ID 9414575)) over the period
from August 18, 2015 through September 18, 2015. from **August 18, 2015** through **September 18, 2015**.
{{% note %}}
##### Store NOAA water sample data to avoid bandwidth usage
To avoid having to re-download this 10MB dataset every time you run a query, To avoid having to re-download this 10MB dataset every time you run a query,
we recommend that you [create a new bucket](/influxdb/cloud/organizations/buckets/create-bucket/) we recommend that you [create a new bucket](/influxdb/cloud/organizations/buckets/create-bucket/)
(`noaa`) and write the NOAA data to it. (`noaa`) and write the NOAA data to it.
@ -84,88 +159,27 @@ csv.from(url: "https://influx-testdata.s3.amazonaws.com/noaa.csv")
|> relativeToNow() |> relativeToNow()
|> to(bucket: "noaa", org: "example-org") |> to(bucket: "noaa", org: "example-org")
``` ```
_Used in [Common queries](/influxdb/cloud/query-data/common-queries/) and [Common tasks](/influxdb/cloud/process-data/common-tasks/)._
### USGS earthquake data
The United States Geological Survey (USGS) collects earthquake data and makes
this data publicly available.
Each earthquake event includes information such as latitude and longitude
coordinates, magnitude, depth, and [more](#collected-usgs-data).
**To periodically retrieve and write USGS earthquake data to InfluxDB**
1. [Create a new bucket](/influxdb/cloud/organizations/buckets/create-bucket/) named `usgs`.
2. [Create a new task](/influxdb/cloud/process-data/manage-tasks/create-task/)
and include the following Flux script:
{{% truncate %}}
```js
import "csv"
import "experimental"
import "experimental/http"
usgsCSV = string(v: (http.get(url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.csv")).body)
csv.from(csv: usgsCSV, mode: "raw")
|> map(fn: (r) => ({
_measurement: "earthquakes",
_time: time(v: r.time),
lat: float(v: r.latitude),
lon: float(v: r.longitude),
depth: float(v: r.depth),
depthError: float(v: r.depthError),
mag: float(v: r.mag),
magType: string(v: r.magType),
nst: int(v: r.nst),
gap: float(v: r.gap),
dmin: float(v: r.dmin),
rms: float(v: r.rms),
net: string(v: r.net),
id: string(v: r.id),
updated: int(v: time(v: r.updated)) / 1000000,
place: string(v: r.place),
type: string(v: r.type),
locationSource: string(v: r.locationSource),
magSource: string(v: r.magSource),
horizontalError: float(v: r.horizontalError),
magError: float(v: r.magError),
magNst: int(v: r.magNst),
}))
|> group(columns: ["_measurement", "locationSource", "magSource", "type", "net", "magType"])
|> experimental.to(bucket: "usgs")
```
{{% /truncate %}}
{{% note %}}
USGS updates earthquake data every minute.
This task retrieves earthquake data for the current day.
Set your task's `every` interval between `1m` and `24h`, depending on how often
you want to retrieve new data.
{{% /note %}} {{% /note %}}
#### Collected USGS data The NOAA water sample dataset is used to demonstrate Flux queries in the
The task above writes the following to InfluxDB: [Common queries](/influxdb/cloud/query-data/common-queries/) and
[Common tasks](/influxdb/cloud/process-data/common-tasks/) guides.
**Fields:** ### USGS Earthquake data
[lat](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#latitude),
[lon](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#longitude),
[depth](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#depth),
[depthError](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#depthError),
[mag](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#mag),
[nst](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#nst),
[gap](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#gap),
[dmin](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#dmin),
[rms](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#rms),
[id](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#id),
[updated](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#updated),
[place](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#place),
[horizontalError](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#horizontalError),
[magError](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#magError),
[magNst](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#magNst)
**Tags:** {{% caption %}}
[magType](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#magType), **Size**: ~6 MB • **Updated**: every 15m
[net](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#net), {{% /caption %}}
[type](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#type),
[locationSource](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#locationSource), The United States Geological Survey (USGS) earthquake dataset contains observations
[magSource](https://earthquake.usgs.gov/data/comcat/data-eventterms.php#magSource) collected from USGS seismic sensors around the world over the last week.
Data is updated approximately every 15m.
To download and output the last week of USGS seismic data, use the
[`sample.data()` function](/influxdb/cloud/reference/flux/stdlib/influxdb-sample/data/).
```js
import "influxdata/influxdb/sample"
sample.data(set: "usgs")
```

2
content/influxdb/cloud/write-data/_index.md
View File

@ -138,7 +138,7 @@ See [Sample data](/influxdb/cloud/reference/sample-data) for more sample InfluxD
{{% /note %}} {{% /note %}}
## Sample data ## Sample data
Use [sample data sets](/influxdb/cloud/reference/sample-data/#sample-data-sets) Use [sample data sets](/influxdb/cloud/reference/sample-data/#sample-datasets)
to quickly populate InfluxDB with sample time series data. to quickly populate InfluxDB with sample time series data.
--- ---

3
content/influxdb/v2.0/query-data/common-queries/_index.md
View File

@ -11,7 +11,8 @@ menu:
weight: 104 weight: 104
--- ---
The following articles walk through common queries using the [NOAA water database data](https://influx-testdata.s3.amazonaws.com/noaa.csv). The following articles walk through common queries using the
[NOAA water database data](/influxdb/v2.0/reference/sample-data/#noaa-water-sample-data).
{{< children >}} {{< children >}}

37
content/influxdb/v2.0/query-data/flux/geo/_index.md
View File

@ -48,43 +48,22 @@ By using it, you agree to the [risks of experimental functions](/influxdb/v2.0/r
## Sample data ## Sample data
Many of the examples in this section use a `sampleGeoData` variable that represents Many of the examples in this section use a `sampleGeoData` variable that represents
a sample set of geo-temporal data. a sample set of geo-temporal data.
The [Bird Migration Sample Data](https://github.com/influxdata/influxdb2-sample-data/tree/master/bird-migration-data) The [Bird Migration Sample Data](/influxdb/v2.0/reference/sample-data/#bird-migration-sample-data)
available on GitHub provides sample geo-temporal data that meets the provides sample geo-temporal data that meets the
[requirements of the Flux Geo package](/influxdb/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements). [requirements of the Flux Geo package](/influxdb/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements).
### Load annotated CSV sample data ### Load bird migration sample data
Use the [experimental `csv.from()` function](/influxdb/v2.0/reference/flux/stdlib/experimental/csv/from/) Use the [`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/)
to load the sample bird migration annotated CSV data from GitHub: to load the sample bird migration data:
```js ```js
import `experimental/csv` import "influxdata/influxdb/sample"
sampleGeoData = csv.from( sampleGeoData = sample.data(set: "birdMigration")
url: "https://github.com/influxdata/influxdb2-sample-data/blob/master/bird-migration-data/bird-migration.csv"
)
``` ```
{{% note %}} {{% note %}}
`csv.from(url: ...)` downloads sample data each time you execute the query **(~1.3 MB)**. `sample.data()` downloads sample data each time you execute the query **(~1.3 MB)**.
If bandwidth is a concern, use the [`to()` function](/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/to/) If bandwidth is a concern, use the [`to()` function](/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/to/)
to write the data to a bucket, and then query the bucket with [`from()`](/influxdb/v2.0/reference/flux/stdlib/built-in/inputs/from/). to write the data to a bucket, and then query the bucket with [`from()`](/influxdb/v2.0/reference/flux/stdlib/built-in/inputs/from/).
{{% /note %}} {{% /note %}}
### Write sample data to InfluxDB with line protocol
Use `curl` and the `influx write` command to write bird migration line protocol to InfluxDB.
Replace `example-bucket` with your destination bucket:
```sh
curl https://raw.githubusercontent.com/influxdata/influxdb2-sample-data/master/bird-migration-data/bird-migration.line \
--output ./tmp-data
influx write -b example-bucket @./tmp-data
rm -f ./tmp-data
```
Use Flux to query the bird migration data and assign it to the `sampleGeoData` variable:
```js
sampleGeoData = from(bucket: "example-bucket")
|> range(start: 2019-01-01T00:00:00Z, stop: 2019-12-31T23:59:59Z)
|> filter(fn: (r) => r._measurement == "migration")
```

54
content/influxdb/v2.0/query-data/flux/sql.md
View File

@ -292,7 +292,7 @@ sql.from(
--- ---
## Sample sensor data ## Sample sensor data
The [sample data generator](#download-and-run-the-sample-data-generator) and The [air sensor sample data](#download-sample-air-sensor-data) and
[sample sensor information](#import-the-sample-sensor-information) simulate a [sample sensor information](#import-the-sample-sensor-information) simulate a
group of sensors that measure temperature, humidity, and carbon monoxide group of sensors that measure temperature, humidity, and carbon monoxide
in rooms throughout a building. in rooms throughout a building.
@ -313,43 +313,33 @@ Sample sensor information is stored in PostgreSQL.
- model_number - model_number
- last_inspected - last_inspected
### Import and generate sample sensor data #### Download sample air sensor data
#### Download and run the sample data generator
`air-sensor-data.rb` is a script that generates air sensor data and stores the data in InfluxDB.
To use `air-sensor-data.rb`:
1. [Create a bucket](/influxdb/v2.0/organizations/buckets/create-bucket/) to store the data. 1. [Create a bucket](/influxdb/v2.0/organizations/buckets/create-bucket/) to store the data.
2. Download the sample data generator. _This tool requires [Ruby](https://www.ruby-lang.org/en/)._ 2. [Create an InfluxDB task](/influxdb/v2.0/process-data/manage-tasks/create-task/)
and use the [`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/)
to download sample air sensor data every 15 minutes.
Write the downloaded sample data to your new bucket:
<a class="btn download" href="/downloads/air-sensor-data.rb" download>Download Air Sensor Generator</a> ```js
import "influxdata/influxdb/sample"
3. Give `air-sensor-data.rb` executable permissions: option task = {
name: "Collect sample air sensor data",
every: 15m
}
``` sample.data(set: "airSensor")
chmod +x air-sensor-data.rb |> to(
org: "example-org",
bucket: "example-bucket"
)
``` ```
4. Start the generator. Specify your organization, bucket, and authorization token. 3. [Query your target bucket](/influxdb/v2.0/query-data/execute-queries/) after
_For information about retrieving your token, see [View tokens](/influxdb/v2.0/security/tokens/view-tokens/)._ the first task run to ensure the sample data is writing successfully.
``` ```js
./air-sensor-data.rb -o your-org -b your-bucket -t YOURAUTHTOKEN
```
The generator begins to write data to InfluxDB and will continue until stopped.
Use `ctrl-c` to stop the generator.
{{% note %}}
Use the `--help` flag to view other configuration options.
{{% /note %}}
5. [Query your target bucket](/influxdb/v2.0/query-data/execute-queries/) to ensure the
generated data is writing successfully.
The generator doesn't catch errors from write requests, so it will continue running
even if data is not writing to InfluxDB successfully.
```
from(bucket: "example-bucket") from(bucket: "example-bucket")
|> range(start: -1m) |> range(start: -1m)
|> filter(fn: (r) => r._measurement == "airSensors") |> filter(fn: (r) => r._measurement == "airSensors")
@ -359,7 +349,7 @@ To use `air-sensor-data.rb`:
1. [Download and install PostgreSQL](https://www.postgresql.org/download/). 1. [Download and install PostgreSQL](https://www.postgresql.org/download/).
2. Download the sample sensor information CSV. 2. Download the sample sensor information CSV.
<a class="btn download" href="/downloads/sample-sensor-info.csv" download>Download Sample Data</a> <a class="btn download" href="https://influx-testdata.s3.amazonaws.com/sample-sensor-info.csv" download>Download sample sensor information</a>
3. Use a PostgreSQL client (`psql` or a GUI) to create the `sensors` table: 3. Use a PostgreSQL client (`psql` or a GUI) to create the `sensors` table:
@ -389,6 +379,6 @@ To use `air-sensor-data.rb`:
#### Import the sample data dashboard #### Import the sample data dashboard
Download and import the Air Sensors dashboard to visualize the generated data: Download and import the Air Sensors dashboard to visualize the generated data:
<a class="btn download" href="/downloads/air-sensors-dashboard.json" download>Download Air Sensors dashboard</a> <a class="btn github" href="https://raw.githubusercontent.com/influxdata/influxdb2-sample-data/master/air-sensor-data/air-sensors-dashboard.json" target="_blank">View Air Sensors dashboard JSON</a>
_For information about importing a dashboard, see [Create a dashboard](/influxdb/v2.0/visualize-data/dashboards/create-dashboard)._ _For information about importing a dashboard, see [Create a dashboard](/influxdb/v2.0/visualize-data/dashboards/create-dashboard)._

9
content/influxdb/v2.0/reference/flux/stdlib/built-in/misc/sleep.md
View File

@ -3,13 +3,14 @@ title: sleep() function
description: The `sleep()` function delays execution by a specified duration. description: The `sleep()` function delays execution by a specified duration.
aliases: aliases:
- /influxdb/v2.0/reference/flux/functions/built-in/misc/sleep/ - /influxdb/v2.0/reference/flux/functions/built-in/misc/sleep/
menu:
influxdb_2_0_ref:
name: sleep
parent: built-in-misc
weight: 401 weight: 401
removed: 0.123.0
--- ---
{{% warn %}}
The `sleep()` function was removed in **Flux 0.123.0**.
{{% /warn %}}
The `sleep()` function delays execution by a specified duration. The `sleep()` function delays execution by a specified duration.
_**Function type:** Miscellaneous_ _**Function type:** Miscellaneous_

26
content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates/aggregatewindow.md
View File

@ -33,7 +33,6 @@ aggregateWindow(
As data is windowed into separate tables and processed, the `_time` column is dropped from each group key. As data is windowed into separate tables and processed, the `_time` column is dropped from each group key.
This function copies the timestamp from a remaining column into the `_time` column. This function copies the timestamp from a remaining column into the `_time` column.
View the [function definition](#function-definition).
`aggregateWindow()` restores the original `_start` and `_stop` values of input data `aggregateWindow()` restores the original `_start` and `_stop` values of input data
and, by default, uses `_stop` to set the `_time` value for each aggregated window. and, by default, uses `_stop` to set the `_time` value for each aggregated window.
@ -59,7 +58,9 @@ _**Data type:** Duration_
### fn ### fn
The [aggregate function](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates) used in the operation. The [aggregate](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates)
or [selector function](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/selectors)
used in the operation.
_**Data type:** Function_ _**Data type:** Function_
@ -90,12 +91,18 @@ _**Data type:** String_
### createEmpty ### createEmpty
For windows without data, this will create an empty window and fill For windows without data, create a single-row table for each empty window (using
it with a `null` aggregate value. [`table.fill()`](/influxdb/v2.0/reference/flux/stdlib/experimental/table/fill/)).
Defaults to `true`. Defaults to `true`.
_**Data type:** Boolean_ _**Data type:** Boolean_
{{% note %}}
When using `createEmpty: true`, [aggregate functions](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates)
return empty tables, but [selector functions](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/selectors) do not.
By design, selectors drop empty tables.
{{% /note %}}
## Examples ## Examples
The examples below use a `data` variable to represent a filtered data set. The examples below use a `data` variable to represent a filtered data set.
@ -138,14 +145,3 @@ data
data data
|> aggregateWindow(every: 1mo, fn: mean) |> aggregateWindow(every: 1mo, fn: mean)
``` ```
## Function definition
```js
aggregateWindow = (every, fn, column="_value", timeSrc="_stop", timeDst="_time", tables=<-) =>
tables
|> window(every:every)
|> fn(column:column)
|> duplicate(column:timeSrc, as:timeDst)
|> window(every:inf, timeColumn:timeDst)
```

24
content/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/_index.md Normal file
View File

@ -0,0 +1,24 @@
---
title: Flux InfluxDB sample package
list_title: InfluxDB sample package
description: >
The Flux InfluxDB sample package provides functions for downloading and outputting InfluxDB data sample.
Import the `influxdata/influxdb/sample` package.
menu:
influxdb_2_0_ref:
name: InfluxDB sample
parent: Flux standard library
weight: 202
influxdb/v2.0/tags: [functions, sample, package]
introduced: 0.123.0
---
The Flux InfluxDB sample package provides functions for downloading and outputting InfluxDB data sample.
Import the `influxdata/influxdb/sample` package:
```js
import "influxdata/influxdb/sample"
```
{{< children type="functions" show="pages" >}}

102
content/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data.md Normal file
View File

@ -0,0 +1,102 @@
---
title: sample.data() function
description: >
The `sample.data()` function downloads and outputs an InfluxDB sample dataset.
menu:
influxdb_2_0_ref:
name: sample.data
parent: InfluxDB sample
weight: 301
related:
- /influxdb/v2.0/reference/sample-data/
introduced: 0.123.0
---
The `sample.data()` function downloads and outputs an InfluxDB sample dataset.
```js
import "influxdata/influxdb/sample"
sample.data(
set: "airSensor"
)
```
{{% note %}}
#### Network bandwidth
Each execution of `sample.data()` downloads the specified dataset from **Amazon S3**.
If using [InfluxDB Cloud](/influxdb/cloud/) or a hosted InfluxDB OSS instance,
you may see additional network bandwidth costs when using this function.
Approximate sample dataset sizes are listed [below](#available-influxdb-sample-datasets)
and in the output of [`sample.list()`](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/list/).
{{% /note %}}
## Available InfluxDB sample datasets
### airSensor
Simulated office building air sensor data with temperature,
humidity, and carbon monoxide metrics.
{{% caption %}}
**Size**: ~600 KB • **Updated**: every 15m
{{% /caption %}}
### birdMigration
2019 African bird migration data from the
[Movebank: Animal Tracking](https://www.kaggle.com/pulkit8595/movebank-animal-tracking) dataset.
Contains geotemporal data between 2019-01-01 and 2019-12-31.
{{% caption %}}
**Size**: ~1.2 MB • **Updated**: N/A
{{% /caption %}}
### noaa
Latest observations from the [NOAA National Data Buoy Center (NDBC)](https://www.ndbc.noaa.gov/).
Contains only the most recent observations (no historical data).
Data is updated approximately every 15m.
{{% caption %}}
**Size**: ~1.3 MB • **Updated**: every 15m
{{% /caption %}}
### usgs
USGS earthquake data from the last week.
Contains geotemporal data collected from USGS seismic sensors around the world.
Data is updated approximately every 15m.
{{% caption %}}
**Size**: ~6 MB • **Updated**: every 15m
{{% /caption %}}
## Parameters
### set
({{< req >}}) InfluxDB sample dataset to download and output.
**Valid values**:
- `airSensor`
- `birdMigration`
- `noaa`
- `usgs`
## Examples
##### Return USGS earthquake data from the last week
```js
import "influxdata/influxdb/sample"
sample.data(set: "usgs")
```
##### Download and write NOAA NDBC data to InfluxDB
Add the following as an [InfluxDB task](/influxdb/v2.0/process-data/) to regularly
collect the latest reported observations from the NOAA NDBC.
{{% get-shared-text "flux/noaa-ndbc-sample-task.md" %}}

21
content/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/list.md Normal file
View File

@ -0,0 +1,21 @@
---
title: sample.list() function
description: >
The `sample.list()` function outputs information about available InfluxDB sample datasets.
menu:
influxdb_2_0_ref:
name: sample.list
parent: InfluxDB sample
weight: 301
related:
- /influxdb/v2.0/reference/sample-data/
introduced: 0.123.0
---
The `sample.list()` function outputs information about available InfluxDB sample datasets.
```js
import "influxdata/influxdb/sample"
sample.list()
```

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/_index.md
View File

@ -8,7 +8,7 @@ aliases:
- /influxdb/v2.0/reference/flux/functions/influxdb-v1/ - /influxdb/v2.0/reference/flux/functions/influxdb-v1/
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: InfluxDB Schema name: InfluxDB schema
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, schema, package] influxdb/v2.0/tags: [functions, schema, package]

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/fieldkeys.md
View File

@ -4,7 +4,7 @@ description: The `schema.fieldKeys()` function returns field keys in a bucket.
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.fieldKeys name: schema.fieldKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [fields] influxdb/v2.0/tags: [fields]
aliases: aliases:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/fieldsascols.md
View File

@ -9,7 +9,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.fieldsAsCols name: schema.fieldsAsCols
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
introduced: 0.88.0 introduced: 0.88.0
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/measurementfieldkeys.md
View File

@ -4,7 +4,7 @@ description: The `schema.measurementFieldKeys()` function returns a list of fiel
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.measurementFieldKeys name: schema.measurementFieldKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [fields] influxdb/v2.0/tags: [fields]
aliases: aliases:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/measurements.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.measurements name: schema.measurements
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [measurements] influxdb/v2.0/tags: [measurements]
related: related:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/measurementtagkeys.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.measurementTagKeys name: schema.measurementTagKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/measurementtagvalues.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.measurementTagValues name: schema.measurementTagValues
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/tagkeys.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.tagKeys name: schema.tagKeys
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-schema/tagvalues.md
View File

@ -6,7 +6,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: schema.tagValues name: schema.tagValues
parent: InfluxDB Schema parent: InfluxDB schema
weight: 301 weight: 301
influxdb/v2.0/tags: [tags] influxdb/v2.0/tags: [tags]
related: related:

12
content/influxdb/v2.0/reference/flux/stdlib/influxdb-tasks/_index.md
View File

@ -1,15 +1,15 @@
--- ---
title: Flux InfluxDB Tasks package title: Flux InfluxDB tasks package
list_title: InfluxDB Tasks package list_title: InfluxDB tasks package
description: > description: >
The Flux InfluxDB Tasks package provides options and functions for working with The Flux InfluxDB tasks package provides options and functions for working with
[InfluxDB tasks](/influxdb/v2.0/process-data/get-started/). [InfluxDB tasks](/influxdb/v2.0/process-data/get-started/).
Import the `influxdata/influxdb/tasks` package. Import the `influxdata/influxdb/tasks` package.
aliases: aliases:
- /influxdb/v2.0/reference/flux/functions/influxdb-v1/ - /influxdb/v2.0/reference/flux/functions/influxdb-v1/
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: InfluxDB Tasks name: InfluxDB tasks
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, tasks, package] influxdb/v2.0/tags: [functions, tasks, package]
@ -17,7 +17,7 @@ related:
- /influxdb/v2.0/process-data/get-started/ - /influxdb/v2.0/process-data/get-started/
--- ---
The Flux InfluxDB Tasks package provides options and functions for working with The Flux InfluxDB tasks package provides options and functions for working with
[InfluxDB tasks](/influxdb/v2.0/process-data/get-started/). [InfluxDB tasks](/influxdb/v2.0/process-data/get-started/).
Import the `influxdata/influxdb/tasks` package: Import the `influxdata/influxdb/tasks` package:
@ -26,7 +26,7 @@ import "influxdata/influxdb/tasks"
``` ```
## Options ## Options
The InfluxDB Tasks package provides the following options: The InfluxDB tasks package provides the following options:
#### lastSuccessTime #### lastSuccessTime
Define the time of the last successful task run. Define the time of the last successful task run.

2
content/influxdb/v2.0/reference/flux/stdlib/influxdb-tasks/lastsuccess.md
View File

@ -4,7 +4,7 @@ description: The `tasks.lastSuccess()` function returns ...
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: tasks.lastSuccess name: tasks.lastSuccess
parent: InfluxDB Tasks parent: InfluxDB tasks
weight: 301 weight: 301
--- ---

8
content/influxdb/v2.0/reference/flux/stdlib/monitor/_index.md
View File

@ -1,14 +1,14 @@
--- ---
title: Flux InfluxDB Monitor package title: Flux InfluxDB monitor package
list_title: InfluxDB Monitor package list_title: InfluxDB monitor package
description: > description: >
The Flux Monitor package provides tools for monitoring and alerting with InfluxDB. The Flux monitor package provides tools for monitoring and alerting with InfluxDB.
Import the `influxdata/influxdb/monitor` package. Import the `influxdata/influxdb/monitor` package.
aliases: aliases:
- /influxdb/v2.0/reference/flux/functions/monitor/ - /influxdb/v2.0/reference/flux/functions/monitor/
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: InfluxDB Monitor name: InfluxDB monitor
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, monitor, alerts, package] influxdb/v2.0/tags: [functions, monitor, alerts, package]

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/check.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.check name: monitor.check
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/deadman.md
View File

@ -7,7 +7,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.deadman name: monitor.deadman
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
cloud_all: true cloud_all: true
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/from.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.from name: monitor.from
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/logs.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.logs name: monitor.logs
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/notify.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.notify name: monitor.notify
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/statechanges.md
View File

@ -8,7 +8,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.stateChanges name: monitor.stateChanges
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

2
content/influxdb/v2.0/reference/flux/stdlib/monitor/statechangesonly.md
View File

@ -6,7 +6,7 @@ description: >
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: monitor.stateChangesOnly name: monitor.stateChangesOnly
parent: InfluxDB Monitor parent: InfluxDB monitor
weight: 202 weight: 202
--- ---

10
content/influxdb/v2.0/reference/flux/stdlib/secrets/_index.md
View File

@ -1,20 +1,20 @@
--- ---
title: Flux InfluxDB Secrets package title: Flux InfluxDB secrets package
list_title: InfluxDB Secrets package list_title: InfluxDB secrets package
description: > description: >
The Flux InfluxDB Secrets package provides functions for working with sensitive secrets managed by InfluxDB. The Flux InfluxDB secrets package provides functions for working with sensitive secrets managed by InfluxDB.
Import the `influxdata/influxdb/secrets` package. Import the `influxdata/influxdb/secrets` package.
aliases: aliases:
- /influxdb/v2.0/reference/flux/functions/secrets/ - /influxdb/v2.0/reference/flux/functions/secrets/
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: InfluxDB Secrets name: InfluxDB secrets
parent: Flux standard library parent: Flux standard library
weight: 202 weight: 202
influxdb/v2.0/tags: [functions, secrets, package] influxdb/v2.0/tags: [functions, secrets, package]
--- ---
InfluxDB Secrets Flux functions provide tools for working with sensitive secrets managed by InfluxDB. InfluxDB secrets Flux functions provide tools for working with sensitive secrets managed by InfluxDB.
Import the `influxdata/influxdb/secrets` package: Import the `influxdata/influxdb/secrets` package:
```js ```js

2
content/influxdb/v2.0/reference/flux/stdlib/secrets/get.md
View File

@ -7,7 +7,7 @@ aliases:
menu: menu:
influxdb_2_0_ref: influxdb_2_0_ref:
name: secrets.get name: secrets.get
parent: InfluxDB Secrets parent: InfluxDB secrets
weight: 202 weight: 202
--- ---

12
content/influxdb/v2.0/reference/release-notes/flux.md
View File

@ -8,6 +8,18 @@ menu:
name: Flux name: Flux
--- ---
## v0.123.0 [2021-07-19]
### Breaking changes
- Remove the [`sleep()` function](/influxdb/v2.0/reference/flux/stdlib/built-in/misc/sleep/).
### Features
- Optimize [`pivot()` transformation](/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/pivot/).
- Add [InfluxDB sample data package](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/).
- Use `table.fill()` when `aggregateWindow(createEmpty: true)` is used.
---
## v0.122.0 [2021-07-13] ## v0.122.0 [2021-07-13]
### Features ### Features

153
content/influxdb/v2.0/reference/sample-data.md
View File

@ -12,67 +12,150 @@ weight: 7
Use sample data to familiarize yourself with time series data and InfluxDB. Use sample data to familiarize yourself with time series data and InfluxDB.
InfluxData provides many sample time series datasets to use with InfluxDB. InfluxData provides many sample time series datasets to use with InfluxDB.
You can also use the [Flux InfluxDB sample package](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/)
## Sample data sets to view, download, and output sample datasets.
The following sample data sets are used as examples in [InfluxDB query guides](/influxdb/v2.0/query-data/flux)
and can be used with **InfluxDB OSS** or **InfluxDB Cloud**.
- [Air sensor sample data](#air-sensor-sample-data) - [Air sensor sample data](#air-sensor-sample-data)
- [Bird migration sample data](#bird-migration-sample-data) - [Bird migration sample data](#bird-migration-sample-data)
- [NOAA sample data](#noaa-sample-data)
- [NOAA NDBC data](#noaa-ndbc-data)
- [NOAA water sample data](#noaa-water-sample-data) - [NOAA water sample data](#noaa-water-sample-data)
- [USGS Earthquake data](#usgs-earthquake-data)
## Air sensor sample data
{{% caption %}}
**Size**: ~600 KB • **Updated**: every 15m
{{% /caption %}}
### Air sensor sample data
Air sensor sample data represents an "Internet of Things" (IoT) use case by simulating Air sensor sample data represents an "Internet of Things" (IoT) use case by simulating
temperature, humidity, and carbon monoxide levels for multiple rooms in a building. temperature, humidity, and carbon monoxide levels for multiple rooms in a building.
The dataset also includes a relational SQL dataset with meta information about sensors in each room.
<a class="btn" href="https://github.com/influxdata/influxdb2-sample-data/tree/master/air-sensor-data" target="\_blank"> To download and output the air sensor sample dataset, use the
<span class="icon-github"></span> View air sensor sample data [`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/).
</a>
_Used in [Query SQL data sources](/influxdb/v2.0/query-data/flux/sql/)._ ```js
import "influxdata/influxdb/sample"
### Bird migration sample data sample.data(set: "airSensor")
Bird migration data is adapted from the ```
[Movebank: Animal Tracking data set on Kaggle](https://www.kaggle.com/pulkit8595/movebank-animal-tracking)
#### Companion SQL sensor data
The air sensor sample dataset is paired with a relational SQL dataset with meta
information about sensors in each room.
These two sample datasets are used to demonstrate
[how to join time series data and relational data with Flux](/influxdb/v2.0/query-data/flux/sql/#join-sql-data-with-data-in-influxdb)
in the [Query SQL data sources](/influxdb/v2.0/query-data/flux/sql/) guide.
<a class="btn download" href="https://influx-testdata.s3.amazonaws.com/sample-sensor-info.csv" download>Download SQL air sensor data</a>
## Bird migration sample data
{{% caption %}}
**Size**: ~1.2 MB • **Updated**: N/A
{{% /caption %}}
Bird migration sample data is adapted from the
[Movebank: Animal Tracking data set](https://www.kaggle.com/pulkit8595/movebank-animal-tracking)
and represents animal migratory movements throughout 2019. and represents animal migratory movements throughout 2019.
Use the [Flux Geo package](/influxdb/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements)
to query and analyze the geo-temporal data in this sample data set.
<a class="btn" href="https://github.com/influxdata/influxdb2-sample-data/tree/master/bird-migration-data" target="\_blank"> To download and output the bird migration sample dataset, use the
<span class="icon-github"></span> View bird migration sample data [`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/).
</a>
_Used in [Work with geo-temporal data](/influxdb/v2.0/query-data/flux/geo/)._ ```js
import "influxdata/influxdb/sample"
sample.data(set: "birdMigration")
```
The bird migration sample dataset is used in the [Work with geo-temporal data](/influxdb/v2.0/query-data/flux/geo/)
guide to demonstrate how to query and analyze geo-temporal data.
## NOAA sample data
There are two National Oceanic and Atmospheric Administration (NOAA) datasets
available to use with InfluxDB.
- [NOAA NDBC data](#noaa-ndbc-data)
- [NOAA water sample data](#noaa-water-sample-data)
### NOAA NDBC data
{{% caption %}}
**Size**: ~1.3 MB • **Updated**: every 15m
{{% /caption %}}
The **NOAA National Data Buoy Center (NDBC)** dataset provides the latest
observations from the NOAA NDBC network of buoys throughout the world.
Observations are updated approximately every 15 minutes.
To download and output the most recent NOAA NDBC observations, use the
[`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/).
```js
import "influxdata/influxdb/sample"
sample.data(set: "noaa")
```
{{% note %}}
#### Store historical NOAA NDBC data
The **NOAA NDBC sample dataset** only returns the most recent observations;
not historical observations.
To regularly query and store NOAA NDBC observations, add the following as an
[InfluxDB task](/inflxudb/v2.0/process-data/manage-tasks/).
Replace `example-org` and `example-bucket` with your organization name and the
name of the bucket to store data in.
{{% get-shared-text "flux/noaa-ndbc-sample-task.md" %}}
{{% /note %}}
### NOAA water sample data ### NOAA water sample data
This data set is publicly available data from the [National Oceanic and Atmospheric Administration’s (NOAA) Center for Operational Oceanographic Products and Services](http://tidesandcurrents.noaa.gov/stations.html). {{% caption %}}
**Size**: ~10 MB • **Updated**: N/A
{{% /caption %}}
[The CSV data](https://influx-testdata.s3.amazonaws.com/noaa.csv) includes 15,258 The **NOAA water sample dataset** is static dataset extracted from
observations of water levels (ft) collected every six minutes at two stations [NOAA Center for Operational Oceanographic Products and Services](http://tidesandcurrents.noaa.gov/stations.html) data.
The sample dataset includes 15,258 observations of water levels (ft) collected every six minutes at two stations
(Santa Monica, CA (ID 9410840) and Coyote Creek, CA (ID 9414575)) over the period (Santa Monica, CA (ID 9410840) and Coyote Creek, CA (ID 9414575)) over the period
from August 18, 2015 through September 18, 2015. from **August 18, 2015** through **September 18, 2015**.
{{% note %}}
#### Store NOAA water sample data to avoid bandwidth usage
To avoid having to re-download this 10MB dataset every time you run a query, To avoid having to re-download this 10MB dataset every time you run a query,
we recommend that you [create a new bucket](/influxdb/v2.0/organizations/buckets/create-bucket/) we recommend that you [create a new bucket](/influxdb/v2.0/organizations/buckets/create-bucket/)
(`noaa`) and write the NOAA data to it. (`noaa`) and write the NOAA sample water data to it.
We also recommend updating the timestamps of the data to be relative to `now()`.
To do so, run the following:
```js ```js
import "experimental/csv" import "experimental/csv"
relativeToNow = (tables=<-) =>
tables
|> elapsed()
|> sort(columns: ["_time"], desc: true)
|> cumulativeSum(columns: ["elapsed"])
|> map(fn: (r) => ({ r with _time: time(v: int(v: now()) - (r.elapsed * 1000000000))}))
csv.from(url: "https://influx-testdata.s3.amazonaws.com/noaa.csv") csv.from(url: "https://influx-testdata.s3.amazonaws.com/noaa.csv")
|> relativeToNow()
|> to(bucket: "noaa", org: "example-org") |> to(bucket: "noaa", org: "example-org")
``` ```
{{% /note %}}
_Used in [Common queries](/influxdb/v2.0/query-data/common-queries/) and [Common tasks](/influxdb/v2.0/process-data/common-tasks/)._ The NOAA water sample dataset is used to demonstrate Flux queries in the
[Common queries](/influxdb/v2.0/query-data/common-queries/) and
[Common tasks](/influxdb/v2.0/process-data/common-tasks/) guides.
## USGS Earthquake data
{{% caption %}}
**Size**: ~6 MB • **Updated**: every 15m
{{% /caption %}}
The United States Geological Survey (USGS) earthquake dataset contains observations
collected from USGS seismic sensors around the world over the last week.
Data is updated approximately every 15m.
To download and output the last week of USGS seismic data, use the
[`sample.data()` function](/influxdb/v2.0/reference/flux/stdlib/influxdb-sample/data/).
```js
import "influxdata/influxdb/sample"
sample.data(set: "usgs")
```

14
shared/text/flux/noaa-ndbc-sample-task.md Normal file
View File

@ -0,0 +1,14 @@
```js
import "influxdata/influxdb/sample"
option task = {
name: "Collect NOAA NDBC data"
every: 15m,
}
sample.data(set: "noaa")
|> to(
org: "example-org",
bucket: "example-bucket"
)
```