# ArrowReadOptions

Controls bounded conversion from a data reader to Apache Arrow record batches.

Class 

`OfficeIMO.Data.Arrow`

**Namespace**

`OfficeIMO.Data.Arrow`

**Assembly**

`OfficeIMO.Data.Arrow`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ArrowReadOptions.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L7)

**Modifiers**

sealed

Controls bounded conversion from a data reader to Apache Arrow record batches.

## Inheritance

- object
- ArrowReadOptions

## Usage

Explore 4 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 4

- Method [DbDataReaderArrowExtensions.ExportArrowCStream](/api/data-arrow/officeimo-data-arrow-dbdatareaderarrowextensions/#method-exportarrowcstream-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken) parameter `options`
- Method [DbDataReaderArrowExtensions.OpenArrowStream](/api/data-arrow/officeimo-data-arrow-dbdatareaderarrowextensions/#method-openarrowstream-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions) parameter `options`
- Method [DbDataReaderArrowExtensions.ReadArrowBatches](/api/data-arrow/officeimo-data-arrow-dbdatareaderarrowextensions/#method-readarrowbatches-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken) parameter `options`
- Method [DbDataReaderArrowExtensions.ReadArrowBatchesAsync](/api/data-arrow/officeimo-data-arrow-dbdatareaderarrowextensions/#method-readarrowbatchesasync-data-common-dbdatareader-officeimo-data-arrow-arrowreadoptions-threading-cancellationtoken) parameter `options`

Filter members 

Show inherited

## Constructors

`public ArrowReadOptions()` [#](#constructor-ctor)

[ArrowReadOptions.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L7)

## 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?`

## Properties

`public int BatchSize { get; set; }` [#](#property-batchsize)

[ArrowReadOptions.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L14)

Gets or sets the maximum number of rows in one record batch.

`public int DecimalPrecision { get; set; }` [#](#property-decimalprecision)

[ArrowReadOptions.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L22)

Gets or sets the precision used for CLR decimal columns.

`public int DecimalScale { get; set; }` [#](#property-decimalscale)

[ArrowReadOptions.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L33)

Gets or sets the scale used for CLR decimal columns.

`public TimeUnit TemporalUnit { get; set; }` [#](#property-temporalunit)

[ArrowReadOptions.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L51)

Gets or sets the Arrow unit used for CLR DateTime, DateTimeOffset, and TimeOnly columns. The default is TimeUnit.Nanosecond, which preserves CLR's 100-nanosecond precision for values in Arrow's nanosecond timestamp range.

`public bool ConvertUnsupportedTypesToString { get; set; }` [#](#property-convertunsupportedtypestostring)

[ArrowReadOptions.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L63)

Gets or sets whether CLR types without a native adapter are converted to invariant text. When false, encountering such a column throws NotSupportedException.

`public IReadOnlyList<Type>? ColumnTypes { get; set; }` [#](#property-columntypes)

[ArrowReadOptions.cs:70](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L70)

Gets or sets an optional CLR type for every source column, in ordinal order. When supplied, these types replace DbDataReader.GetFieldType and allow callers to skip source-reader schema inference.

`public IReadOnlyList<bool>? ColumnNullability { get; set; }` [#](#property-columnnullability)

[ArrowReadOptions.cs:82](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Data.Arrow/ArrowReadOptions.cs#L82)

Gets or sets whether every source column permits nulls, in ordinal order. When omitted, all Arrow fields are nullable. A false entry declares a required field and rejects a batch containing null values in that column.

<!-- PowerForge markdown artifact sha256:6661F20B57E683CA50D8DD60F0D439541BC1A27AC2935BF48C85651F2E298688 -->
