docs-v2/content/v2.0/reference/flux/functions/json/encode.md

1.0 KiB

title description menu weight
json.encode() function The `json.encode()` function converts a value into JSON bytes.
v2_0_ref
name parent
json.encode JSON
202

The json.encode() function converts a value into JSON bytes.

Function type: Type conversion

import "json"

json.encode(v: "some value")

This function encodes Flux types as follows:

  • time values in RFC3339 format
  • duration values in number of milliseconds since the epoch
  • regexp values as their string representation
  • bytes values as base64-encoded strings
  • function values are not encoded and produce an error

Parameters

v

The value to convert.

Data type: Boolean | Duration | Float | Integer | String | Time | UInteger

Examples

Encode all values in a column in JSON bytes

import "json"

from(bucket: "example-bucket")
  |> range(start: -1h)
  |> map(fn: (r) => ({
      r with _value: json.encode(v: r._value)
  }))