cordova.plugin.sqlitetransfer

Usage

The plugin is exposed via the cordova.plugins.sqlitePorter object and provides the following functions:

• importSqlToDb()
• exportDbToSql()
• importJsonToDb()
• exportDbToJson()
• wipeDb()

importSqlToDb()

Executes a set of SQL statements against the defined database. Can be used to import data defined in the SQL statements into the database, and may additionally include commands to create the table structure.

cordova.plugins.sqlitePorter.importSqlToDb(db, sql, opts);

Parameters

• {Database} db - open SQLite database to import into
• {string} sql - SQL statements to execute against database.
• {object} opts - optional parameters:
  • {function} successFn - callback function to execute once import is complete, called with arguments:
    • {integer} count - total number of statements executed in the given SQL string.
  • {function} errorFn - callback function to execute on error during import, called with arguments:
    • {object} error - object representing the error.
  • {function} progressFn - callback function to execute after each successful execution of SQL statement, called with arguments:
    • {object} count - number of statements executed so far.
    • {integer} totalCount - total number of statements in the given SQL string.

Example usage

Create a database from a SQL dump

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var sql = "CREATE TABLE Artist ([Id] PRIMARY KEY, [Title]);"+
    "INSERT INTO Artist(Id,Title) VALUES ('1','Fred');";
var successFn = function(count){
    alert("Successfully imported "+count+" SQL statements to DB");
};
var errorFn = function(error){
    alert("The following error occurred: "+error.message);
};
var progressFn = function(current, total){
    console.log("Imported "+current+"/"+total+" statements");
};
cordova.plugins.sqlitePorter.importSqlToDb(db, sql, {
    successFn: successFn,
    errorFn: errorFn,
    progressFn: progressFn
});

Update an existing database

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var sql = "INSERT INTO Artist(Id,Title) VALUES ('6','Jane');"+
    "UPDATE Artist SET Title='Susan' WHERE Id='2';"+
    "DELETE FROM Artist WHERE Id='5';";
