TypeORM module setup in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the TypeORM module in a NestJS application?

The TypeORM module connects your NestJS app to a database, letting you work with data using objects instead of raw queries.

beginner

How do you import the TypeORM module in a NestJS app?

You import it in your module file using TypeOrmModule.forRoot() with database settings, then add it to the imports array.

intermediate

What key information must you provide in TypeOrmModule.forRoot()?

You must provide the database type, host, port, username, password, database name, and entities to use.

beginner

Why do you include entities in the TypeORM module setup?

Entities define the tables and structure of your database. Including them lets TypeORM know what data models to manage.

intermediate

What does setting synchronize: true do in TypeORM configuration?

It automatically creates or updates database tables to match your entities. Useful in development but risky in production.

Which method is used to configure the TypeORM module in NestJS?

A TypeOrmModule.setup()

B TypeOrmModule.forRoot()

C TypeOrmModule.configure()

D TypeOrmModule.init()

TypeOrmModule.forRoot() is the correct method to set up database connection options in NestJS.

What should you include in the entities array when setting up TypeORM?

A Entity classes representing tables

B Middleware functions

C Raw SQL queries

D Database table names as strings

Entities are classes that represent database tables, so you include those classes in the entities array.

What does setting synchronize: true do in TypeORM config?

A Disables database synchronization

B Encrypts database data

C Automatically updates database schema to match entities

D Enables logging of queries

Synchronize: true makes TypeORM update the database schema to match your entity definitions automatically.

Where do you add TypeOrmModule.forRoot() in a NestJS app?

A In the service file

B In the main.ts file

C In the controller file

D In the root module's imports array

You add TypeOrmModule.forRoot() in the imports array of the root module to initialize the database connection.

Which database types can you specify in TypeORM configuration?

A Multiple types like MySQL, PostgreSQL, SQLite, etc.

B Only PostgreSQL

C Only MySQL

D Only MongoDB

TypeORM supports many database types including MySQL, PostgreSQL, SQLite, and more.

Explain how to set up the TypeORM module in a NestJS application from scratch.

Think about what you need to connect your app to a database and tell NestJS about your data models.

Describe the role of the synchronize option in TypeORM configuration and when to use it.

Consider how your database tables stay in sync with your code models.

Practice

1. What is the main purpose of using TypeOrmModule.forRoot() in a NestJS application?

easy

A. To handle user authentication

B. To configure the database connection and entities for TypeORM

C. To create REST API endpoints automatically

D. To manage application state globally

Solution

1. Step 1: Understand the role of TypeOrmModule.forRoot()

   This method sets up the database connection and registers entities for TypeORM in NestJS.

2. Step 2: Identify what it does not do

   It does not create REST endpoints, handle authentication, or manage global state.

3. Final Answer:

   To configure the database connection and entities for TypeORM -> Option B

4. Quick Check:

   TypeOrmModule.forRoot() = Database setup [OK]

Hint: Remember: forRoot sets up DB connection and entities [OK]

Common Mistakes:

• Thinking it creates API routes
• Confusing it with authentication modules
• Assuming it manages app state

2. Which of the following is the correct way to import and configure TypeORM for PostgreSQL in a NestJS module?

easy

A. import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
imports: [TypeOrmModule.forRoot({
type: 'sqlite',
database: ':memory:',
entities: [User],
synchronize: false,
})],
})

B. import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
imports: [TypeOrmModule.forFeature({
type: 'postgres',
host: 'localhost',
port: 5432,
username: 'user',
password: 'pass',
database: 'testdb',
entities: [User],
synchronize: true,
})],
})

C. import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
imports: [TypeOrmModule.forRootAsync({
useFactory: () => ({
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'user',
password: 'pass',
database: 'testdb',
entities: [User],
synchronize: true,
}),
})],
})

D. import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
imports: [TypeOrmModule.forRoot({
type: 'postgres',
host: 'localhost',
port: 5432,
username: 'user',
password: 'pass',
database: 'testdb',
entities: [User],
synchronize: true,
})],
})

Solution

1. Step 1: Identify the correct method for root configuration

   TypeOrmModule.forRoot() is used to configure the main database connection with options like type, host, port, entities, and synchronize.

2. Step 2: Check the options and syntax

   import { TypeOrmModule } from '@nestjs/typeorm'; @Module({ imports: [TypeOrmModule.forRoot({ type: 'postgres', host: 'localhost', port: 5432, username: 'user', password: 'pass', database: 'testdb', entities: [User], synchronize: true, })], }) correctly uses forRoot with proper PostgreSQL database config and entities array. import { TypeOrmModule } from '@nestjs/typeorm'; @Module({ imports: [TypeOrmModule.forFeature({ type: 'postgres', host: 'localhost', port: 5432, username: 'user', password: 'pass', database: 'testdb', entities: [User], synchronize: true, })], }) incorrectly uses forFeature for root config. import { TypeOrmModule } from '@nestjs/typeorm'; @Module({ imports: [TypeOrmModule.forRootAsync({ useFactory: () => ({ type: 'mysql', host: 'localhost', port: 3306, username: 'user', password: 'pass', database: 'testdb', entities: [User], synchronize: true, }), })], }) uses forRootAsync with MySQL config instead of PostgreSQL. import { TypeOrmModule } from '@nestjs/typeorm'; @Module({ imports: [TypeOrmModule.forRoot({ type: 'sqlite', database: ':memory:', entities: [User], synchronize: false, })], }) uses SQLite config instead of PostgreSQL.

