Skip to content
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.

Sign up for GitHub

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

Jump to bottom

abris add installation documentation #356

Merged
merged 2 commits into from
Feb 22, 2024
Merged

abris add installation documentation #356

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3497d7
abris add installation documentation
cerveada Feb 13, 2024
10a2972
code review changes
cerveada Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -43,6 +43,37 @@ 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.2.0 \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
--packages org.apache.spark:spark-avro_2.12:3.5.0,za.co.absa:abris_2.12:6.2.0 \
--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>
Copy link
Collaborator

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

</dependency>
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you could also add documentation for sbt


## Usage

ABRiS API is in it's most basic form almost identical to Spark built-in support for Avro, but it provides additional functionality.
Expand Down
Loading