/* global ALLOC_NORMAL FS HEAP8 Module _free addFunction allocate allocateUTF8OnStack getValue intArrayFromString removeFunction setValue stackAlloc stackRestore stackSave */ /** * @module SqlJs */ // Wait for preRun to run, and then finish our initialization Module["onRuntimeInitialized"] = function onRuntimeInitialized() { "use strict"; // Declare toplevel variables // register, used for temporary stack values var apiTemp = stackAlloc(4); var cwrap = Module["cwrap"]; // Null pointer var NULL = 0; // SQLite enum var SQLITE_OK = 0; var SQLITE_ROW = 100; var SQLITE_DONE = 101; var SQLITE_INTEGER = 1; var SQLITE_FLOAT = 2; var SQLITE_TEXT = 3; var SQLITE_BLOB = 4; // var - Encodings, used for registering functions. var SQLITE_UTF8 = 1; // var - cwrap function var sqlite3_open = cwrap("sqlite3_open", "number", ["string", "number"]); var sqlite3_close_v2 = cwrap("sqlite3_close_v2", "number", ["number"]); var sqlite3_exec = cwrap( "sqlite3_exec", "number", ["number", "string", "number", "number", "number"] ); var sqlite3_changes = cwrap("sqlite3_changes", "number", ["number"]); var sqlite3_prepare_v2 = cwrap( "sqlite3_prepare_v2", "number", ["number", "string", "number", "number", "number"] ); var sqlite3_prepare_v2_sqlptr = cwrap( "sqlite3_prepare_v2", "number", ["number", "number", "number", "number", "number"] ); var sqlite3_bind_text = cwrap( "sqlite3_bind_text", "number", ["number", "number", "number", "number", "number"] ); var sqlite3_bind_blob = cwrap( "sqlite3_bind_blob", "number", ["number", "number", "number", "number", "number"] ); var sqlite3_bind_double = cwrap( "sqlite3_bind_double", "number", ["number", "number", "number"] ); var sqlite3_bind_int = cwrap( "sqlite3_bind_int", "number", ["number", "number", "number"] ); var sqlite3_bind_parameter_index = cwrap( "sqlite3_bind_parameter_index", "number", ["number", "string"] ); var sqlite3_step = cwrap("sqlite3_step", "number", ["number"]); var sqlite3_errmsg = cwrap("sqlite3_errmsg", "string", ["number"]); var sqlite3_data_count = cwrap("sqlite3_data_count", "number", ["number"]); var sqlite3_column_double = cwrap( "sqlite3_column_double", "number", ["number", "number"] ); var sqlite3_column_text = cwrap( "sqlite3_column_text", "string", ["number", "number"] ); var sqlite3_column_blob = cwrap( "sqlite3_column_blob", "number", ["number", "number"] ); var sqlite3_column_bytes = cwrap( "sqlite3_column_bytes", "number", ["number", "number"] ); var sqlite3_column_type = cwrap( "sqlite3_column_type", "number", ["number", "number"] ); var sqlite3_column_name = cwrap( "sqlite3_column_name", "string", ["number", "number"] ); var sqlite3_reset = cwrap("sqlite3_reset", "number", ["number"]); var sqlite3_clear_bindings = cwrap( "sqlite3_clear_bindings", "number", ["number"] ); var sqlite3_finalize = cwrap("sqlite3_finalize", "number", ["number"]); var sqlite3_create_function_v2 = cwrap( "sqlite3_create_function_v2", "number", [ "number", "string", "number", "number", "number", "number", "number", "number", "number" ] ); var sqlite3_value_type = cwrap("sqlite3_value_type", "number", ["number"]); var sqlite3_value_bytes = cwrap("sqlite3_value_bytes", "number", ["number"]); var sqlite3_value_text = cwrap("sqlite3_value_text", "string", ["number"]); var sqlite3_value_blob = cwrap("sqlite3_value_blob", "number", ["number"]); var sqlite3_value_double = cwrap("sqlite3_value_double", "number", ["number"]); var sqlite3_result_double = cwrap( "sqlite3_result_double", "", ["number", "number"] ); var sqlite3_result_null = cwrap( "sqlite3_result_null", "", ["number"] ); var sqlite3_result_text = cwrap( "sqlite3_result_text", "", ["number", "string", "number", "number"] ); var sqlite3_result_blob = cwrap( "sqlite3_result_blob", "", ["number", "number", "number", "number"] ); var sqlite3_result_int = cwrap("sqlite3_result_int", "", ["number", "number"]); var sqlite3_result_error = cwrap( "sqlite3_result_error", "", ["number", "string", "number"] ); var registerExtensionFunctions = cwrap( "RegisterExtensionFunctions", "number", ["number"] ); /** * @classdesc * Represents a prepared statement. * Prepared statements allow you to have a template sql string, * that you can execute multiple times with different parameters. * * You can't instantiate this class directly, you have to use a * {@link Database} object in order to create a statement. * * **Warning**: When you close a database (using db.close()), * all its statements are closed too and become unusable. * * Statements can't be created by the API user directly, only by Database::prepare * * @see Database.html#prepare-dynamic * @see https://en.wikipedia.org/wiki/Prepared_statement * * @constructs Statement * @memberof module:SqlJs */ function Statement(stmt1, db) { this.stmt = stmt1; this.db = db; // Index of the leftmost parameter is 1 this.pos = 1; // Pointers to allocated memory, that need to be freed // when the statemend is destroyed this.allocatedmem = []; } /** @typedef {string|number|null|Uint8Array} Database.SqlValue */ /** @typedef {Database.SqlValue[]|Object} Statement.BindParams */ /** Bind values to the parameters, after having reseted the statement * * SQL statements can have parameters, named *'?', '?NNN', ':VVV', '@VVV', '$VVV'*, * where NNN is a number and VVV a string. * This function binds these parameters to the given values. * * *Warning*: ':', '@', and '$' are included in the parameters names * * ## Value types * Javascript type | SQLite type * -----------------| ----------- * number | REAL, INTEGER * boolean | INTEGER * string | TEXT * Array, Uint8Array| BLOB * null | NULL * * @example Bind values to named parameters * var stmt = db.prepare( * "UPDATE test SET a=@newval WHERE id BETWEEN $mini AND $maxi" * ); * stmt.bind({$mini:10, $maxi:20, '@newval':5}); * * @example Bind values to anonymous parameters * // Create a statement that contains parameters like '?', '?NNN' * var stmt = db.prepare("UPDATE test SET a=? WHERE id BETWEEN ? AND ?"); * // Call Statement.bind with an array as parameter * stmt.bind([5, 10, 20]); * * @see http://www.sqlite.org/datatype3.html * @see http://www.sqlite.org/lang_expr.html#varparam * @param {Statement.BindParams} values The values to bind * @return {boolean} true if it worked * @throws {String} SQLite Error */ Statement.prototype["bind"] = function bind(values) { if (!this.stmt) { throw "Statement closed"; } this["reset"](); if (Array.isArray(values)) { return this.bindFromArray(values); } return this.bindFromObject(values); }; /** Execute the statement, fetching the the next line of result, that can be retrieved with {@link Statement.get}. @return {boolean} true if a row of result available @throws {String} SQLite Error */ Statement.prototype["step"] = function step() { var ret; if (!this.stmt) { throw "Statement closed"; } this.pos = 1; ret = sqlite3_step(this.stmt); switch (ret) { case SQLITE_ROW: return true; case SQLITE_DONE: return false; default: return this.db.handleError(ret); } }; /* Internal methods to retrieve data from the results of a statement that has been executed */ Statement.prototype.getNumber = function getNumber(pos) { if (pos == null) { pos = this.pos; this.pos += 1; } return sqlite3_column_double(this.stmt, pos); }; Statement.prototype.getString = function getString(pos) { if (pos == null) { pos = this.pos; this.pos += 1; } return sqlite3_column_text(this.stmt, pos); }; Statement.prototype.getBlob = function getBlob(pos) { var i; var ptr; var result; var size; if (pos == null) { pos = this.pos; this.pos += 1; } size = sqlite3_column_bytes(this.stmt, pos); ptr = sqlite3_column_blob(this.stmt, pos); result = new Uint8Array(size); i = 0; while (i < size) { result[i] = HEAP8[ptr + i]; i += 1; } return result; }; /** Get one row of results of a statement. If the first parameter is not provided, step must have been called before. @param {Statement.BindParams} [params=[]] If set, the values will be bound to the statement before it is executed @return {Database.SqlValue[]} One row of result @example Print all the rows of the table test to the console var stmt = db.prepare("SELECT * FROM test"); while (stmt.step()) console.log(stmt.get()); */ Statement.prototype["get"] = function get(params) { var field; var ref; var results1; if (params != null && this["bind"](params)) { this["step"](); } results1 = []; field = 0; ref = sqlite3_data_count(this.stmt); while (field < ref) { switch (sqlite3_column_type(this.stmt, field)) { case SQLITE_INTEGER: case SQLITE_FLOAT: results1.push(this.getNumber(field)); break; case SQLITE_TEXT: results1.push(this.getString(field)); break; case SQLITE_BLOB: results1.push(this.getBlob(field)); break; default: results1.push(null); } field += 1; } return results1; }; /** Get the list of column names of a row of result of a statement. @return {string[]} The names of the columns @example var stmt = db.prepare("SELECT 5 AS nbr, x'616200' AS data, NULL AS null_value;"); stmt.step(); // Execute the statement console.log(stmt.getColumnNames()); // Will print ['nbr','data','null_value'] */ Statement.prototype["getColumnNames"] = function getColumnNames() { var i; var ref; var results1; results1 = []; i = 0; ref = sqlite3_data_count(this.stmt); while (i < ref) { results1.push(sqlite3_column_name(this.stmt, i)); i += 1; } return results1; }; /** Get one row of result as a javascript object, associating column names with their value in the current row. @param {Statement.BindParams} [params] If set, the values will be bound to the statement, and it will be executed @return {Object} The row of result @see {@link Statement.get} @example var stmt = db.prepare("SELECT 5 AS nbr; var x'616200' AS data; var NULL AS null_value;"); stmt.step(); // Execute the statement console.log(stmt.getAsObject()); // Will print {nbr:5, data: Uint8Array([1,2,3]), null_value:null} */ Statement.prototype["getAsObject"] = function getAsObject(params) { var i; var len; var name; var names; var rowObject; var values; values = this["get"](params); names = this["getColumnNames"](); rowObject = {}; i = 0; len = names.length; while (i < len) { name = names[i]; rowObject[name] = values[i]; i += 1; } return rowObject; }; /** Shorthand for bind + step + reset Bind the values, execute the statement, ignoring the rows it returns, and resets it @param {Statement.BindParams} [values] Value to bind to the statement */ Statement.prototype["run"] = function run(values) { if (values != null) { this["bind"](values); } this["step"](); return this["reset"](); }; Statement.prototype.bindString = function bindString(string, pos) { var bytes; var strptr; if (pos == null) { pos = this.pos; this.pos += 1; } bytes = intArrayFromString(string); strptr = allocate(bytes, "i8", ALLOC_NORMAL); this.allocatedmem.push(strptr); this.db.handleError(sqlite3_bind_text( this.stmt, pos, strptr, bytes.length - 1, 0 )); return true; }; Statement.prototype.bindBlob = function bindBlob(array, pos) { var blobptr; if (pos == null) { pos = this.pos; this.pos += 1; } blobptr = allocate(array, "i8", ALLOC_NORMAL); this.allocatedmem.push(blobptr); this.db.handleError(sqlite3_bind_blob( this.stmt, pos, blobptr, array.length, 0 )); return true; }; Statement.prototype.bindNumber = function bindNumber(num, pos) { var bindfunc; if (pos == null) { pos = this.pos; this.pos += 1; } bindfunc = ( num === (num | 0) ? sqlite3_bind_int : sqlite3_bind_double ); this.db.handleError(bindfunc(this.stmt, pos, num)); return true; }; Statement.prototype.bindNull = function bindNull(pos) { if (pos == null) { pos = this.pos; this.pos += 1; } return sqlite3_bind_blob(this.stmt, pos, 0, 0, 0) === SQLITE_OK; }; Statement.prototype.bindValue = function bindValue(val, pos) { if (pos == null) { pos = this.pos; this.pos += 1; } switch (typeof val) { case "string": return this.bindString(val, pos); case "number": case "boolean": return this.bindNumber(val + 0, pos); case "object": if (val === null) { return this.bindNull(pos); } if (val.length != null) { return this.bindBlob(val, pos); } break; default: break; } throw ( "Wrong API use : tried to bind a value of an unknown type (" + val + ")." ); }; /** Bind names and values of an object to the named parameters of the statement @param {Object} valuesObj @private @nodoc */ Statement.prototype.bindFromObject = function bindFromObject(valuesObj) { var that; that = this; Object.keys(valuesObj).forEach(function each(name) { var num; num = sqlite3_bind_parameter_index(that.stmt, name); if (num !== 0) { that.bindValue(valuesObj[name], num); } }); return true; }; /** Bind values to numbered parameters @param {Database.SqlValue[]} valuesObj @private @nodoc */ Statement.prototype.bindFromArray = function bindFromArray(values) { var num; num = 0; while (num < values.length) { this.bindValue(values[num], num + 1); num += 1; } return true; }; /** Reset a statement, so that it's parameters can be bound to new values It also clears all previous bindings, freeing the memory used by bound parameters. */ Statement.prototype["reset"] = function reset() { this.freemem(); return ( sqlite3_clear_bindings(this.stmt) === SQLITE_OK && sqlite3_reset(this.stmt) === SQLITE_OK ); }; /** Free the memory allocated during parameter binding */ Statement.prototype["freemem"] = function freemem() { var mem; while ((mem = this.allocatedmem.pop()) !== undefined) { _free(mem); } }; /** Free the memory used by the statement @return {boolean} true in case of success */ Statement.prototype["free"] = function free() { var res; this.freemem(); res = sqlite3_finalize(this.stmt) === SQLITE_OK; delete this.db.statements[this.stmt]; this.stmt = NULL; return res; }; /** @classdesc * Represents an SQLite database * @constructs Database * @memberof module:SqlJs * Open a new database either by creating a new one or opening an existing one, * stored in the byte array passed in first argument * @param {number[]} data An array of bytes representing * an SQLite database file */ function Database(data) { this.filename = "dbfile_" + (0xffffffff * Math.random() >>> 0); if (data != null) { FS.createDataFile("/", this.filename, data, true, true); } this.handleError(sqlite3_open(this.filename, apiTemp)); this.db = getValue(apiTemp, "i32"); registerExtensionFunctions(this.db); // A list of all prepared statements of the database this.statements = {}; // A list of all user function of the database // (created by create_function call) this.functions = {}; } /** Execute an SQL query, ignoring the rows it returns. @param {string} sql a string containing some SQL text to execute @param {any[]} [params=[]] When the SQL statement contains placeholders, you can pass them in here. They will be bound to the statement before it is executed. If you use the params argument, you **cannot** provide an sql string that contains several queries (separated by `;`) @example // Insert values in a table db.run("INSERT INTO test VALUES (:age, :name)", { ':age' : 18, ':name' : 'John' }); @return {Database} The database object (useful for method chaining) */ Database.prototype["run"] = function run(sql, params) { var stmt; if (!this.db) { throw "Database closed"; } if (params) { stmt = this["prepare"](sql, params); try { stmt["step"](); } finally { stmt["free"](); } } else { this.handleError(sqlite3_exec(this.db, sql, 0, 0, apiTemp)); } return this; }; /** * @typedef {{columns:string[], values:Database.SqlValue[][]}} Database.QueryExecResult * @property {string[]} columns the name of the columns of the result * (as returned by {@link Statement.getColumnNames}) * @property {Database.SqlValue[][]} values one array per row, containing the column values */ /** Execute an SQL query, and returns the result. * * This is a wrapper against * {@link Database.prepare}, * {@link Statement.step}, * {@link Statement.get}, * and {@link Statement.free}. * * The result is an array of result elements. There are as many result elements * as the number of statements in your sql string (statements are separated * by a semicolon) * * ## Example use * We have the following table, named *test* : * * | id | age | name | * |:--:|:---:|:------:| * | 1 | 1 | Ling | * | 2 | 18 | Paul | * | 3 | 3 | Markus | * * We query it like that: * ```javascript * var db = new SQL.Database(); * var res = db.exec("SELECT id FROM test; SELECT age,name FROM test;"); * ``` * * `res` is now : * ```javascript * [ * {columns: ['id'], values:[[1],[2],[3]]}, * {columns: ['age','name'], values:[[1,'Ling'],[18,'Paul'],[3,'Markus']]} * ] * ``` * * @param {string} sql a string containing some SQL text to execute * @return {Database.QueryExecResult[]} The results of each statement */ Database.prototype["exec"] = function exec(sql) { var curresult; var stmt; if (!this.db) { throw "Database closed"; } var stack = stackSave(); try { var nextSqlPtr = allocateUTF8OnStack(sql); var pzTail = stackAlloc(4); var results = []; while (getValue(nextSqlPtr, "i8") !== NULL) { setValue(apiTemp, 0, "i32"); setValue(pzTail, 0, "i32"); this.handleError(sqlite3_prepare_v2_sqlptr( this.db, nextSqlPtr, -1, apiTemp, pzTail )); // pointer to a statement, or null var pStmt = getValue(apiTemp, "i32"); nextSqlPtr = getValue(pzTail, "i32"); // Empty statement if (pStmt !== NULL) { curresult = null; stmt = new Statement(pStmt, this); while (stmt["step"]()) { if (curresult === null) { curresult = { columns: stmt["getColumnNames"](), values: [], }; results.push(curresult); } curresult["values"].push(stmt["get"]()); } stmt["free"](); } } return results; } catch (errCaught) { if (stmt) { stmt["free"](); } throw errCaught; } finally { stackRestore(stack); } }; /** Execute an sql statement, and call a callback for each row of result. **Currently** this method is synchronous, it will not return until the callback has been called on every row of the result. But this might change. @param {string} sql A string of SQL text. Can contain placeholders that will be bound to the parameters given as the second argument @param {Array} [params=[]] Parameters to bind to the query @param {function({Object}):void} callback A function that will be called on each row of result @param {function()} done A function that will be called when all rows have been retrieved @return {Database} The database object. Useful for method chaining @example Read values from a table db.each("SELECT name,age FROM users WHERE age >= $majority", {$majority:18}, function (row){console.log(row.name + " is a grown-up.")} ); */ Database.prototype["each"] = function each(sql, params, callback, done) { var stmt; if (typeof params === "function") { done = callback; callback = params; params = undefined; } stmt = this["prepare"](sql, params); try { while (stmt["step"]()) { callback(stmt["getAsObject"]()); } } finally { stmt["free"](); } if (typeof done === "function") { return done(); } return undefined; }; /** Prepare an SQL statement @param {string} sql a string of SQL, that can contain placeholders (`?`, `:VVV`, `:AAA`, `@AAA`) @param {Statement.BindParams} [params] values to bind to placeholders @return {Statement} the resulting statement @throws {String} SQLite error */ Database.prototype["prepare"] = function prepare(sql, params) { var pStmt; var stmt; setValue(apiTemp, 0, "i32"); this.handleError(sqlite3_prepare_v2(this.db, sql, -1, apiTemp, NULL)); // pointer to a statement, or null pStmt = getValue(apiTemp, "i32"); if (pStmt === NULL) { throw "Nothing to prepare"; } stmt = new Statement(pStmt, this); if (params != null) { stmt.bind(params); } this.statements[pStmt] = stmt; return stmt; }; /** Exports the contents of the database to a binary array @return {Uint8Array} An array of bytes of the SQLite3 database file */ Database.prototype["export"] = function exportDatabase() { var binaryDb; Object.values(this.statements).forEach(function each(stmt) { stmt["free"](); }); Object.values(this.functions).forEach(removeFunction); this.functions = {}; this.handleError(sqlite3_close_v2(this.db)); binaryDb = FS.readFile(this.filename, { encoding: "binary", }); this.handleError(sqlite3_open(this.filename, apiTemp)); this.db = getValue(apiTemp, "i32"); return binaryDb; }; /** Close the database, and all associated prepared statements. * The memory associated to the database and all associated statements * will be freed. * * **Warning**: A statement belonging to a database that has been closed cannot * be used anymore. * * Databases **must** be closed when you're finished with them, or the * memory consumption will grow forever */ Database.prototype["close"] = function close() { Object.values(this.statements).forEach(function each(stmt) { stmt["free"](); }); Object.values(this.functions).forEach(removeFunction); this.functions = {}; this.handleError(sqlite3_close_v2(this.db)); FS.unlink("/" + this.filename); this.db = null; }; /** Analyze a result code, return null if no error occured, and throw an error with a descriptive message otherwise @nodoc */ Database.prototype["handleError"] = function handleError(returnCode) { var errmsg; if (returnCode === SQLITE_OK) { return null; } errmsg = sqlite3_errmsg(this.db); throw new Error(errmsg); }; /** Returns the number of changed rows (modified, inserted or deleted) by the latest completed INSERT, UPDATE or DELETE statement on the database. Executing any other type of SQL statement does not modify the value returned by this function. @return {number} the number of rows modified */ Database.prototype["getRowsModified"] = function getRowsModified() { return sqlite3_changes(this.db); }; /** Register a custom function with SQLite @example Register a simple function db.create_function("addOne", function (x) {return x+1;}) db.exec("SELECT addOne(1)") // = 2 @param {string} name the name of the function as referenced in SQL statements. @param {function} func the actual function to be executed. @return {Database} The database object. Useful for method chaining */ Database.prototype["create_function"] = function create_function(name, func) { // TODO : add type arguments for compatibility with the llvm backend // https://emscripten.org/docs/porting/connecting_cpp_and_javascript/Interacting-with-code.html#calling-javascript-functions-as-function-pointers-from-c var func_ptr; function wrapped_func(cx, argc, argv) { var result; function extract_blob(ptr) { var size = sqlite3_value_bytes(ptr); var blob_ptr = sqlite3_value_blob(ptr); var blob_arg = new Uint8Array(size); for (var j = 0; j < size; j += 1) blob_arg[j] = HEAP8[blob_ptr + j]; return blob_arg; } var args = []; for (var i = 0; i < argc; i += 1) { var value_ptr = getValue(argv + (4 * i), "i32"); var value_type = sqlite3_value_type(value_ptr); var arg; if (value_type === SQLITE_INTEGER || value_type === SQLITE_FLOAT) { arg = sqlite3_value_double(value_ptr); } else if (value_type === SQLITE_TEXT) { arg = sqlite3_value_text(value_ptr); } else if (value_type === SQLITE_BLOB) { arg = extract_blob(value_ptr); } else arg = null; args.push(arg); } try { result = func.apply(null, args); } catch (error) { sqlite3_result_error(cx, error, -1); return; } switch (typeof result) { case "boolean": sqlite3_result_int(cx, result ? 1 : 0); break; case "number": sqlite3_result_double(cx, result); break; case "string": sqlite3_result_text(cx, result, -1, -1); break; case "object": if (result === null) { sqlite3_result_null(cx); } else if (result.length != null) { var blobptr = allocate(result, "i8", ALLOC_NORMAL); sqlite3_result_blob(cx, blobptr, result.length, -1); _free(blobptr); } else { sqlite3_result_error(cx, ( "Wrong API use : tried to return a value " + "of an unknown type (" + result + ")." ), -1); } break; default: sqlite3_result_null(cx); } } if (Object.prototype.hasOwnProperty.call(this.functions, name)) { removeFunction(this.functions[name]); delete this.functions[name]; } // The signature of the wrapped function is : // void wrapped(sqlite3_context *db, int argc, sqlite3_value **argv) func_ptr = addFunction(wrapped_func, "viii"); this.functions[name] = func_ptr; this.handleError(sqlite3_create_function_v2( this.db, name, func.length, SQLITE_UTF8, 0, func_ptr, 0, 0, 0 )); return this; }; // export Database to Module Module.Database = Database; };