MikroORM

https://mikro-orm.io/docs/next
Admin
MikroORM is a TypeScript ORM for Node.js that supports various SQL and NoSQL databases, providing...
Tokens:305,108
Snippets:3,371
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Clone Schema-First Guide Project

Source: https://mikro-orm.io/docs/next/schema-first-guide

Clone the example project from GitHub to explore the final application structure.

```bash
git clone https://github.com/mikro-orm/schema-first-guide.git
```

--------------------------------

### Clone MikroORM Guide Repository

Source: https://mikro-orm.io/docs/next/guide

Clone the GitHub repository to get the final project for the guide. This provides a working example to follow along with.

```bash
git clone https://github.com/mikro-orm/guide.git
```

--------------------------------

### server.ts Example

Source: https://mikro-orm.io/docs/next/guide/first-entity

This is the server.ts file content for checkpoint 1, demonstrating the initial setup with a User entity and EntityManager.

```typescript
import { defineConfig, LoadStrategy } from '@mikro-orm/core';
import { User } from './User';

export default defineConfig({
  entities: [User],
  dbName: ':memory:',
  loadStrategy: LoadStrategy.ALL_WITHOUT_EAGER,
});
```

--------------------------------

### Install libSQL driver with Bun

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the libSQL driver using Bun.

```bash
bun add @mikro-orm/core @mikro-orm/libsql  

```

--------------------------------

### Running Basic Build and Production Start

Source: https://mikro-orm.io/docs/next/guide/advanced

Commands to execute the build process and start the compiled application.

```bash
npm run build  

npm run start:prod  

```

--------------------------------

### Install Core Dependencies with Bun

Source: https://mikro-orm.io/docs/next/schema-first-guide

Installs core MikroORM packages and Fastify using Bun.

```bash
bun add @mikro-orm/core \
            @mikro-orm/mysql \
            @mikro-orm/migrations \
            fastify
```

--------------------------------

### Install SQL Drivers with Bun

Source: https://mikro-orm.io/docs/next/usage-with-sql

Install the appropriate driver package for your SQL database using Bun. Ensure `@mikro-orm/core` is installed explicitly if using other MikroORM packages.

```bash
# for postgresql (works with cockroachdb too)  
bun add @mikro-orm/postgresql  
  
# for pglite (embedded PostgreSQL in WASM)  
bun add @mikro-orm/pglite  
  
# for mysql (works with mariadb too)  
bun add @mikro-orm/mysql  
  
# for mariadb (works with mysql too)  
bun add @mikro-orm/mariadb  
  
# for sqlite  
bun add @mikro-orm/sqlite  
  
# for libsql/turso  
bun add @mikro-orm/libsql  
  
# for mssql  
bun add @mikro-orm/mssql  
  
# for oracle  
bun add @mikro-orm/oracledb  
```

```bash
bun add @mikro-orm/core @mikro-orm/postgresql @mikro-orm/migrations @mikro-orm/cli  
```

--------------------------------

### Install Dependencies with Bun

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary MikroORM, SQL, and kysely-durable-objects packages using Bun.

```bash
bun add @mikro-orm/core @mikro-orm/sql kysely kysely-durable-objects  
```

--------------------------------

### Run Bundled Build and Production Start

Source: https://mikro-orm.io/docs/next/guide/advanced

Commands to create a bundled production build with Vite and then start the application.

```bash
npm run bundle  

npm run start:prod  

```

--------------------------------

### Install libSQL driver with npm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the libSQL driver using npm.

```bash
npm install @mikro-orm/core @mikro-orm/libsql  

```

--------------------------------

### Install @mikro-orm/decorators with Bun

Source: https://mikro-orm.io/docs/next/upgrading-v6-to-v7

Install the new decorators package using Bun.

```bash
bun add @mikro-orm/decorators  
```

--------------------------------

### Install Dependencies with npm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary MikroORM, SQL, and kysely-durable-objects packages using npm.

```bash
npm install @mikro-orm/core @mikro-orm/sql kysely kysely-durable-objects  
```

--------------------------------

### Install MikroORM PostgreSQL Driver (Bun)

Source: https://mikro-orm.io/docs/next/usage-with-cockroachdb

Install the core MikroORM package and the PostgreSQL driver using Bun.

```bash
bun add @mikro-orm/core @mikro-orm/postgresql  
```

--------------------------------

### Install MikroORM with Bun

Source: https://mikro-orm.io/docs/next/quick-start

Install the core MikroORM package and the driver for your chosen database using Bun.

