Annotated CSV

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

InfluxDB and Flux return query results in annotated CSV format. You can also read annotated CSV directly from Flux with the csv.from() function, write data to InfluxDB using annotated CSV and the influx write command, or upload a CSV file in the UI.

CSV tables must be encoded in UTF-8 and Unicode Normal Form C as defined in UAX15. InfluxDB removes carriage returns before newline characters.

Examples

In this topic, you’ll find examples of valid CSV syntax for responses to the following query:

  1. from(bucket:"mydb/autogen")
  2.     |> range(start:2018-05-08T20:50:00Z, stop:2018-05-08T20:51:00Z)
  3.     |> group(columns:["_start","_stop", "region", "host"])
  4.     |> yield(name:"my-result")

CSV response format

Flux supports encodings listed below.

Tables

A table may have the following rows and columns.

Rows

  • Annotation rows: describe column properties.

  • Header row: defines column labels (one header row per table).

  • Record row: describes data in the table (one record per row).

Example

Encoding of a table with and without a header row.

Header row Without header row

  1. result,table,_start,_stop,_time,region,host,_value
  2. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
  3. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
  4. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62
  1. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
  2. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
  3. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62

Columns

In addition to the data columns, a table may include the following columns:

  • Annotation column: Only used in annotation rows. Always the first column. Displays the name of an annotation. Value can be empty or a supported annotation. You’ll notice a space for this column for the entire length of the table, so rows appear to start with ,.

  • Result column: Contains the name of the result specified by the query.

  • Table column: Contains a unique ID for each table in a result.

Multiple tables and results

If a file or data stream contains multiple tables or results, the following requirements must be met:

  • A table column indicates which table a row belongs to.
  • All rows in a table are contiguous.
  • An empty row delimits a new table boundary in the following cases:
    • Between tables in the same result that do not share a common table schema.
    • Between concatenated CSV files.
  • Each new table boundary starts with new annotation and header rows.
Example

Encoding of two tables in the same result with the same schema (header row) and different schema.

Same schema Different schema

  1. result,table,_start,_stop,_time,region,host,_value
  2. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
  3. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
  4. my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62
  5. my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,west,A,62.73
  6. my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,west,B,12.83
  7. my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,C,51.62
  1. ,result,table,_start,_stop,_time,region,host,_value
  2. ,my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43
  3. ,my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25
  4. ,my-result,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62
  6. ,result,table,_start,_stop,_time,location,device,min,max
  7. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,USA,5825,62.73,68.42
  8. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,USA,2175,12.83,56.12
  9. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,USA,6913,51.62,54.25

Dialect options

Flux supports the following dialect options for text/csv format.

OptionDescriptionDefault
headerIf true, the header row is included.true
delimiterCharacter used to delimit columns.,
quoteCharCharacter used to quote values containing the delimiter.“
annotationsList of annotations to encode (datatype, group, or default).empty
commentPrefixString prefix to identify a comment. Always added to annotations.#

Annotations

Annotation rows describe column properties, and start with # (or commentPrefix value). The first column in an annotation row always contains the annotation name. Subsequent columns contain annotation values as shown in the table below.

Annotation nameValuesDescription
datatypea data type or line protocol elementDescribes the type of data or which line protocol element the column represents.
groupboolean flag true or falseIndicates the column is part of the group key.
defaulta value of the column’s data typeValue to use for rows with an empty value.

To encode a table with its group key, the datatype, group, and default annotations must be included. If a table has no rows, the default annotation provides the group key values.

Data types

DatatypeFlux typeDescription
booleanbool“true” or “false”
unsignedLonguintunsigned 64-bit integer
longintsigned 64-bit integer
doublefloatIEEE-754 64-bit floating-point number
stringstringUTF-8 encoded string
base64Binarybytesbase64 encoded sequence of bytes as defined in RFC 4648
dateTimetimeinstant in time, may be followed with a colon : and a description of the format (number, RFC3339, RFC3339Nano)
durationdurationlength of time represented as an unsigned 64-bit integer number of nanoseconds

Line protocol elements

