This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-connect-swift.git
The following commit(s) were added to refs/heads/main by this push:
new 79d8189 [MINOR] Make `README.md` up-to-date
79d8189 is described below
commit 79d8189a1b4ecf18e22f815d4a5a4c71693e2d4a
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Tue Apr 22 19:39:24 2025 +0900
[MINOR] Make `README.md` up-to-date
### What changes were proposed in this pull request?
This PR aims to make `README.md` up-to-date.
### Why are the changes needed?
To fix the outdated information.
### Does this PR introduce _any_ user-facing change?
No behavior change because this is a doc-only update.
### How was this patch tested?
Manual review.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #83 from dongjoon-hyun/minor.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
README.md | 37 ++++++++++++++++++++++++-------------
1 file changed, 24 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 7866367..eee9add 100644
--- a/README.md
+++ b/README.md
@@ -9,24 +9,28 @@ This is an experimental Swift library to show how to connect
to a remote Apache
So far, this library project is tracking the upstream changes like the [Apache
Spark](https://spark.apache.org) 4.0.0 RC4 release and [Apache
Arrow](https://arrow.apache.org) project's Swift-support.
## Requirement
+
- [Apache Spark 4.0.0 RC4 (April
2025)](https://dist.apache.org/repos/dist/dev/spark/v4.0.0-rc4-bin/)
-- [Swift 6.0 (2024)](https://swift.org)
+- [Swift 6.0 (2024) or 6.1 (2025)](https://swift.org)
- [gRPC Swift 2.1 (March
2025)](https://github.com/grpc/grpc-swift/releases/tag/2.1.2)
-- [gRPC Swift Protobuf 1.1 (March
2025)](https://github.com/grpc/grpc-swift-protobuf/releases/tag/1.1.0)
-- [gRPC Swift NIO Transport 1.0 (March
2025)](https://github.com/grpc/grpc-swift-nio-transport/releases/tag/1.0.2)
+- [gRPC Swift Protobuf 1.2 (April
2025)](https://github.com/grpc/grpc-swift-protobuf/releases/tag/1.2.0)
+- [gRPC Swift NIO Transport 1.0 (March
2025)](https://github.com/grpc/grpc-swift-nio-transport/releases/tag/1.0.3)
+- [FlatBuffers v25.2.10 (February
2025)](https://github.com/google/flatbuffers/releases/tag/v25.2.10)
- [Apache Arrow Swift](https://github.com/apache/arrow/tree/main/swift)
## How to use in your apps
Create a Swift project.
-```
-$ mkdir SparkConnectSwiftApp
-$ cd SparkConnectSwiftApp
-$ swift package init --name SparkConnectSwiftApp --type executable
+
+```bash
+mkdir SparkConnectSwiftApp
+cd SparkConnectSwiftApp
+swift package init --name SparkConnectSwiftApp --type executable
```
Add `SparkConnect` package to the dependency like the following
-```
+
+```bash
$ cat Package.swift
import PackageDescription
@@ -49,7 +53,7 @@ let package = Package(
Use `SparkSession` of `SparkConnect` module in Swift.
-```
+```bash
$ cat Sources/main.swift
import SparkConnect
@@ -78,7 +82,7 @@ await spark.stop()
Run your Swift application.
-```
+```bash
$ swift run
...
Connected to Apache Spark 4.0.0 Server
@@ -105,16 +109,17 @@ SELECT * FROM t
```
You can find this example in the following repository.
-- https://github.com/dongjoon-hyun/spark-connect-swift-app
+
+- <https://github.com/dongjoon-hyun/spark-connect-swift-app>
## How to use `Spark SQL REPL` via `Spark Connect for Swift`
This project also provides `Spark SQL REPL`. You can run it directly from this
repository.
-```
+```bash
$ swift run
...
-Build of product 'SQLRepl' complete! (2.33s)
+Build of product 'SparkSQLRepl' complete! (2.33s)
Connected to Apache Spark 4.0.0 Server
spark-sql (default)> SHOW DATABASES;
+---------+
@@ -176,3 +181,9 @@ spark-sql (default)> DROP DATABASE db1 CASCADE;
++
spark-sql (default)> exit;
```
+
+You can use `SPARK_REMOTE` to specify the [Spark Connect connection
string](https://spark.apache.org/docs/latest/spark-connect-overview.html#set-sparkremote-environment-variable)
in order to provide more options.
+
+```bash
+SPARK_REMOTE=sc://localhost swift run
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