```bash
# for mongodb  

bun add @mikro-orm/core @mikro-orm/mongodb  

  
# for mysql (works with mariadb too)  
bun add @mikro-orm/core @mikro-orm/mysql  

  
# for mariadb (works with mysql too)  
bun add @mikro-orm/core @mikro-orm/mariadb  

  
# for postgresql (works with cockroachdb too)  
bun add @mikro-orm/core @mikro-orm/postgresql  

  
# for pglite (embedded PostgreSQL in WASM)  
bun add @mikro-orm/core @mikro-orm/pglite  

  
# for sqlite  
bun add @mikro-orm/core @mikro-orm/sqlite  

  
# for libsql/turso  
bun add @mikro-orm/core @mikro-orm/libsql  

  
# for mssql  
bun add @mikro-orm/core @mikro-orm/mssql  

  
# for oracle  
bun add @mikro-orm/core @mikro-orm/oracledb  

  

```

--------------------------------

### Install MikroORM with PGlite (Bun)

Source: https://mikro-orm.io/docs/next/usage-with-pglite

Install the core MikroORM package and the PGlite driver using Bun.

```bash
bun add @mikro-orm/core @mikro-orm/pglite  
```

--------------------------------

### Install Core Dependencies with pnpm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Installs core MikroORM packages and Fastify using pnpm.

```bash
pnpm add @mikro-orm/core \
            @mikro-orm/mysql \
            @mikro-orm/migrations \
            fastify
```

--------------------------------

### Install libSQL driver with Yarn

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the libSQL driver using Yarn.

```bash
yarn add @mikro-orm/core @mikro-orm/libsql  

```

--------------------------------

### Install Dependencies with pnpm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary MikroORM, SQL, and kysely-durable-objects packages using pnpm.

```bash
pnpm add @mikro-orm/core @mikro-orm/sql kysely kysely-durable-objects  
```

--------------------------------

### Install libSQL driver with pnpm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the libSQL driver using pnpm.

```bash
pnpm add @mikro-orm/core @mikro-orm/libsql  

```

--------------------------------

### Install SQL Drivers with npm

Source: https://mikro-orm.io/docs/next/usage-with-sql

Install the appropriate driver package for your SQL database using npm. Ensure `@mikro-orm/core` is installed explicitly if using other MikroORM packages.

```bash
# for postgresql (works with cockroachdb too)  
npm install @mikro-orm/postgresql  
  
# for pglite (embedded PostgreSQL in WASM)  
npm install @mikro-orm/pglite  
  
# for mysql (works with mariadb too)  
npm install @mikro-orm/mysql  
  
# for mariadb (works with mysql too)  
npm install @mikro-orm/mariadb  
  
# for sqlite  
npm install @mikro-orm/sqlite  
  
# for libsql/turso  
npm install @mikro-orm/libsql  
  
# for mssql  
npm install @mikro-orm/mssql  
  
# for oracle  
npm install @mikro-orm/oracledb  
```

```bash
npm install @mikro-orm/core @mikro-orm/postgresql @mikro-orm/migrations @mikro-orm/cli  
```

--------------------------------

### Install better-sqlite3 driver with Bun

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the better-sqlite3 driver using Bun.

```bash
bun add @mikro-orm/core @mikro-orm/sqlite  

```

--------------------------------

### Install Mikro-ORM Seeder with Bun

Source: https://mikro-orm.io/docs/next/guide/project-setup

Install the seeder package using Bun.

```bash
bun add @mikro-orm/seeder
```

--------------------------------

### Install MikroORM PostgreSQL Driver (npm)

Source: https://mikro-orm.io/docs/next/usage-with-cockroachdb

Install the core MikroORM package and the PostgreSQL driver using npm.

```bash
npm install @mikro-orm/core @mikro-orm/postgresql  
```

--------------------------------

### Install Core Dependencies with npm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Installs core MikroORM packages and Fastify using npm.

```bash
npm install @mikro-orm/core \
            @mikro-orm/mysql \
            @mikro-orm/migrations \
            fastify
```

--------------------------------

### Install MikroORM with npm

Source: https://mikro-orm.io/docs/next/quick-start

Install the core MikroORM package and the driver for your chosen database using npm.

