# DbDataReaderArrowExtensions

Apache Arrow projections for forward-only tabular readers.

Class 

`OfficeIMO.Data.Arrow`

**Namespace**

`OfficeIMO.Data.Arrow`

**Assembly**

`OfficeIMO.Data.Arrow`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[DbDataReaderArrowStreamExtensions.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/DbDataReaderArrowStreamExtensions.cs#L21)

**Modifiers**

static

Apache Arrow projections for forward-only tabular readers.

## Inheritance

- object
- DbDataReaderArrowExtensions

Filter members 

Show inherited

## Methods

`public static ArrowCArrayStreamOwner ExportArrowCStream(DbDataReader reader, ArrowReadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-exportarrowcstream-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken)

[DbDataReaderArrowStreamExtensions.cs:55](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/DbDataReaderArrowStreamExtensions.cs#L55)

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

Parameters

**reader System.Data.Common.DbDataReader required**

Forward-only reader to project.

**options OfficeIMO.Data.Arrow.ArrowReadOptions? = null optional**

Bounded Arrow projection options.

**cancellationToken System.Threading.CancellationToken = default optional**

Cancellation observed by native stream callbacks.

Returns

`ArrowCArrayStreamOwner`

`public static IArrowArrayStream OpenArrowStream(DbDataReader reader, ArrowReadOptions? options = null)` [#](#method-openarrowstream-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions)

[DbDataReaderArrowStreamExtensions.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/DbDataReaderArrowStreamExtensions.cs#L21)

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

Parameters

**reader System.Data.Common.DbDataReader required**

**options OfficeIMO.Data.Arrow.ArrowReadOptions? = null optional**

Returns

`IArrowArrayStream`

`public static IEnumerable<RecordBatch> ReadArrowBatches(DbDataReader reader, ArrowReadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-readarrowbatches-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken)

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 required**

**options OfficeIMO.Data.Arrow.ArrowReadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`IEnumerable<RecordBatch>`

`public static IAsyncEnumerable<RecordBatch> ReadArrowBatchesAsync(DbDataReader reader, ArrowReadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-readarrowbatchesasync-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken)

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 required**

**options OfficeIMO.Data.Arrow.ArrowReadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`IAsyncEnumerable<RecordBatch>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:5E5B6D7CF41BC88D62399B5F575B2C9B5A25ED5F301FB836B01C36A4AAD823AF -->
