You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by mg...@apache.org on 2024/08/21 15:30:59 UTC
(spark) branch master updated: [SPARK-48638][FOLLOW][CONNECT] Fix documentation for ExecutionInfo
This is an automated email from the ASF dual-hosted git repository.
mgrund pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 99b793965f01 [SPARK-48638][FOLLOW][CONNECT] Fix documentation for ExecutionInfo
99b793965f01 is described below
commit 99b793965f0126fd7b0cbc169cb6996058ff6023
Author: Martin Grund <ma...@databricks.com>
AuthorDate: Wed Aug 21 17:30:46 2024 +0200
[SPARK-48638][FOLLOW][CONNECT] Fix documentation for ExecutionInfo
### What changes were proposed in this pull request?
A previous renaming of the method and class names left the documentation out of sync. This patch fixes this.
### Why are the changes needed?
Consistency.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Existing tests.
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #47829 from grundprinzip/SPARK-48638-v2.
Authored-by: Martin Grund <ma...@databricks.com>
Signed-off-by: Martin Grund <ma...@databricks.com>
---
python/pyspark/sql/dataframe.py | 6 +++---
python/pyspark/sql/metrics.py | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py
index 050ecf4cf3c3..6f1afaba5f98 100644
--- a/python/pyspark/sql/dataframe.py
+++ b/python/pyspark/sql/dataframe.py
@@ -6326,9 +6326,9 @@ class DataFrame:
@property
def executionInfo(self) -> Optional["ExecutionInfo"]:
"""
- Returns a QueryExecution object after the query was executed.
+ Returns a ExecutionInfo object after the query was executed.
- The queryExecution method allows to introspect information about the actual
+ The executionInfo method allows to introspect information about the actual
query execution after the successful execution. Accessing this member before
the query execution will return None.
@@ -6339,7 +6339,7 @@ class DataFrame:
Returns
-------
- An instance of QueryExecution or None when the value is not set yet.
+ An instance of ExecutionInfo or None when the value is not set yet.
Notes
-----
diff --git a/python/pyspark/sql/metrics.py b/python/pyspark/sql/metrics.py
index 050034ffba04..0f4142e91b25 100644
--- a/python/pyspark/sql/metrics.py
+++ b/python/pyspark/sql/metrics.py
@@ -269,7 +269,7 @@ class CollectedMetrics:
class ExecutionInfo:
- """The query execution class allows users to inspect the query execution of this particular
+ """The ExecutionInfo class allows users to inspect the query execution of this particular
data frame. This value is only set in the data frame if it was executed."""
def __init__(
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org