Snowflake dialect

Author: dmitchell

README.md

@@ -1,6 +1,3 @@
-<p align="center">
-    <img src="https://raw.githubusercontent.com/kotlin-orm/ktorm-docs/master/source/images/logo-full.png" alt="Ktorm" width="300" />
-</p>
 <p align="center">
     <a href="https://github.com/kotlin-orm/ktorm/actions/workflows/build.yml">
         <img src="https://github.com/kotlin-orm/ktorm/actions/workflows/build.yml/badge.svg" alt="Build Status" />

buildSrc/src/main/kotlin/ktorm.base.gradle.kts

@@ -25,8 +25,8 @@ detekt {
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
 }
 
 tasks {
@@ -37,15 +37,15 @@ tasks {
         dependsOn(codegen)
 
         kotlinOptions {
-            jvmTarget = "1.8"
+            jvmTarget = "11"
             allWarningsAsErrors = true
             freeCompilerArgs = listOf("-Xexplicit-api=strict")
         }
     }
 
     compileTestKotlin {
         kotlinOptions {
-            jvmTarget = "1.8"
+            jvmTarget = "11"
         }
     }
 

buildSrc/src/main/kotlin/ktorm.publish.gradle.kts

@@ -164,6 +164,11 @@ publishing {
                         name.set("hc224")
                         email.set("[email protected]")
                     }
+                    developer {
+                        id.set("dmitchell")
+                        name.set("Don Mitchell")
+                        email.set("[email protected]")
+                    }
                 }
             }
         }

ktorm-support-snowflake/src/main/kotlin/org/ktorm/support/snowflake/BulkInsert.kt