```bash
# for mongodb  

npm install @mikro-orm/core @mikro-orm/mongodb  

  
# for mysql (works with mariadb too)  
npm install @mikro-orm/core @mikro-orm/mysql  

  
# for mariadb (works with mysql too)  
npm install @mikro-orm/core @mikro-orm/mariadb  

  
# for postgresql (works with cockroachdb too)  
npm install @mikro-orm/core @mikro-orm/postgresql  

  
# for pglite (embedded PostgreSQL in WASM)  
npm install @mikro-orm/core @mikro-orm/pglite  

  
# for sqlite  
npm install @mikro-orm/core @mikro-orm/sqlite  

  
# for libsql/turso  
npm install @mikro-orm/core @mikro-orm/libsql  

  
# for mssql  
npm install @mikro-orm/core @mikro-orm/mssql  

  
# for oracle  
npm install @mikro-orm/core @mikro-orm/oracledb  

  

```

--------------------------------

### Install Vite with Bun

Source: https://mikro-orm.io/docs/next/guide/advanced

Installs Vite as a development dependency using Bun.

```bash
bun add vite --dev  

```

--------------------------------

### Install Dependencies with Yarn

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary MikroORM, SQL, and kysely-durable-objects packages using Yarn.

```bash
yarn add @mikro-orm/core @mikro-orm/sql kysely kysely-durable-objects  
```

--------------------------------

### Install reflect-metadata with Bun

Source: https://mikro-orm.io/docs/next/using-decorators

Install the reflect-metadata package using Bun. This is required for the ReflectMetadataProvider.

```bash
bun add reflect-metadata
```

--------------------------------

### Install Core Dependencies with Yarn

Source: https://mikro-orm.io/docs/next/schema-first-guide

Installs core MikroORM packages and Fastify using Yarn.

```bash
yarn add @mikro-orm/core \
            @mikro-orm/mysql \
            @mikro-orm/migrations \
            fastify
```

--------------------------------

### Install Auth and Session Packages

Source: https://mikro-orm.io/docs/next/usage-with-adonis

Install the necessary authentication and session packages for AdonisJS.

```bash
npm install @adonisjs/auth @adonisjs/session  

```

--------------------------------

### Install MikroORM with Yarn

Source: https://mikro-orm.io/docs/next/quick-start

Install the core MikroORM package and the driver for your chosen database using Yarn.

```bash
# for mongodb  

yarn add @mikro-orm/core @mikro-orm/mongodb  

  
# for mysql (works with mariadb too)  
yarn add @mikro-orm/core @mikro-orm/mysql  

  
# for mariadb (works with mysql too)  
yarn add @mikro-orm/core @mikro-orm/mariadb  

  
# for postgresql (works with cockroachdb too)  
yarn add @mikro-orm/core @mikro-orm/postgresql  

  
# for pglite (embedded PostgreSQL in WASM)  
yarn add @mikro-orm/core @mikro-orm/pglite  

  
# for sqlite  
yarn add @mikro-orm/core @mikro-orm/sqlite  

  
# for libsql/turso  
yarn add @mikro-orm/core @mikro-orm/libsql  

  
# for mssql  
yarn add @mikro-orm/core @mikro-orm/mssql  

  
# for oracle  
yarn add @mikro-orm/core @mikro-orm/oracledb  

  

```

--------------------------------

### Install better-sqlite3 driver with npm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the better-sqlite3 driver using npm.

```bash
npm install @mikro-orm/core @mikro-orm/sqlite  

```

--------------------------------

### Install MikroORM with PGlite (Yarn)

Source: https://mikro-orm.io/docs/next/usage-with-pglite

Install the core MikroORM package and the PGlite driver using Yarn.

```bash
yarn add @mikro-orm/core @mikro-orm/pglite  
```

--------------------------------

### Install MikroORM with pnpm

Source: https://mikro-orm.io/docs/next/quick-start

Install the core MikroORM package and the driver for your chosen database using pnpm.

```bash
# for mongodb  

pnpm add @mikro-orm/core @mikro-orm/mongodb  

  
# for mysql (works with mariadb too)  
pnpm add @mikro-orm/core @mikro-orm/mysql  

  
# for mariadb (works with mysql too)  
pnpm add @mikro-orm/core @mikro-orm/mariadb  

  
# for postgresql (works with cockroachdb too)  
pnpm add @mikro-orm/core @mikro-orm/postgresql  

  
# for pglite (embedded PostgreSQL in WASM)  
pnpm add @mikro-orm/core @mikro-orm/pglite  

  
# for sqlite  
pnpm add @mikro-orm/core @mikro-orm/sqlite  

  
# for libsql/turso  
pnpm add @mikro-orm/core @mikro-orm/libsql  

  
# for mssql  
pnpm add @mikro-orm/core @mikro-orm/mssql  

  
# for oracle  
pnpm add @mikro-orm/core @mikro-orm/oracledb  

  

```

