You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "panbingkun (via GitHub)" <gi...@apache.org> on 2024/03/13 07:13:05 UTC
[PR] [SPARK-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
panbingkun opened a new pull request, #45494:
URL: https://github.com/apache/spark/pull/45494
### What changes were proposed in this pull request?
The pr aims to:
- fix connect-repl `usage prompt`.
- fix docs link.
### Why are the changes needed?
Only fix bug.
- Usage prompt
1.update `enable_ssl` to `use_ssl`.
2.add `user_agent` and `session_id`
Before:
<img width="1025" alt="image" src="https://github.com/apache/spark/assets/15246973/db401e7f-9569-469c-90eb-17c277472b4d">
After:
<img width="1025" alt="image" src="https://github.com/apache/spark/assets/15246973/de7b1f8c-1d0d-4696-8f93-f72636b0d1a0">
- Docs link
### Does this PR introduce _any_ user-facing change?
Yes, the `connect-repl` `usage prompt` and `docs link` have been corrected.
### How was this patch tested?
- Manually test.
- Pass GA.
### 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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #45494: [SPARK-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link`
URL: https://github.com/apache/spark/pull/45494
--
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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #45494:
URL: https://github.com/apache/spark/pull/45494#discussion_r1522658327
##########
connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala:
##########
@@ -29,17 +29,21 @@ private[sql] object SparkConnectClientParser {
* usage string.
*/
def usage(): String =
+ // scalastyle:off line.size.limit
s"""
|Options:
| --remote REMOTE URI of the Spark Connect Server to connect to.
| --host HOST Host where the Spark Connect Server is running.
| --port PORT Port where the Spark Connect Server is running.
- | --enable-ssl Connect to the server using SSL.
+ | --use_ssl Connect to the server using SSL.
| --token TOKEN Token to use for authentication.
| --user_id USER_ID Id of the user connecting.
| --user_name USER_NAME Name of the user connecting.
+ | --user_agent USER_AGENT The User-Agent Client information (only intended for logging purposes by the server).
Review Comment:
An explanation of `user_agent`
https://github.com/apache/spark/blob/c7795bb8cc82073ba555aaa233e3b2586ae6d1eb/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClient.scala#L676
https://github.com/apache/spark/blob/c7795bb8cc82073ba555aaa233e3b2586ae6d1eb/connector/connect/common/src/main/protobuf/spark/connect/base.proto#L72-L75
--
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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #45494:
URL: https://github.com/apache/spark/pull/45494#issuecomment-1996597762
Merged to 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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #45494:
URL: https://github.com/apache/spark/pull/45494#discussion_r1522653119
##########
docs/spark-connect-overview.md:
##########
@@ -279,7 +279,7 @@ The customizations may also be passed in through CLI arguments as shown below:
spark-connect-repl --host myhost.com --port 443 --token ABCDEFG
{% endhighlight %}
-The supported list of CLI arguments may be found [here](https://github.com/apache/spark/blob/master/connector/connect/client/jvm/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L48).
Review Comment:
The link has outdated.
--
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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #45494:
URL: https://github.com/apache/spark/pull/45494#discussion_r1522651676
##########
connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala:
##########
@@ -29,17 +29,21 @@ private[sql] object SparkConnectClientParser {
* usage string.
*/
def usage(): String =
+ // scalastyle:off line.size.limit
s"""
|Options:
| --remote REMOTE URI of the Spark Connect Server to connect to.
| --host HOST Host where the Spark Connect Server is running.
| --port PORT Port where the Spark Connect Server is running.
- | --enable-ssl Connect to the server using SSL.
+ | --use_ssl Connect to the server using SSL.
Review Comment:
Obviously, it is `use_ssl` here
https://github.com/apache/spark/blob/master/connector/connect/common/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L63
--
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-47374][CONNECT][DOCS] Fix connect-repl `usage prompt` & `docs link` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on PR #45494:
URL: https://github.com/apache/spark/pull/45494#issuecomment-1993719969
cc @hvanhovell @HyukjinKwon
--
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