var successFn = function(count){
    alert("Successfully imported "+count+" SQL statements to DB");
};
var errorFn = function(error){
    alert("The following error occurred: "+error.message);
};
var progressFn = function(current, total){
    console.log("Imported "+current+"/"+total+" statements";
};
cordova.plugins.sqlitePorter.importSqlToDb(db, sql, {
    successFn: successFn,
    errorFn: errorFn,
    progressFn: progressFn
});

exportDbToSql()

Exports a SQLite DB as a set of SQL statements.

cordova.plugins.sqlitePorter.exportDbToSql(db, opts);

Parameters

• {Database} db - open SQLite database to export
• {object} opts - optional parameters:
  • {function} successFn - callback function to execute after export is complete, with arguments:
    • {string} sql - exported SQL statements combined into a single string.
    • {integer} count - number of SQL statements in exported string.
  • {boolean} dataOnly - if true, only row data will be exported. Otherwise, table structure will also be exported. Defaults to false.
  • {boolean} structureOnly - if true, only table structure will be exported. Otherwise, row will also be exported. Defaults to false.

Example usage

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var successFn = function(sql, count){
    console.log("Exported SQL: "+sql);
    alert("Exported SQL contains "+count+" statements");
};
cordova.plugins.sqlitePorter.exportDbToSql(db, {
    successFn: successFn
});

importJsonToDb()

Converts table structure and/or row data contained within a JSON structure into SQL statements that can be executed against a SQLite database. Can be used to import data into the database and/or create the table structure.

cordova.plugins.sqlitePorter.importJsonToDb(db, json, opts);

Parameters

• {Database} db - open SQLite database to import into
• {string/object} json - JSON structure containing row data and/or table structure as either a JSON object or string
• {object} opts - optional parameters:
  • {function} successFn - callback function to execute once import is complete, called with arguments:
    • {integer} count - total number of statements executed in the given SQL string.
  • {function} errorFn - callback function to execute on error during import, called with arguments:
    • {object} error - object representing the error.
  • {function} progressFn - callback function to execute after each successful execution of SQL statement, called with arguments:
    • {object} count - number of statements executed so far.
    • {integer} totalCount - total number of statements in the given SQL string.
  • {integer} batchInsertSize - maximum number of inserts to batch into a SQL statement using UNION SELECT method. Defaults to 250 if not specified. Set to 1 to disable batching and perform 1 insert per SQL statement. You can tweak this to optimize performance but numbers higher than 500 may cause the app to run out of memory and crash.

The structure

Example usage

Create a database from a SQL dump

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var json = {
    "structure":{
        "tables":{
            "Artist":"([Id] PRIMARY KEY, [Title])"
        },
       "otherSQL": [
            "CREATE UNIQUE INDEX Artist_ID ON Artist(Id)"
       ]
    },
    "data":{
        "inserts":{
            "Artist":[
                {"Id":"1","Title":"Fred"},
                {"Id":"2","Title":"Bob"},
                {"Id":"3","Title":"Jack"},
                {"Id":"4","Title":"John"}
            ]
        }
    }
};
var successFn = function(count){
    alert("Successfully imported JSON to DB; equivalent to "+count+" SQL statements");
};
var errorFn = function(error){
    alert("The following error occurred: "+error.message);
};
var progressFn = function(current, total){
    console.log("Imported "+current+"/"+total+" statements";
};
cordova.plugins.sqlitePorter.importJsonToDb(db, json, {
    successFn: successFn,
    errorFn: errorFn,
    progressFn: progressFn,
    batchInsertSize: 500
});

Update an existing database

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var json = {
    "data":{
        "inserts":{
            "Artist":[
                {"Id":"1","Title":"Fred"},
                {"Id":"2","Title":"Bob"}
            ]
        },
        "updates":{
            "Artist":
                [
                    {
                        "set": {"Title":"Jill"},
                        "where": {"Id":"3"}
                    },
                    {
                        "set": {"Title":"Susan"},
                        "where": {"Id":"4"}
                    }
                ]
            },
        },
        "deletes":{
            "Artist":[
                {"Id":"5"},
                {"Id":"6"}
            ]
        }
    }
};
var successFn = function(count){
    alert("Successfully imported JSON to DB; equivalent to "+count+" SQL statements");
};
var errorFn = function(error){
    alert("The following error occurred: "+error.message);
};
var progressFn = function(current, total){
    console.log("Imported "+current+"/"+total+" statements";
};
cordova.plugins.sqlitePorter.importJsonToDb(db, json, {
    successFn: successFn,
    errorFn: errorFn,
    progressFn: progressFn
});

exportDbToJson()

Exports a SQLite DB as a JSON structure

cordova.plugins.sqlitePorter.exportDbToJson(db, opts);

Parameters

• {Database} db - open SQLite database to export
• {object} opts - optional parameters:
  • {function} successFn - callback function to execute after export is complete, with arguments:
    • {object} json - exported JSON structure.
    • {integer} count - number of SQL statements that exported JSON structure corresponds to.
  • {boolean} dataOnly - if true, only row data will be exported. Otherwise, table structure will also be exported. Defaults to false.
  • {boolean} structureOnly - if true, only table structure will be exported. Otherwise, row will also be exported. Defaults to false.

Example usage

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var successFn = function(json, count){
        console.log("Exported JSON: "+json);
        alert("Exported JSON contains equivalent of "+count+" SQL statements");
    };
cordova.plugins.sqlitePorter.exportDbToJson(db, {
    successFn: successFn
});

wipeDb()

Wipes all data from a database by dropping all existing tables.

cordova.plugins.sqlitePorter.wipeDb(db, opts);

Parameters

• {Database} db - open SQLite database to wipe
• {object} opts - optional parameters:
  • {function} successFn - callback function to execute once wipe is complete, called with arguments:
    • {integer} count - number of tables dropped.
  • {function} errorFn - callback function to execute on error during wipe, called with arguments:
    • {object} error - object representing the error.
  • {function} progressFn - callback function to execute after each successful table drop, called with arguments:
    • {object} count - number of tables dropped so far.
    • {integer} totalCount - total number of tables to drop.

Example usage

var db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024);
var successFn = function(count){
    alert("Successfully wiped "+count+" tables");
};
var errorFn = function(error){
    alert("The following error occurred: "+error.message);
};
var progressFn = function(current, total){
    console.log("Wiped "+current+"/"+total+" tables";
};
cordova.plugins.sqlitePorter.wipeDb(db, {
    successFn: successFn,
    errorFn: errorFn,
    progressFn: progressFn
});

JSON structure

This json parameter uses a custom data structure defined by this plugin for the import/export of SQLite table structure and data.

There are two top-level keys, both of which are optional:

{
    "structure": ...,
    "data": ...
}

structure

Defines the table structure of the SQLite DB and other non-data-related SQL statements (e.g. index definitions). There are two possible keys:

{
    "structure":{
        "tables": ...,
        "otherSQL": ...
    }
}

tables

A key/value map which defines table structure, where the key is the table name and the value is the SQL table definition.

Note: on importing a tables structure, if a table with same name as a key exists in the target database, it will be dropped and recreated using the specified table structure.

For example, the SQL statement CREATE TABLE Artist ([Id] PRIMARY KEY, [Title]); would have the corresponding tables entry:

{
    "structure":{
        "tables": {
            "Artist":"([Id] PRIMARY KEY, [Title])"
        }
    }
}

otherSQL

A list of SQL statements which are not related to table structure or data insertion, for example the creation of indices, for example:

{
   "otherSQL": [
        "CREATE UNIQUE INDEX Artist_ID ON Artist(Id)"
   ]
}

data

Defines data to insert into database tables. There are 3 optional keys:

{
    "structure":{
        "data": {
            "inserts": ...,
            "updates": ...,
            "deletes": ...
        }
    }
}

inserts

A key/value map of row data to insert, where the key is the table name and the value is a list of row data objects in which the key is the field name and the value is the field value.

For example, the SQL statement:

INSERT INTO Artist(Id,Title) VALUES ('6','Jane');

Would be represented as:

{
    "structure":{
        "data": {
            "inserts": {
                "Artist":[
                    {
                        "Id":"6",
                        "Title":"Jane"
                    }
                ]
            }
        }
    }
}

updates

A key/value map of row data to update, where the key is the table name and the value is a list of row update objects. A row update update consists of a where key which identifies the row to update via the primary key and a set object which defines the row data to insert.

For example, the SQL statement:

UPDATE Artist SET Title='Susan' WHERE Id='2';

Would be represented as:

{
    "structure":{
        "data": {
            "updates": {
                "Artist":[
                    {
                        "set": {
                            "Title":"Susan"
                        },
                        "where": {
                            "Id":"2"
                        }
                    }
                ]
            }
        }
    }
}

deletes

A key/value map of rows to delete, where the key is the table name and the value is an object define the primary key of the row to delete.

For example, the SQL statement:

DELETE FROM Artist WHERE Id='5';

Would be represented as:

{
    "structure":{
        "data": {
            "updates": {
                "Artist":[
                    {
                        "Id":"5"
                    }
                ]
            }
        }
    }
}

JSON structure examples

Table creation

A JSON structure to create a table structure, but not insert any row data, might look like this:

{
    "structure":{
        "tables":{
          "Album":"([AlbumId] PRIMARY KEY, [Title])",
          "TrackDetails":"([TrackId] PRIMARY KEY, [Name])"
        },
        "otherSQL": [
          "CREATE UNIQUE INDEX Album_ID ON Album(AlbumId)"
        ]
    }
}

Table creation and data insertion

A JSON structure to create a table structure and insert row data might look like this:

{
  "structure":{
    "tables":{
      "Album":"([AlbumId] PRIMARY KEY, [Title])",
      "TrackDetails":"([TrackId] PRIMARY KEY, [Name])"
    },
    "otherSQL": [
      "CREATE UNIQUE INDEX Album_ID ON Album(AlbumId)"
    ]
  },
  "data":{
    "inserts":{
      "Album":[
        {
          "AlbumId":"1",
          "Title":"Fred"
        },
        {
          "AlbumId":"2",
          "Title":"Bob"
        },
        {
          "AlbumId":"3",
          "Title":"Tom"
        },
        {
          "AlbumId":"4",
          "Title":"Dick"
        },
        {
          "AlbumId":"5",
          "Title":"Harry"
        }
      ],
      "TrackDetails":[
        {
          "TrackId":"1",
          "Name":"This track is cool"
        },
        {
            "TrackId":"1",
            "Name":"This track sucks"
        }
      ]
    }
  }
}

Data updates

A JSON structure which updates row data but doesn't change the table structure might look like this:

{
    "data":{
        "inserts":{
            "Artist":[
                {
                    "Id":"1",
                    "Title":"Fred"
                },
                {
                    "Id":"2",
                    "Title":"Bob"
                }
            ]
        },
        "updates":{
            "Artist":
                [
                    {
                        "set": {
                            "Title":"Jill"
                        },
                        "where": {
                            "Id":"3"
                        }
                    },
                    {
                        "set": {
                            "Title":"Susan"
                        },
                        "where": {
                            "Id":"4"
                        }
                    }
                ]
            },
        },
        "deletes":{
            "Artist":[
                {
                    "Id":"5"
                },
                {
                    "Id":"6"
                }
            ]
        }
    }
}

License

================

The MIT License

Copyright (c) 2015 Working Edge Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.