Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update Spark shell command to include setting additional class path #435

Merged
merged 1 commit into from
May 15, 2024
Merged

docs: Update Spark shell command to include setting additional class path #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/source/user-guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,17 @@ Note that the project builds for Scala 2.12 by default but can be built for Scal
make release PROFILES="-Pspark-3.4 -Pscala-2.13"
```

## Run Spark with Comet enabled
## Run Spark Shell with Comet enabled

Make sure `SPARK_HOME` points to the same Spark version as Comet was built for.

```console
export COMET_JAR=spark/target/comet-spark-spark3.4_2.12-0.1.0-SNAPSHOT.jar

$SPARK_HOME/bin/spark-shell \
--jars spark/target/comet-spark-spark3.4_2.12-0.1.0-SNAPSHOT.jar \
--jars $COMET_JAR \
--conf spark.driver.extraClassPath=$COMET_JAR \
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need extraClassPath? --jars adds to both driver and executor

https://spark.apache.org/docs/latest/configuration.html
spark.jars Comma-separated list of jars to include on the driver and executor classpaths. Globs are allowed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we need to specify extraClassPath to resolve the ClassNotFoundException issues described in #182. This is specific to spark-shell and not needed for spark-submit.

Copy link
Member

Choose a reason for hiding this comment

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

It seems some difference on handling extra classpaths on the driver and the executors between spark-submit and spark-shell.

--conf spark.executor.extraClassPath=$COMET_JAR \
--conf spark.sql.extensions=org.apache.comet.CometSparkSessionExtensions \
--conf spark.comet.enabled=true \
--conf spark.comet.exec.enabled=true \
Expand Down