The datatype annotation accepts data types and line protocol elements. Line protocol elements identify how columns are converted into line protocol when using the influx write command to write annotated CSV to InfluxDB.

Line protocol elementDescription
measurementcolumn value is the measurement
field (default)column header is the field key, column value is the field value
tagcolumn header is the tag key, column value is the tag value
timecolumn value is the timestamp (alias for dateTime)
ignore orignoredcolumn is ignored and not included in line protocol

Mixing data types and line protocol elements

Columns with data types (other than dateTime) in the #datatype annotation are treated as fields when converted to line protocol. Columns without a specified data type default to field when converted to line protocol and column values are left unmodified in line protocol. See an example below and line protocol data types and format.

Time columns

A column with time or dateTime #datatype annotations are used as the timestamp when converted to line protocol. If there are multiple time or dateTime columns, the last column (on the right) is used as the timestamp in line protocol. Other time columns are ignored and the influx write command outputs a warning.

Time column values should be Unix timestamps (in an accepted timestamp precision), RFC3339, or RFC3339Nano.

Example line protocol elements in datatype annotation
  1. #datatype measurement,tag,tag,field,field,ignored,time
  2. m,cpu,host,time_steal,usage_user,nothing,time
  3. cpu,cpu1,host1,0,2.7,a,1482669077000000000
  4. cpu,cpu1,host2,0,2.2,b,1482669087000000000

Resulting line protocol:

  1. cpu,cpu=cpu1,host=host1 time_steal=0,usage_user=2.7 1482669077000000000
  2. cpu,cpu=cpu1,host=host2 time_steal=0,usage_user=2.2 1482669087000000000
Example of mixing data types line protocol elements
  1. #datatype measurement,tag,string,double,boolean,long,unsignedLong,duration,dateTime
  2. #default test,annotatedDatatypes,,,,,,
  3. m,name,s,d,b,l,ul,dur,time
  4. ,,str1,1.0,true,1,1,1ms,1
  5. ,,str2,2.0,false,2,2,2us,2020-01-11T10:10:10Z

Resulting line protocol:

  1. test,name=annotatedDatatypes s="str1",d=1,b=true,l=1i,ul=1u,dur=1000000i 1
  2. test,name=annotatedDatatypes s="str2",d=2,b=false,l=2i,ul=2u,dur=2000i 1578737410000000000

Annotated CSV in Flux

Flux requires all annotation and header rows in annotated CSV. The example below illustrates how to use the csv.from() function to read annotated CSV in Flux:

  1. import "csv"
  3. csvData = "#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double,string,string
  4. #group,false,false,true,true,false,true,false,false,true,true
  5. #default,,,,,,,,,,
  6. ,result,table,_start,_stop,_time,region,host,_value,_measurement,_field
  7. ,,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43,cpu,usage_system
  8. ,,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25,cpu,usage_system
  9. ,,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62,cpu,usage_system
  10. ,,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,west,A,62.73,cpu,usage_system
  11. ,,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,west,B,12.83,cpu,usage_system
  12. ,,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,C,51.62,cpu,usage_system
  13. "
  15. csv.from(csv: csvData)

Flux only supports data types in the #datatype annotation. It does does not support line protocol elements.

Errors

If an error occurs during execution, a table returns with:

  • An error column that contains an error message.
  • A reference column with a unique reference code to identify more information about the error.
  • A second row with error properties.

If an error occurs:

  • Before results materialize, the HTTP status code indicates an error. Error details are encoded in the csv table.
  • After partial results are sent to the client, the error is encoded as the next table and remaining results are discarded. In this case, the HTTP status code remains 200 OK.
Example

Encoding for an error with the datatype annotation:

  1. #datatype,string,long
  2. ,error,reference
  3. ,Failed to parse query,897

Encoding for an error that occurs after a valid table has been encoded:

  1. #datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,string,string,double
  2. ,result,table,_start,_stop,_time,region,host,_value
  3. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,west,A,62.73
  4. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,west,B,12.83
  5. ,my-result,1,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,west,C,51.62
  1. #datatype,string,long
  2. ,error,reference,query terminated: reached maximum allowed memory limits,576

csv syntax