Skip to main content

Export Result

Exports a Magpie result for download or display on a map.

Syntax​

export result
  [from sql(<sql query>)]
  [with format <file format>]
  [with delimiter "<delimiter>"]
  [with encoding "<encoding>"]
  [with quote char "<quote character>"]
  [with escape char "<escape character>"]
  [with null value "<null value>"]
  [with date format "<date format>"]
  [with timestamp format "<timestamp format>"]
  [with ignore leading white space]
  [with ignore trailing white space]
  [with quote all]

Parameters​

sql query​

String — If present, this SQL query result will be made available for export upon completion. Otherwise, the latest result will be exported.

file format​

String — The format of the exported file. Default is csv. Options: csv, json.

delimiter​

String — The character used to separate fields within the file. Only used for csv files. Default is ,.

encoding​

String — The encoding of the file. Default is UTF-8.

quote character​

String — The character optionally used to enclose fields within the file. Only used for csv files. Default is ".

escape character​

String — The character optionally used to escape quotations within a quoted field. Only used for csv files. Default is ".

null value​

String — Nulls will be converted to this value within the file. Only used for csv files. Default is an empty string.

date format​

String — The Java date format used when writing dates to the file. Default is yyyy-MM-dd.

timestamp format​

String — The Java datetime format used when writing timestamps to the file. Default is yyyy-MM-dd'T'HH:mm:ss.SSSXXX for json and yyyy-MM-dd HH:mm:ss for csv.

ignore leading white space​

None. If present, leading white space will be trimmed from each field before export. Only used for csv files.

ignore trailing white space​

None. If present, trailing white space will be trimmed from each field before export. Only used for csv files.

quote all​

None. If present, this option causes all fields to be enclosed in quotes. Only used for csv files.