Rename to_record_batch_stream to execute_stream and update references in the codebase; mark the old method as deprecated.

Author: kosiew

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

@@ -194,12 +194,12 @@ Asynchronous iteration is supported as well, allowing integration with
         ...  # process each batch as it is produced
 
 To work with the stream directly, use
-``to_record_batch_stream()``, which returns a
+``execute_stream()``, which returns a
 :class:`~datafusion.RecordBatchStream`:
 
 .. code-block:: python
 
-    stream = df.to_record_batch_stream()
+    stream = df.execute_stream()
     for batch in stream:
         ...
 

python/datafusion/dataframe.py

@@ -1040,9 +1040,12 @@ def execute_stream_partitioned(self) -> list[RecordBatchStream]:
         streams = self.df.execute_stream_partitioned()
         return [RecordBatchStream(rbs) for rbs in streams]
 
-    def to_record_batch_stream(self) -> RecordBatchStream:  # noqa: F811
+    @deprecated("Use execute_stream() instead")
+    def to_record_batch_stream(self) -> RecordBatchStream:
         """Return a :py:class:`RecordBatchStream` over this DataFrame's results.
 
+        This method is deprecated. Use :py:meth:`execute_stream` instead.
+
         Returns:
             A ``RecordBatchStream`` representing the lazily generated record
             batches for this DataFrame.
@@ -1133,11 +1136,11 @@ def __arrow_c_stream__(self, requested_schema: object | None = None) -> object:
 
     def __iter__(self) -> Iterator[RecordBatch]:
         """Return an iterator over this DataFrame's record batches."""
-        return iter(self.to_record_batch_stream())
+        return iter(self.execute_stream())
 
     def __aiter__(self) -> AsyncIterator[RecordBatch]:
         """Return an async iterator over this DataFrame's record batches."""
-        return self.to_record_batch_stream().__aiter__()
+        return self.execute_stream().__aiter__()
 
     def transform(self, func: Callable[..., DataFrame], *args: Any) -> DataFrame:
         """Apply a function to the current DataFrame which returns another DataFrame.

python/tests/test_dataframe.py

@@ -403,8 +403,8 @@ def test_iter_returns_datafusion_recordbatch(df):
         assert isinstance(batch, RecordBatch)
 
 
-def test_to_record_batch_stream(df):
-    stream = df.to_record_batch_stream()
+def test_execute_stream_basic(df):
+    stream = df.execute_stream()
     batches = list(stream)
 
     assert len(batches) == 1