This is an automated email from the ASF dual-hosted git repository.
dongjoon 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 aa1eca8d26cc [MINOR][DOCS] Add `since` tag for
`Scan.reportDriverMetrics`
aa1eca8d26cc is described below
commit aa1eca8d26cc69cc0e85403ea65ca07f577248ca
Author: zouxxyy <zouxinyu....@alibaba-inc.com>
AuthorDate: Sat Dec 2 11:43:50 2023 -0800
[MINOR][DOCS] Add `since` tag for `Scan.reportDriverMetrics`
### What changes were proposed in this pull request?
Add `since` tag for `reportDriverMetrics`
### Why are the changes needed?
The `reportDriverMetrics` api in `Scan`was introduced in spark3.4.0, we
need to the `since` tag to facilitate developers
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
No need test
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #44116 from Zouxxyy/dev/add-tag.
Authored-by: zouxxyy <zouxinyu....@alibaba-inc.com>
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
.../src/main/java/org/apache/spark/sql/connector/read/Scan.java | 2 ++
1 file changed, 2 insertions(+)
diff --git
a/sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/Scan.java
b/sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/Scan.java
index 969a47be7070..edb6e631c30f 100644
--- a/sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/Scan.java
+++ b/sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/Scan.java
@@ -121,6 +121,8 @@ public interface Scan {
* Returns an array of custom metrics which are collected with values at the
driver side only.
* Note that these metrics must be included in the supported custom metrics
reported by
* `supportedCustomMetrics`.
+ *
+ * @since 3.4.0
*/
default CustomTaskMetric[] reportDriverMetrics() {
return new CustomTaskMetric[]{};
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
