@capacitor-community/sqlite 3.3.2 → 3.3.3-4

package/CHANGELOG.md

@@ -1,3 +1,50 @@
+## 3.3.3-4 (2022-01-06)
+
+### Added Features
+
+ - add getUrl method Get DB Path iOS & Android 
+
+### Bug Fixes
+
+ - fix Get DB Path or file URI issue#208
+
+## 3.3.3-3 (2022-01-03)
+
+### Bug Fixes
+
+ - fix Android Error during database version upgrade issue#209
+
+## 3.3.3-2 (2022-01-03)
+
+### Added Features
+
+ - iOS Support for databases that are not visible to iTunes and are not backed up by iCloud issue#207
+
+### Bug Fixes
+
+ - fix README.md
+ - fix API.md
+
+## 3.3.3-1 (2021-12-18)
+
+### Chore
+
+ - Update to @capacitor/core 3.3.3
+ - Update to @capacitor/ios 3.3.3
+ - Update to @capacitor/android 3.3.3
+
+### Added Features
+
+ - Open in Read-Only Mode databases without SQLite suffix 
+ - getNCDatabasePath, createNCConnection, closeNCConnection, isNCDatabase
+ - add NonConformedDatabase.md documentation
+
+### Bug Fixes
+
+ - fix mode "UNIQUE" not case sensitive in importToJson index issue#203
+ - fix support non-conformed database in read-only mode issue#201
+
+
 ## 3.3.2 (2021-12-13)
 
 ### Chore

package/README.md

@@ -16,7 +16,7 @@
   <a href="https://www.npmjs.com/package/@capacitor-community/sqlite"><img src="https://img.shields.io/npm/dw/@capacitor-community/sqlite?style=flat-square" /></a>
   <a href="https://www.npmjs.com/package/@capacitor-community/sqlite"><img src="https://img.shields.io/npm/v/@capacitor-community/sqlite?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-9-orange?style=flat-square" /></a>
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-11-orange?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
@@ -28,6 +28,23 @@
 
 ## CAPACITOR 3 (Master)
 
+🚨 Since release 3.3.3-2 ->> 🚨
+
+  - iOS only
+    Support for a database location not visible to iTunes and backed up to iCloud.
+    For this you must add to the `const config: CapacitorConfig` of the `capacitor.config.ts` file of your application the following:
+    ```ts
+      plugins: {
+        CapacitorSQLite: {
+          "iosDatabaseLocation": "Library/CapacitorDatabase"
+        }
+      }
+    ``` 
+    Pre-existing databases from the `Documents` folder will be moved to the new folder `Library/CapacitorDatabase` and your application will work as before.
+    If you do not modify the `capacitor.config.ts` file of your application the databases will still reside in the `Documents` folder
+
+🚨 Since release 3.3.3-2 <<- 🚨
+
 🚨 Since release 3.2.5-2 ->> 🚨
 
   - support zip file in copyFromAssets method
@@ -184,6 +201,7 @@ No configuration required for this plugin
 | open (non-encrypted DB)     | ✅      | ✅  | ✅        | ✅  |
 | open (encrypted DB)         | ✅      | ✅  | ❌        | ❌  |
 | close                       | ✅      | ✅  | ✅        | ✅  |
+| getUrl                      | ✅      | ✅  | ❌        | ❌  |
 | getVersion                  | ✅      | ✅  | ✅        | ✅  |
 | execute                     | ✅      | ✅  | ✅        | ✅  |
 | executeSet                  | ✅      | ✅  | ✅        | ✅  |
@@ -212,6 +230,10 @@ No configuration required for this plugin
 | changeEncryptionSecret      | ✅      | ✅  | ❌        | ❌  |
 | initWebStore                | ❌      | ❌  | ❌        | ✅  |
 | saveToStore                 | ❌      | ❌  | ❌        | ✅  |
+| getNCDatabasePath           | ✅      | ✅  | ❌        | ❌  |
+| createNCConnection          | ✅      | ✅  | ❌        | ❌  |
+| closeNCConnection           | ✅      | ✅  | ❌        | ❌  |
+| isNCDatabase                | ✅      | ✅  | ❌        | ❌  |
 
 ## Supported SQLite Types
 
@@ -237,6 +259,8 @@ No configuration required for this plugin
 
 - [Web_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Web-Usage.md)
 
+- [Non_Conformed_Databases_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/NonConformedDatabases.md)
+
 ### Framework's Usage 
 
 - [Ionic/Angular_Usage_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Angular-Usage.md)
