Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/flux/v0.x/stdlib/influxdata/influxdb/to.md

6.0 KiB
Raw Permalink Blame History

title description aliases menu weight flux/v0.x/tags related introduced
to() function `to()` writes data to an **InfluxDB Cloud or v2.x** bucket and outputs the written data.
/flux/v0.x/stdlib/universe/to
/influxdb/v2.0/reference/flux/functions/outputs/to
/influxdb/v2.0/reference/flux/functions/built-in/outputs/to/
/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/to/
/influxdb/cloud/reference/flux/stdlib/built-in/outputs/to/
flux_0_x_ref
name parent
to influxdb-pkg
301
outputs
/flux/v0.x/stdlib/experimental/to/
/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-into-clause, InfluxQL – SELECT INTO
0.7.0

to() writes data to an InfluxDB Cloud or v2.x bucket and outputs the written data.

to(
    bucket: "my-bucket",
    org: "my-org",
    host: "http://localhost:8086",
    token: "mY5uP3rS3cRe7t0k3n",
    timeColumn: "_time",
    tagColumns: ["tag1", "tag2", "tag3"],
    fieldFn: (r) => ({ r._field: r._value }),
)

// OR

to(
    bucketID: "1234567890",
    orgID: "0987654321",
    host: "http://localhost:8086",
    token: "mY5uP3rS3cRe7t0k3n",
    timeColumn: "_time",
    tagColumns: ["tag1", "tag2", "tag3"],
    fieldFn: (r) => ({ r._field: r._value }),
)

{{% note %}}

to() does not require a package import

to() is part of the influxdata/influxdb package, but is included with the universe package by default and does not require an import statement or package namespace. {{% /note %}}

Output data requirements

to() writes data structured using the standard [InfluxDB v2.x and InfluxDB Cloud data structure](/{{< latest "influxdb" >}}/reference/key-concepts/data-elements/) that includes, at a minimum, the following columns:

  • _time
  • _measurement
  • _field
  • _value

All other columns are written to InfluxDB as [tags](/{{< latest "influxdb" >}}/reference/key-concepts/data-elements/#tags).

{{% note %}} to() drops rows with a null _time value and does not write them to InfluxDB. {{% /note %}}

Parameters

{{% note %}} You must provide a bucket or bucketID and an org or orgID. {{% /note %}}

bucket

Bucket to write data to. bucket and bucketID are mutually exclusive.

bucketID

Bucket ID to write data to. bucketID and bucket are mutually exclusive.

org

InfluxDB organization name. org and orgID are mutually exclusive.

orgID

InfluxDB organization ID. orgID and org are mutually exclusive.

{{% warn %}} to() cannot write to from one InfluxDB Cloud organization to another. {{% /warn %}}

host

[InfluxDB URL](/{{< latest "influxdb" >}}/reference/urls/) or InfluxDB Cloud region URL to write to.

{{% warn %}} host is required when writing to a remote InfluxDB instance. If specified, token is also required. {{% /warn %}}

token

[InfluxDB API token](/{{< latest "influxdb" >}}/security/tokens).

{{% warn %}} token is required when writing to another organization or when writing to a remote InfluxDB host. {{% /warn %}}

timeColumn

Time column of the output. Default is "_time".

tagColumns

Tag columns in the output. Defaults to all columns with type string, excluding all value columns and columns identified by fieldFn.

fieldFn

Function that takes a record from the input table and returns a record. For each record from the input table, fieldFn returns a record that maps the output field key to the output value. Default is (r) => ({ [r._field]: r._value }) Output data type: Record

{{% note %}} Make sure fieldFn parameter names match each specified parameter. To learn why, see Match parameter names. {{% /note %}}

Examples

Default to() operation

Given the following table:

_time _start _stop _measurement _field _value
0005 0000 0009 "a" "temp" 100.1
0006 0000 0009 "a" "temp" 99.3
0007 0000 0009 "a" "temp" 99.9

The default to() operation:

data
    |> to(bucket:"my-bucket", org:"my-org")

is equivalent to writing the above data using the following line protocol:

_measurement=a temp=100.1 0005
_measurement=a temp=99.3 0006
_measurement=a temp=99.9 0007

Custom to() operation

The default to() operation can be overridden. For example, given the following table:

_time _start _stop tag1 tag2 hum temp
0005 0000 0009 "a" "b" 55.3 100.1
0006 0000 0009 "a" "b" 55.4 99.3
0007 0000 0009 "a" "b" 55.5 99.9

The operation:

data
    |> to(
        bucket:"my-bucket",
        org:"my-org",
        tagColumns:["tag1"],
        fieldFn: (r) => ({"hum": r.hum, "temp": r.temp}),
    )

is equivalent to writing the above data using the following line protocol:

_tag1=a hum=55.3,temp=100.1 0005
_tag1=a hum=55.4,temp=99.3 0006
_tag1=a hum=55.5,temp=99.9 0007

Write to multiple buckets

The example below does the following:

  1. Writes data to bucket1 and returns the data as it is written.
  2. Ungroups the returned data.
  3. Counts the number of rows.
  4. Maps columns required to write to InfluxDB.
  5. Writes the modified data to bucket2.
data
    |> to(bucket: "bucket1")
    |> group()
    |> count()
    |> map(fn: (r) => ({r with _time: now(), _measurement: "writeStats", _field: "numPointsWritten"}))
    |> to(bucket: "bucket2")