[SPARK-47374][CONNECT][DOCS] Fix connect-repl usage prompt & docs link
#45494
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
panbingkun
commented
Mar 13, 2024
| 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. |
There was a problem hiding this comment.
panbingkun
commented
Mar 13, 2024
| @@ -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). | |||
There was a problem hiding this comment.
The link has outdated.
panbingkun
commented
Mar 13, 2024
| | --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). |
There was a problem hiding this comment.
An explanation of user_agent
HyukjinKwon
approved these changes
Mar 14, 2024
|
Merged to master. |
sweisdb
pushed a commit
to sweisdb/spark
that referenced
this pull request
Apr 1, 2024
…link` ### 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 The url `https://github.com/apache/spark/blob/master/connector/connect/client/jvm/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L48` does not exist. Before: <img width="1324" alt="image" src="https://github.com/apache/spark/assets/15246973/a1dd0578-cba1-4cfe-8330-fcd48c84ca69"> After: <img width="1222" alt="image" src="https://github.com/apache/spark/assets/15246973/a66467e3-652f-4288-888d-d676b3365569"> ### 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. Closes apache#45494 from panbingkun/SPARK-47374. Authored-by: panbingkun <panbingkun@baidu.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
The pr aims to:
usage prompt.Why are the changes needed?
Only fix bug.
Usage prompt
1.update
enable_ssltouse_ssl.2.add
user_agentandsession_idBefore:
After:
Docs link
The url
https://github.com/apache/spark/blob/master/connector/connect/client/jvm/src/main/scala/org/apache/spark/sql/connect/client/SparkConnectClientParser.scala#L48does not exist.Before:
After:
Does this PR introduce any user-facing change?
Yes, the
connect-replusage promptanddocs linkhave been corrected.How was this patch tested?
Was this patch authored or co-authored using generative AI tooling?
No.