RecordBatchReader¶

arro3.core.RecordBatchReader ¶

A Python-facing Arrow record batch reader.

This is a wrapper around a [RecordBatchReader].

closed ¶

closed: bool = <attribute 'closed' of 'arro3.core._core.RecordBatchReader' objects>

Returns true if this reader has already been consumed.

schema ¶

schema = <attribute 'schema' of 'arro3.core._core.RecordBatchReader' objects>

Access the schema of this table

__arrow_c_stream__ `method descriptor` ¶

__arrow_c_stream__(requested_schema: object | None = None) -> object

An implementation of the Arrow PyCapsule Interface. This dunder method should not be called directly, but enables zero-copy data transfer to other Python libraries that understand Arrow memory.

For example, you can call pyarrow.table() to convert this array into a pyarrow table, without copying memory.

from_arrow `builtin` ¶

from_arrow(
    input: ArrowArrayExportable | ArrowStreamExportable,
) -> RecordBatchReader

Construct this from an existing Arrow object.

It can be called on anything that exports the Arrow stream interface (__arrow_c_stream__), such as a Table or RecordBatchReader.

from_arrow_pycapsule `builtin` ¶

from_arrow_pycapsule(capsule) -> RecordBatchReader

Construct this object from a bare Arrow PyCapsule.