Merge pull request #85 from qiaoyuang/main

Update version to 1.3.1

Author: qiaoyuang

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 - Date format: YYYY-MM-dd
 
+## v1.3.1 / 2024-04-24
+
+### sqllin-dsl
+
+* Fix a crash when a data class doesn't contain any `String` element.
+* Fix the [issue#81](https://github.com/ctripcorp/SQLlin/issues/81) about insert and query null values
+* Fix some wrongs about generation of SQL syntax
+
+### sqllin-driver
+
+* **Breaking change**: Remove the deprecated API `CommonCursor#forEachRows`
+* **Breaking change**: the `getInt`, `getLong`, `getFloat` and `getDouble` will throw an exception when the value is NULl in SQLite
+* Add a new public API: `CommonCursor#isNull`, for check if the value is NULL in SQLite
+
 ## v1.3.0 / 2024-04-21
 
 ### All

gradle.properties

@@ -1,4 +1,4 @@
-VERSION=1.3.0
+VERSION=1.3.1
 GROUP=com.ctrip.kotlin
 
 kotlinVersion=1.9.23

sqllin-driver/README.md

@@ -102,7 +102,7 @@ databaseConnection.executeUpdateDelete(SQL.UPDATE, arrayOf(20, "Tom"))
 
 // SELECT
 val cursor: CommonCursor = databaseConnection.query(SQL.QUERY, arrayOf(20, "Tom"))
-cursor.forEachRows { index -> // Index of rows
+cursor.forEachRow { index -> // Index of rows
     val age: Int = cursor.getInt("age")
     val name: String = cursor.getString("name")
 }

sqllin-driver/README_CN.md

@@ -91,7 +91,7 @@ databaseConnection.executeUpdateDelete(SQL.UPDATE, arrayOf(20, "Tom"))
 
 // SELECT
 val cursor: CommonCursor = databaseConnection.query(SQL.QUERY, arrayOf(20, "Tom"))
-cursor.forEachRows { index -> // Index of rows
+cursor.forEachRow { index -> // Index of rows
     val age: Int = cursor.getInt("age")
     val name: String = cursor.getString("name")
 }

sqllin-driver/src/androidMain/kotlin/com/ctrip/sqllin/driver/AndroidCursor.kt

@@ -25,10 +25,33 @@ import android.database.Cursor
 
 internal class AndroidCursor(private val cursor: Cursor) : CommonCursor {
 
-    override fun getInt(columnIndex: Int): Int = cursor.getInt(columnIndex)
-    override fun getLong(columnIndex: Int): Long = cursor.getLong(columnIndex)
-    override fun getFloat(columnIndex: Int): Float = cursor.getFloat(columnIndex)
-    override fun getDouble(columnIndex: Int): Double = cursor.getDouble(columnIndex)
+    override fun getInt(columnIndex: Int): Int = try {
+        cursor.getInt(columnIndex)
+    } catch (e: Exception) {
+        e.printStackTrace()
+        throw SQLiteException("The value of column $columnIndex is NULL")
+    }
+
+    override fun getLong(columnIndex: Int): Long = try {
+        cursor.getLong(columnIndex)
+    } catch (e: Exception) {
+        e.printStackTrace()
+        throw SQLiteException("The value of column $columnIndex is NULL")
+    }
+
+    override fun getFloat(columnIndex: Int): Float = try {
+        cursor.getFloat(columnIndex)
+    } catch (e: Exception) {
+        e.printStackTrace()
+        throw SQLiteException("The value of column $columnIndex is NULL")
+    }
+
+    override fun getDouble(columnIndex: Int): Double = try {
+        cursor.getDouble(columnIndex)
+    } catch (e: Exception) {
+        e.printStackTrace()
+        throw SQLiteException("The value of column $columnIndex is NULL")
+    }
 
     override fun getString(columnIndex: Int): String? = try {
         cursor.getString(columnIndex)
@@ -46,12 +69,6 @@ internal class AndroidCursor(private val cursor: Cursor) : CommonCursor {
 
     override fun getColumnIndex(columnName: String): Int = cursor.getColumnIndexOrThrow(columnName)
 
-    @Deprecated(
-        message = "Please use the new API: forEachRow",
-        replaceWith = ReplaceWith(expression = "forEachRow"),
-    )
-    override fun forEachRows(block: (Int) -> Unit) = forEachRow(block)
-
     override fun forEachRow(block: (Int) -> Unit) {
         if (!cursor.moveToFirst()) return
         var index = 0
@@ -61,5 +78,7 @@ internal class AndroidCursor(private val cursor: Cursor) : CommonCursor {
 
     override fun next(): Boolean = cursor.moveToNext()
 
+    override fun isNull(columnIndex: Int): Boolean = cursor.isNull(columnIndex)
+
     override fun close() = cursor.close()
 }

sqllin-driver/src/commonMain/kotlin/com/ctrip/sqllin/driver/CommonCursor.kt

@@ -33,14 +33,11 @@ public interface CommonCursor : AutoCloseable {
 
     public fun getColumnIndex(columnName: String): Int
 
-    @Deprecated(
-        message = "Please use the new API: forEachRow",
-        replaceWith = ReplaceWith(expression = "forEachRow"),
-    )
-    public fun forEachRows(block: (Int) -> Unit)
     public fun forEachRow(block: (Int) -> Unit)
 
     public fun next(): Boolean
 
+    public fun isNull(columnIndex: Int): Boolean
+
     public override fun close()
 }

sqllin-driver/src/commonMain/kotlin/com/ctrip/sqllin/driver/Extension.kt

@@ -93,7 +93,7 @@ internal fun DatabaseConnection.migrateIfNeeded(
 ) = withTransaction {
     val initialVersion = withQuery("PRAGMA user_version;") {
         it.next()
-        it.getInt(0)
+        it.getInt(0) ?: 0
     }
     if (initialVersion == 0) {
         create(this)

sqllin-driver/src/commonMain/kotlin/com/ctrip/sqllin/driver/SQLiteException.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2024 Trip.com.
+ *
+ * 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 com.ctrip.sqllin.driver
+
+/**
+ * The exceptions about SQLite, they include the native SQLite result codes and error message
+ * @author Yuang Qiao
+ */
+
+public open class SQLiteException(message: String) : Exception(message)

sqllin-driver/src/commonTest/kotlin/com/ctrip/sqllin/driver/CommonBasicTest.kt

@@ -28,15 +28,17 @@ class CommonBasicTest(private val path: DatabasePath) {
 
     private class Book(
         val name: String,
-        val author: String,
+        val author: String?,
         val pages: Int,
         val price: Double,
-        val array: ByteArray,
+        val array: ByteArray?,
     )
 
     private val bookList = listOf(
         Book(name = "The Da Vinci Code", author = "Dan Brown", pages = 454, price = 16.96, byteArrayOf()),
         Book(name = "The Lost Symbol", author = "Dan Brown", pages = 510, price = 19.95, byteArrayOf(1, 2, 3)),
+        Book(name = "", author = "Dan Brown", pages = 454, price = 16.96, byteArrayOf()),
+        Book(name = "The Lost Symbol", author = null, pages = 510, price = 19.95, null),
     )
 
     fun testCreateAndUpgrade() {
@@ -87,6 +89,8 @@ class CommonBasicTest(private val path: DatabasePath) {
             it.withTransaction { connection ->
                 connection.executeInsert(SQL.INSERT_BOOK, arrayOf("The Da Vinci Code", "Dan Brown", 454, 16.96, byteArrayOf()))
                 connection.executeInsert(SQL.INSERT_BOOK, arrayOf("The Lost Symbol", "Dan Brown", 510, 19.95, byteArrayOf(1, 2, 3)))
+                connection.executeInsert(SQL.INSERT_BOOK, arrayOf("", "Dan Brown", 454, 16.96, byteArrayOf()))
+                connection.executeInsert(SQL.INSERT_BOOK, arrayOf("The Lost Symbol", null, 510, 19.95, null))
             }
         }
         val readOnlyConfig = getDefaultDBConfig(true)
@@ -99,7 +103,7 @@ class CommonBasicTest(private val path: DatabasePath) {
                     assertEquals(book.author, cursor.getString(++columnIndex))
                     assertEquals(book.pages, cursor.getInt(++columnIndex))
                     assertEquals(book.price, cursor.getDouble(++columnIndex))
-                    assertEquals(book.array.size, cursor.getByteArray(++columnIndex)?.size)
+                    assertEquals(book.array?.size, cursor.getByteArray(++columnIndex)?.size)
                 }
             }
         }
@@ -204,7 +208,7 @@ class CommonBasicTest(private val path: DatabasePath) {
                             assertEquals(book.author, cursor.getString(++columnIndex))
                             assertEquals(book.pages, cursor.getInt(++columnIndex))
                             assertEquals(book.price, cursor.getDouble(++columnIndex))
-                            assertEquals(book.array.size, cursor.getByteArray(++columnIndex)?.size)
+                            assertEquals(book.array?.size, cursor.getByteArray(++columnIndex)?.size)
                         }
                     }
                 }

sqllin-driver/src/jvmMain/kotlin/com/ctrip/sqllin/driver/JdbcCursor.kt

@@ -24,26 +24,40 @@ import java.sql.ResultSet
  */
 internal class JdbcCursor(private val resultSet: ResultSet) : CommonCursor {
 
-    override fun getInt(columnIndex: Int): Int = resultSet.getInt(columnIndex + 1)
+    override fun getInt(columnIndex: Int): Int {
+        val result = resultSet.getInt(columnIndex + 1)
+        if (resultSet.wasNull())
+            throw SQLiteException("The value of column $columnIndex is NULL")
+        return result
+    }
 
-    override fun getLong(columnIndex: Int): Long = resultSet.getLong(columnIndex + 1)
+    override fun getLong(columnIndex: Int): Long {
+        val result = resultSet.getLong(columnIndex + 1)
+        if (resultSet.wasNull())
+            throw SQLiteException("The value of column $columnIndex is NULL")
+        return result
+    }
 
-    override fun getFloat(columnIndex: Int): Float = resultSet.getFloat(columnIndex + 1)
+    override fun getFloat(columnIndex: Int): Float {
+        val result = resultSet.getFloat(columnIndex + 1)
+        if (resultSet.wasNull())
+            throw SQLiteException("The value of column $columnIndex is NULL")
+        return result
+    }
 
-    override fun getDouble(columnIndex: Int): Double = resultSet.getDouble(columnIndex + 1)
+    override fun getDouble(columnIndex: Int): Double {
+        val result = resultSet.getDouble(columnIndex + 1)
+        if (resultSet.wasNull())
+            throw SQLiteException("The value of column $columnIndex is NULL")
+        return result
+    }
 
     override fun getString(columnIndex: Int): String? = resultSet.getString(columnIndex + 1)
 
     override fun getByteArray(columnIndex: Int): ByteArray? = resultSet.getBytes(columnIndex + 1)
 
     override fun getColumnIndex(columnName: String): Int = resultSet.findColumn(columnName) - 1
 
-    @Deprecated(
-        message = "Please use the new API: forEachRow",
-        replaceWith = ReplaceWith(expression = "forEachRow"),
-    )
-    override fun forEachRows(block: (Int) -> Unit) = forEachRow(block)
-
     override fun forEachRow(block: (Int) -> Unit) {
         var index = 0
         while (next())
@@ -52,6 +66,11 @@ internal class JdbcCursor(private val resultSet: ResultSet) : CommonCursor {
 
     override fun next(): Boolean = resultSet.next()
 
+    override fun isNull(columnIndex: Int): Boolean {
+        resultSet.getObject(columnIndex + 1)
+        return resultSet.wasNull()
+    }
+
     override fun close() {
         resultSet.close()
         resultSet.statement.close()