You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "hvanhovell (via GitHub)" <gi...@apache.org> on 2025/02/05 01:54:13 UTC
[PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
hvanhovell opened a new pull request, #49800:
URL: https://github.com/apache/spark/pull/49800
### What changes were proposed in this pull request?
This PR fixes a bunch of issues with SQL API docs for Scala and Java:
- Removes the now defunct Connect API docs. The current SQL docs provide enough coverage.
- Removes the following internal packages from the docs: `org.apache.spark.sql.artifact`, `org.apache.spark.sql.scripting`, and `org.apache.spark.sql.ml`.
- Fixes the removal of the `org.apache.spark.error` and `org.apache.spark.sql.error` packages.
- Marks a bunch of internal classes in the `org.apache.spark.sql` as `private[sql]` to remove them from the docs.
- Moves the `TableValuedFunctionArgument` interface from `org.apache.spark.sql` to `org.apache.spark.sql.internal` because it kept showing up in the docs.
### Why are the changes needed?
Readable docs are important!
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Manual inspection of the Java and Scala docs.
### Was this patch authored or co-authored using generative AI tooling?
No.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #49800:
URL: https://github.com/apache/spark/pull/49800#discussion_r1942362928
##########
project/SparkBuild.scala:
##########
@@ -1366,14 +1363,18 @@ trait SharedUnidocSettings {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/collection")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/io")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/kvstore")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/artifact")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalyst")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/connect/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/classic/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/execution")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/internal")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/scripting")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/ml")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalog/v2/utils")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.errors")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.sql.errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/errors")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/v2/avro")))
Review Comment:
ah I see. Yea we should move it to `org.apache.spark.sql.execution.datasources.avro` following other file sources.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
Posted by "hvanhovell (via GitHub)" <gi...@apache.org>.
hvanhovell commented on PR #49800:
URL: https://github.com/apache/spark/pull/49800#issuecomment-2639845374
Merging to 4.0/master.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
Posted by "asfgit (via GitHub)" <gi...@apache.org>.
asfgit closed pull request #49800: [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues.
URL: https://github.com/apache/spark/pull/49800
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #49800:
URL: https://github.com/apache/spark/pull/49800#discussion_r1942157850
##########
project/SparkBuild.scala:
##########
@@ -1366,14 +1363,18 @@ trait SharedUnidocSettings {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/collection")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/io")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/kvstore")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/artifact")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalyst")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/connect/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/classic/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/execution")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/internal")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/scripting")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/ml")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalog/v2/utils")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.errors")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.sql.errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/errors")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/v2/avro")))
Review Comment:
shall we also exclude `org.apache.spark.sql.avro`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. [spark]
Posted by "hvanhovell (via GitHub)" <gi...@apache.org>.
hvanhovell commented on code in PR #49800:
URL: https://github.com/apache/spark/pull/49800#discussion_r1942181077
##########
project/SparkBuild.scala:
##########
@@ -1366,14 +1363,18 @@ trait SharedUnidocSettings {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/collection")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/io")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/util/kvstore")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/artifact")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalyst")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/connect/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/classic/")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/execution")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/internal")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/scripting")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/ml")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/catalog/v2/utils")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.errors")))
- .map(_.filterNot(_.getCanonicalPath.contains("org.apache.spark.sql.errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/errors")))
+ .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/errors")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hive")))
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/v2/avro")))
Review Comment:
Well the problem is that `org.apache.spark.sql.avro.functions` is user facing API. I can mark the entire datasource implementation as `private[sql]`, but I'd prefer to move it elsewhere.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org