influxdata / influxdata/docs-v2

json.parse Flux documentation lacks useful information

Open
#3,751 2 comments 0 reactions 1 assignee View on GitHub

@sanderson is already working on this.

Since Mar 1, 2022.

Flux
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

Presumably, users have achieved getting json into their app somehow (for example via http.get()).

But what can you do with it? The documentation says:
"The function can return lists, records, strings, booleans, and float values."

For each of these, they must be turned into a Flux table in some way, and common cases are that the user wants to:
1. join the data with ts data that they have queried from a bucket
2. write the data to a bucket

In both cases they need to convert the json to a table, which is sort of documented for the case where the json object is a flat list. But what if the json is more complex? In most cases the json returned is an object, how do I parse that into a table?

##### Relevant URLs
- https://docs.influxdata.com/flux/v0.x/stdlib/experimental/json/parse/
- https://awesome.influxdata.com/docs/part-2/querying-and-data-transformations/#json

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.