tests; readme; migrator.status() improvements

Author: SanderGi

.badges/lines-of-code.svg

@@ -20,18 +20,10 @@ async function main(argv) {
 
     /** @type {MigrationOptions} */
     const options = {};
-    if (args.has('--dbPath')) {
-        options.dbPath = args.get('--dbPath');
-    }
-    if (args.has('--schemaPath')) {
-        options.schemaPath = args.get('--schemaPath');
-    }
-    if (args.has('--migrationsPath')) {
-        options.migrationsPath = args.get('--migrationsPath');
-    }
-    if (args.has('--migrationTable')) {
-        options.migration = args.get('--migrationTable');
-    }
+    options.dbPath = args.get('--dbPath');
+    options.schemaPath = args.get('--schemaPath');
+    options.migrationsPath = args.get('--migrationsPath');
+    options.migration = args.get('--migrationTable');
     const migrator = new Migrator(options);
 
     if (cmd === 'status') {
@@ -60,6 +52,12 @@ async function main(argv) {
             console.log(`${symbols.success} No schema changes detected.`);
         }
 
+        if (status.has_tampered_data) {
+            console.log(
+                `${symbols.error} The database schema has been modified by other means than 'sam migrate'. Please undo any DDL changes you've made and instead change the schema file and/or create a migration file`,
+            );
+        }
+
         if (status.missing_migrations.length > 0) {
             console.log(colors.FgCyan('\nUnapplied migrations:'));
             for (const migration of status.missing_migrations) {
@@ -81,24 +79,12 @@ async function main(argv) {
     } else if (cmd === 'make') {
         /** @type {MakeOptions} */
         const makeOptions = {};
-        if (args.has('--onRename')) {
-            makeOptions.onRename = args.get('--onRename');
-        }
-        if (args.has('--onDestructiveChange')) {
-            makeOptions.onDestructiveChange = args.get('--onDestructiveChange');
-        }
-        if (args.has('--onChangedIndex')) {
-            makeOptions.onChangedIndex = args.get('--onChangedIndex');
-        }
-        if (args.has('--onChangedView')) {
-            makeOptions.onChangedView = args.get('--onChangedView');
-        }
-        if (args.has('--onChangedTrigger')) {
-            makeOptions.onChangedTrigger = args.get('--onChangedTrigger');
-        }
-        if (target) {
-            makeOptions.createIfNoChanges = false;
-        } else {
+        makeOptions.onRename = args.get('--onRename');
+        makeOptions.onDestructiveChange = args.get('--onDestructiveChange');
+        makeOptions.onChangedIndex = args.get('--onChangedIndex');
+        makeOptions.onChangedView = args.get('--onChangedView');
+        makeOptions.onChangedTrigger = args.get('--onChangedTrigger');
+        if (target !== '--onlyCreateIfChanges') {
             makeOptions.createIfNoChanges = true;
         }
 

README.md

@@ -264,9 +264,9 @@ export class Database {
     /**
      * Prepares a SQL query with parameters and returns a prepared statement.
      * @param {string} sql the SQL query to prepare
-     * @param {Params} params the parameters to bind to the query. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the query. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @template [Row=any] - the type of the row object that is returned
-     * @template {any[]} [Params=any[]] - the type of the parameters that can be bound to the prepared statement
+     * @template {any[] | Object} [Params=any] - the type of the parameters that can be bound to the prepared statement
      * @returns {Promise<Statement<Row, Params>} a promise that resolves to a {@link Statement} object representing the prepared statement
      * @throws {Error} if the query cannot be prepared
      * @see {@link sqlite3.Database#prepare}
@@ -309,7 +309,7 @@ export class Database {
 /**
  * Represents a prepared statement. Async wrapper around the sqlite3.Statement class.
  * @template [Row=any] - the type of the row object that is returned
- * @template {any[]} [Params=any[]] - the type of the parameters that can be bound to the prepared statement
+ * @template {any[] | Object} [Params=any[]] - the type of the parameters that can be bound to the prepared statement
  */
 export class Statement {
     /**
@@ -330,7 +330,7 @@ export class Statement {
 
     /**
      * Binds parameters to the prepared statement. Completely resets the row cursor and removes any previously bound parameters.
-     * @param {Params} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @returns {Promise<void>} a promise that resolves when the parameters have been bound
      * @throws {Error} if the parameters cannot be bound
      * @see {@link sqlite3.Statement#bind}
@@ -391,7 +391,7 @@ export class Statement {
 
     /**
      * Runs the prepared statement with the optional bound parameters (overwriting any previously bound parameters when supplied).
-     * @param {Params} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @returns {Promise<RunResult>} a promise that resolves to a {@link RunResult} object with a `lastID` property and a `changes` property
      * @throws {Error} if the prepared statement cannot be run
      * @see {@link sqlite3.Statement#run}
@@ -413,7 +413,7 @@ export class Statement {
 
     /**
      * Gets a single row from the prepared statement with the optional bound parameters (overwriting any previously bound parameters when supplied).
-     * @param {Params} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @returns {Promise<Row | undefined>} a promise that resolves to the first row returned by the prepared statement or undefined if no rows are returned
      * @throws {Error} if the prepared statement cannot be run
      * @see {@link sqlite3.Statement#get}
@@ -434,7 +434,7 @@ export class Statement {
 
     /**
      * Gets all rows from the prepared statement with the optional bound parameters (overwriting any previously bound parameters when supplied).
-     * @param {Params} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @returns {Promise<Row[]>} a promise that resolves to all rows returned by the prepared statement
      * @throws {Error} if the prepared statement cannot be run
      * @see {@link sqlite3.Statement#all}
@@ -455,7 +455,7 @@ export class Statement {
 
     /**
      * Runs the prepared statement with the optional bound parameters (overwriting any previously bound parameters when supplied) and returns the rows one by one as an async generator (useful for saving memory with large query results).
-     * @param {Params} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
+     * @param {Params | Params[]} params the parameters to bind to the prepared statement. Supports a dictionary with `:name`, `@name` and `$name` style parameters, or an array with `?` position based parameters.
      * @returns {AsyncGenerator<Row, void, undefined>} an async generator that yields each row returned by the prepared statement
      * @throws {Error} if the prepared statement cannot be run
      * @example <caption>Using the async generator</caption>