--------------------------------

### Install MikroORM PostgreSQL Driver (Yarn)

Source: https://mikro-orm.io/docs/next/usage-with-cockroachdb

Install the core MikroORM package and the PostgreSQL driver using Yarn.

```bash
yarn add @mikro-orm/core @mikro-orm/postgresql  
```

--------------------------------

### Install MikroORM with PGlite (pnpm)

Source: https://mikro-orm.io/docs/next/usage-with-pglite

Install the core MikroORM package and the PGlite driver using pnpm.

```bash
pnpm add @mikro-orm/core @mikro-orm/pglite  
```

--------------------------------

### Install MikroORM with PGlite (npm)

Source: https://mikro-orm.io/docs/next/usage-with-pglite

Install the core MikroORM package and the PGlite driver using npm.

```bash
npm install @mikro-orm/core @mikro-orm/pglite  
```

--------------------------------

### Install better-sqlite3 driver with pnpm

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the better-sqlite3 driver using pnpm.

```bash
pnpm add @mikro-orm/core @mikro-orm/sqlite  

```

--------------------------------

### Basic Build and Start Scripts

Source: https://mikro-orm.io/docs/next/guide/advanced

These scripts in package.json handle TypeScript compilation and starting the application in production mode.

```json
"scripts": {
  
  "build": "tsc",  
  
  "start": "tsx src/server.ts",  
  
  "start:prod": "node dist/server.js",  
  
  "test": "vitest"  
},  

```

--------------------------------

### Install better-sqlite3 driver with Yarn

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the core MikroORM package and the better-sqlite3 driver using Yarn.

```bash
yarn add @mikro-orm/core @mikro-orm/sqlite  

```

--------------------------------

### Full MikroORM Configuration Example

Source: https://mikro-orm.io/docs/next/usage-with-nextjs

Provides a comprehensive example of configuring MikroORM, including database name, debug mode, explicit entity and migration lists, and extensions.

```typescript
// mikro-orm.config.ts  

import { defineConfig } from '@mikro-orm/sqlite';  

import { Migrator } from '@mikro-orm/migrations';  

import { UserSchema, Social } from './lib/user.entity';  

import { ArticleSchema } from './lib/article.entity';  

import { TagSchema } from './lib/tag.entity';  

import { CommentSchema } from './lib/comment.entity';  

import { Migration20251221173216 } from '@/migrations/Migration20251221173216';  

  

export default defineConfig({  

  dbName: 'sqlite.db',  

  debug: process.env.NODE_ENV !== 'production',  

  

  // Explicit entity list - no glob patterns  

  entities: [  

    UserSchema,  

    ArticleSchema,  

    TagSchema,  

    CommentSchema,  

    Social, // Don't forget embeddables  

  ],  

  

  // Explicitly register extensions  

  extensions: [Migrator],  

  

  // Explicit migration list - no glob patterns  

  migrations: {  

    migrationsList: [Migration20251221173216],  

  },  

});  

```

--------------------------------

### Define Book Entity with Decorators

Source: https://mikro-orm.io/docs/next/quick-start

Define a 'Book' entity using decorators from '@mikro-orm/decorators/legacy'. Ensure additional setup as described in the 'Using Decorators' guide.

```typescript
import { Collection } from '@mikro-orm/core';  
import { Entity, PrimaryKey, Property, ManyToOne, ManyToMany } from '@mikro-orm/decorators/legacy';  
  
@Entity()  
export class Book {  
  
  @PrimaryKey()  
  id!: bigint;  
  
  @Property()  
  title!: string;  
  
  @ManyToOne(() => Author)  
  author!: Author;  
  
  @ManyToMany(() => BookTag)  
  tags = new Collection<BookTag>(this);  
  
}  
```

--------------------------------

### Initialize Project with npm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Initializes a new Node.js project using npm.

```bash
npm init
```

--------------------------------

### Install MikroORM Reflection Package

Source: https://mikro-orm.io/docs/next/using-decorators

Install the reflection package for MikroORM using npm, Yarn, pnpm, or Bun.

```bash
npm install @mikro-orm/reflection
```

```bash
yarn add @mikro-orm/reflection
```

```bash
pnpm add @mikro-orm/reflection
```

```bash
bun add @mikro-orm/reflection
```

--------------------------------

### Install MikroORM PostgreSQL Driver (pnpm)

Source: https://mikro-orm.io/docs/next/usage-with-cockroachdb

