diff --git a/content/v2.0/reference/flux/stdlib/experimental/array/_index.md b/content/v2.0/reference/flux/stdlib/experimental/array/_index.md new file mode 100644 index 000000000..56b73c88d --- /dev/null +++ b/content/v2.0/reference/flux/stdlib/experimental/array/_index.md @@ -0,0 +1,22 @@ +--- +title: Flux Array package +list_title: Array package +description: > + The Flux Array package provides functions for building tables from Flux arrays. + Import the `experimental/array` package. +menu: + v2_0_ref: + name: Array + parent: Experimental +weight: 301 +v2.0/tags: [functions, array, package, table] +--- + +Flux Array functions provide tools for building tables from Flux arrays. +Import the `experimental/array` package: + +```js +import "experimental/array" +``` + +{{< children type="functions" show="pages" >}} diff --git a/content/v2.0/reference/flux/stdlib/experimental/array/from.md b/content/v2.0/reference/flux/stdlib/experimental/array/from.md new file mode 100644 index 000000000..3bf188488 --- /dev/null +++ b/content/v2.0/reference/flux/stdlib/experimental/array/from.md @@ -0,0 +1,63 @@ +--- +title: array.from() function +description: > + The experimental `array.from()` function constructs a table from an array of objects. +menu: + v2_0_ref: + name: array.from + parent: Array +weight: 401 +--- + +The experimental `array.from()` function constructs a table from an array of objects. +Each object in the array is converted into an output row or record. +All records must have the same keys and data types. + +_**Function type:** Input_ + +{{< keep-url >}} +```js +import "experimental/array" + +array.from(rows: [ + {_time: 2020-01-01T00:00:00Z, _field: "exampleField", _value: 3, foo: "bar"}, + {_time: 2020-01-01T00:01:00Z, _field: "exampleField", _value: 4, foo: "bar"}, + {_time: 2020-01-01T00:02:00Z, _field: "exampleField", _value: 1, foo: "bar"} +]) +``` + +## Parameters + +### rows +Array of records to construct a table with. + +_**Data type:** Array of objects_ + +## Examples + +##### Build an arbitrary table +```js +import "experimental/array" + +rows = [ + {foo: "bar", baz: 21.2} + {foo: "bar", baz: 23.8} +] + +array.from(rows: rows) +``` + +##### Union custom rows with query results +```js +import "influxdata/influxdb/v1" +import "experimental/array" + +tags = v1.tagValues( + bucket: "example-bucket", + tag: "host" +) + +wildcard_tag = array.from(rows: [{_value: "*"}]) + +union(tables: [tags, wildcard_tag]) +```