@rebasepro/server-postgres 0.16.0 → 0.16.1-canary.g0d7af95

package/dist/cli-helpers.d.ts

@@ -89,6 +89,47 @@ export declare function seedDevDatabaseSearchHelpers(devDatabaseUrl: string, col
  * catalogs. Separated from {@link getTableExcludes} so its failure mode can
  * be handled explicitly (fail closed) and so tests can inject a stub.
  */
+/**
+ * Every index Postgres holds on a table Rebase manages, as
+ * `schema.table.index`.
+ *
+ * Constraint-backed indexes are left out: a `PRIMARY KEY` or a `UNIQUE` is a
+ * *constraint* to Atlas, diffed from the constraint declaration, and naming its
+ * index in an exclude would shield the constraint itself.
+ */
+export declare function queryExistingIndexes(databaseUrl: string): Promise<string[]>;
+/**
+ * Glob patterns keeping Atlas away from indexes that are not Rebase's.
+ *
+ * The problem this solves is live and predates the `indexes:` block. `db push`
+ * is declarative, so an index on a managed table that is absent from
+ * `schema.sql` is drift — and Atlas plans `DROP INDEX` for it. Verified
+ * against atlas v1.2.3: create one by hand, re-run an unchanged push, and the
+ * plan is a bare drop. `DROP INDEX` is not in `DESTRUCTIVE_PATTERNS`, so the
+ * auto-approved apply took it without asking. Until now the only way to have
+ * an index at all was to write it by hand, which made that the *only* outcome.
+ *
+ * Ownership rather than a prompt, because once indexes are declarable a drop
+ * is usually correct: removing one from the config should remove it from the
+ * database, quietly. What must never be dropped is an index Rebase never
+ * created — a hand-written one, or one an introspected database arrived with.
+ * {@link isRebaseIndexName} is the test, the same arrangement
+ * `isGeneratedPolicyName` uses to let policy reconciliation drop only what it
+ * generated.
+ *
+ * The named-in-the-desired-state check comes first and is what makes removal
+ * work: a declared index that the author has just deleted still matches the
+ * name pattern, is no longer in the plan, and so is *not* excluded — Atlas
+ * drops it, as intended.
+ *
+ * Three-part `schema.table.index`, never two: a two-part pattern reads as a
+ * *table* named `<index>` in a *schema* named `<table>`, matches nothing, and
+ * reports no error — the trap already recorded for the search excludes.
+ */
+export declare function getForeignIndexExcludes(databaseUrl: string, collectionsPath: string, deps?: {
+    queryExistingIndexes?: (databaseUrl: string) => Promise<string[]>;
+    getManagedIndexNames?: (collectionsPath: string) => Promise<Set<string>>;
+}): Promise<string[]>;
 export declare function queryExistingTables(databaseUrl: string): Promise<string[]>;
 /**
  * Raised when the exclude list could not be built. `db push` MUST abort on