Skip to main content

Database

TypeORM entity packages for different databases.

Available Packages

DatabasePackage
PostgreSQLTypeORM PostgreSQL
MySQL/MariaDBTypeORM MySQL

What They Provide

Database packages provide TypeORM entity classes for authentication data.

User/Session Entities

Always include via getNAuthEntities():

  • User accounts
  • Active sessions
  • Login history
  • Email/phone verification
  • Social account links
  • MFA devices
  • Audit logs

Storage Entities

Only include via getNAuthTransientStorageEntities() if using DatabaseStorageAdapter:

  • Rate limiting counters
  • Distributed locks

Quick Start

Pick your database package, import entities:

import { getNAuthEntities } from '@nauth-toolkit/database-typeorm-postgres';
// or
import { getNAuthEntities } from '@nauth-toolkit/database-typeorm-mysql';

Add to TypeORM:

entities: [
...getNAuthEntities(),
// Your entities...
]