3. Final Answer:

   The PostgreSQL configuration using TypeOrmModule.forRoot() -> Option D

4. Quick Check:

   forRoot() = main DB config [OK]

Hint: Use forRoot() for main DB setup, forFeature() for repositories [OK]

Common Mistakes:

• Using forFeature() instead of forRoot() for DB config
• Confusing forRootAsync with forRoot without async needs
• Setting synchronize false during development

3. Given this TypeORM configuration snippet in a NestJS app:

TypeOrmModule.forRoot({
  type: 'sqlite',
  database: ':memory:',
  entities: [User],
  synchronize: true,
})

What will happen when the app starts?

medium

A. An in-memory SQLite database is created, tables for User entity are auto-created

B. A persistent SQLite file database is created on disk

C. The app throws an error because ':memory:' is invalid

D. The User entity tables are not created automatically

Solution

1. Step 1: Understand ':memory:' in SQLite config

   Using ':memory:' creates a temporary in-memory database that exists only while the app runs.

2. Step 2: Effect of synchronize: true

   With synchronize: true, TypeORM automatically creates tables for all entities (like User) on app start.

3. Final Answer:

   An in-memory SQLite database is created, tables for User entity are auto-created -> Option A

4. Quick Check:

   ':memory:' + synchronize: true = auto in-memory tables [OK]

Hint: ':memory:' means temporary DB; synchronize true creates tables [OK]

Common Mistakes:

• Thinking ':memory:' creates a file on disk
• Assuming tables need manual creation
• Believing ':memory:' is invalid syntax

4. You wrote this TypeORM setup in your NestJS app:

TypeOrmModule.forRoot({
  type: 'postgres',
  host: 'localhost',
  port: 5432,
  username: 'user',
  password: 'pass',
  database: 'testdb',
  entities: [User],
  synchronize: true
})

But the app crashes with an error: "Entity metadata not found for User". What is the likely cause?

medium

A. The User entity class is not imported or registered correctly in entities array

B. The database connection details are incorrect

C. synchronize: true is not allowed with Postgres

D. TypeOrmModule.forRoot() must be called inside a service, not a module

Solution

1. Step 1: Analyze the error message

   "Entity metadata not found for User" means TypeORM cannot find the User entity definition.

2. Step 2: Check entities registration

   This usually happens if the User entity class is not imported or not included properly in the entities array of the config.

3. Final Answer:

   The User entity class is not imported or registered correctly in entities array -> Option A

4. Quick Check:

   Missing entity import = metadata error [OK]

Hint: Always import and add entities to entities array [OK]

Common Mistakes:

• Forgetting to import entity classes
• Misplacing entities array outside forRoot config
• Assuming synchronize causes this error

5. You want to set up TypeORM in a NestJS app to connect to a MySQL database, but only synchronize the schema during development, not in production. Which setup correctly achieves this?

hard

A. TypeOrmModule.forRoot({
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'root',
password: 'pass',
database: 'appdb',
entities: [User],
synchronize: false,
})

B. TypeOrmModule.forRoot({
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'root',
password: 'pass',
database: 'appdb',
entities: [User],
synchronize: true,
})

C. TypeOrmModule.forRoot({
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'root',
password: 'pass',
database: 'appdb',
entities: [User],
synchronize: process.env.NODE_ENV === 'development',
})

D. TypeOrmModule.forRootAsync({
useFactory: () => ({
type: 'mysql',
host: 'localhost',
port: 3306,
username: 'root',
password: 'pass',
database: 'appdb',
entities: [User],
synchronize: false,
}),
})

Solution

1. Step 1: Understand conditional synchronize setting

   To synchronize only in development, synchronize should be true only when NODE_ENV is 'development'.

2. Step 2: Check options for conditional synchronize

   TypeOrmModule.forRoot({ type: 'mysql', host: 'localhost', port: 3306, username: 'root', password: 'pass', database: 'appdb', entities: [User], synchronize: process.env.NODE_ENV === 'development', }) uses synchronize: process.env.NODE_ENV === 'development', which correctly sets synchronize true only in development.

3. Step 3: Review other options

   TypeOrmModule.forRoot({ type: 'mysql', host: 'localhost', port: 3306, username: 'root', password: 'pass', database: 'appdb', entities: [User], synchronize: true, }) always synchronizes (bad for production). TypeOrmModule.forRoot({ type: 'mysql', host: 'localhost', port: 3306, username: 'root', password: 'pass', database: 'appdb', entities: [User], synchronize: false, }) never synchronizes (bad for development). TypeOrmModule.forRootAsync({ useFactory: () => ({ type: 'mysql', host: 'localhost', port: 3306, username: 'root', password: 'pass', database: 'appdb', entities: [User], synchronize: false, }), }) uses forRootAsync but sets synchronize false always, so no conditional sync.

4. Final Answer:

   synchronize: process.env.NODE_ENV === 'development' -> Option C

5. Quick Check:

   Conditional synchronize = process.env.NODE_ENV check [OK]

Hint: Use environment variable to toggle synchronize true/false [OK]

Common Mistakes:

• Always setting synchronize true in production
• Never enabling synchronize during development
• Not using environment variables for config