Skip to content

Commit 19f39ef

Browse files
SemyonSinchenkoSemyonSinchenko
authored
Add Maven Central coordinates section to installation guide (#774)
This commit enhances the installation documentation by adding a detailed section on Maven Central coordinates for GraphFrames. The update provides clarity on the artifact naming convention, which follows the pattern: `graphframes-{component-name}-{spark-major-version}_{scala-version}` The section includes specific examples for core, GraphX, and Spark Connect components, helping users correctly identify and include dependencies. It also explains the purpose of each component, distinguishing between primary usage, Spark Connect plugin, and internal GraphX dependency. This addition ensures that users can easily locate and integrate GraphFrames artifacts for their specific Spark and Scala versions, improving the setup experience and reducing potential confusion.
1 parent afea945 commit 19f39ef

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

‎docs/mdoc/01-installation.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
If you are new to using Apache Spark, refer to the [Apache Spark Documentation](http://spark.apache.org/docs/latest/index.html) and its [Quick-Start Guide](http://spark.apache.org/docs/latest/quick-start.html) for more information.
44

5+
## Maven Central Coordinates
6+
7+
GraphFrames core is [published](https://central.sonatype.com/namespace/io.graphframes) in the Maven Central under namespace `io.graphframes`. All the artifacts are groupped using the following logic.
8+
9+
```
10+
graphframes-{component-name}-{spark-major-version}_{scala-version}
11+
```
12+
13+
Examples:
14+
- `graphframes-spark3_2.12`, graphframes core for spark 3.x and scala version 2.12
15+
- `graphframes-graphx-spark4_2.13`, graphframes internal fork of GraphX for spark 4.x and scala version 2.13
16+
- `graphframes-connect-spark3_2.13`, graphframes Spark Connect plugin for spark 3.x and scala version 2.13
17+
18+
### Core
19+
20+
GraphFrames core is the main package that should be used.
21+
22+
### Spark-Connect plugin
23+
24+
Only for users who want to use GraphFrames with Spark Connect.
25+
26+
### GraphFrames-GraphX
27+
28+
Runtime dependency of graphframes, should be resolved automatically. Contains internal modified and updated fork of the Apache Saprk GraphX.
29+
530
## Spark Versions Compatibility
631

732
| Component | Spark 3.x (Scala 2.12) | Spark 3.x (Scala 2.13) | Spark 4.x (Scala 2.13) |

0 commit comments

Comments
 (0)