feat: add StarRocks as a compatibility-tested database

driessamyn · driessamyn · commit 4d7ef5d7ba3b · 2026-03-24T07:34:41.000Z
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -126,7 +126,7 @@ jobs:
     if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'run-compat-tests')
     strategy:
       matrix:
-        db: [ MARIADB ]
+        db: [ MARIADB, STARROCKS ]
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
         with:
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ Kapper is a lightweight, Dapper-inspired ORM (Object-Relational Mapping) library
 ![MSSQL](https://img.shields.io/badge/mssql-%23CC2927.svg?style=for-the-badge&logo=microsoftsqlserver&logoColor=white)
 ![DuckDB](https://img.shields.io/badge/duckdb-FFF000.svg?style=for-the-badge&logo=duckdb&logoColor=black)
 ![MariaDB](https://img.shields.io/badge/mariadb-003545.svg?style=for-the-badge&logo=mariadb&logoColor=white)
+![StarRocks](https://img.shields.io/badge/starrocks-5C2D91.svg?style=for-the-badge&logoColor=white)
 
 See [Kapper](https://driessamyn.github.io/kapper/) for more information.
 
diff --git a/core/src/integrationTest/kotlin/net/samyn/kapper/AbstractDbTests.kt b/core/src/integrationTest/kotlin/net/samyn/kapper/AbstractDbTests.kt
@@ -10,6 +10,7 @@ import org.junit.jupiter.params.ParameterizedClass
 import org.junit.jupiter.params.provider.Arguments
 import org.junit.jupiter.params.provider.Arguments.arguments
 import org.junit.jupiter.params.provider.MethodSource
+import org.testcontainers.containers.GenericContainer
 import org.testcontainers.containers.JdbcDatabaseContainer
 import org.testcontainers.containers.MSSQLServerContainer
 import org.testcontainers.containers.MariaDBContainer
@@ -57,6 +58,14 @@ abstract class AbstractDbTests {
             MariaDBContainer("mariadb:11.7").also { it.start() }
         }
 
+        private val starrocks by lazy {
+            GenericContainer("starrocks/allin1-ubuntu:latest").apply {
+                withExposedPorts(9030)
+                withStartupTimeout(Duration.ofMinutes(3))
+                start()
+            }
+        }
+
         private val msSqlServer by lazy {
             MSSQLServerContainer("mcr.microsoft.com/mssql/server:2017-CU12")
                 .acceptLicense()
@@ -86,6 +95,29 @@ abstract class AbstractDbTests {
                 "MSSQLSERVER" to { getConnection(msSqlServer) },
                 "ORACLE" to { getConnection(oracle) },
                 "MARIADB" to { getConnection(mariadb) },
+                "STARROCKS" to {
+                    Class.forName("com.mysql.cj.jdbc.Driver")
+                    val url = "jdbc:mysql://${starrocks.host}:${starrocks.getMappedPort(9030)}/"
+                    val bootstrapConn = DriverManager.getConnection(url, "root", "")
+                    // Wait for BE to register with the cluster
+                    for (i in 1..60) {
+                        try {
+                            val alive = bootstrapConn.createStatement().use { stmt ->
+                                stmt.executeQuery("SHOW BACKENDS").use { rs ->
+                                    rs.next() && rs.getBoolean("Alive")
+                                }
+                            }
+                            if (alive) break
+                        } catch (_: Exception) {
+                        }
+                        Thread.sleep(2000)
+                    }
+                    bootstrapConn.createStatement().use {
+                        it.execute("CREATE DATABASE IF NOT EXISTS test")
+                    }
+                    bootstrapConn.close()
+                    DriverManager.getConnection("${url}test", "root", "")
+                },
             )
 
         val dbs =
@@ -125,7 +157,7 @@ abstract class AbstractDbTests {
     @BeforeAll
     fun setup() {
         dbs.forEach { container ->
-            setupDatabase(connections.computeIfAbsent(container.key) { container.value() })
+            setupDatabase(connections.computeIfAbsent(container.key) { container.value() }, container.key)
         }
     }
 
@@ -137,18 +169,37 @@ abstract class AbstractDbTests {
         connections.clear()
     }
 
-    protected open fun setupDatabase(connection: Connection) {
+    protected open fun setupDatabase(
+        connection: Connection,
+        dbKey: String = "",
+    ) {
         val dbFlavour = connection.getDbFlavour()
+        val isStarRocks = dbKey == "STARROCKS"
         connection.createStatement().use { statement ->
+            val createTable =
+                if (isStarRocks) {
+                    """
+                    CREATE TABLE super_heroes_$testId (
+                        id ${convertDbColumnType("UUID", dbFlavour)},
+                        name VARCHAR(100),
+                        email VARCHAR(100),
+                        age ${convertDbColumnType("INT", dbFlavour)}
+                    )
+                    PRIMARY KEY (id)
+                    DISTRIBUTED BY HASH(id) BUCKETS 1
+                    """.trimIndent()
+                } else {
+                    """
+                    CREATE TABLE super_heroes_$testId (
+                        id ${convertDbColumnType("UUID", dbFlavour)} PRIMARY KEY,
+                        name VARCHAR(100),
+                        email VARCHAR(100),
+                        age ${convertDbColumnType("INT", dbFlavour)}
+                    )
+                    """.trimIndent()
+                }
             statement.execute(
-                """
-                CREATE TABLE super_heroes_$testId (
-                    id ${convertDbColumnType("UUID", dbFlavour)} PRIMARY KEY,
-                    name VARCHAR(100),
-                    email VARCHAR(100),
-                    age ${convertDbColumnType("INT", dbFlavour)}
-                )
-                """.trimIndent().also {
+                createTable.also {
                     println("------------ $dbFlavour --------------")
                     println(it)
                 },
diff --git a/core/src/integrationTest/kotlin/net/samyn/kapper/ExecuteDtoTests.kt b/core/src/integrationTest/kotlin/net/samyn/kapper/ExecuteDtoTests.kt
@@ -5,6 +5,7 @@ import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.shouldBe
 import net.samyn.kapper.internal.getDbFlavour
+import org.junit.jupiter.api.Assumptions.assumeFalse
 import org.junit.jupiter.api.Test
 import java.sql.SQLException
 import java.util.UUID
@@ -148,6 +149,10 @@ class ExecuteDtoTests : AbstractDbTests() {
 
     @Test
     fun `with TX and DTO rolls back`() {
+        assumeFalse(
+            System.getProperty("db", "").trim().uppercase() == "STARROCKS",
+            "StarRocks PRIMARY KEY tables use upsert semantics",
+        )
         val id = UUID.randomUUID()
         shouldThrow<SQLException> {
             connection.withTransaction {
diff --git a/core/src/integrationTest/kotlin/net/samyn/kapper/ExecuteTests.kt b/core/src/integrationTest/kotlin/net/samyn/kapper/ExecuteTests.kt
@@ -5,6 +5,7 @@ import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.shouldBe
 import net.samyn.kapper.internal.getDbFlavour
+import org.junit.jupiter.api.Assumptions.assumeFalse
 import org.junit.jupiter.api.Test
 import java.sql.SQLException
 import java.util.UUID
@@ -179,6 +180,10 @@ class ExecuteTests : AbstractDbTests() {
 
     @Test
     fun `with TX rolls back`() {
+        assumeFalse(
+            System.getProperty("db", "").trim().uppercase() == "STARROCKS",
+            "StarRocks PRIMARY KEY tables use upsert semantics",
+        )
         val id = UUID.randomUUID()
         shouldThrow<SQLException> {
             connection.withTransaction {
diff --git a/core/src/integrationTest/kotlin/net/samyn/kapper/TypesTest.kt b/core/src/integrationTest/kotlin/net/samyn/kapper/TypesTest.kt
@@ -2,6 +2,7 @@ package net.samyn.kapper
 
 import io.kotest.matchers.shouldBe
 import net.samyn.kapper.internal.getDbFlavour
+import org.junit.jupiter.api.Assumptions.assumeFalse
 import org.junit.jupiter.api.Test
 import java.math.BigDecimal
 import java.sql.Connection
@@ -15,7 +16,11 @@ import java.util.UUID
 import kotlin.random.Random
 
 class TypesTest : AbstractDbTests() {
-    override fun setupDatabase(connection: Connection) {
+    override fun setupDatabase(
+        connection: Connection,
+        dbKey: String,
+    ) {
+        if (dbKey == "STARROCKS") return
         val dbFlavour = connection.getDbFlavour()
         connection.createStatement().use { statement ->
             statement.execute(
@@ -51,6 +56,10 @@ class TypesTest : AbstractDbTests() {
 
     @Test
     fun `can insert and retreive the same types`() {
+        assumeFalse(
+            System.getProperty("db", "").trim().uppercase() == "STARROCKS",
+            "StarRocks does not support all SQL types tested here",
+        )
         val testData = createTestObject()
         val result =
             connection.execute(
diff --git a/core/src/main/kotlin/net/samyn/kapper/internal/DbFlavourFunc.kt b/core/src/main/kotlin/net/samyn/kapper/internal/DbFlavourFunc.kt
@@ -11,7 +11,8 @@ fun Connection.getDbFlavour(): DbFlavour {
         productName.contains("postgres", ignoreCase = true) ||
             productName.contains("enterprisedb", ignoreCase = true) -> DbFlavour.POSTGRESQL
         productName.contains("mysql", ignoreCase = true) ||
-            productName.contains("mariadb", ignoreCase = true) -> DbFlavour.MYSQL
+            productName.contains("mariadb", ignoreCase = true) ||
+            productName.contains("starrocks", ignoreCase = true) -> DbFlavour.MYSQL
         productName.contains("sqlite", ignoreCase = true) -> DbFlavour.SQLITE
         productName.contains("oracle", ignoreCase = true) -> DbFlavour.ORACLE
         productName.contains("sql server", ignoreCase = true) ||
diff --git a/core/src/test/kotlin/net/samyn/kapper/internal/DbFlavourTest.kt b/core/src/test/kotlin/net/samyn/kapper/internal/DbFlavourTest.kt
@@ -34,6 +34,7 @@ class DbFlavourTest {
                 "MySQL Community Server",
                 "MySQL Enterprise Server",
                 "MariaDB",
+                "StarRocks",
             ],
     )
     fun `when databaseProductName is mysql then getDbFlavour returns MYSQL`(value: String) {

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ class DbFlavourTest {`
`34`	`34`	`"MySQL Community Server",`
`35`	`35`	`"MySQL Enterprise Server",`
`36`	`36`	`"MariaDB",`
	`37`	`+ "StarRocks",`
`37`	`38`	`],`
`38`	`39`	`)`
`39`	`40`	fun `when databaseProductName is mysql then getDbFlavour returns MYSQL`(value: String) {