This is an automated email from the ASF dual-hosted git repository.
uros-b pushed a commit to branch branch-4.x
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-4.x by this push:
new a79ae57a37d8 [MINOR][SQL][DOC] Mention bin/spark-connect-shell in docs
a79ae57a37d8 is described below
commit a79ae57a37d83ea6cb9b75112504e00952194cf1
Author: Nicholas Chammas <[email protected]>
AuthorDate: Sat Aug 15 10:23:40 2026 +0000
[MINOR][SQL][DOC] Mention bin/spark-connect-shell in docs
### What changes were proposed in this pull request?
Mention `bin/spark-connect-shell` in the Spark Connect docs.
### Why are the changes needed?
This script exists and is intended for end-users. It should be mentioned
somewhere in the docs at least once.
### Does this PR introduce _any_ user-facing change?
Documentation only.
### How was this patch tested?
Reviewed the docs locally via:
```sh
SKIP_API=1 bundle exec jekyll serve
```
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #58009 from nchammas/spark-connect-shell-docs.
Authored-by: Nicholas Chammas <[email protected]>
Signed-off-by: Uros Bojanic <[email protected]>
(cherry picked from commit f95d79c2531cf95a787cc2936187f59187892505)
Signed-off-by: Uros Bojanic <[email protected]>
---
docs/spark-connect-overview.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/spark-connect-overview.md b/docs/spark-connect-overview.md
index 2f1c0836c383..02b9318ad415 100644
--- a/docs/spark-connect-overview.md
+++ b/docs/spark-connect-overview.md
@@ -111,17 +111,19 @@ latest release in the release drop down at the top of
the page. Then choose you
Now extract the Spark package you just downloaded on your computer, for
example:
-{% highlight bash %}
+```bash
tar -xvf spark-{{site.SPARK_VERSION_SHORT}}-bin-hadoop3.tgz
-{% endhighlight %}
+```
In a terminal window, go to the `spark` folder in the location where you
extracted
Spark before and run the `start-connect-server.sh` script to start Spark
server with
Spark Connect, like in this example:
-{% highlight bash %}
+```bash
./sbin/start-connect-server.sh
-{% endhighlight %}
+```
+
+Alternatively, `./bin/spark-connect-shell` starts an interactive Scala shell
with the Connect server hosted inside the shell process itself.
Make sure to use the same version of the package as the Spark version you
downloaded previously. In this example, Spark {{site.SPARK_VERSION_SHORT}}
with Scala 2.13.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
