84 lines
2.2 KiB
Markdown
84 lines
2.2 KiB
Markdown
---
|
|
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
|
|
- /v2.0/reference/flux/functions/csv/from/
|
|
menu:
|
|
v2_0_ref:
|
|
name: csv.from
|
|
parent: CSV
|
|
weight: 202
|
|
---
|
|
|
|
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_
|
|
|
|
```js
|
|
import "csv"
|
|
|
|
csv.from(csv: csvData)
|
|
|
|
// OR
|
|
|
|
csv.from(file: "/path/to/data-file.csv")
|
|
```
|
|
|
|
## Parameters
|
|
|
|
### csv
|
|
Annotated CSV text.
|
|
|
|
{{% note %}}
|
|
CSV data must use Annotated CSV syntax and include all
|
|
[annotation rows](/v2.0/reference/syntax/annotated-csv/#annotations).
|
|
For more information, see [Annotated CSV](/v2.0/reference/syntax/annotated-csv/).
|
|
{{% /note %}}
|
|
|
|
_**Data type:** String_
|
|
|
|
### 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 `fluxd` process.
|
|
_The CSV file must exist in the same file system running the `fluxd` process._
|
|
|
|
{{% warn %}}
|
|
**InfluxDB OSS** and **{{< cloud-name "short" >}}** user interfaces do _**not**_ support the `file` parameter.
|
|
Neither allow access to the underlying filesystem.
|
|
However, the [Flux REPL](/v2.0/reference/cli/influx/repl/) does support the `file` parameter.
|
|
{{% /warn %}}
|
|
|
|
_**Data type:** String_
|
|
|
|
## Examples
|
|
|
|
### Query CSV data from a file
|
|
```js
|
|
import "csv"
|
|
|
|
csv.from(file: "/path/to/data-file.csv")
|
|
```
|
|
|
|
### Query raw CSV-formatted text
|
|
```js
|
|
import "csv"
|
|
|
|
csvData = "
|
|
#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double
|
|
#group,false,false,false,false,false,false,false,false
|
|
#default,,,,,,,,
|
|
,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
|
|
,mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
|
|
,mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62
|
|
"
|
|
|
|
csv.from(csv: csvData)
|
|
```
|