ak.from_arrow — Awkward Array documentation

# ak.from_arrow

Defined in awkward.operations.convert on line 2593.

ak.from_arrow(array, highlevel=True, behavior=None)
  Parameters:

    - (pyarrow.Array (array) – or `pyarrow.Table`): Apache Arrow array to convert into an Awkward Array.

    - pyarrow.ChunkedArray – or `pyarrow.Table`): Apache Arrow array to convert into an Awkward Array.

    - pyarrow.RecordBatch – or `pyarrow.Table`): Apache Arrow array to convert into an Awkward Array.

  :paramor `pyarrow.Table`): Apache Arrow array to convert into an

    Awkward Array.

  Parameters:

    - highlevel (bool) – If True, return an `ak.Array`; otherwise, return a low-level `ak.layout.Content` subclass.

    - behavior (None or dict) – Custom `ak.behavior` for the output array, if high-level.

Converts an Apache Arrow array into an Awkward Array.

Arrow arrays can maintain the distinction between “option-type but no elements are missing” and “not option-type” at all levels except the top level. Arrow tables can maintain the distinction at all levels. However, note that there is no distinction between `?union[X, Y, Z]]` type and `union[?X, ?Y, ?Z]` type. Be aware of these type distinctions when passing data through Arrow or Parquet.

See also `ak.to_arrow`, `ak.to_arrow_table`.