@@ -0,0 +1,218 @@
+/*
+ * Copyright 2018-2025 the original author or 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
+ *
+ *      http://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.ktorm.support.snowflake
+
+import org.ktorm.database.Database
+import org.ktorm.dsl.AliasRemover
+import org.ktorm.dsl.AssignmentsBuilder
+import org.ktorm.dsl.KtormDsl
+import org.ktorm.dsl.batchInsert
+import org.ktorm.expression.ColumnAssignmentExpression
+import org.ktorm.expression.FunctionExpression
+import org.ktorm.expression.SqlExpression
+import org.ktorm.expression.TableExpression
+import org.ktorm.schema.BaseTable
+import org.ktorm.schema.Column
+
+/**
+ * Bulk insert expression, represents a bulk insert statement in Snowflake. This is a copy of the MySQL version.
+ * Given that 4 modules copy this, it's probably worth moving this to a shared module.
+ *
+ * For example:
+ *
+ * ```sql
+ * insert into table (column1, column2) values (?, ?), (?, ?), (?, ?)...
+ * on duplicate key update ...
+ * ```
+ *
+ * @property table the table to be inserted.
+ * @property assignments column assignments of the bulk insert statement.
+ * @property updateAssignments the updated column assignments while key conflict exists.
+ */
+public data class BulkInsertExpression(
+    val table: TableExpression,
+    val assignments: List<List<ColumnAssignmentExpression<*>>>,
+    val updateAssignments: List<ColumnAssignmentExpression<*>> = emptyList(),
+    override val isLeafNode: Boolean = false,
+    override val extraProperties: Map<String, Any> = emptyMap()
+) : SqlExpression()
+
+/**
+ * Construct a bulk insert expression in the given closure, then execute it and return the effected row count.
+ *
+ * The usage is almost the same as [batchInsert], but this function is implemented by generating a special SQL
+ * using MySQL bulk insert syntax, instead of based on JDBC batch operations. For this reason, its performance
+ * is much better than [batchInsert].
+ *
+ * The generated SQL is like: `insert into table (column1, column2) values (?, ?), (?, ?), (?, ?)...`.
+ *
+ * Usage:
+ *
+ * ```kotlin
+ * database.bulkInsert(Employees) {
+ *     item {
+ *         set(it.name, "jerry")
+ *         set(it.job, "trainee")
+ *         set(it.managerId, 1)
+ *         set(it.hireDate, LocalDate.now())
+ *         set(it.salary, 50)
+ *         set(it.departmentId, 1)
+ *     }
+ *     item {
+ *         set(it.name, "linda")
+ *         set(it.job, "assistant")
+ *         set(it.managerId, 3)
+ *         set(it.hireDate, LocalDate.now())
+ *         set(it.salary, 100)
+ *         set(it.departmentId, 2)
+ *     }
+ * }
+ * ```
+ *
+ * @param table the table to be inserted.
+ * @param block the DSL block, extension function of [BulkInsertStatementBuilder], used to construct the expression.
+ * @return the effected row count.
+ * @see batchInsert
+ */
+public fun <T : BaseTable<*>> Database.bulkInsert(
+    table: T, block: BulkInsertStatementBuilder<T>.() -> Unit
+): Int {
+    val builder = BulkInsertStatementBuilder(table).apply(block)
+    require(builder.assignments.isNotEmpty()) { "There are no items in the bulk operation." }
+
+    val expression = dialect.createExpressionVisitor(AliasRemover).visit(
+        BulkInsertExpression(table.asExpression(), builder.assignments)
+    )
+
+    return executeUpdate(expression)
+}
+
+/**
+ * Bulk insert records to the table, determining if there is a key conflict while inserting each of them,
+ * and automatically performs updates if any conflict exists.
+ *
+ * Usage:
+ *
+ * ```kotlin
+ * database.bulkInsertOrUpdate(Employees) {
+ *     item {
+ *         set(it.id, 1)
+ *         set(it.name, "vince")
+ *         set(it.job, "engineer")
+ *         set(it.salary, 1000)
+ *         set(it.hireDate, LocalDate.now())
+ *         set(it.departmentId, 1)
+ *     }
+ *     item {
+ *         set(it.id, 5)
+ *         set(it.name, "vince")
+ *         set(it.job, "engineer")
+ *         set(it.salary, 1000)
+ *         set(it.hireDate, LocalDate.now())
+ *         set(it.departmentId, 1)
+ *     }
+ *     onDuplicateKey {
+ *         set(it.salary, it.salary + 900)
+ *     }
+ * }
+ * ```
+ *
+ * Generated SQL:
+ *
+ * ```sql
+ * insert into t_employee (id, name, job, salary, hire_date, department_id)
+ * values (?, ?, ?, ?, ?, ?), (?, ?, ?, ?, ?, ?)
+ * on duplicate key update salary = salary + ?
+ * ```
+ *
+ * @since 3.3.0
+ * @param table the table to be inserted.
+ * @param block the DSL block used to construct the expression.
+ * @return the effected row count.
+ * @see bulkInsert
+ */
+public fun <T : BaseTable<*>> Database.bulkInsertOrUpdate(
+    table: T, block: BulkInsertOrUpdateStatementBuilder<T>.() -> Unit
+): Int {
+    val builder = BulkInsertOrUpdateStatementBuilder(table).apply(block)
+    require(builder.assignments.isNotEmpty()) { "There are no items in the bulk operation." }
+    require(builder.assignments.none { it.isEmpty() }) { "There are no columns to insert in the statement." }
+
+    val expression = dialect.createExpressionVisitor(AliasRemover).visit(
+        BulkInsertExpression(table.asExpression(), builder.assignments, builder.updateAssignments)
+    )
+
+    return executeUpdate(expression)
+}
+
+/**
+ * DSL builder for bulk insert statements.
+ */
+@KtormDsl
+public open class BulkInsertStatementBuilder<T : BaseTable<*>>(internal val table: T) {
+    internal val assignments = ArrayList<List<ColumnAssignmentExpression<*>>>()
+
+    /**
+     * Add the assignments of a new row to the bulk insert.
+     */
+    public fun item(block: AssignmentsBuilder.(T) -> Unit) {
+        val builder = SnowflakeAssignmentsBuilder()
+        builder.block(table)
+
+        require(
+            assignments.isEmpty() ||
+                    assignments[0].map { it.column.name } == builder.assignments.map { it.column.name }
+        ) { "Every item in a batch operation must be the same." }
+        assignments += builder.assignments
+    }
+}
+
+/**
+ * DSL builder for bulk insert or update statements.
+ */
+@KtormDsl
+public class BulkInsertOrUpdateStatementBuilder<T : BaseTable<*>>(table: T) : BulkInsertStatementBuilder<T>(table) {
+    internal val updateAssignments = ArrayList<ColumnAssignmentExpression<*>>()
+
+    /**
+     * Specify the update assignments while any key conflict exists.
+     */
+    public fun onDuplicateKey(block: BulkInsertOrUpdateOnDuplicateKeyClauseBuilder.(T) -> Unit) {
+        val builder = BulkInsertOrUpdateOnDuplicateKeyClauseBuilder()
+        builder.block(table)
+        updateAssignments += builder.assignments
+    }
+}
+
+/**
+ * DSL builder for bulk insert or update on duplicate key clause.
+ */
+@KtormDsl
+public class BulkInsertOrUpdateOnDuplicateKeyClauseBuilder : SnowflakeAssignmentsBuilder() {
+
+    /**
+     * Use VALUES() function in a ON DUPLICATE KEY UPDATE clause.
+     */
+    public fun <T : Any> values(column: Column<T>): FunctionExpression<T> {
+        // values(column)
+        return FunctionExpression(
+            functionName = "values",
+            arguments = listOf(column.asExpression()),
+            sqlType = column.sqlType
+        )
+    }
+}