@mikro-orm/entity-generator

Entity generator for MikroORM. Generates entity definitions from an existing database schema, supporting both decorator-based and defineEntity-based output.

Installation

npm install @mikro-orm/entity-generator

Usage

Via CLI

npx mikro-orm generate-entities --save --path=./src/entities

Programmatic API

import { MikroORM } from '@mikro-orm/postgresql';

const orm = await MikroORM.init({ ... });
const generator = orm.entityGenerator;

// Generate entity files from the current database schema
const dump = await generator.generate({
  save: true,
  path: './src/entities',
});

Features

• Generates entities from any supported SQL or MongoDB database
• Output formats: defineEntity helper (default), decorators, or EntitySchema
• Detects and generates relations, indexes, enums, and embeddables
• Configurable naming conventions and output options
• Bidirectional relation generation with Ref wrapper support

Documentation

See the official MikroORM documentation.

License

Copyright © 2018-present Martin Adámek. Licensed under the MIT License.