Install the core MikroORM package and the PostgreSQL driver using pnpm.

```bash
pnpm add @mikro-orm/core @mikro-orm/postgresql  
```

--------------------------------

### Install Dev Dependencies with Bun

Source: https://mikro-orm.io/docs/next/schema-first-guide

Installs development dependencies for MikroORM CLI and TypeScript using Bun.

```bash
bun add --dev @mikro-orm/cli \
                       @mikro-orm/entity-generator \
                       typescript \
                       tsx \
                       @types/node \
                       rimraf \
                       vitest
```

--------------------------------

### Configure Custom SQLite Dialect with driverOptions

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Integrate any SQLite library by providing a Kysely dialect via the `driverOptions` in the Mikro-ORM configuration. This example shows basic setup.

```typescript
import { MikroORM, SqliteDriver } from '@mikro-orm/sql';

const orm = await MikroORM.init({
  driver: SqliteDriver,
  entities: [...],
  dbName: ':memory:',
  driverOptions: myCustomKyselyDialect,
});
```

--------------------------------

### Initialize Project with Bun

Source: https://mikro-orm.io/docs/next/schema-first-guide

Initializes a new Node.js project using Bun.

```bash
bun init
```

--------------------------------

### Exclude MikroORM Dependencies with esbuild

Source: https://mikro-orm.io/docs/next/deployment

Use the `external` configuration option in esbuild to exclude MikroORM packages and database drivers. This example shows exclusions for a PostgreSQL setup.

```javascript
external: [
  '@mikro-orm/migrations',
  '@mikro-orm/entity-generator',
  '@mikro-orm/mariadb',
  '@mikro-orm/mongodb',
  '@mikro-orm/mysql',
  '@mikro-orm/mssql',
  '@mikro-orm/oracledb',
  '@mikro-orm/pglite',
  '@mikro-orm/seeder',
  '@mikro-orm/sqlite',
  '@mikro-orm/libsql',
  'better-sqlite3',
  'mysql',
  'mysql2',
  'oracledb',
  'pg-native',
  'pg-query-stream',
  'tedious'
]
```

--------------------------------

### Entity with Internal Accessor using Decorators (Duplicate)

Source: https://mikro-orm.io/docs/next/defining-entities

This example reiterates the decorator-based configuration for using an internal accessor with native private fields. It shows the `@Property({ accessor: true })` setup.

```typescript
@Entity({ forceConstructor: true })
export class User {
  @PrimaryKey()
  id!: number;

  #email!: string;

  // the ORM will use the accessor internally
  @Property({ accessor: true })
  get email() {
    return this.#email;
  }

  set email(email: string) {
    return this.#email;
  }
}
```

--------------------------------

### Install MikroORM with node:sqlite

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary MikroORM packages and Kysely for use with the node:sqlite driver.

```bash
npm install @mikro-orm/core @mikro-orm/sql kysely  

```

```bash
yarn add @mikro-orm/core @mikro-orm/sql kysely  

```

```bash
pnpm add @mikro-orm/core @mikro-orm/sql kysely  

```

```bash
bun add @mikro-orm/core @mikro-orm/sql kysely  

```

--------------------------------

### Install MikroORM CLI

Source: https://mikro-orm.io/docs/next/quick-start

Install the CLI package as a development dependency. Ensure the version aligns with your `@mikro-orm/core` package.

```bash
yarn add --dev @mikro-orm/cli
```

--------------------------------

### Persisting Changes and Implicit Transactions

Source: https://mikro-orm.io/docs/next/unit-of-work

This example demonstrates how to modify an existing entity and add a new one, then persist them. Calling `em.persist(user).flush()` will automatically start a transaction, update the user's email, and insert the new car due to bi-directional cascading.

```typescript
const user = await em.findOne(User, 1);

user.email = 'foo@bar.com';

const car = new Car();

user.cars.add(car);

// thanks to bi-directional cascading you only need to persist user entity
// flushing will create a transaction, insert new car and update user with new email
await em.persist(user).flush();

```

--------------------------------

### Bootstrap Fastify Application with MikroORM (TypeScript)

Source: https://mikro-orm.io/docs/next/schema-first-guide

Sets up a Fastify server, initializes the ORM, applies migrations, and registers request context for database operations. Includes a basic route for fetching articles.

