Enhance documentation to clarify that DataFrame objects are iterable, yielding pyarrow.RecordBatch instances lazily.

Author: kosiew

docs/source/user-guide/dataframe/index.rst

@@ -168,6 +168,14 @@ out-of-memory errors.
     for batch in reader:
         ...  # process each batch as it is produced
 
+DataFrames are also iterable, yielding :class:`pyarrow.RecordBatch` objects
+lazily so you can loop over results directly:
+
+.. code-block:: python
+
+    for batch in df:
+        ...  # process each batch as it is produced
+
 See :doc:`../io/arrow` for additional details on the Arrow interface.
 
 HTML Rendering

python/datafusion/dataframe.py

@@ -290,6 +290,9 @@ def __init__(
 class DataFrame:
     """Two dimensional table representation of data.
 
+    DataFrame objects are iterable; iterating over a DataFrame yields
+    :class:`pyarrow.RecordBatch` instances lazily.
+
     See :ref:`user_guide_concepts` in the online documentation for more information.
     """