pgroll 0.0.9 → 0.0.10

package/README.md

@@ -94,12 +94,13 @@ pgroll [global options] <command>
 
 ### Global options
 
-| Option                      | Description                                                     |
-| --------------------------- | --------------------------------------------------------------- |
-| `-d, --migrationDir <path>` | Directory holding the migration files (default `./migrations`). |
-| `-u, --url <url>`           | PostgreSQL connection URL (overrides `PG*` env vars).           |
-| `-V, --version`             | Print the `pgroll` version.                                     |
-| `-h, --help`                | Show help.                                                      |
+| Option                      | Description                                                        |
+| --------------------------- | ------------------------------------------------------------------ |
+| `-d, --migrationDir <path>` | Directory holding the migration files (default: `./migrations`).   |
+| `-u, --url <url>`           | PostgreSQL connection URL (overrides `PG*` env vars).              |
+| `-s, --schema <schema>`     | Schema for pgroll's internal migrations table (default: `public`). |
+| `-V, --version`             | Print the `pgroll` version.                                        |
+| `-h, --help`                | Show help.                                                         |
 
 ### Commands
 
@@ -159,12 +160,13 @@ await migrator.go(0, { eventHandler: info => console.log(info) });
 await sql.end();
 ```
 
-### `new Migrator(dbClient, migrationsDir?)`
+### `new Migrator(dbClient, migrationsDir?, schema?)`
 
-| Parameter       | Type                | Description                                                   |
-| --------------- | ------------------- | ------------------------------------------------------------- |
-| `dbClient`      | `Sql` (PostgresJS)  | A `postgres` client instance.                                 |
-| `migrationsDir` | `string` (optional) | Directory of migration files. Defaults to `<cwd>/migrations`. |
+| Parameter       | Type                | Description                                                          |
+| --------------- | ------------------- | -------------------------------------------------------------------- |
+| `dbClient`      | `Sql` (PostgresJS)  | A `postgres` client instance.                                        |
+| `migrationsDir` | `string` (optional) | Directory of migration files. Defaults to `<cwd>/migrations`.        |
+| `schema`        | `string` (optional) | Schema for pgroll's internal migrations table. Defaults to `public`. |
 
 ### Methods
 
@@ -180,10 +182,12 @@ human-readable message as each migration is applied.
 
 ## How it works
 
-On the first run, `pgroll` creates a bookkeeping table:
+On the first run, `pgroll` creates a bookkeeping table in the configured schema (default
+`public`, override with `-s, --schema`). All references to it are schema-qualified, so it is
+unaffected by any `search_path` a migration sets:
 
 ```sql