```typescript
import { RequestContext } from '@mikro-orm/core';  
import { fastify } from 'fastify';  
import { initORM } from './db.js';  
  
export async function bootstrap(port = 3001, migrate = true) {  

  const db = initORM({  

      ensureDatabase: { create: false },  

  });  

  

  if (migrate) {  

    // sync the schema  

    await db.orm.migrator.up();  

  }  

  

  const app = fastify();  

  

  // register request context hook  

  app.addHook('onRequest', (request, reply, done) => {  

    RequestContext.create(db.em, done);  

  });  

  

  // shut down the connection when closing the app  

  app.addHook('onClose', async () => {  

    await db.orm.close();  

  });  

  

  // register routes here  

  app.get('/article', async (request) => {  

    const { limit, offset } = request.query as {  

      limit?: number;  

      offset?: number;  

    };  

    const [items, total] = await db.article.findAndCount(  

      {},  

      {  

        limit,  

        offset,  

      }  

    );  

  

    return { items, total };  

  });  

  

  const url = await app.listen({ port });  

  

  return { app, url };  

}  
```

--------------------------------

### Install AdminJS Core

Source: https://mikro-orm.io/docs/next/usage-with-adminjs

Installs the core AdminJS package.

```bash
$ yarn add adminjs
```

--------------------------------

### Create Project Folder Structure

Source: https://mikro-orm.io/docs/next/guide/first-entity

Set up the basic directory structure for the project, including module subdirectories.

```bash
# create the project folder and `cd` into it
mkdir blog-api && cd blog-api

# create module folders, inside `src` folder
mkdir -p src/modules/{user,article,common}

```

--------------------------------

### Install SQL Drivers with pnpm

Source: https://mikro-orm.io/docs/next/usage-with-sql

Install the appropriate driver package for your SQL database using pnpm. Ensure `@mikro-orm/core` is installed explicitly if using other MikroORM packages.

```bash
# for postgresql (works with cockroachdb too)  
pnpm add @mikro-orm/postgresql  
  
# for pglite (embedded PostgreSQL in WASM)  
pnpm add @mikro-orm/pglite  
  
# for mysql (works with mariadb too)  
pnpm add @mikro-orm/mysql  
  
# for mariadb (works with mysql too)  
pnpm add @mikro-orm/mariadb  
  
# for sqlite  
pnpm add @mikro-orm/sqlite  
  
# for libsql/turso  
pnpm add @mikro-orm/libsql  
  
# for mssql  
pnpm add @mikro-orm/mssql  
  
# for oracle  
pnpm add @mikro-orm/oracledb  
```

```bash
pnpm add @mikro-orm/core @mikro-orm/postgresql @mikro-orm/migrations @mikro-orm/cli  
```

--------------------------------

### MikroORM CLI Help

Source: https://mikro-orm.io/docs/next/quick-start

View all available commands and their usage by running the CLI without any arguments.

```bash
npx mikro-orm
```

--------------------------------

### Install SQL Drivers with Yarn

Source: https://mikro-orm.io/docs/next/usage-with-sql

Install the appropriate driver package for your SQL database using Yarn. Ensure `@mikro-orm/core` is installed explicitly if using other MikroORM packages.

```bash
# for postgresql (works with cockroachdb too)  
yarn add @mikro-orm/postgresql  
  
# for pglite (embedded PostgreSQL in WASM)  
yarn add @mikro-orm/pglite  
  
# for mysql (works with mariadb too)  
yarn add @mikro-orm/mysql  
  
# for mariadb (works with mysql too)  
yarn add @mikro-orm/mariadb  
  
# for sqlite  
yarn add @mikro-orm/sqlite  
  
# for libsql/turso  
yarn add @mikro-orm/libsql  
  
# for mssql  
yarn add @mikro-orm/mssql  
  
# for oracle  
yarn add @mikro-orm/oracledb  
```

```bash
yarn add @mikro-orm/core @mikro-orm/postgresql @mikro-orm/migrations @mikro-orm/cli  
```

--------------------------------

### Install Bun SQLite dependencies

Source: https://mikro-orm.io/docs/next/usage-with-sqlite

Install the necessary packages for using MikroORM with Bun's built-in SQLite module.

```bash
bun add @mikro-orm/core @mikro-orm/sql kysely kysely-bun-sqlite
```

--------------------------------

### Install @mikro-orm/decorators with pnpm

Source: https://mikro-orm.io/docs/next/upgrading-v6-to-v7

Install the new decorators package using pnpm.

```bash
pnpm add @mikro-orm/decorators  
```

--------------------------------

### Install @mikro-orm/decorators with Yarn

Source: https://mikro-orm.io/docs/next/upgrading-v6-to-v7

Install the new decorators package using Yarn.

```bash
yarn add @mikro-orm/decorators  
```

