Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

DbDataReaderArrowExtensions

Namespace OfficeIMO.Data.Arrow
Assembly OfficeIMO.Data.Arrow
Modifiers static

Apache Arrow projections for forward-only tabular readers.

Inheritance

  • Object
  • DbDataReaderArrowExtensions

Methods

public static ArrowCArrayStreamOwner ExportArrowCStream(DbDataReader reader, ArrowReadOptions options = null, CancellationToken cancellationToken = default) #
Returns: ArrowCArrayStreamOwner

Exports the current result set through the Arrow C stream interface without materializing the whole result set.

Parameters

reader System.Data.Common.DbDataReader requiredposition: 0
Forward-only reader to project.
options OfficeIMO.Data.Arrow.ArrowReadOptions = null optionalposition: 1
Bounded Arrow projection options.
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
Cancellation observed by native stream callbacks.
public static IArrowArrayStream OpenArrowStream(DbDataReader reader, ArrowReadOptions options = null) #
Returns: IArrowArrayStream

Opens the current result set as a bounded Apache Arrow record-batch stream.

Parameters

reader System.Data.Common.DbDataReader requiredposition: 0
options OfficeIMO.Data.Arrow.ArrowReadOptions = null optionalposition: 1
public static IEnumerable<RecordBatch> ReadArrowBatches(DbDataReader reader, ArrowReadOptions options = null, CancellationToken cancellationToken = default) #
Returns: IEnumerable<RecordBatch>

Converts the current result set into bounded Arrow record batches. The caller retains ownership of both the reader and every returned batch.

Parameters

reader System.Data.Common.DbDataReader requiredposition: 0
options OfficeIMO.Data.Arrow.ArrowReadOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static IAsyncEnumerable<RecordBatch> ReadArrowBatchesAsync(DbDataReader reader, ArrowReadOptions options = null, CancellationToken cancellationToken = default) #
Returns: IAsyncEnumerable<RecordBatch>

Asynchronously converts the current result set into bounded Arrow record batches. The caller retains ownership of both the reader and every returned batch.

Parameters

reader System.Data.Common.DbDataReader requiredposition: 0
options OfficeIMO.Data.Arrow.ArrowReadOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2