InfluxDB 2.0 JavaScript client
Home > @influxdata/influxdb-client-apis > Dialect
Options for tabular data output. Default output is annotated CSV with headers.
For more information about tabular data **dialect**, see W3 metadata vocabulary for tabular data.
Signature:
interface Dialect
Property | Modifiers | Type | Description |
---|---|---|---|
annotations? | Array<‘group’ | ‘datatype’ | ‘default’> | <p>(Optional) Annotation rows to include in the results. An _annotation_ is metadata associated with an object (column) in the data model.</p><p>#### Related guides</p><p>- See Annotated CSV annotations for examples and more information.</p><p>For more information about **annotations** in tabular data, see W3 metadata vocabulary for tabular data.</p> | |
commentPrefix? | string | (Optional) The character prefixed to comment strings. Default is a number sign (# ). |
|
dateTimeFormat? | ‘RFC3339’ | ‘RFC3339Nano’ | <p>(Optional) The format for timestamps in results. Default is `RFC3339` date/time format. To include nanoseconds in timestamps, use RFC3339Nano .</p><p>#### Example formatted date/time values</p><p>| Format | Value | |:------------|:----------------------------| | RFC3339 | "2006-01-02T15:04:05Z07:00" | | RFC3339Nano | "2006-01-02T15:04:05.999999999Z07:00" |</p> |
|
delimiter? | string | (Optional) The separator used between cells. Default is a comma (, ). |
|
header? | boolean | (Optional) If true, the results contain a header row. |