--------------------------------

### Install @mikro-orm/decorators with npm

Source: https://mikro-orm.io/docs/next/upgrading-v6-to-v7

Install the new decorators package using npm.

```bash
npm install @mikro-orm/decorators  
```

--------------------------------

### Install Core Dependencies with Bun

Source: https://mikro-orm.io/docs/next/guide/first-entity

Install the necessary MikroORM core and SQLite packages, along with Fastify, using Bun.

```bash
bun add @mikro-orm/core \
            @mikro-orm/sqlite \
            fastify

```

--------------------------------

### Install Vite with pnpm

Source: https://mikro-orm.io/docs/next/guide/advanced

Installs Vite as a development dependency using pnpm.

```bash
pnpm add vite --save-dev  

```

--------------------------------

### Install Vite with Yarn

Source: https://mikro-orm.io/docs/next/guide/advanced

Installs Vite as a development dependency using Yarn.

```bash
yarn add vite --dev  

```

--------------------------------

### Install Vite with npm

Source: https://mikro-orm.io/docs/next/guide/advanced

Installs Vite as a development dependency using npm.

```bash
npm install vite --save-dev  

```

--------------------------------

### Initialize Project with pnpm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Initializes a new Node.js project using pnpm.

```bash
pnpm init
```

--------------------------------

### Generated SQL for upsert

Source: https://mikro-orm.io/docs/next/entity-manager

Example of the SQL query generated by an upsert operation with conflict resolution.

```sql
insert into "author"  

  ("id", "current_age", "email", "foo")  

  values  

    (1, 41, 'a1', true),  

    (2, 42, 'a2', true),  

    (5, 43, 'a3', true)  

  on conflict ("email")  

  do update set  

    "current_age" = excluded."current_age",  

    "foo" = excluded."foo"  

  returning "_id", "current_age", "foo", "bar"
```

--------------------------------

### Migration Create Output

Source: https://mikro-orm.io/docs/next/guide/project-setup

Example output showing a new migration file being successfully created by the MikroORM CLI.

```bash
npx mikro-orm migration:create
Migration20220913205718.ts successfully created
```

--------------------------------

### Initializing MikroORM with MongoDB

Source: https://mikro-orm.io/docs/next/usage-with-mongo

Bootstrap the application using the MongoDB driver and clientUrl.

```typescript
import { MikroORM } from '@mikro-orm/mongodb'; // or any other driver package  

  

const orm = await MikroORM.init({  

  entities: [Author, Book, ...],  

  dbName: 'my-db-name',  

  clientUrl: '...',  

});  

console.log(orm.em); // access EntityManager via `em` property
```

--------------------------------

### Install Mikro-ORM Seeder with pnpm

Source: https://mikro-orm.io/docs/next/guide/project-setup

Install the seeder package using pnpm.

```bash
pnpm add @mikro-orm/seeder
```

--------------------------------

### Install Mikro-ORM Seeder with Yarn

Source: https://mikro-orm.io/docs/next/guide/project-setup

Install the seeder package using Yarn.

```bash
yarn add @mikro-orm/seeder
```

--------------------------------

### Install Mikro-ORM Seeder with npm

Source: https://mikro-orm.io/docs/next/guide/project-setup

Install the seeder package using npm.

```bash
npm install @mikro-orm/seeder
```

--------------------------------

### Initialize MikroORM with PostgreSQL Driver

Source: https://mikro-orm.io/docs/next/usage-with-sql

Bootstrap the ORM by creating a configuration file and calling MikroORM.init(). Import from your driver package to access driver-specific features.

```typescript
import { MikroORM } from '@mikro-orm/postgresql'; // or any other SQL driver package  

const orm = await MikroORM.init({
  entities: [Author, Book],
  dbName: 'my-db-name',
});
```

--------------------------------

### Install reflect-metadata with pnpm

Source: https://mikro-orm.io/docs/next/using-decorators

Install the reflect-metadata package using pnpm. This is required for the ReflectMetadataProvider.

```bash
pnpm add reflect-metadata
```

--------------------------------

### Install reflect-metadata with Yarn

Source: https://mikro-orm.io/docs/next/using-decorators

Install the reflect-metadata package using Yarn. This is required for the ReflectMetadataProvider.

```bash
yarn add reflect-metadata
```

--------------------------------

### Install reflect-metadata with npm

Source: https://mikro-orm.io/docs/next/using-decorators

Install the reflect-metadata package using npm. This is required for the ReflectMetadataProvider.

