-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
abris add installation documentation #356
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,12 +23,12 @@ | |
|
||
## Supported versions | ||
|
||
| Abris | Spark | Scala | | ||
|:-----: |:-----: |:-----: | | ||
| 6.2.0 - 6.x.x | 3.2.1 - 3.2.x | 2.12 / 2.13 | | ||
| 6.0.0 - 6.1.1 | 3.2.0 | 2.12 / 2.13 | | ||
| Abris | Spark | Scala | | ||
|:-----: |:-------------:|:-----: | | ||
| 6.2.0 - 6.x.x | 3.2.1 - 3.5.x | 2.12 / 2.13 | | ||
| 6.0.0 - 6.1.1 | 3.2.0 | 2.12 / 2.13 | | ||
| 5.0.0 - 5.x.x | 3.0.x / 3.1.x | 2.12 | | ||
| 5.0.0 - 5.x.x | 2.4.x | 2.11 / 2.12 | | ||
| 5.0.0 - 5.x.x | 2.4.x | 2.11 / 2.12 | | ||
|
||
From version 6.0.0, ABRiS only supports Spark 3.2.x. | ||
|
||
|
@@ -43,6 +43,47 @@ This is documentation for Abris **version 6**. Documentation for older versions | |
## Confluent Schema Registry Version | ||
Abris by default uses Confluent client version 6.2.0. | ||
|
||
## Installation | ||
Abris needs `spark-avro` to run, make sure you include the `spark-avro` dependency when using Abris. | ||
The version of `spark-avro` and `Spark` should be identical. | ||
|
||
Example: submitting a Spark job: | ||
``` | ||
./bin/spark-submit \ | ||
--packages org.apache.spark:spark-avro_2.12:3.5.0,za.co.absa:abris_2.12:6.4.0 \ | ||
...rest of submit params... | ||
``` | ||
|
||
Example: using Abris in maven project: | ||
```xml | ||
<dependency> | ||
<groupId>org.apache.spark</groupId> | ||
<artifactId>spark-core_2.12</artifactId> | ||
<version>3.5.0</version> | ||
<scope>provided</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.apache.spark</groupId> | ||
<artifactId>spark-avro_2.12</artifactId> | ||
<version>3.5.0</version> <!-- version must be the same as Spark --> | ||
</dependency> | ||
<dependency> | ||
<groupId>za.co.absa</groupId> | ||
<artifactId>abris_2.12</artifactId> | ||
<version>6.4.0</version> | ||
</dependency> | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe you could also add documentation for sbt |
||
|
||
Example: using Abris in SBT project: | ||
```Scala | ||
libraryDependencies ++= Seq( | ||
"org.apache.spark" %% "spark-core" % "3.5.0" % Provided, | ||
"org.apache.spark" %% "spark-avro" % "3.5.0", | ||
"za.co.absa" %% "abris" % "6.4.0" | ||
) | ||
``` | ||
|
||
|
||
## Usage | ||
|
||
ABRiS API is in it's most basic form almost identical to Spark built-in support for Avro, but it provides additional functionality. | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also add an exclusion here, just to be sure