Merge pull request #147 from influxdata/update/from-csv

Moved fromCSV into csv package
pull/148/head
Scott Anderson 2019-04-11 09:29:18 -06:00 committed by GitHub
commit 31336b4dbd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 13 deletions

View File

@ -0,0 +1,22 @@
---
title: Flux CSV package
list_title: CSV package
description: >
The Flux CSV package provides functions for working with data in annotated CSV format.
Import the `csv` package.
menu:
v2_0_ref:
name: CSV
parent: Flux packages and functions
weight: 202
v2.0/tags: [functions, csv, package]
---
CSV Flux functions provide tools for working with data in [annotated CSV format](https://github.com/influxdata/flux/blob/master/docs/SPEC.md#csv).
Import the `csv` package:
```js
import "csv"
```
{{< children type="functions" show="pages" >}}

View File

@ -1,37 +1,44 @@
---
title: fromCSV() function
description: The `fromCSV()` function retrieves data from a CSV data source.
title: csv.from() function
description: The `csv.from()` function retrieves data from a CSV data source.
aliases:
- /v2.0/reference/flux/functions/inputs/fromcsv
- /v2.0/reference/flux/functions/built-in/inputs/fromcsv
menu:
v2_0_ref:
name: fromCSV
parent: built-in-inputs
weight: 401
name: csv.from
parent: CSV
weight: 202
---
The `fromCSV()` function retrieves data from a comma-separated value (CSV) data source.
The `csv.from()` function retrieves data from a comma-separated value (CSV) data source.
It returns a stream of tables.
Each unique series is contained within its own table.
Each record in the table represents a single point in the series.
_**Function type:** Input_
_**Output data type:** Object_
_**Function type:** Input_
```js
from(file: "/path/to/data-file.csv")
import "csv"
csv.from(file: "/path/to/data-file.csv")
// OR
from(csv: csvData)
csv.from(csv: csvData)
```
{{% cloud-msg %}}
`csv.from()` is not available in {{< cloud-name "short" >}}.
{{% /cloud-msg %}}
## Parameters
### file
The file path of the CSV file to query.
The path can be absolute or relative.
If relative, it is relative to the working directory of the `influxd` process.
_The CSV file must exist in the same file system running the `influxd` process._
_**Data type:** String_
@ -50,11 +57,15 @@ _**Data type:** String_
### Query CSV data from a file
```js
from(file: "/path/to/data-file.csv")
import "csv"
csv.from(file: "/path/to/data-file.csv")
```
### Query raw CSV-formatted text
```js
import "csv"
csvData = "
result,table,_start,_stop,_time,region,host,_value
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
@ -62,5 +73,5 @@ mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.
mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62
"
from(csv: csvData)
csv.from(csv: csvData)
```

View File

@ -6,7 +6,7 @@ description: >
Import the `strings` package.
menu:
v2_0_ref:
name: Strings
name: String
parent: Flux packages and functions
weight: 204
v2.0/tags: [strings, functions, package]