-CREATE TABLE IF NOT EXISTS migrations (
+CREATE TABLE IF NOT EXISTS <schema>.migrations (
   name       varchar(500) PRIMARY KEY,
   version    smallint NOT NULL,
   applied_at timestamp DEFAULT CURRENT_TIMESTAMP

package/dist/src/cli.js

@@ -10,8 +10,9 @@ let migrator;
 program
     .version('0.0.9')
     .description('Database migration tool')
-    .option('-d, --migrationDir <filepath>', 'Specify migration directory(Default: ./migrations)')
+    .option('-d, --migrationDir <filepath>', 'Specify migration directory (Default: ./migrations)')
     .option('-u, --url <url>', 'PostgreSQL connection URL (overrides PG* env vars)')
+    .option('-s, --schema <schema>', 'Specify schema (Default: public)')
     .hook('preAction', cmd => {
     const opts = cmd.opts();
     const pgOptions = {
@@ -19,7 +20,7 @@ program
             // do nothing
         }
     };
-    migrator = new Migrator(opts.url ? postgres(opts.url, pgOptions) : postgres(pgOptions), opts.migrationDir);
+    migrator = new Migrator(opts.url ? postgres(opts.url, pgOptions) : postgres(pgOptions), opts.migrationDir, opts.schema);
 });
 program
     .command('up')
@@ -64,8 +65,8 @@ program
     .description('Navigate to a specific version; version 0 performs a rollback, reverting all migrations.')
     .argument('<version>', 'version to migrate to')
     .action(async (version) => {
-    const parsedVersion = Number.parseInt(version, 10);
-    if (Number.isNaN(parsedVersion)) {
+    const parsedVersion = Number(version);
+    if (!Number.isSafeInteger(parsedVersion) || parsedVersion < 0) {
         console.error('Invalid version number.');
         process.exit(1);
     }

package/dist/src/index.d.ts

@@ -5,6 +5,7 @@ interface Option {
 }
 export interface IMigrator {
     migrationsDir: string;
+    schema: string;
     up: (opts?: Option) => Promise<void>;
     down: (opts?: Option) => Promise<void>;
     go: (version: number, opts?: Option) => Promise<void>;
@@ -13,7 +14,8 @@ export interface IMigrator {
 export declare class Migrator implements IMigrator {
     private readonly dbClient;
     readonly migrationsDir: string;
-    constructor(dbClient: Sql, migrationsDir?: string);
+    readonly schema: string;
+    constructor(dbClient: Sql, migrationsDir?: string, schema?: string);
     ensureMigrationTable(tx: ReservedSql): Promise<void>;
     up(): Promise<void>;
     down(): Promise<void>;

package/dist/src/index.js

@@ -4,12 +4,15 @@ import { getMigrationFiles } from "./utils.js";
 export class Migrator {
     dbClient;
     migrationsDir;
-    constructor(dbClient, migrationsDir = '') {
+    schema;
+    constructor(dbClient, migrationsDir = '', schema = 'public') {
         this.dbClient = dbClient;
         this.migrationsDir = migrationsDir || `${process.cwd()}/migrations`;
+        this.schema = schema;
     }
     async ensureMigrationTable(tx) {
-        await tx `CREATE TABLE IF NOT EXISTS migrations(
+        await tx `CREATE SCHEMA IF NOT EXISTS ${tx(this.schema)}`;
+        await tx `CREATE TABLE IF NOT EXISTS ${tx(this.schema)}.migrations(
                         name varchar(500) PRIMARY KEY,
                         version smallint NOT NULL,
                         applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);`;
@@ -29,6 +32,7 @@ export class Migrator {
             const currentVersion = await this.getCurrentVersionWithTx(tx);
             if (currentVersion === version) {
                 opts?.eventHandler(`Already at version ${version}`);
+                await this.commit(tx);
                 return;
             }
             const direction = version > currentVersion ? 'up' : 'down';
@@ -37,10 +41,8 @@ export class Migrator {
                 const fileVersion = Math.min(fileNames.length, version);
                 for (let i = currentVersion; i < fileVersion; i++) {
                     const file = fileNames[i] ?? '';
-                    await Promise.all([
-                        tx.file(path.join(this.migrationsDir, file)).execute(),
-                        tx `INSERT INTO migrations(name, version) VALUES (${file}, ${i} + 1)`
-                    ]);
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `INSERT INTO ${tx(this.schema)}.migrations(name, version) VALUES (${file}, ${i} + 1)`;
                     opts?.eventHandler(`Successfully migrated: ${file}`);
                 }
                 if (version > fileNames.length) {
@@ -54,10 +56,8 @@ export class Migrator {
                 const end = start + (currentVersion - version);
                 for (let i = start; i < end; i++) {
                     const file = fileNames[i] ?? '';
-                    await Promise.all([
-                        tx.file(path.join(this.migrationsDir, file)).execute(),
-                        tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                    ]);
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `DELETE FROM ${tx(this.schema)}.migrations WHERE version = ${fileNames.length - i}`;
                     opts?.eventHandler(`Successfully migrated: ${file}`);
                 }
             }
@@ -84,10 +84,8 @@ export class Migrator {
                 for (const fileName of fileNames) {
                     const id = fileNames.indexOf(fileName);
                     if (id >= currentVersion) {
-                        await Promise.all([
-                            tx.file(path.join(this.migrationsDir, fileName)).execute(),
-                            tx `INSERT INTO migrations(name, version) VALUES (${fileName}, ${id} + 1)`
-                        ]);
+                        await tx.file(path.join(this.migrationsDir, fileName)).execute();
+                        await tx `INSERT INTO ${tx(this.schema)}.migrations(name, version) VALUES (${fileName}, ${id} + 1)`;
                         opts?.eventHandler(`Successfully migrated: ${fileName}`);
                     }
                 }
@@ -97,10 +95,8 @@ export class Migrator {
                 const start = fileNames.length - currentVersion;
                 for (let i = start; i < fileNames.length; i++) {
                     const file = fileNames[i] ?? '';
-                    await Promise.all([
-                        tx.file(path.join(this.migrationsDir, file)).execute(),
-                        tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                    ]);
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `DELETE FROM ${tx(this.schema)}.migrations WHERE version = ${fileNames.length - i}`;
                     opts?.eventHandler(`Successfully migrated: ${file}`);
                 }
             }
@@ -116,11 +112,12 @@ export class Migrator {
         }
     }
     async getCurrentVersion() {
-        const result = await this.dbClient `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
+        const result = await this
+            .dbClient `SELECT version FROM ${this.dbClient(this.schema)}.migrations ORDER BY version DESC LIMIT 1`;
         return result.length > 0 ? result[0]?.['version'] : 0;
     }
     async getCurrentVersionWithTx(tx) {
-        const result = await tx `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
+        const result = await tx `SELECT version FROM ${tx(this.schema)}.migrations ORDER BY version DESC LIMIT 1`;
         return result.length > 0 ? result[0]?.['version'] : 0;
     }
     async acquireLock(tx) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgroll",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Postgres migration tool",
   "type": "module",
   "main": "dist/src/index.js",
@@ -50,24 +50,24 @@
   "license": "ISC",
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@types/node": "^25.9.1",
-    "@vitest/coverage-v8": "^4.1.7",
-    "@vitest/eslint-plugin": "^1.6.18",
-    "eslint": "^10.4.0",
+    "@types/node": "^26.0.1",
+    "@vitest/coverage-v8": "^4.1.9",
+    "@vitest/eslint-plugin": "^1.6.20",
+    "eslint": "^10.5.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.17.0",
     "eslint-plugin-promise": "^7.3.0",
-    "eslint-plugin-sonarjs": "^4.0.3",
-    "eslint-plugin-unicorn": "^64.0.0",
-    "globals": "^17.6.0",
-    "prettier": "^3.8.3",
+    "eslint-plugin-sonarjs": "^4.1.0",
+    "eslint-plugin-unicorn": "^69.0.0",
+    "globals": "^17.7.0",
+    "prettier": "^3.8.4",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.60.0",
-    "vitest": "^4.1.7"
+    "typescript-eslint": "^8.62.0",
+    "vitest": "^4.1.9"
   },
   "dependencies": {
-    "commander": "^14.0.3",
+    "commander": "^15.0.0",
     "postgres": "^3.4.9"
   }
 }