Merge pull request #69 from touchlab/kpg/no_version_check

Open db without version check

Author: kpgalligan

gradle.properties

@@ -1,7 +1,7 @@
 kotlin.code.style=official
 
 GROUP=co.touchlab
-VERSION_NAME=1.1.0
+VERSION_NAME=1.1.1
 KOTLIN_VERSION=1.6.20-RC2
 
 kotlin.native.ignoreDisabledTargets=true

sqliter-driver/src/nativeCommonMain/kotlin/co/touchlab/sqliter/DatabaseConfiguration.kt

@@ -18,6 +18,18 @@ package co.touchlab.sqliter
 
 import co.touchlab.sqliter.interop.Logger
 
+/**
+ * The database manager will skip version checks, create, and update when this is set. This is useful if you
+ * need to do some kind of operation on a db without initializing it. For example, converting a clear text db
+ * to an encrypted db.
+ *
+ * Using this value is a bit of a hack. The next major version will likely include a refactor of config.
+ *
+ * User version is usually positive, but there are no enforced restrictions from the sqlite side. Using an "uncommon"
+ * negative number in case somebody uses negatives for some reason.
+ */
+const val NO_VERSION_CHECK = -50_001
+
 data class DatabaseConfiguration(
     val name: String?,
     val version: Int,

sqliter-driver/src/nativeCommonMain/kotlin/co/touchlab/sqliter/native/NativeDatabaseManager.kt

@@ -87,7 +87,9 @@ class NativeDatabaseManager(private val path:String,
                 conn.updateJournalMode(configuration.journalMode)
 
                 try {
-                    conn.migrateIfNeeded(configuration.create, configuration.upgrade, configuration.version)
+                    val version = configuration.version
+                    if(version != NO_VERSION_CHECK)
+                        conn.migrateIfNeeded(configuration.create, configuration.upgrade, version)
                 } catch (e: Exception) {
 
                     // If this failed, we have to close the connection or we will end up leaking it.

sqliter-driver/src/nativeCommonTest/kotlin/co/touchlab/sqliter/DatabaseConfigurationTest.kt

@@ -165,6 +165,18 @@ class DatabaseConfigurationTest : BaseDatabaseTest(){
         runFkTest("fkon", true)
     }
 
+    @Test
+    fun noVersionTest(){
+        val conf = DatabaseConfiguration(
+            name = TEST_DB_NAME,
+            inMemory = true,
+            version = NO_VERSION_CHECK,
+            create = { throw IllegalStateException("Shouldn't be here") })
+        val manager = createDatabaseManager(conf)
+        val conn = manager.createMultiThreadedConnection()
+        assertEquals(conn.getVersion(), 0)
+    }
+
     private fun runFkTest(dbname: String, enableFK: Boolean){
         var bookId = 1
         fun makeBookWithoutTransaction(conn: DatabaseConnection) =