Skip to content

export.ExportMain.Function.exportRows

Christian d'Heureuse edited this page Nov 16, 2026 · 1 revision

tedious-plus / export/ExportMain / exportRows

Function: exportRows()

function exportRows(
   rowSource, 
   metadata, 
   options
): Promise<number>;

Defined in: export/ExportMain.ts:242

Exports rows of tabular data, e.g. the result rows of a query, into a file.

This is the function used by ConnectionPlus.exportQuery(). It can be used directly to export rows from another source. When the export fails, the state of the output file is undefined.

Parameters

rowSource

AsyncIterable<ArrayRow>

The rows to be exported, as arrays of column values.

metadata

Tedious_ArrayRowMetadata

The metadata of the columns.

options

ExportOptions

The output file and optional settings for the columns and the format.

Returns

Promise<number>

A promise for the number of rows exported.

Clone this wiki locally