2323
2424## Supported versions
2525
26- | Abris | Spark | Scala |
27- | :-----: | :-----: | :-----: |
28- | 6.2.0 - 6.x.x | 3.2.1 - 3.2 .x | 2.12 / 2.13 |
29- | 6.0.0 - 6.1.1 | 3.2.0 | 2.12 / 2.13 |
26+ | Abris | Spark | Scala |
27+ | :-----: | :-------------: | :-----: |
28+ | 6.2.0 - 6.x.x | 3.2.1 - 3.5 .x | 2.12 / 2.13 |
29+ | 6.0.0 - 6.1.1 | 3.2.0 | 2.12 / 2.13 |
3030| 5.0.0 - 5.x.x | 3.0.x / 3.1.x | 2.12 |
31- | 5.0.0 - 5.x.x | 2.4.x | 2.11 / 2.12 |
31+ | 5.0.0 - 5.x.x | 2.4.x | 2.11 / 2.12 |
3232
3333From version 6.0.0, ABRiS only supports Spark 3.2.x.
3434
@@ -43,6 +43,47 @@ This is documentation for Abris **version 6**. Documentation for older versions
4343## Confluent Schema Registry Version
4444Abris by default uses Confluent client version 6.2.0.
4545
46+ ## Installation
47+ Abris needs ` spark-avro ` to run, make sure you include the ` spark-avro ` dependency when using Abris.
48+ The version of ` spark-avro ` and ` Spark ` should be identical.
49+
50+ Example: submitting a Spark job:
51+ ```
52+ ./bin/spark-submit \
53+ --packages org.apache.spark:spark-avro_2.12:3.5.0,za.co.absa:abris_2.12:6.4.0 \
54+ ...rest of submit params...
55+ ```
56+
57+ Example: using Abris in maven project:
58+ ``` xml
59+ <dependency >
60+ <groupId >org.apache.spark</groupId >
61+ <artifactId >spark-core_2.12</artifactId >
62+ <version >3.5.0</version >
63+ <scope >provided</scope >
64+ </dependency >
65+ <dependency >
66+ <groupId >org.apache.spark</groupId >
67+ <artifactId >spark-avro_2.12</artifactId >
68+ <version >3.5.0</version > <!-- version must be the same as Spark -->
69+ </dependency >
70+ <dependency >
71+ <groupId >za.co.absa</groupId >
72+ <artifactId >abris_2.12</artifactId >
73+ <version >6.4.0</version >
74+ </dependency >
75+ ```
76+
77+ Example: using Abris in SBT project:
78+ ``` Scala
79+ libraryDependencies ++= Seq (
80+ " org.apache.spark" %% " spark-core" % " 3.5.0" % Provided ,
81+ " org.apache.spark" %% " spark-avro" % " 3.5.0" ,
82+ " za.co.absa" %% " abris" % " 6.4.0"
83+ )
84+ ```
85+
86+
4687## Usage
4788
4889ABRiS API is in it's most basic form almost identical to Spark built-in support for Avro, but it provides additional functionality.
0 commit comments