@@ -302,7 +326,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/digaus"><img src="https://avatars.githubusercontent.com/u/15358538?v=4" width="100px;" alt=""/><br /><sub><b>Dirk Gausmann</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/IT-MikeS"><img src="https://avatars.githubusercontent.com/u/20338451?v=4" width="100px;" alt=""/><br /><sub><b>Mike Summerfeldt</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/peakcool"><img src="https://avatars.githubusercontent.com/u/14804014?v=4" width="100px;" alt=""/><br /><sub><b>Peakcool</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/gion-andri"><img src="https://avatars.githubusercontent.com/u/540998?v=4" width="100px;" alt=""/><br /><sub><b>Gion-Andri Cantieni</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">💻</a></td>
+    <td align="center"><a href="https://github.com/gion-andri"><img src="https://avatars.githubusercontent.com/u/540998?v=4" width="100px;" alt=""/><br /><sub><b>Gion-Andri Cantieni</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/robingenz"><img src="https://avatars.githubusercontent.com/u/13857929?v=4" width="100px;" alt=""/><br /><sub><b>Robin Genz</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/dewald-els"><img src="https://avatars.githubusercontent.com/u/10051247?v=4" width="100px;" alt=""/><br /><sub><b>Dewald Els</b></sub></a><br /><a href="https://github.com/capacitor-community/sqlite/commits?author=jepiqueau" title="Code">💻</a></td>
   </tr>
 </table>
 

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLite.java

@@ -14,6 +14,7 @@ import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.JsonSQ
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.UtilsJson;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsFile;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsMigrate;
+import com.getcapacitor.community.database.sqlite.SQLite.UtilsNCDatabase;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsSecret;
 import java.io.File;
@@ -39,6 +40,7 @@ public class CapacitorSQLite {
     private UtilsFile uFile = new UtilsFile();
     private UtilsJson uJson = new UtilsJson();
     private UtilsMigrate uMigrate = new UtilsMigrate();
+    private UtilsNCDatabase uNCDatabase = new UtilsNCDatabase();
     private UtilsSecret uSecret;
     private SharedPreferences sharedPreferences;
 
@@ -116,6 +118,15 @@ public class CapacitorSQLite {
         }
     }
 
