system.dataset.toCSV

Description

Formats the contents of a dataset as CSV (comma separated values), returning the resulting CSV as a string. If the "forExport" flag is set, then the format will be appropriate for parsing using the system.dataset.fromCSV function.

Syntax

system.dataset.toCSV(dataset, showHeaders, forExport, localized)

Parameters

Dataset dataset - The dataset to export to CSV.

Boolean showHeaders - If set to true(1), a header row will be present in the CSV. Default is true(1).

Boolean forExport - If set to true(1), extra header information will be present in the CSV data which is necessary for the CSV to be compatible with the fromCSV method. Overrides showHeaders. Default is false(0).

Boolean localized - If set to true(1), the string representations of the values in the CSV data will be localized.

Returns

String - The CSV data as a string

Scope

All

Examples

This snippet would run a SQL query against a database, and turn the results into a CSV string. It would then store resulting CSV to a file on the local hard drive.

results = system.db.runQuery("SELECT * FROM example1 LIMIT 100")

results = system.dataset.toDataSet(results)

csv = system.dataset.toCSV(dataset = results, showHeaders = True, forExport = False)

filePath = "C:\\output\\results.csv"

system.file.writeFile(filePath, csv)

See also:

system.dataset.exportCSV