Skip to content

Commit

Permalink
#125: Move code into sub-package db
Browse files Browse the repository at this point in the history
* updated `README.md`
  • Loading branch information
benedeki committed Jul 3, 2024
1 parent dcf14b2 commit 855b2ac
Showing 1 changed file with 31 additions and 27 deletions.
58 changes: 31 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[![Build](https://github.com/AbsaOSS/fa-db/workflows/Build/badge.svg)](https://github.com/AbsaOSS/fa-db/actions)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/core_2.11/badge.svg)](https://search.maven.org/search?q=g:za.co.absa.fa-db)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa..db.fa-db/core_2.12/badge.svg)](https://search.maven.org/search?q=g:za.co.absa.fa-db)

___

Expand Down Expand Up @@ -59,30 +59,32 @@ Import one of the two available module at the moment. Slick module works with Sc
any effect type (typically IO or ZIO) provided cats effect's Async instance is available.

```scala
libraryDependencies *= "za.co.absa.fa-db" %% "slick" % "X.Y.Z"
libraryDependencies *= "za.co.absa.fa-db" %% "doobie" % "X.Y.Z"
libraryDependencies *= "za.co.absa.db.fa-db" %% "slick" % "X.Y.Z"
libraryDependencies *= "za.co.absa.db.fa-db" %% "doobie" % "X.Y.Z"
```

#### Maven

##### Scala 2.12

Modules:
* Core [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/core_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/core_2.12)
* Slick [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/slick_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/slick_2.12)
* Doobie [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/doobie_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/doobie_2.12)
* Core [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.db.fa-db/core_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/core_2.12)
* Slick [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.db.fa-db/slick_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/slick_2.12)
* Doobie [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.db.fa-db/doobie_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/doobie_2.12)

```xml
<dependency>
<groupId>za.co.absa.fa-db</groupId>
<artifactId>slick_2.12</artifactId>
<version>${latest_version}</version>
</dependency>
<dependency>
<groupId>za.co.absa.fa-db</groupId>
<artifactId>doobie_2.12</artifactId>
<version>${latest_version}</version>
</dependency>
<dependencies>
<dependency>
<groupId>za.co.absa.db.fa-db</groupId>
<artifactId>slick_2.12</artifactId>
<version>${latest_version}</version>
</dependency>
<dependency>
<groupId>za.co.absa.db.fa-db</groupId>
<artifactId>doobie_2.12</artifactId>
<version>${latest_version}</version>
</dependency>
</dependencies>
```

### Scala 2.13
Expand All @@ -92,23 +94,25 @@ Modules:
* Doobie [![Maven Central](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/doobie_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/za.co.absa.fa-db/doobie_2.13)

```xml
<dependency>
<groupId>za.co.absa.fa-db</groupId>
<artifactId>slick_2.13</artifactId>
<version>${latest_version}</version>
</dependency>
<dependency>
<groupId>za.co.absa.fa-db</groupId>
<artifactId>doobie_2.13</artifactId>
<version>${latest_version}</version>
</dependency>
<dependencies>
<dependency>
<groupId>za.co.absa.db.fa-db</groupId>
<artifactId>slick_2.13</artifactId>
<version>${latest_version}</version>
</dependency>
<dependency>
<groupId>za.co.absa.db.fa-db</groupId>
<artifactId>doobie_2.13</artifactId>
<version>${latest_version}</version>
</dependency>
</dependencies>
```

## Concepts

### Status codes

Text about status codes returned from the database function can be found [here](core/src/main/scala/za/co/absa/fadb/status/README.md).
Text about status codes returned from the database function can be found [here](core/src/main/scala/za/co/absa/db/fadb/status/README.md).


## Slick module
Expand Down

0 comments on commit 855b2ac

Please sign in to comment.