Skip to content

[SPARK-47374][CONNECT][DOCS] Fix connect-repl usage prompt & docs link - #45494

Closed
panbingkun wants to merge 2 commits into
apache:masterfrom
panbingkun:SPARK-47374
Closed

panbingkun wants to merge 2 commits into
apache:masterfrom
panbingkun:SPARK-47374

Conversation

@panbingkun

@panbingkun panbingkun commented Mar 13, 2024 •

Copy link
Copy Markdown
Contributor

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:
    image

    After:
    image

  • 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:
    image

    After:
    image

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.

| --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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link has outdated.

| --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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An explanation of user_agent

// Provides optional information about the client sending the request. This field
// can be used for language or version specific information and is only intended for
// logging purposes and will not be interpreted by the server.
optional string client_type = 3;

@panbingkun

Copy link
Copy Markdown
Contributor Author

cc @hvanhovell @HyukjinKwon

@HyukjinKwon

Copy link
Copy Markdown
Member

Merged to master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants