Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pan3793 committed Sep 18, 2024
1 parent 7cdc63e commit 860aeae
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion HOW-TO.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@
- limitations under the License.
-->

Kyuubi Connect
==============

### Source Code under development

```
git clone https://github.com/pan3793/kyuubi.git -b kyuubi-next kyuubi-next
```

### Requirements

- `JAVA_HOME` points to Java 17
Expand All @@ -24,6 +33,7 @@

#### Run within IDEA

- Run `build/mvn clean install -DskipTests` to build the project and produce the Spark engine jar
- Run `kyuubi-server/src/main/scala/org/apache/kyuubi/server/KyuubiServer.scala` using IDEA

You can set `SPARK_HOME`, `KYUUBI_CONF_DIR` in the Run/Debug Configuration Dialog
Expand All @@ -35,7 +45,7 @@ You can set `SPARK_HOME`, `KYUUBI_CONF_DIR` in the Run/Debug Configuration Dialo
```
build/dist
cd dist
bin/kyuubi run
bin/kyuubi run --conf kyuubi.frontend.grpc.bind.port=10999
```

The gRPC service listens 10999 by default.
Expand All @@ -55,3 +65,23 @@ PySpark Connect client (Requires: Python >=3.9)
pip install pyspark-connect==4.0.0.dev1
pyspark --remote sc://H27212-MAC-01.local:10999 --user_id chengpan --user_name chengpan
```

Run examples
```
Welcome to
____ __
/ __/__ ___ _____/ /__
_\ \/ _ \/ _ `/ __/ '_/
/___/ .__/\_,_/_/ /_/\_\ version 4.0.0-SNAPSHOT
/_/
Type in expressions to have them evaluated.
Spark session available as 'spark'.
scala> spark.sql("select 1").show()
+---+
| 1|
+---+
| 1|
+---+
```

0 comments on commit 860aeae

Please sign in to comment.