Skip to content

Commit

Permalink
Bump "exposed-adt-mapping" to v0.3.0-SNAPSHOT which depends on Expose…
Browse files Browse the repository at this point in the history
…d v0.56.0 to resolve some binary incompatibilities as found out in internal projects, and update README.md to remind people about the Exposed version
  • Loading branch information
ShreckYe committed Nov 26, 2024
1 parent 44ef514 commit 74dca80
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,18 @@ Only PostgreSQL with [Reactive PostgreSQL Client](https://vertx.io/docs/vertx-pg

This library is experimental now. The APIs are subject to change (especially those marked with `@ExperimentalEvscApi`), the tests are incomplete, and please expect bugs and report them.

## Maven coordinate
## Add to your dependencies

### The Maven coordinates

```kotlin
"com.huanshankeji:exposed-vertx-sql-client-$module:$evscVersion"
"com.huanshankeji:exposed-vertx-sql-client-$module:$libraryVersion"
```

### **Important note**

As Exposed is a library that has not reached stability yet and often has incompatible changes, you are recommended to stick to the same version of Exposed used by this library. The current version is v0.56.0.

## API documentation

See the [hosted API documentation](https://huanshankeji.github.io/exposed-vertx-sql-client/) for the APIs.
Expand All @@ -31,21 +37,21 @@ Here is a basic usage guide.
Add the PostgreSQL module, which was the only module, to your dependencies with the Gradle build script:

```kotlin
implementation("com.huanshankeji:exposed-vertx-sql-client-postgresql:0.4.0")
implementation("com.huanshankeji:exposed-vertx-sql-client-postgresql:$libraryVersion")
```

### Since v0.5.0

Add the core module to your dependencies with the Gradle build script:

```kotlin
implementation("com.huanshankeji:exposed-vertx-sql-client-core:$evscVersion")
implementation("com.huanshankeji:exposed-vertx-sql-client-core:$libraryVersion")
```

And add an RDBMS module, for example, the PostgreSQL module:

```kotlin
implementation("com.huanshankeji:exposed-vertx-sql-client-postgresql:$evscVersion")
implementation("com.huanshankeji:exposed-vertx-sql-client-postgresql:$libraryVersion")
```

### Create a `DatabaseClient`
Expand Down Expand Up @@ -144,7 +150,7 @@ With the extension SQL DSL APIs, your code becomes more concise, but it might be
Gradle dependency configuration (only needed since v0.5.0):

```kotlin
implementation("com.huanshankeji:exposed-vertx-sql-client-sql-dsl:$evscVersion")
implementation("com.huanshankeji:exposed-vertx-sql-client-sql-dsl:$libraryVersion")
```

Example code:
Expand Down Expand Up @@ -176,7 +182,7 @@ Please read [that library's basic usage guide](https://github.com/huanshankeji/e
Gradle dependency configuration (only needed since v0.5.0):

```kotlin
implementation("com.huanshankeji:exposed-vertx-sql-client-sql-dsl-with-mapper:$evscVersion")
implementation("com.huanshankeji:exposed-vertx-sql-client-sql-dsl-with-mapper:$libraryVersion")
```

Example code:
Expand Down
2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/VersionsAndDependencies.kt
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ val commonDependencies = CommonDependencies(commonVersions)
val commonGradleClasspathDependencies = CommonGradleClasspathDependencies(commonVersions)

object DependencyVersions {
val exposedAdtMapping = "0.2.0"
val exposedAdtMapping = "0.3.0-SNAPSHOT" // TODO don't use a snapshot version in a main branch
}

0 comments on commit 74dca80

Please sign in to comment.