Split modules, completely overhaul the client creation APIs, and decouple PostgreSQL, our SQL DSL APIs, and our mapper SQL DSL APIs

README.md

@@ -20,13 +20,39 @@ Here is a basic usage guide. This project currently serves our own use, therefor
 
 ### Create a `DatabaseClient`
 
+Create an `EvscConfig` as the single source of truth:
+
+```kotlin
+val evscConfig = ConnectionConfig.Socket("localhost", user = "user", password = "password", database = "database")
+    .toUniversalEvscConfig()
+```
+
+Local alternative with Unix domain socket:
+
+```kotlin
+val evscConfig = defaultPostgresqlLocalConnectionConfig(
+    user = "user",
+    socketConnectionPassword = "password",
+    database = "database"
+).toPerformantUnixEvscConfig()
+```
+
+Create an Exposed `Database` with the `ConnectionConfig.Socket`, which can be reused for multiple `Verticle`s:
+
 ```kotlin
-val socketConnectionConfig =
-    ConnectionConfig.Socket("localhost", user = "user", password = "password", database = "database")
-val exposedDatabase = exposedDatabaseConnectPostgreSql(socketConnectionConfig)
-val databaseClient = createPgPoolDatabaseClient(
-    vertx, socketConnectionConfig, exposedDatabase = exposedDatabase
-)
+val exposedDatabase = evscConfig.exposedConnectionConfig.exposedDatabaseConnectPostgresql()
+```
+
+Create a Vert.x `SqlClient` with the `ConnectionConfig`, preferably in a `Verticle`:
+
+```kotlin
+val vertxPool = createPgPool(vertx, evscConfig.vertxSqlClientConnectionConfig)
+```
+
+Create a `Database` with the provided Vert.x `SqlClient` and Exposed `Database`, preferably in a `Verticle`:
+
+```kotlin
+val databaseClient = DatabaseClient(vertxPool, exposedDatabase)
 ```
 
 ### Example table definitions
@@ -97,6 +123,8 @@ val exampleName1 =
 val exampleName2 =
     databaseClient.selectSingleColumn(Examples, Examples.name) { where(Examples.id eq 2) }.single()
 
+val examplesExist = databaseClient.selectExpression(exists(Examples.selectAll()))
+
 val deleteRowCount1 = databaseClient.deleteWhere(Examples) { id eq 1 }
 assert(deleteRowCount1 == 1)
 val deleteRowCount2 = databaseClient.deleteIgnoreWhere(Examples) { id eq 2 }

buildSrc/src/main/kotlin/conventions.gradle.kts

@@ -1,12 +1,8 @@
-import com.huanshankeji.team.`Shreck Ye`
-import com.huanshankeji.team.pomForTeamDefaultOpenSource
 import com.huanshankeji.team.repositoriesAddTeamGithubPackagesMavenRegistry
-import org.gradle.kotlin.dsl.repositories
 
 plugins {
     id("com.huanshankeji.team.with-group")
-    id("com.huanshankeji.kotlin-jvm-library-sonatype-ossrh-publish-conventions")
-    id("com.huanshankeji.team.default-github-packages-maven-publish")
+    kotlin("jvm")
 }
 
 repositories {
@@ -18,9 +14,3 @@ repositoriesAddTeamGithubPackagesMavenRegistry("kotlin-common")
 kotlin.jvmToolchain(8)
 
 version = projectVersion
-
-publishing.publications.getByName<MavenPublication>("maven") {
-    pomForTeamDefaultOpenSource(project, "Exposed Vert.x SQL Client", "Exposed on top of Vert.x Reactive SQL Client") {
-        `Shreck Ye`()
-    }
-}

buildSrc/src/main/kotlin/lib-conventions.gradle.kts

@@ -0,0 +1,20 @@
+import com.huanshankeji.team.`Shreck Ye`
+import com.huanshankeji.team.pomForTeamDefaultOpenSource
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask
+
+plugins {
+    id("conventions")
+    id("com.huanshankeji.kotlin-jvm-library-sonatype-ossrh-publish-conventions")
+    id("com.huanshankeji.team.default-github-packages-maven-publish")
+    id("com.huanshankeji.team.dokka.github-dokka-convention")
+}
+
+publishing.publications.getByName<MavenPublication>("maven") {
+    pomForTeamDefaultOpenSource(project, "Exposed Vert.x SQL Client", "Exposed on top of Vert.x Reactive SQL Client") {
+        `Shreck Ye`()
+    }
+}
+
+tasks.named<KotlinCompilationTask<*>>("compileKotlin").configure {
+    compilerOptions.freeCompilerArgs.add("-opt-in=com.huanshankeji.exposedvertxsqlclient.InternalApi")
+}

lib/build.gradle.kts → core/build.gradle.kts

@@ -1,15 +1,12 @@
 plugins {
-    conventions
-    id("com.huanshankeji.benchmark.kotlinx-benchmark-jvm-conventions")
-    id("com.huanshankeji.team.dokka.github-dokka-convention")
+    `lib-conventions`
 }
 
 dependencies {
     api(commonDependencies.exposed.core()) // TODO: use `implementation` when possible
     // TODO: remove the Exposed JDBC dependency and the PostgresSQL dependency when there is no need to to generate SQLs with an Exposed transaction
     runtimeOnly(commonDependencies.exposed.module("jdbc"))
     api(commonDependencies.kotlinCommon.exposed())
-    implementation("com.huanshankeji:exposed-adt-mapping:${DependencyVersions.exposedAdtMapping}")
 
     with(commonDependencies.vertx) {
         implementation(platformStackDepchain())
@@ -24,21 +21,3 @@ dependencies {
 
     implementation(commonDependencies.kotlinCommon.net())
 }
-
-
-// for PostgreSQL
-dependencies {
-    runtimeOnly(commonDependencies.postgreSql())
-    implementation(commonDependencies.vertx.moduleWithoutVersion("pg-client"))
-}
-
-afterEvaluate {
-// for the benchmarks
-    dependencies {
-        with(commonDependencies.testContainers) {
-            "benchmarksImplementation"(platformBom())
-            "benchmarksImplementation"(postgreSql)
-        }
-        "benchmarksImplementation"(commonDependencies.slf4j.simple())
-    }
-}

lib/src/main/kotlin/com/huanshankeji/exposedvertxsqlclient/ConnectionConfig.kt → core/src/main/kotlin/com/huanshankeji/exposedvertxsqlclient/ConnectionConfig.kt

@@ -1,5 +1,7 @@
 package com.huanshankeji.exposedvertxsqlclient
 
+import com.huanshankeji.exposedvertxsqlclient.vertx.sqlclient.setRole
+
 sealed interface ConnectionConfig {
     val userAndRole: String
     val database: String
@@ -14,11 +16,17 @@ sealed interface ConnectionConfig {
         override val userAndRole: String get() = user
     }
 
+    /**
+     * @see setRole
+     */
     class UnixDomainSocketWithPeerAuthentication(
         val path: String,
         val role: String,
         override val database: String
     ) : ConnectionConfig {
         override val userAndRole: String get() = role
     }
-}
+}
+
+fun ConnectionConfig.Socket.toUniversalEvscConfig() =
+    EvscConfig(this, this)