Skip to content

README.md

Latest commit

 

History

History
57 lines (43 loc) · 1.52 KB

README.md

File metadata and controls

57 lines (43 loc) · 1.52 KB

@omgjs/labkit-server-database

@omgjs/labkit-server-database contains PostgreSQL and TypeORM configuration helpers that keep database setup explicit and migration-safe.

Owns

  • PostgreSQL URL normalization.
  • Discrete PostgreSQL connection option parsing.
  • SSL option parsing.
  • Database runtime flags.
  • Migration safety checks.
  • Safe connection summaries for logs.
  • Feature database manifest types.
  • Manifest composition for entities and migrations.

Does Not Own

  • Application data source bootstrapping.
  • Running migrations.
  • Editing or generating migration files.
  • Product-specific entities.
  • TypeORM module registration for a complete app.

Usage

import {
  assertDatabaseMigrationSafety,
  composeServerDatabaseManifests,
  readPostgresConnectionUrl,
} from "@omgjs/labkit-server-database";
import { serverAuthTypeormDatabaseManifest } from "@omgjs/labkit-server-auth-typeorm";

const manifest = composeServerDatabaseManifests([
  serverAuthTypeormDatabaseManifest,
  chatDatabaseManifest,
]);

assertDatabaseMigrationSafety({
  synchronize: false,
  migrationsRun: true,
});

Feature packages should export manifests. Apps compose those manifests into their TypeORM options and still own when migrations run.

Release Channel

This package is published on npm as part of the Labkit release train. Patch releases may include documentation-only clarifications, so consumers can update within the same minor line without expecting runtime API changes.

Package Format

This is a server-only CommonJS package.