+    public String getNCDatabasePath(String folderPath, String database) throws Exception {
+        try {
+            String databasePath = uNCDatabase.getNCDatabasePath(context, folderPath, database);
+            return databasePath;
+        } catch (Exception e) {
+            throw new Exception(e.getMessage());
+        }
+    }
+
     /**
      * CreateConnection
      * @param dbName
@@ -148,6 +159,38 @@ public class CapacitorSQLite {
         }
     }
 
+    /**
+     * CreateConnection
+     * @param dbPath
+     * @param version
+     * @throws Exception
+     */
+    public void createNCConnection(String dbPath, int version) throws Exception {
+        // check if connection already exists
+        Database conn = dbDict.get(dbPath);
+        if (conn != null) {
+            String msg = "Connection " + dbPath + " already exists";
+            throw new Exception(msg);
+        }
+        try {
+            Boolean isDBPathExists = uFile.isPathExists(dbPath);
+            if (!isDBPathExists) {
+                String msg = "Database " + dbPath + " does not exist";
+                throw new Exception(msg);
+            }
+            Database db = new Database(context, dbPath, false, "no-encryption", version, new Hashtable<>(), sharedPreferences);
+            if (db != null) {
+                dbDict.put(dbPath, db);
+                return;
+            } else {
+                String msg = "db is null";
+                throw new Exception(msg);
+            }
+        } catch (Exception e) {
+            throw new Exception(e.getMessage());
+        }
+    }
+
     /**
      * Open
      * @param dbName
@@ -200,6 +243,28 @@ public class CapacitorSQLite {
         }
     }
 
+    /**
+     * GetUrl
+     * @param dbName
+     * @throws Exception
+     * @return String
+     */
+    public String getUrl(String dbName) throws Exception {
+        dbName = getDatabaseName(dbName);
+        Database db = dbDict.get(dbName);
+        if (db != null) {
+            try {
+                String url = db.getUrl();
+                return url;
+            } catch (Exception e) {
+                throw new Exception(e.getMessage());
+            }
+        } else {
+            String msg = "No available connection for database " + dbName;
+            throw new Exception(msg);
+        }
+    }
+
     /**
      * GetVersion
      * @param dbName
@@ -222,6 +287,29 @@ public class CapacitorSQLite {
         }
     }
 
+    /**
+     * CloseNCConnection
+     * @param dbPath
+     * @throws Exception
+     */
+    public void closeNCConnection(String dbPath) throws Exception {
+        Database db = dbDict.get(dbPath);
+        if (db != null) {
+            if (db.isOpen()) {
+                try {
+                    close(dbPath);
+                } catch (Exception e) {
+                    throw new Exception(e.getMessage());
+                }
+            }
+            dbDict.remove(dbPath);
+            return;
+        } else {
+            String msg = "No available connection for database " + dbPath;
+            throw new Exception(msg);
+        }
+    }
+
     /**
      * CloseConnection
      * @param dbName
@@ -301,6 +389,16 @@ public class CapacitorSQLite {
         return uFile.isFileExists(context, dbName + "SQLite.db");
     }
 
+    /**
+     * IsNCDatabase
+     * @param dbPath
+     * @return Boolean
+     * @throws Exception
+     */
+    public Boolean isNCDatabase(String dbPath) {
+        return uFile.isPathExists(dbPath);
+    }
+
     /**
      * IsTableExists
      * @param dbName
@@ -398,7 +496,7 @@ public class CapacitorSQLite {
         dbName = getDatabaseName(dbName);
         Database db = dbDict.get(dbName);
         if (db != null) {
-            if (db.isOpen()) {
+            if (!db.isNCDB() && db.isOpen()) {
                 // convert string in string[]
                 String[] sqlCmdArray = uSqlite.getStatementsArray(statements);
                 try {
@@ -428,7 +526,7 @@ public class CapacitorSQLite {
         dbName = getDatabaseName(dbName);
         Database db = dbDict.get(dbName);
         if (db != null) {
-            if (db.isOpen()) {
+            if (!db.isNCDB() && db.isOpen()) {
                 try {
                     JSObject res = db.executeSet(set, transaction);
                     return res;
@@ -458,7 +556,7 @@ public class CapacitorSQLite {
         dbName = getDatabaseName(dbName);
         Database db = dbDict.get(dbName);
         if (db != null) {
-            if (db.isOpen()) {
+            if (!db.isNCDB() && db.isOpen()) {
                 if (values.length() > 0) {
                     try {
                         ArrayList<Object> arrValues = uSqlite.objectJSArrayToArrayList(values);
@@ -737,11 +835,11 @@ public class CapacitorSQLite {
 
     private String getDatabaseName(String dbName) {
         String retName = dbName;
-
-        if (retName.endsWith(".db")) {
-            retName = retName.substring(0, retName.length() - 3);
+        if (!retName.contains("/")) {
+            if (retName.endsWith(".db")) {
+                retName = retName.substring(0, retName.length() - 3);
+            }
         }
-
         return retName;
     }
 

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLitePlugin.java

@@ -132,6 +132,60 @@ public class CapacitorSQLitePlugin extends Plugin {
         }
     }
 
+    @PluginMethod
+    public void getNCDatabasePath(PluginCall call) {
+        String folderPath = null;
+        String dbName = null;
+        if (!call.getData().has("path")) {
+            String msg = "getNCDatabasePath: Must provide a folder path";
+            rHandler.retPath(call, null, msg);
+            return;
+        }
+        folderPath = call.getString("path");
+        if (!call.getData().has("database")) {
+            String msg = "getNCDatabasePath: Must provide a database name";
+            rHandler.retPath(call, null, msg);
+            return;
+        }
+        dbName = call.getString("database");
+        try {
+            String databasePath = implementation.getNCDatabasePath(folderPath, dbName);
+            rHandler.retPath(call, databasePath, null);
+            return;
+        } catch (Exception e) {
+            String msg = "getNCDatabasePath: " + e.getMessage();
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+    }
+
+    /**
+     * CreateNCConnection Method
+     * Create a non-conformed connection to a database
+     * @param call
+     */
+    @PluginMethod
+    public void createNCConnection(PluginCall call) {
+        String dbPath = null;
+        int dbVersion = Integer.valueOf(-1);
+        if (!call.getData().has("databasePath")) {
+            String msg = "CreateNCConnection: Must provide a database path";
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+        dbPath = call.getString("databasePath");
+        dbVersion = call.getInt("version", 1);
+        try {
+            implementation.createNCConnection(dbPath, dbVersion);
+            rHandler.retResult(call, null, null);
+            return;
+        } catch (Exception e) {
+            String msg = "CreateNCConnection: " + e.getMessage();
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+    }
+
     /**
      * CreateConnection Method
      * Create a connection to a database
@@ -141,8 +195,6 @@ public class CapacitorSQLitePlugin extends Plugin {
     public void createConnection(PluginCall call) {
         String dbName = null;
         int dbVersion = Integer.valueOf(-1);
-        String secret = null;
-        String newsecret = null;
         String inMode = null;
         JSObject ret = new JSObject();
         if (!call.getData().has("database")) {
@@ -166,7 +218,6 @@ public class CapacitorSQLitePlugin extends Plugin {
             }
         } else {
             inMode = "no-encryption";
-            secret = "";
         }
         Dictionary<Integer, JSONObject> upgDict = versionUpgrades.get(dbName);
         try {
@@ -228,6 +279,30 @@ public class CapacitorSQLitePlugin extends Plugin {
         }
     }
 
+    /**
+     * GetUrl Method
+     * Get a database Url
+     * @param call
+     */
+    @PluginMethod
+    public void getUrl(PluginCall call) {
+        if (!call.getData().has("database")) {
+            String msg = "GetUrl: Must provide a database name";
+            rHandler.retUrl(call, null, msg);
+            return;
+        }
+        String dbName = call.getString("database");
+        try {
+            String res = implementation.getUrl(dbName);
+            rHandler.retUrl(call, res, null);
+            return;
+        } catch (Exception e) {
+            String msg = "GetUrl: " + e.getMessage();
+            rHandler.retUrl(call, null, msg);
+            return;
+        }
+    }
+
     /**
      * GetVersion Method
      * Get a database Version
@@ -246,12 +321,36 @@ public class CapacitorSQLitePlugin extends Plugin {
             rHandler.retVersion(call, res, null);
             return;
         } catch (Exception e) {
-            String msg = "Open: " + e.getMessage();
+            String msg = "GetVersion: " + e.getMessage();
             rHandler.retVersion(call, null, msg);
             return;
         }
     }
 
+    /**
+     * CloseNCConnection Method
+     * Close a non-conformed database connection
+     * @param call
+     */
+    @PluginMethod
+    public void closeNCConnection(PluginCall call) {
+        if (!call.getData().has("databasePath")) {
+            String msg = "CloseNCConnection: Must provide a database path";
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+        String dbPath = call.getString("databasePath");
+        try {
+            implementation.closeNCConnection(dbPath);
+            rHandler.retResult(call, null, null);
+            return;
+        } catch (Exception e) {
+            String msg = "CloseNCConnection: " + e.getMessage();
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+    }
+
     /**
      * CloseConnection Method
      * Close the connection to a database
@@ -323,6 +422,29 @@ public class CapacitorSQLitePlugin extends Plugin {
         }
     }
 
+    /**
+     * IsDatabase Method
+     * Check if the database file exists
+     * @param call
+     */
+    @PluginMethod
+    public void isNCDatabase(PluginCall call) {
+        if (!call.getData().has("databasePath")) {
+            rHandler.retResult(call, null, "Must provide a database path");
+            return;
+        }
+        String dbPath = call.getString("databasePath");
+        try {
+            Boolean res = implementation.isNCDatabase(dbPath);
+            rHandler.retResult(call, res, null);
+            return;
+        } catch (Exception e) {
+            String msg = "isNCDatabase: " + e.getMessage();
+            rHandler.retResult(call, null, msg);
+            return;
+        }
+    }
+
     /**
      * IsTableExists Method
      * Check if a table exists in a database

package/android/src/main/java/com/getcapacitor/community/database/sqlite/RetHandler.java

@@ -140,4 +140,52 @@ public class RetHandler {
             return;
         }
     }
+
+    /**
+     * RetPath Method
+     * Create and return the capNCDatabasePathResult object
+     * @param call
+     * @param res
+     * @param message
+     */
+    public void retPath(PluginCall call, String res, String message) {
+        JSObject ret = new JSObject();
+        if (message != null) {
+            ret.put("message", message);
+            Log.v(TAG, "*** ERROR " + message);
+            call.reject(message);
+            return;
+        }
+        if (res != null) {
+            ret.put("path", res);
+            call.resolve(ret);
+            return;
+        } else {
+            call.resolve();
+        }
+    }
+
+    /**
+     * RetUrl Method
+     * Create and return the capSQLiteUrl object
+     * @param call
+     * @param res
+     * @param message
+     */
+    public void retUrl(PluginCall call, String res, String message) {
+        JSObject ret = new JSObject();
+        if (message != null) {
+            ret.put("message", message);
+            Log.v(TAG, "*** ERROR " + message);
+            call.reject(message);
+            return;
+        }
+        if (res != null) {
+            ret.put("url", res);
+            call.resolve(ret);
+            return;
+        } else {
+            call.resolve();
+        }
+    }
 }