@opengeni/db 0.7.2 → 0.9.3

package/dist/migrate.d.ts

@@ -1,3 +1,28 @@
+interface ConcurrentIndexMigration {
+    indexName: string;
+    lockTimeout: string;
+    skipWhenValid: boolean;
+    statement: string;
+}
+/**
+ * Most migration files intentionally execute as one implicit transaction.
+ * PostgreSQL forbids CREATE INDEX CONCURRENTLY there, so a migration may opt
+ * into one narrowly validated transactionless statement with:
+ *
+ *   -- opengeni:concurrent-index lock-timeout=5s
+ *   CREATE [UNIQUE] INDEX CONCURRENTLY IF NOT EXISTS ...;
+ *
+ * The directive is deliberately not a generic "no transaction" escape hatch:
+ * only one idempotent concurrent-index statement is accepted, lock acquisition
+ * is always bounded, and an invalid artifact left by a failed concurrent build
+ * is removed before retry. Seven governed historical migrations predate the
+ * IF NOT EXISTS rule; only those exact filenames may use their immutable bare
+ * statements, and the runner makes their retries idempotent by skipping an
+ * already-valid index. This keeps additive large-table indexes online without
+ * rewriting shipped history or making arbitrary partially-applied migration
+ * scripts possible.
+ */
+declare function parseConcurrentIndexMigration(file: string, sqlText: string): ConcurrentIndexMigration | null;
 /**
  * Apply the OpenGeni SQL migration chain.
  *
@@ -7,18 +32,18 @@
  * byte-for-byte historical behavior — the migration test suite calls
  * `migrate(DB_URL)` and is unaffected.
  *
- * EMBEDDED (Step I, §7.8 runtime/SDK half): pass a `schema` (or set
+ * EMBEDDED SCHEMA MODE: pass a `schema` (or set
  * `OPENGENI_DB_SCHEMA`). The migrate session then `CREATE SCHEMA IF NOT EXISTS`
  * for both `<schema>` and `opengeni_private`, and sets
  * `search_path = "<schema>", "opengeni_private", "public"`, so EVERY unqualified
  * DDL statement lands in the dedicated schema with NO per-statement SQL rewrite
- * (the SPIKE-1 F1 result). Two things make this work and stay idempotent:
+ * (the schema-isolation contract). Two things make this work and stay idempotent:
  *   1. The policy-existence guards in the migration SQL use `current_schema()`
  *      (not a hardcoded `'public'`) — so a re-run finds the policy it already
  *      created in `<schema>` and DROP/CREATEs idempotently instead of failing
  *      with "policy already exists". (This guard substitution is the migrate-
  *      time enabler for the runtime search_path approach; without it the SDK
- *      entry point silently fails on re-run — the Fork-6 hazard.)
+ *      entry point silently fails on re-run — the migration replay hazard.)
  *   2. `public` stays LAST on the path so `gen_random_uuid()` (pgcrypto) and the
  *      `vector` type — both installed into `public` by 0000 — still resolve. The
  *      `opengeni_private.*` helpers are always called with an absolute prefix.
@@ -37,4 +62,4 @@ declare function migrate(databaseUrl?: string, schema?: string | undefined): Pro
  */
 declare function runMigrations(adminConnection: string, targetSchema?: string): Promise<void>;
 
-export { migrate, runMigrations };
+export { type ConcurrentIndexMigration, migrate, parseConcurrentIndexMigration, runMigrations };

package/dist/migrate.js

@@ -1,10 +1,12 @@
 import {
   migrate,
+  parseConcurrentIndexMigration,
   runMigrations
-} from "./chunk-7LDU7F5P.js";
+} from "./chunk-KW526IJA.js";
 import "./chunk-PZ5AY32C.js";
 export {
   migrate,
+  parseConcurrentIndexMigration,
   runMigrations
 };
 //# sourceMappingURL=migrate.js.map