[SPARK-50382][CONNECT] Add documentation for general information on application development with/extending Spark Connect #48922
+241
−0
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
HyukjinKwon
reviewed
Nov 22, 2024
| # Internal class that satisfies the interface by the Python client | ||
| # of Spark Connect to generate the protobuf representation from | ||
| # an instance of the expression. | ||
| class ExampleExpression(Expression): |
There was a problem hiding this comment.
nit but indentation would have to use 4 spaces instead of tabs
HyukjinKwon
reviewed
Nov 22, 2024
| <img src="img/extending-spark-connect-labelled.png" title="Figure 2: Labelled Architecture" alt="Extending Spark | ||
| Connect Diagram - Labelled Steps" /> | ||
| </p> | ||
| #### (1) Spark Connect Protocol Extension |
There was a problem hiding this comment.
Let's add a space above and below of those ####. They aren't properly rendered in some markdown editors (as technically it's the standard to put spaces around them)
HyukjinKwon
reviewed
Nov 22, 2024
|
|
||
| <p style="text-align: center;"> | ||
| <img src="img/extending-spark-connect.png" title="Figure 1: Architecture" alt="Extending Spark | ||
| Connect Diagram" /> |
There was a problem hiding this comment.
Suggested change
| Connect Diagram" /> | |
| Connect Diagram"/> |
HyukjinKwon
reviewed
Nov 22, 2024
| A Spark Server Library consists of the following components, illustrated in Fig. 2: | ||
|
|
||
| 1. The Spark Connect protocol extension (blue box _Proto_ API) | ||
| 2. A Spark Connect Plugin… |
There was a problem hiding this comment.
is … a typo? or incomplete? Below too.
HyukjinKwon
reviewed
Nov 22, 2024
| Application, alongside PySpark or the Scala Spark Client. | ||
| <p style="text-align: center;"> | ||
| <img src="img/extending-spark-connect-labelled.png" title="Figure 2: Labelled Architecture" alt="Extending Spark | ||
| Connect Diagram - Labelled Steps" /> |
There was a problem hiding this comment.
Suggested change
| Connect Diagram - Labelled Steps" /> | |
| Connect Diagram - Labelled Steps"/> |
HyukjinKwon
reviewed
Nov 22, 2024
Comment on lines
+215
to
+217
| from pyspark.sql.connect.column import Expression | ||
| from myxample.proto import ExamplePluginExpression | ||
| import pyspark.sql.connect.proto as proto |
There was a problem hiding this comment.
Suggested change
| from pyspark.sql.connect.column import Expression | |
| from myxample.proto import ExamplePluginExpression | |
| import pyspark.sql.connect.proto as proto | |
| from pyspark.sql.connect.column import Expression | |
| import pyspark.sql.connect.proto as proto | |
| from myxample.proto import ExamplePluginExpression |
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?
Adds a new page,
app-dev-spark-connect.md, which is hyperlinked from theUse Spark Connect in standalone applicationssection inspark-connect-overview.Why are the changes needed?
There is a lack of documentation in the area of application development (with Spark Connect) especially so on extending Spark Connect with custom logic/libraries/plugins.
Does this PR introduce any user-facing change?
Yes, new page titled "Application Development with Spark Connect"
Render screenshot:
How was this patch tested?
Local rendering
Was this patch authored or co-authored using generative AI tooling?
No