Add support for returning in the Kotlin Query DSL API

nakamura-to · nakamura-to · commit 67d34ea13a91 · 2025-04-28T09:46:06.000+09:00
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/KEntityql.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/KEntityql.kt
@@ -26,13 +26,12 @@ import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlBatchDeleteStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlBatchInsertStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlBatchUpdateStatement
-import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlDeleteStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlInsertStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlMultiInsertStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlSelectStarting
-import org.seasar.doma.kotlin.jdbc.criteria.statement.KEntityqlUpdateStatement
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KSetOperand
 import org.seasar.doma.kotlin.jdbc.criteria.statement.KStatement
+import org.seasar.doma.kotlin.jdbc.criteria.statement.KStatementAdapter
 
 @Suppress("DEPRECATION")
 @Deprecated(
@@ -66,7 +65,7 @@ class KEntityql(config: Config) {
         block: UpdateSettings.() -> Unit = {},
     ): KStatement<Result<ENTITY>> {
         val statement = entityql.update(entityMetamodel, entity, block)
-        return KEntityqlUpdateStatement(statement)
+        return KStatementAdapter(statement)
     }
 
     fun <ENTITY : Any> delete(
@@ -75,7 +74,7 @@ class KEntityql(config: Config) {
         block: DeleteSettings.() -> Unit = {},
     ): KStatement<Result<ENTITY>> {
         val statement = entityql.delete(entityMetamodel, entity, block)
-        return KEntityqlDeleteStatement(statement)
+        return KStatementAdapter(statement)
     }
 
     fun <ENTITY : Any> insert(
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlDeleteStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlDeleteStatement.kt
@@ -17,9 +17,15 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.Sql
-import org.seasar.doma.jdbc.criteria.statement.Statement
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
+import org.seasar.doma.jdbc.criteria.statement.EntityqlDeleteStatement
 
-class KEntityqlDeleteStatement<ENTITY>(private val statement: Statement<Result<ENTITY>>) : KStatement<Result<ENTITY>> {
+class KEntityqlDeleteStatement<ENTITY>(private val statement: EntityqlDeleteStatement<ENTITY>) : KStatement<Result<ENTITY>> {
+
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<Result<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
 
     override fun execute(): Result<ENTITY> {
         return statement.execute()
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlInsertStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlInsertStatement.kt
@@ -17,20 +17,26 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.Sql
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
 import org.seasar.doma.jdbc.criteria.statement.EntityqlInsertStatement
 
 class KEntityqlInsertStatement<ENTITY>(
     private val statement: EntityqlInsertStatement<ENTITY>,
 ) : KStatement<Result<ENTITY>> {
 
-    fun onDuplicateKeyUpdate(): KStatement<Result<ENTITY>> {
+    fun onDuplicateKeyUpdate(): KEntityqlUpsertStatement<ENTITY> {
         return KEntityqlUpsertStatement(statement.onDuplicateKeyUpdate())
     }
 
-    fun onDuplicateKeyIgnore(): KStatement<Result<ENTITY>> {
+    fun onDuplicateKeyIgnore(): KEntityqlUpsertStatement<ENTITY> {
         return KEntityqlUpsertStatement(statement.onDuplicateKeyIgnore())
     }
 
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<Result<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
+
     override fun execute(): Result<ENTITY> {
         return statement.execute()
     }
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlMultiInsertStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlMultiInsertStatement.kt
@@ -17,20 +17,26 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.MultiResult
 import org.seasar.doma.jdbc.Sql
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
 import org.seasar.doma.jdbc.criteria.statement.EntityqlMultiInsertStatement
 
 class KEntityqlMultiInsertStatement<ENTITY>(
     private val statement: EntityqlMultiInsertStatement<ENTITY>,
 ) : KStatement<MultiResult<ENTITY>> {
 
-    fun onDuplicateKeyUpdate(): KStatement<MultiResult<ENTITY>> {
+    fun onDuplicateKeyUpdate(): KEntityqlMultiUpsertStatement<ENTITY> {
         return KEntityqlMultiUpsertStatement(statement.onDuplicateKeyUpdate())
     }
 
-    fun onDuplicateKeyIgnore(): KStatement<MultiResult<ENTITY>> {
+    fun onDuplicateKeyIgnore(): KEntityqlMultiUpsertStatement<ENTITY> {
         return KEntityqlMultiUpsertStatement(statement.onDuplicateKeyIgnore())
     }
 
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<MultiResult<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
+
     override fun execute(): MultiResult<ENTITY> {
         return statement.execute()
     }
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlMultiUpsertStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlMultiUpsertStatement.kt
@@ -17,9 +17,16 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.MultiResult
 import org.seasar.doma.jdbc.Sql
-import org.seasar.doma.jdbc.criteria.statement.Statement
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
+import org.seasar.doma.jdbc.criteria.statement.EntityqlMultiInsertIntermediate
 
-class KEntityqlMultiUpsertStatement<ENTITY>(private val statement: Statement<MultiResult<ENTITY>>) : KStatement<MultiResult<ENTITY>> {
+class KEntityqlMultiUpsertStatement<ENTITY>(private val statement: EntityqlMultiInsertIntermediate<ENTITY>) :
+    KStatement<MultiResult<ENTITY>> {
+
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<MultiResult<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
 
     override fun execute(): MultiResult<ENTITY> {
         return statement.execute()
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlUpdateStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlUpdateStatement.kt
@@ -17,9 +17,15 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.Sql
-import org.seasar.doma.jdbc.criteria.statement.Statement
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
+import org.seasar.doma.jdbc.criteria.statement.EntityqlUpdateStatement
 
-class KEntityqlUpdateStatement<ENTITY>(private val statement: Statement<Result<ENTITY>>) : KStatement<Result<ENTITY>> {
+class KEntityqlUpdateStatement<ENTITY>(private val statement: EntityqlUpdateStatement<ENTITY>) : KStatement<Result<ENTITY>> {
+
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<Result<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
 
     override fun execute(): Result<ENTITY> {
         return statement.execute()
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlUpsertStatement.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KEntityqlUpsertStatement.kt
@@ -17,9 +17,15 @@ package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.Sql
-import org.seasar.doma.jdbc.criteria.statement.Statement
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel
+import org.seasar.doma.jdbc.criteria.statement.EntityqlInsertIntermediate
 
-class KEntityqlUpsertStatement<ENTITY>(private val statement: Statement<Result<ENTITY>>) : KStatement<Result<ENTITY>> {
+class KEntityqlUpsertStatement<ENTITY>(private val statement: EntityqlInsertIntermediate<ENTITY>) : KStatement<Result<ENTITY>> {
+
+    fun returning(vararg properties: PropertyMetamodel<*>): KStatement<Result<ENTITY>> {
+        val s = statement.returning(*properties)
+        return KStatementAdapter(s)
+    }
 
     override fun execute(): Result<ENTITY> {
         return statement.execute()
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KStatementAdapter.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KStatementAdapter.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.seasar.doma.kotlin.jdbc.criteria.statement
+
+import org.seasar.doma.jdbc.Sql
+import org.seasar.doma.jdbc.criteria.statement.Statement
+
+class KStatementAdapter<RESULT>(private val statement: Statement<RESULT>) : KStatement<RESULT> {
+    override fun execute(): RESULT {
+        return statement.execute()
+    }
+
+    override fun asSql(): Sql<*> {
+        return statement.asSql()
+    }
+}
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KUnifiedDeleteStarting.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KUnifiedDeleteStarting.kt
@@ -16,13 +16,12 @@
 package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.BatchResult
-import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.criteria.statement.UnifiedDeleteStarting
 import org.seasar.doma.kotlin.jdbc.criteria.declaration.KWhereDeclaration
 
 class KUnifiedDeleteStarting<ENTITY : Any>(private val statement: UnifiedDeleteStarting<ENTITY>) {
 
-    fun single(entity: ENTITY): KStatement<Result<ENTITY>> {
+    fun single(entity: ENTITY): KEntityqlDeleteStatement<ENTITY> {
         return KEntityqlDeleteStatement(statement.single(entity))
     }
 
diff --git a/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KUnifiedUpdateStarting.kt b/doma-kotlin/src/main/kotlin/org/seasar/doma/kotlin/jdbc/criteria/statement/KUnifiedUpdateStarting.kt
@@ -16,13 +16,12 @@
 package org.seasar.doma.kotlin.jdbc.criteria.statement
 
 import org.seasar.doma.jdbc.BatchResult
-import org.seasar.doma.jdbc.Result
 import org.seasar.doma.jdbc.criteria.statement.UnifiedUpdateStarting
 import org.seasar.doma.kotlin.jdbc.criteria.declaration.KSetDeclaration
 
 class KUnifiedUpdateStarting<ENTITY : Any>(private val statement: UnifiedUpdateStarting<ENTITY>) {
 
-    fun single(entity: ENTITY): KStatement<Result<ENTITY>> {
+    fun single(entity: ENTITY): KEntityqlUpdateStatement<ENTITY> {
         return KEntityqlUpdateStatement(statement.single(entity))
     }
 
diff --git a/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityDeleteTest.kt b/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityDeleteTest.kt
@@ -16,11 +16,16 @@
 package org.seasar.doma.it.criteria
 
 import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertNotEquals
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertNull
 import org.junit.jupiter.api.extension.ExtendWith
+import org.seasar.doma.it.Dbms
 import org.seasar.doma.it.IntegrationTestEnvironment
+import org.seasar.doma.it.Run
 import org.seasar.doma.jdbc.Config
+import org.seasar.doma.jdbc.Result
 import org.seasar.doma.kotlin.jdbc.criteria.KQueryDsl
 
 @ExtendWith(IntegrationTestEnvironment::class)
@@ -49,4 +54,24 @@ class KQueryDslEntityDeleteTest(config: Config) {
             .execute()
         assertEquals(0, result.count)
     }
+
+    @Test
+    @Run(unless = [Dbms.MYSQL, Dbms.MYSQL8, Dbms.ORACLE])
+    fun returning() {
+        val e = Employee_()
+
+        val employee =
+            dsl.from(e).where { eq(e.employeeId, 5) }.fetchOne()
+
+        val result: Result<Employee> = dsl.delete(e).single(employee).returning().execute()
+        assertEquals(1, result.count)
+        assertNotEquals(employee, result.entity)
+
+        val resultEntity = result.entity
+        assertEquals(5, resultEntity.employeeId)
+
+        val entity =
+            dsl.from(e).where { eq(e.employeeId, 5) }.fetchOneOrNull()
+        assertNull(entity)
+    }
 }
diff --git a/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityInsertTest.kt b/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityInsertTest.kt
@@ -16,10 +16,15 @@
 package org.seasar.doma.it.criteria
 
 import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertNotEquals
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertNotNull
 import org.junit.jupiter.api.extension.ExtendWith
+import org.seasar.doma.it.Dbms
 import org.seasar.doma.it.IntegrationTestEnvironment
+import org.seasar.doma.it.Run
 import org.seasar.doma.jdbc.Config
+import org.seasar.doma.jdbc.Result
 import org.seasar.doma.kotlin.jdbc.criteria.KQueryDsl
 
 @ExtendWith(IntegrationTestEnvironment::class)
@@ -41,4 +46,33 @@ class KQueryDslEntityInsertTest(config: Config) {
         checkNotNull(department2)
         assertEquals("aaa", department2.departmentName)
     }
+
+    @Test
+    @Run(unless = [Dbms.MYSQL, Dbms.MYSQL8, Dbms.ORACLE])
+    fun returning() {
+        val d = Department_()
+
+        val department = Department()
+        department.departmentId = 99
+        department.departmentNo = 99
+        department.departmentName = "aaa"
+        department.location = "bbb"
+
+        val result: Result<Department> = dsl.insert(d).single(department).returning().execute()
+        assertNotEquals(department, result.getEntity())
+        assertEquals(1, result.count)
+        val resultEntity = result.getEntity()
+        assertEquals(department.departmentId, resultEntity.departmentId)
+        assertEquals(department.departmentNo, resultEntity.departmentNo)
+        assertEquals(department.departmentName, resultEntity.departmentName)
+        assertEquals(department.location, resultEntity.location)
+        assertEquals(1, resultEntity.version)
+
+        val department2 =
+            dsl.from(d)
+                .where { eq(d.departmentId, department.departmentId) }
+                .fetchOne()
+        assertNotNull(department2)
+        assertEquals("aaa", department2.departmentName)
+    }
 }
diff --git a/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityMultiInsertTest.kt b/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityMultiInsertTest.kt
@@ -0,0 +1,71 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.seasar.doma.it.criteria
+
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertNotEquals
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+import org.seasar.doma.it.Dbms
+import org.seasar.doma.it.IntegrationTestEnvironment
+import org.seasar.doma.it.Run
+import org.seasar.doma.jdbc.Config
+import org.seasar.doma.kotlin.jdbc.criteria.KQueryDsl
+
+@ExtendWith(IntegrationTestEnvironment::class)
+class KQueryDslEntityMultiInsertTest(config: Config) {
+
+    private val dsl = KQueryDsl(config)
+
+    @Test
+    @Run(unless = [Dbms.MYSQL, Dbms.MYSQL8, Dbms.ORACLE])
+    fun returning() {
+        val d = Department_()
+
+        val department = Department()
+        department.departmentId = 99
+        department.departmentNo = 99
+        department.departmentName = "aaa"
+        department.location = "bbb"
+
+        val department2 = Department()
+        department2.departmentId = 100
+        department2.departmentNo = 100
+        department2.departmentName = "ccc"
+        department2.location = "ddd"
+
+        val departments = listOf(department, department2)
+
+        val result = dsl.insert(d).multi(departments).returning().execute()
+        assertNotEquals(departments, result.entities)
+        Assertions.assertEquals(2, result.count)
+
+        val entity1 = result.getEntities().get(0)
+        Assertions.assertEquals(99, entity1.departmentId)
+        Assertions.assertEquals(99, entity1.departmentNo)
+        assertEquals("aaa", entity1.departmentName)
+        assertEquals("bbb", entity1.location)
+        Assertions.assertEquals(1, entity1.version)
+
+        val entity2 = result.getEntities().get(1)
+        Assertions.assertEquals(100, entity2.departmentId)
+        Assertions.assertEquals(100, entity2.departmentNo)
+        assertEquals("ccc", entity2.departmentName)
+        assertEquals("ddd", entity2.location)
+        Assertions.assertEquals(1, entity2.version)
+    }
+}
diff --git a/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityUpdateTest.kt b/integration-test-kotlin/src/test/kotlin/org/seasar/doma/it/criteria/KQueryDslEntityUpdateTest.kt