```bash
npm install reflect-metadata
```

--------------------------------

### Create Project Directory

Source: https://mikro-orm.io/docs/next/schema-first-guide

Creates a new directory for the project and navigates into it.

```bash
mkdir blog-api && cd blog-api
```

--------------------------------

### Install renamer with Bun

Source: https://mikro-orm.io/docs/next/schema-first-guide

Install the 'renamer' package as a development dependency using Bun.

```bash
bun add --dev renamer  
```

--------------------------------

### Install renamer with pnpm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Install the 'renamer' package as a development dependency using pnpm.

```bash
pnpm add --save-dev renamer  
```

--------------------------------

### Install renamer with Yarn

Source: https://mikro-orm.io/docs/next/schema-first-guide

Install the 'renamer' package as a development dependency using Yarn.

```bash
yarn add --dev renamer  
```

--------------------------------

### Bootstrap Fastify App with MikroORM

Source: https://mikro-orm.io/docs/next/guide/advanced

Initializes the MikroORM, sets up Fastify, registers JWT and request context hooks, and defines global error handling. This is the main entry point for the application.

```typescript
import { NotFoundError, RequestContext } from "@mikro-orm/core";  
import { fastify } from "fastify";  
import fastifyJWT from "@fastify/jwt";  
import { initORM } from "./db.js";  
import { registerArticleRoutes } from "./modules/article/routes.js";  
import { registerUserRoutes } from "./modules/user/routes.js";  
import { AuthError } from "./modules/common/utils.js";  
  
export async function bootstrap(port = 3001, migrate = true) {  
  const db = initORM();  
  
  if (migrate) {  
    // sync the schema  
    await db.orm.migrator.up();  
  }  
  
  const app = fastify();  
  
  // register JWT plugin  
  app.register(fastifyJWT, {  
    secret: process.env.JWT_SECRET ?? "12345678", // fallback for testing  
  });  
  
  // register request context hook  
  app.addHook("onRequest", (request, reply, done) => {  
    RequestContext.create(db.em, done);  
  });  
  
  // register auth hook after the ORM one to use the context  
  app.addHook("onRequest", async (request) => {  
    try {  
      const ret = await request.jwtVerify<{ id: number }>();  
      request.user = await db.user.findOneOrFail(ret.id);  
    } catch (e) {  
      app.log.error(e);  
      // ignore token errors, we validate the request.user exists only where needed  
    }  
  });  
  
  // register global error handler to process 404 errors from `findOneOrFail` calls  
  app.setErrorHandler((error, request, reply) => {  
    if (error instanceof AuthError) {  
      return reply.status(401).send({ error: error.message });  
    }  
  
    if (error instanceof NotFoundError) {  
      return reply.status(404).send({ error: error.message });  
    }  
  
    app.log.error(error);  
    reply.status(500).send({ error: error.message });  
  });  
  
  // shut down the connection when closing the app  
  app.addHook("onClose", async () => {  
    await db.orm.close();  
  });  
  
  // register routes here  
  app.register(registerArticleRoutes, { prefix: "article" });  
  app.register(registerUserRoutes, { prefix: "user" });  
  
  const url = await app.listen({ port });  
  
  return { app, url, db };  
}  
```

--------------------------------

### Initialize Project with Yarn

Source: https://mikro-orm.io/docs/next/schema-first-guide

Initializes a new Node.js project using Yarn.

```bash
yarn init
```

--------------------------------

### Install renamer with npm

Source: https://mikro-orm.io/docs/next/schema-first-guide

Install the 'renamer' package as a development dependency using npm.

```bash
npm install --save-dev renamer  
```

--------------------------------

### MikroORM Migration CLI Commands

Source: https://mikro-orm.io/docs/next/guide/project-setup

Demonstrates essential MikroORM CLI commands for managing database migrations, including creation, listing, and execution.

```bash
# create new migration based on the schema difference
npx mikro-orm migration:create

# list pending migrations
npx mikro-orm migration:pending

# run the pending migrations
npx mikro-orm migration:up

# list executed migrations
npx mikro-orm migration:list
```

--------------------------------

### Install pluralize package

Source: https://mikro-orm.io/docs/next/schema-first-guide

Install the pluralize package and its types for automatic singular/plural transformations.

```bash
npm install --save-dev pluralize @types/pluralize  
```

```bash
yarn add --dev pluralize @types/pluralize  
```

```bash
pnpm add --save-dev pluralize @types/pluralize  
```

```bash
bun add --dev pluralize @types/pluralize  
```
Tokens:
Raw