Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #618 from influxdata/update/annotated-csv 

Updated Annotated CSV examples
pull/631/head
Scott Anderson 2019-11-19 15:49:52 -07:00 committed by GitHub
parent 0565bccbce 4395dd2d6b
commit 5a4f2ec16f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
content/v2.0/reference/flux/stdlib/csv/from.md
View File

@ -47,9 +47,9 @@ _**Data type:** String_
Raw CSV-formatted text.
{{% note %}}
CSV data must be in the CSV format produced by the Flux HTTP response standard.
See the [Flux technical specification](https://github.com/influxdata/flux/blob/master/docs/SPEC.md#csv)
for information about this format.
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_
@ -68,10 +68,13 @@ csv.from(file: "/path/to/data-file.csv")
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
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
#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)

24
content/v2.0/reference/syntax/annotated-csv.md
View File

@ -143,7 +143,7 @@ my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,
Flux supports the following dialect options for `text/csv` format.
| Option | Description | Default |
| :-------- | :--------- |:------- |
| :-------- | :--------- |:-------:|
| **header** | If true, the header row is included. | `true` |
| **delimiter** | Character used to delimit columns. | `,` |
| **quoteChar** | Character used to quote values containing the delimiter. | `"` |
@ -172,7 +172,8 @@ Example encoding of datatype, group, and default annotations.
```js
import "csv"
a = "#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double
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
@ -183,7 +184,8 @@ a = "#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,st
,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,west,B,12.83
,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,C,51.62
"
csv.from(csv:a) |> yield()
csv.from(csv: csvData)
```
### Valid data types
@ -215,20 +217,24 @@ If an error occurs:
##### Example
Encoding for an error with the datatype annotation:
```js
```csv
#datatype,string,long
,error,reference
,Failed to parse query,897
```
```
Encoding for an error that occurs after a valid table has been encoded:
```js
#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double,result,table,_start,_stop,_time,region,host,_value
```csv
#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double
,result,table,_start,_stop,_time,region,host,_value
,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,west,A,62.73
,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,west,B,12.83
,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,C,51.62
```
```js
```
```csv
#datatype,string,long
,error,reference,query terminated: reached maximum allowed memory limits,576
```