mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-21 11:36:05 +00:00
a77705984e
With TREK_DB_URL set, TREK now boots on Postgres; without it nothing changes. - The database engine contract gains open, close, reopen and the schema bootstrap; DatabaseLifecycle delegates to the engine resolveEngine() picks. - An empty Postgres database gets server/assets/postgres/baseline.sql (generated from the entities by gen:pg-baseline, with the reference rows the migrations up to its cut insert: tour types, provider catalogues, addons, app settings) and every migration up to its cut recorded as executed, in one transaction. A database holding tables without TREK's history is refused before anything is written; a migrated one runs the newer-database refusal and its pending migrations, which refuse without a copy unless TREK_DB_PRE_MIGRATE_SNAPSHOT=false. - INTEGER columns are bigint on Postgres (SQLite's INTEGER is 64-bit: an epoch-millisecond column overflowed int4), and the engine's driver reads bigint and numeric back as numbers, refusing values past 2^53. - The two SQLite triggers are ported to PL/pgSQL; check:pg-baseline fails while a SQLite trigger has no port, and while the baseline drifts from the entities before a later migration freezes it. - Backups and restores on Postgres refuse until they can dump and load one. - Migration helpers read the catalog per engine (dialect/catalog.ts), and the email case index no longer needs group_concat. - CI runs check:pg-baseline and boots the image on postgres:17 twice.
41 lines
1.7 KiB
TypeScript
41 lines
1.7 KiB
TypeScript
import type { AnyOrm } from '../orm';
|
|
import type { Options } from '@mikro-orm/core';
|
|
|
|
/** The databases TREK can be pointed at. MySQL/MariaDB are out of scope (server/CLAUDE.md). */
|
|
type EngineId = 'sqlite' | 'postgres';
|
|
|
|
/**
|
|
* One database engine: what the ORM needs to reach it, how the connection
|
|
* opens, closes and comes back after a restore, and how a database is brought
|
|
* to the current schema. Code that differs by engine dispatches through this,
|
|
* or through the helpers in `db/dialect/`, never through its own platform
|
|
* check (`lint:engine-dispatch`).
|
|
*
|
|
* Free of Nest like every other file under `db/`: `src/db` does not import
|
|
* `src/nest` (`lint:boundaries`). `DatabaseLifecycle` is the provider that
|
|
* calls it.
|
|
*/
|
|
export interface DatabaseEngine {
|
|
readonly id: EngineId;
|
|
/** For log lines and errors: the file path, or the URL without its password. */
|
|
describe(): string;
|
|
/** What MikroORM needs to reach the database: the driver and its target, the pool, driver options. */
|
|
ormOptions(): Partial<Options>;
|
|
/**
|
|
* Called once at boot, before the schema bootstrap. `onReopened` is what
|
|
* has to follow a later reopen (rebinding the ORM, migrating the restored
|
|
* database forward).
|
|
*/
|
|
open(onReopened: () => Promise<void>): void;
|
|
/** Closes what the engine itself holds; the ORM's own pool is closed with the Nest container. */
|
|
close(): void;
|
|
/** Comes back after the database was replaced by a restore, then runs `onReopened`. */
|
|
reopen(): Promise<void>;
|
|
/**
|
|
* Brings the database to the current schema, then seeds it. `snapshot:
|
|
* false` skips the copy taken before pending migrations (a restore, whose
|
|
* archive is the copy).
|
|
*/
|
|
schemaBootstrap(orm: AnyOrm, options: { snapshot: boolean }): Promise<void>;
|
|
}
|