Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

Commit

Permalink
Update 01-ug-quick-start-guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paryoja committed Nov 16, 2021
1 parent d8c4b79 commit a196b93
Showing 1 changed file with 59 additions and 13 deletions.
72 changes: 59 additions & 13 deletions docs/_docs/01-ug-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,16 +239,62 @@ hs.explain(query, verbose = True)

#### Enable Hyperspace

Now that you have created an index that your query can utilize, you can enable Hyperspace and execute your query:

Scala:
```scala
spark.enableHyperspace
query.show
```

Python:
```python
Hyperspace.enable(spark)
query.show()
```
Now that you have created an index that your query can utilize, you can enable Hyperspace and execute your query.
There are two ways to enable Hyperspace:

1. Using Hyperspace extension

You can start a session with Hyperspace extension.
The follows are examples to use Spark™ with Hyperspace.

spark-submit:
```
spark-submit -c spark.sql.extensions=com.microsoft.hyperspace.HyperspaceSparkSessionExtension ...
```
Scala:
```scala
val spark = SparkSession
.builder()
.appName("...")
.master("...")
.config("spark.sql.extensions", "com.microsoft.hyperspace.HyperspaceSparkSessionExtension")
.getOrCreate()
```
Python:
```python
from pyspark.sql import SparkSession
spark = SparkSession \
.builder \
.appName("...") \
.master("...") \
.config("spark.sql.extensions", "com.microsoft.hyperspace.HyperspaceSparkSessionExtension") \
.getOrCreate()
```
Spark configuration file (default: `$SPARK_HOME/conf/spark-defaults.conf`):
```cs
# Add the following line to the configuration file.
spark.sql.extensions com.microsoft.hyperspace.HyperspaceSparkSessionExtension
```
2. Calling enableHyperspace function explicitly
By explicitly calling enableHyperspace (for Scala) or Hyperspace.enable (for Python), Spark will use Hyperspace indexes when it is applicable.
Scala:
```scala
spark.enableHyperspace
query.show
```
Python:
```python
Hyperspace.enable(spark)
query.show()
```

0 comments on commit a196b93

Please sign in to comment.