Class ArrowWriteExtensions

Namespace

ExcelReader.Arrow

Assembly

ExcelReader.Arrow.dll

Writes an Apache Arrow Apache.Arrow.RecordBatch to a workbook as one sheet — the write-side mirror of ToArrowRecordBatch(IExcelSheet, ArrowReadOptions?).

public static class ArrowWriteExtensions

Inheritance

object

ArrowWriteExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

WriteRecordBatch(CsvWorkbookWriter, RecordBatch, ArrowWriteOptions?)

Writes batch to workbook as CSV's single unnamed sheet, in a single call. SheetName is ignored.

public static void WriteRecordBatch(this CsvWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null)

Parameters

workbook CsvWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

Exceptions

ArgumentNullException

workbook or batch is null.

NotSupportedException

A column's Arrow type is not one of the supported types.

WriteRecordBatch(XlsWorkbookWriter, RecordBatch, ArrowWriteOptions?)

Same as WriteRecordBatch(XlsxWorkbookWriter, RecordBatch, ArrowWriteOptions?), for a legacy XLS workbook.

public static void WriteRecordBatch(this XlsWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null)

Parameters

workbook XlsWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

Exceptions

ArgumentNullException

workbook or batch is null.

NotSupportedException

A column's Arrow type is not one of the supported types.

WriteRecordBatch(XlsbWorkbookWriter, RecordBatch, ArrowWriteOptions?)

Same as WriteRecordBatch(XlsxWorkbookWriter, RecordBatch, ArrowWriteOptions?), for an XLSB workbook.

public static void WriteRecordBatch(this XlsbWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null)

Parameters

workbook XlsbWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

Exceptions

ArgumentNullException

workbook or batch is null.

NotSupportedException

A column's Arrow type is not one of the supported types.

WriteRecordBatch(XlsxWorkbookWriter, RecordBatch, ArrowWriteOptions?)

Writes batch to workbook as one XLSX sheet, in a single call: adds the sheet, writes the header row (unless WriteHeader is false) and every data row, then ends the sheet and the workbook.

public static void WriteRecordBatch(this XlsxWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null)

Parameters

workbook XlsxWorkbookWriter

A freshly created, not-yet-started workbook writer.

batch RecordBatch

The batch to write. Supported Arrow types: string, large string, string view, every integer width (signed and unsigned), half float, float, double, decimal128, decimal256, boolean, date32, date64, time32, time64, timestamp and null.

options ArrowWriteOptions

The sheet name and whether to write a header row; Default when null.

Exceptions

ArgumentNullException

workbook or batch is null.

NotSupportedException

A column's Arrow type is not one of the supported types.

WriteRecordBatchAsync(CsvWorkbookWriter, RecordBatch, ArrowWriteOptions?, CancellationToken)

Asynchronous counterpart to WriteRecordBatch(CsvWorkbookWriter, RecordBatch, ArrowWriteOptions?).

public static ValueTask WriteRecordBatchAsync(this CsvWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null, CancellationToken ct = default)

Parameters

workbook CsvWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

ct CancellationToken

Returns

ValueTask

WriteRecordBatchAsync(XlsWorkbookWriter, RecordBatch, ArrowWriteOptions?, CancellationToken)

Asynchronous counterpart to WriteRecordBatch(XlsWorkbookWriter, RecordBatch, ArrowWriteOptions?).

public static ValueTask WriteRecordBatchAsync(this XlsWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null, CancellationToken ct = default)

Parameters

workbook XlsWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

ct CancellationToken

Returns

ValueTask

WriteRecordBatchAsync(XlsbWorkbookWriter, RecordBatch, ArrowWriteOptions?, CancellationToken)

Asynchronous counterpart to WriteRecordBatch(XlsbWorkbookWriter, RecordBatch, ArrowWriteOptions?).

public static ValueTask WriteRecordBatchAsync(this XlsbWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null, CancellationToken ct = default)

Parameters

workbook XlsbWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

ct CancellationToken

Returns

ValueTask

WriteRecordBatchAsync(XlsxWorkbookWriter, RecordBatch, ArrowWriteOptions?, CancellationToken)

Asynchronous counterpart to WriteRecordBatch(XlsxWorkbookWriter, RecordBatch, ArrowWriteOptions?).

public static ValueTask WriteRecordBatchAsync(this XlsxWorkbookWriter workbook, RecordBatch batch, ArrowWriteOptions? options = null, CancellationToken ct = default)

Parameters

workbook XlsxWorkbookWriter

batch RecordBatch

options ArrowWriteOptions

ct CancellationToken

Returns

ValueTask