edinburgh 0.4.4 → 0.4.5

package/README.md

@@ -388,13 +388,9 @@ await Product.byCategory.batchProcess({is: "old"}, (product) => {
 // Commits every ~1 second or 4096 rows (configurable via limitSeconds, limitRows)
 ```
 
-### Schema Evolution
+### Lazy Schema Migrations
 
-Edinburgh handles schema changes automatically:
-
-- **Adding/removing fields**: Old rows are lazily migrated on read. New fields use their default value.
-- **Changing field types**: Requires a `static migrate()` function.
-- **Adding/removing indexes**: Requires running `npx migrate-edinburgh`.
+When you change a model's schema, Edinburgh will lazily try to migrate old records on access. This allows you to deploy code changes without downtime or a separate migration step. Optionally, you may provide a `static migrate(record: Record<string, any>)` function on the model to transform old records during lazy migration. If there is a migration error (like a new field without a default value, or an incompatible type change), a run-time error is thrown when loading the affected model instance.
 
 ```typescript
 @E.registerModel
@@ -402,15 +398,40 @@ class User extends E.Model<User> {
   static pk = E.primary(User, "id");
   id = E.field(E.identifier);
   name = E.field(E.string);
-  role = E.field(E.string, {default: "user"});  // new field
+  role = E.field(E.string);  // newly added field
 
   static migrate(record: Record<string, any>) {
-    record.role ??= "user";  // provide value for old rows
+    record.role ??= record.name.indexOf("admin") >= 0 ? "admin" : "user"; // set role based on name for old records
   }
 }
 ```
 
-Run `npx migrate-edinburgh` (or call `E.runMigration()`) after adding/removing indexes, changing index field types, or when a `migrate()` function affects indexed fields.
+Edinburgh will lazily (re)run the `migrate` function on an instance whenever its implementation (the literal function code) has changed. For robustness, make sure that your `migrate` function...
+- Is idempotent (meaning it can be safely run multiple times on the same row without changing the result after the first run), and
+- Should perform *all* transformation steps starting from the oldest version that could possibly still be in the database. (See the next section.)
+
+While lazy migration is convenient and often sufficient, in some cases you need migrations to happen immediately...
+
+### Forced Schema Migrations
+
+The `migrate-edinburgh` CLI tool will scan the entire database, pro-actively performing the following migrations:
+- **Populate secondary indexes**: If you added or changed secondary indexes, it will build them. Until you do, the indexes will be empty (or only contain instances that have been saved since the index was created).
+- **Migrate primary indexes**: In case you changed the primary key fields or field types (not recommended!) of a model, it will build the new primary index, as well as all secondary indexes (to point at the new primary keys). Until you do, all of your old data will appear to be missing! Note that this may fail on duplicates.
+- **Remove orphaned indexes**: If you removed or changed an index, the stale data will be deleted from the database.
+- **Rewrite primary data**: These are the types of migrations that would normally be done lazily on instance access. As there's usually not much benefit to doing this forcibly, and it can be very time-consuming (and generates a lot of I/O), this is *not* done by default. It may however be useful if you want to clean up the contents of your `migrate()` function, if you have control over all application deployments. Use the `--rewrite-data` flag to enable this.
+
+```bash
+npx migrate-edinburgh ./src/models.ts
+```
+
+Run `npx migrate-edinburgh` without arguments to see all options. You can also call `runMigration()` programmatically:
+
+```typescript
+import { runMigration } from "edinburgh";
+
+const result = await runMigration({ tables: ["User"] });
+console.log(result.secondaries);  // { User: 1500 }
+```
 
 ### preCommit Hook
 
@@ -687,9 +708,6 @@ Common use cases:
 
 **Signature:** `() => void`
 
-**Parameters:**
-
-
 **Examples:**
 
 ```typescript
@@ -710,18 +728,12 @@ class Post extends E.Model<Post> {
 
 **Signature:** `() => Uint8Array<ArrayBufferLike>`
 
-**Parameters:**
-
-
 **Returns:** The primary key for this instance.
 
 #### model.getPrimaryKeyHash · [method](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L253)
 
 **Signature:** `() => number`
 
-**Parameters:**
-
-
 **Returns:** A 53-bit positive integer non-cryptographic hash of the primary key, or undefined if not yet saved.
 
 #### model.isLazyField · [method](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L253)
@@ -738,9 +750,6 @@ Prevent this instance from being persisted to the database.
 
 **Signature:** `() => this`
 
-**Parameters:**
-
-
 **Returns:** This model instance for chaining.
 
 **Examples:**
@@ -759,9 +768,6 @@ Removes the instance and all its index entries from the database and prevents fu
 
 **Signature:** `() => void`
 
-**Parameters:**
-
-
 **Examples:**
 
 ```typescript
@@ -797,9 +803,6 @@ Check if this model instance is valid.
 
 **Signature:** `() => boolean`
 
-**Parameters:**
-
-
 **Returns:** true if all validations pass.
 
 **Examples:**
@@ -813,23 +816,14 @@ if (!user.isValid()) shoutAtTheUser();
 
 **Signature:** `() => "created" | "deleted" | "loaded" | "lazy"`
 
-**Parameters:**
-
-
 #### model.toString · [method](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L253)
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 #### model.[Symbol.for('nodejs.util.inspect.custom')] · [method](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L253)
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 ### registerModel · [function](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L113)
 
 Register a model class with the Edinburgh ORM system.
@@ -1242,9 +1236,6 @@ Indexes enable fast queries on specific field combinations and enforce uniquenes
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 ### UniqueIndex · [class](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L253)
 
 Unique index that stores references to the primary key.
@@ -1352,10 +1343,10 @@ Invalid function arguments will throw TypeError.
 
 **Value:** `DatabaseErrorConstructor`
 
-### runMigration · [function](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L118)
+### runMigration · [function](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L124)
 
-Run database migration: upgrade all rows to the latest schema version,
-convert old primary indices, and clean up orphaned secondary indices.
+Run database migration: populate secondary indexes for old-version rows,
+convert old primary indices, rewrite row data, and clean up orphaned indices.
 
 **Signature:** `(options?: MigrationOptions) => Promise<MigrationResult>`
 
@@ -1371,99 +1362,65 @@ Limit migration to specific table names.
 
 **Type:** `string[]`
 
-#### migrationOptions.convertOldPrimaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L23)
+#### migrationOptions.populateSecondaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L23)
 
-Whether to convert old primary indices for known tables (default: true).
+Populate secondary indexes for rows at old schema versions (default: true).
 
 **Type:** `boolean`
 
-#### migrationOptions.deleteOrphanedIndexes · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L31)
+#### migrationOptions.migratePrimaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L32)
 
-Whether to delete orphaned secondary/unique indices (default: true).
+Convert old primary indices when primary key fields changed (default: true).
 
 **Type:** `boolean`
 
-#### migrationOptions.upgradeVersions · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L39)
+#### migrationOptions.rewriteData · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L40)
 
-Whether to upgrade rows to the latest version (default: true).
+Rewrite all row data to the latest schema version (default: false).
 
 **Type:** `boolean`
 
-#### migrationOptions.onProgress · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L44)
+#### migrationOptions.removeOrphans · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L46)
+
+Delete orphaned secondary/unique index entries (default: true).
+
+**Type:** `boolean`
+
+#### migrationOptions.onProgress · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L48)
 
 Progress callback.
 
 **Type:** `(info: ProgressInfo) => void`
 
-### MigrationResult · [interface](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L49)
+### MigrationResult · [interface](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L51)
 
-#### migrationResult.secondaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L51)
+#### migrationResult.secondaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L54)
 
-Per-table stats for row upgrades.
+Per-table counts of secondary index entries populated.
 
 **Type:** `Record<string, number>`
 
-#### migrationResult.primaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L52)
+#### migrationResult.primaries · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L59)
 
-Per-table stats for old primary conversions.
+Per-table counts of old primary rows migrated.
 
 **Type:** `Record<string, number>`
 
-#### migrationResult.conversionFailures · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L58)
+#### migrationResult.conversionFailures · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L59)
 
 Per-table conversion failure counts by reason.
 
 **Type:** `Record<string, Record<string, number>>`
 
-#### migrationResult.orphaned · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L59)
+#### migrationResult.rewritten · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L64)
 
-Number of orphaned index entries deleted.
-
-**Type:** `number`
+Per-table counts of rows rewritten to latest version.
 
-## Schema Migrations
-
-Edinburgh automatically tracks the schema version of each model. When you change fields, field types, indexes, or the `migrate()` function, Edinburgh detects a new schema version.
-
-### What happens automatically (lazy migration)
-
-Changes to regular (non-index) field values are migrated lazily. When a row with an old schema version is loaded from disk, it is deserialized using the old field types and transformed by the optional static `migrate()` function. This is transparent and requires no downtime.
-
-```typescript
-@E.registerModel
-class User extends E.Model<User> {
-  static pk = E.primary(User, "id");
-  id = E.field(E.identifier);
-  name = E.field(E.string);
-  role = E.field(E.string);  // newly added field
-
-  static migrate(record: Record<string, any>) {
-    record.role ??= "user";  // provide a default for old rows
-  }
-}
-```
-
-### What requires `migrate-edinburgh`
-
-The `migrate-edinburgh` CLI tool (or the `runMigration()` API) must be run when:
-
-- **Adding or removing** secondary or unique indexes
-- **Changing the fields or types** of an existing index
-- A **`migrate()` function changes values** that are used in index fields
-
-The tool populates new indexes, removes orphaned ones, and updates index entries whose values were changed by `migrate()`. It does *not* rewrite primary data rows - lazy migration handles that on read.
-
-```bash
-npx migrate-edinburgh --import ./src/models.ts
-```
+**Type:** `Record<string, number>`
 
-Run `npx migrate-edinburgh` to see all of its options.
+#### migrationResult.orphans · [member](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L68)
 
-You can also call `runMigration()` programmatically:
+Number of orphaned index entries deleted.
 
-```typescript
-import { runMigration } from "edinburgh";
+**Type:** `number`
 
-const result = await runMigration({ tables: ["User"] });
-console.log(result.upgraded);  // { User: 1500 }
-```

package/build/src/migrate-cli.d.ts

@@ -1,20 +1,5 @@
 #!/usr/bin/env node
 /**
- * migrate-edinburgh CLI tool
- *
- * Runs database migrations: upgrades all rows to the latest schema version,
- * converts old primary indices, and cleans up orphaned secondary indices.
- *
- * Usage:
- *   npx migrate-edinburgh --import ./src/models.ts [options]
- *
- * Options:
- *   --import <path>     Path to the module that registers all models (required)
- *   --db <path>         Database directory (default: .edinburgh)
- *   --tables <names>    Comma-separated list of table names to migrate
- *   --batch-size <n>    Number of rows per transaction batch (default: 500)
- *   --no-convert        Skip converting old primary indices
- *   --no-cleanup        Skip deleting orphaned secondary indices
- *   --no-upgrade        Skip upgrading rows to latest version
+ * See `npx migrate-edinburgh --help` for usage.
  */
 export {};

package/build/src/migrate-cli.js

@@ -1,61 +1,69 @@
 #!/usr/bin/env node
 /**
- * migrate-edinburgh CLI tool
- *
- * Runs database migrations: upgrades all rows to the latest schema version,
- * converts old primary indices, and cleans up orphaned secondary indices.
- *
- * Usage:
- *   npx migrate-edinburgh --import ./src/models.ts [options]
- *
- * Options:
- *   --import <path>     Path to the module that registers all models (required)
- *   --db <path>         Database directory (default: .edinburgh)
- *   --tables <names>    Comma-separated list of table names to migrate
- *   --batch-size <n>    Number of rows per transaction batch (default: 500)
- *   --no-convert        Skip converting old primary indices
- *   --no-cleanup        Skip deleting orphaned secondary indices
- *   --no-upgrade        Skip upgrading rows to latest version
+ * See `npx migrate-edinburgh --help` for usage.
  */
 import { runMigration } from './migrate.js';
 function parseArgs(args) {
     let importPath = '';
     const options = {};
+    const tables = [];
     for (let i = 0; i < args.length; i++) {
-        switch (args[i]) {
-            case '--import':
-                importPath = args[++i];
-                break;
+        const arg = args[i];
+        switch (arg) {
             case '--db':
                 options.dbDir = args[++i];
                 break;
-            case '--tables':
-                options.tables = args[++i].split(',').map(s => s.trim());
+            case '+secondaries':
+                options.populateSecondaries = true;
+                break;
+            case '-secondaries':
+                options.populateSecondaries = false;
+                break;
+            case '+primaries':
+                options.migratePrimaries = true;
+                break;
+            case '-primaries':
+                options.migratePrimaries = false;
+                break;
+            case '+data':
+                options.rewriteData = true;
                 break;
-            case '--no-convert':
-                options.convertOldPrimaries = false;
+            case '-data':
+                options.rewriteData = false;
                 break;
-            case '--no-cleanup':
-                options.deleteOrphanedIndexes = false;
+            case '+orphans':
+                options.removeOrphans = true;
                 break;
-            case '--no-upgrade':
-                options.upgradeVersions = false;
+            case '-orphans':
+                options.removeOrphans = false;
                 break;
             default:
-                if (args[i].startsWith('-')) {
-                    console.error(`Unknown option: ${args[i]}`);
+                if (arg.startsWith('-') || arg.startsWith('+')) {
+                    console.error(`Unknown option: ${arg}`);
                     process.exit(1);
                 }
+                if (!importPath) {
+                    importPath = arg;
+                }
+                else {
+                    tables.push(arg);
+                }
         }
     }
+    if (tables.length > 0)
+        options.tables = tables;
     if (!importPath) {
-        console.error('Usage: npx migrate-edinburgh --import <path> [options]');
-        console.error('  --import <path>     Module that registers all models (required)');
-        console.error('  --db <path>         Database directory (default: .edinburgh)');
-        console.error('  --tables <names>    Comma-separated table names');
-        console.error('  --no-convert        Skip old primary conversion');
-        console.error('  --no-cleanup        Skip orphaned index cleanup');
-        console.error('  --no-upgrade        Skip version upgrades');
+        console.error('Usage: npx migrate-edinburgh <import_path> [<table> ...] [options]');
+        console.error('');
+        console.error('  <import_path>     Module that registers all models (required)');
+        console.error('  <table>           Table names to migrate (default: all)');
+        console.error('');
+        console.error('Options:');
+        console.error('  --db <path>       Database directory (default: .edinburgh)');
+        console.error('  -secondaries      Skip populating secondary indexes');
+        console.error('  -primaries        Skip migrating old primary indexes');
+        console.error('  -orphans          Skip removing orphaned index entries');
+        console.error('  +data             Rewrite all row data to latest schema version');
         process.exit(1);
     }
     return { importPath, options };
@@ -88,13 +96,19 @@ async function main() {
     console.log('\n');
     // Report results
     if (Object.keys(result.secondaries).length > 0) {
-        console.log('Upgraded rows:');
+        console.log('Populated secondary indexes:');
         for (const [table, count] of Object.entries(result.secondaries)) {
             console.log(`  ${table}: ${count}`);
         }
     }
+    if (Object.keys(result.rewritten).length > 0) {
+        console.log('Rewritten rows:');
+        for (const [table, count] of Object.entries(result.rewritten)) {
+            console.log(`  ${table}: ${count}`);
+        }
+    }
     if (Object.keys(result.primaries).length > 0) {
-        console.log('Converted old primary rows:');
+        console.log('Migrated old primary rows:');
         for (const [table, count] of Object.entries(result.primaries)) {
             console.log(`  ${table}: ${count}`);
         }
@@ -107,10 +121,10 @@ async function main() {
             }
         }
     }
-    if (result.orphaned > 0) {
-        console.log(`Deleted ${result.orphaned} orphaned index entries`);
+    if (result.orphans > 0) {
+        console.log(`Deleted ${result.orphans} orphaned index entries`);
     }
-    if (Object.keys(result.secondaries).length === 0 && Object.keys(result.primaries).length === 0 && result.orphaned === 0) {
+    if (Object.keys(result.secondaries).length === 0 && Object.keys(result.primaries).length === 0 && Object.keys(result.rewritten).length === 0 && result.orphans === 0) {
         console.log('No migration needed - database is up to date.');
     }
     console.log('Done.');

package/build/src/migrate-cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrate-cli.js","sourceRoot":"","sources":["../../src/migrate-cli.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAyB,MAAM,cAAc,CAAC;AAEnE,SAAS,SAAS,CAAC,IAAc;IAC7B,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,MAAM,OAAO,GAA0C,EAAE,CAAC;IAE1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACd,KAAK,UAAU;gBACX,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvB,MAAM;YACV,KAAK,MAAM;gBACP,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,MAAM;YACV,KAAK,UAAU;gBACX,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACzD,MAAM;YACV,KAAK,cAAc;gBACf,OAAO,CAAC,mBAAmB,GAAG,KAAK,CAAC;gBACpC,MAAM;YACV,KAAK,cAAc;gBACf,OAAO,CAAC,qBAAqB,GAAG,KAAK,CAAC;gBACtC,MAAM;YACV,KAAK,cAAc;gBACf,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC;gBAChC,MAAM;YACV;gBACI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,OAAO,CAAC,KAAK,CAAC,mBAAmB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,CAAC;QACT,CAAC;IACL,CAAC;IAED,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACxE,OAAO,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACnF,OAAO,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAChF,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACnE,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACnE,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACnE,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AACnC,CAAC;AAED,KAAK,UAAU,IAAI;IACf,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEpD,6BAA6B;IAC7B,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,CAAC,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACzC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,0DAA0D;IAC1D,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC;QACzE,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC;QAChE,CAAC,CAAC,UAAU,CAAC;IACjB,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IAE3B,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,OAAO,CAAC,UAAU,GAAG,CAAC,IAAI,EAAE,EAAE;QAC1B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,SAAS;gBAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC7B,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,SAAS,YAAY,MAAM,IAAI,CAAC,CAAC;IACrF,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAElB,iBAAiB;IACjB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC9B,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QAC3C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxE,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrD,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,KAAK,MAAM,GAAG,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,QAAQ,yBAAyB,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QACtH,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IACb,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"migrate-cli.js","sourceRoot":"","sources":["../../src/migrate-cli.ts"],"names":[],"mappings":";AAEA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAyB,MAAM,cAAc,CAAC;AAEnE,SAAS,SAAS,CAAC,IAAc;IAC7B,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,MAAM,OAAO,GAA0C,EAAE,CAAC;IAC1D,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,QAAQ,GAAG,EAAE,CAAC;YACV,KAAK,MAAM;gBACP,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,MAAM;YACV,KAAK,cAAc;gBAAE,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAAC,MAAM;YAC/D,KAAK,cAAc;gBAAE,OAAO,CAAC,mBAAmB,GAAG,KAAK,CAAC;gBAAC,MAAM;YAChE,KAAK,YAAY;gBAAE,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;gBAAC,MAAM;YAC1D,KAAK,YAAY;gBAAE,OAAO,CAAC,gBAAgB,GAAG,KAAK,CAAC;gBAAC,MAAM;YAC3D,KAAK,OAAO;gBAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;gBAAC,MAAM;YAChD,KAAK,OAAO;gBAAE,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC;gBAAC,MAAM;YACjD,KAAK,UAAU;gBAAE,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;gBAAC,MAAM;YACrD,KAAK,UAAU;gBAAE,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC;gBAAC,MAAM;YACtD;gBACI,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7C,OAAO,CAAC,KAAK,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;oBACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,CAAC;gBACD,IAAI,CAAC,UAAU,EAAE,CAAC;oBACd,UAAU,GAAG,GAAG,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;QACT,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAE/C,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACpF,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACjF,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAC9E,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;QACvE,OAAO,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACxE,OAAO,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC1E,OAAO,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACnF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AACnC,CAAC;AAED,KAAK,UAAU,IAAI;IACf,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEpD,6BAA6B;IAC7B,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,CAAC,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACzC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,0DAA0D;IAC1D,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC;QACzE,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC;QAChE,CAAC,CAAC,UAAU,CAAC;IACjB,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IAE3B,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,OAAO,CAAC,UAAU,GAAG,CAAC,IAAI,EAAE,EAAE;QAC1B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,SAAS;gBAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC7B,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,SAAS,YAAY,MAAM,IAAI,CAAC,CAAC;IACrF,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAElB,iBAAiB;IACjB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC5C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAC1C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxE,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrD,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,KAAK,KAAK,MAAM,GAAG,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,OAAO,yBAAyB,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACnK,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IACb,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}

package/build/src/migrate.d.ts

@@ -1,12 +1,14 @@
 export interface MigrationOptions {
     /** Limit migration to specific table names. */
     tables?: string[];
-    /** Whether to convert old primary indices for known tables (default: true). */
-    convertOldPrimaries?: boolean;
-    /** Whether to delete orphaned secondary/unique indices (default: true). */
-    deleteOrphanedIndexes?: boolean;
-    /** Whether to upgrade rows to the latest version (default: true). */
-    upgradeVersions?: boolean;
+    /** Populate secondary indexes for rows at old schema versions (default: true). */
+    populateSecondaries?: boolean;
+    /** Convert old primary indices when primary key fields changed (default: true). */
+    migratePrimaries?: boolean;
+    /** Rewrite all row data to the latest schema version (default: false). */
+    rewriteData?: boolean;
+    /** Delete orphaned secondary/unique index entries (default: true). */
+    removeOrphans?: boolean;
     /** Progress callback. */
     onProgress?: (info: ProgressInfo) => void;
 }
@@ -17,17 +19,19 @@ export interface ProgressInfo {
     table?: string;
 }
 export interface MigrationResult {
-    /** Per-table stats for row upgrades. */
+    /** Per-table counts of secondary index entries populated. */
     secondaries: Record<string, number>;
-    /** Per-table stats for old primary conversions. */
+    /** Per-table counts of old primary rows migrated. */
     primaries: Record<string, number>;
     /** Per-table conversion failure counts by reason. */
     conversionFailures: Record<string, Record<string, number>>;
+    /** Per-table counts of rows rewritten to latest version. */
+    rewritten: Record<string, number>;
     /** Number of orphaned index entries deleted. */
-    orphaned: number;
+    orphans: number;
 }
 /**
- * Run database migration: upgrade all rows to the latest schema version,
- * convert old primary indices, and clean up orphaned secondary indices.
+ * Run database migration: populate secondary indexes for old-version rows,
+ * convert old primary indices, rewrite row data, and clean up orphaned indices.
  */
 export declare function runMigration(options?: MigrationOptions): Promise<MigrationResult>;