TypeORM MySQL

Package: @nauth-toolkit/database-typeorm-mysql Type: Database Package

MySQL/MariaDB entity implementations using TypeORM.

npm

npm install @nauth-toolkit/database-typeorm-mysql

Yarn

yarn add @nauth-toolkit/database-typeorm-mysql

pnpm

pnpm add @nauth-toolkit/database-typeorm-mysql

Bun

bun add @nauth-toolkit/database-typeorm-mysql

Exports

Export	Description
getNAuthEntities()	User/session entities (always include)
getNAuthTransientStorageEntities()	Rate limit/lock entities (only if using DatabaseStorageAdapter)
runNAuthMigrations	Run pending nauth-toolkit migrations. Called automatically during bootstrap.
Individual entities	User, Session, MFADevice, SocialProviderSecret, etc.

getNAuthEntities()

Returns core authentication entities.

Entities included:

• User - User accounts
• Session - Active sessions
• LoginAttempt - Login history
• VerificationToken - Email/phone codes
• SocialAccount - OAuth accounts
• ChallengeSession - MFA challenges
• MFADevice - Registered devices
• AuthAudit - Audit logs
• TrustedDevice - Trusted devices
• SocialProviderSecret - Apple JWT client secret storage

NestJS

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

TypeOrmModule.forRoot({
  type: 'mysql',
  entities: [
    ...getNAuthEntities(),
    // Your app entities...
  ],
})

Express

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

const dataSource = new DataSource({
  type: 'mysql',
  entities: [
    ...getNAuthEntities(),
    // Your app entities...
  ],
});

await dataSource.initialize();

Fastify

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

const dataSource = new DataSource({
  type: 'mysql',
  entities: [
    ...getNAuthEntities(),
    // Your app entities...
  ],
});

await dataSource.initialize();

getNAuthTransientStorageEntities()

Returns transient storage entities. Only use with DatabaseStorageAdapter.

Entities included:

• RateLimit - Rate limiting
• StorageLock - Distributed locks

NestJS

import {
  getNAuthEntities,
  getNAuthTransientStorageEntities
} from '@nauth-toolkit/database-typeorm-mysql';
import { DatabaseStorageAdapter } from '@nauth-toolkit/storage-database';

// Include storage entities
TypeOrmModule.forRoot({
  entities: [
    ...getNAuthEntities(),
    ...getNAuthTransientStorageEntities(),
  ],
})

// Use DatabaseStorageAdapter
AuthModule.forRoot({
  storageAdapter: new DatabaseStorageAdapter(),
})

Express

import {
  getNAuthEntities,
  getNAuthTransientStorageEntities
} from '@nauth-toolkit/database-typeorm-mysql';
import { DatabaseStorageAdapter } from '@nauth-toolkit/storage-database';

const dataSource = new DataSource({
  entities: [
    ...getNAuthEntities(),
    ...getNAuthTransientStorageEntities(),
  ],
});

const nauth = await NAuth.create({
  dataSource,
  config: {
    storageAdapter: new DatabaseStorageAdapter(),
  },
});

Fastify

import {
  getNAuthEntities,
  getNAuthTransientStorageEntities
} from '@nauth-toolkit/database-typeorm-mysql';
import { DatabaseStorageAdapter } from '@nauth-toolkit/storage-database';
import { FastifyAdapter } from '@nauth-toolkit/core';

const dataSource = new DataSource({
  entities: [
    ...getNAuthEntities(),
    ...getNAuthTransientStorageEntities(),
  ],
});

const nauth = await NAuth.create({
  dataSource,
  adapter: new FastifyAdapter(),
  config: {
    storageAdapter: new DatabaseStorageAdapter(),
  },
});

When to Include Storage Entities

Storage Adapter	Include getNAuthTransientStorageEntities()?
RedisStorageAdapter	No
DatabaseStorageAdapter	Yes (required)

Related

• TypeORM PostgreSQL
• Database Storage
• Session Storage