NestJS Enterprise Backend APIs · 课时

TypeORM 集成基础

在 NestJS 中设置 TypeORM、定义实体，并使用存储库执行基本数据库操作。

TypeORM 集成基础 是 CoddyKit 上的免费 NestJS Enterprise Backend APIs 课时。这是第 3 节课，共 3 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 NestJS Enterprise Backend APIs 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 NestJS Enterprise Backend APIs 课程共包含 3 节课。

本课时的部分内容尚未翻译，以英文显示。

Intro to TypeORM in NestJS

Welcome to integrating TypeORM with NestJS! TypeORM is an Object-Relational Mapper (ORM) that helps you work with databases using TypeScript or JavaScript.

Instead of writing raw SQL queries, you interact with your database using familiar object-oriented programming concepts like classes and objects.

Why Use an ORM?

ORMs like TypeORM offer several benefits:

Abstraction: No need to write complex SQL.
Type Safety: With TypeScript, your database interactions are type-checked.
Portability: Easily switch between different database systems (PostgreSQL, MySQL, SQLite, etc.).
Productivity: Faster development with less boilerplate code.

Setting Up TypeORM Module

First, we need to install TypeORM and the database driver for your chosen database (e.g., pg for PostgreSQL, sqlite3 for SQLite).

Then, we configure the TypeOrmModule in your main application module (usually AppModule) to establish the database connection.

TypeOrmModule Configuration

Here's how you might configure TypeORM in your app.module.ts. This example uses SQLite for simplicity, which stores data in a file.

We use TypeOrmModule.forRoot() to set up the connection globally.

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'sqlite',
      database: 'db.sqlite',
      entities: [], // We'll add our entities here soon!
      synchronize: true, // Auto-create tables (dev only!)
    }),
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

Defining Your First Entity

An Entity is a class that maps directly to a database table. Each instance of the entity class represents a row in that table.

We use decorators like @Entity(), @PrimaryGeneratedColumn(), and @Column() to define the table and its columns.

User Entity Example

Let's create a simple User entity. This will map to a user table in our database.

@PrimaryGeneratedColumn() creates an auto-incrementing primary key.
@Column() defines a regular column.

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @Column({ default: true })
  isActive: boolean;
}

Registering Entities in Module

After defining your entity, you need to tell TypeORM about it. Update your AppModule's TypeOrmModule.forRoot() configuration to include your new User entity.

This allows TypeORM to create the corresponding table in your database.

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './user.entity'; // Import your entity

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'sqlite',
      database: 'db.sqlite',
      entities: [User], // Register your User entity here
      synchronize: true,
    }),
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

Introducing Repositories

TypeORM Repositories are objects that provide methods for interacting with a specific entity's table in the database.

You inject a repository into your NestJS service (e.g., UserService) to perform CRUD operations (Create, Read, Update, Delete).

Basic Operations: Create & Read

To use a repository, you inject it using @InjectRepository(). Let's see how to create a new user and retrieve all users.

save(): Inserts a new record or updates an existing one.
find(): Retrieves all records for the entity.

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';

@Injectable()
export class UserService {
  constructor(
    @InjectRepository(User)
    private usersRepository: Repository<User>,
  ) {}

  async createUser(): Promise<User> {
    const newUser = this.usersRepository.create({
      firstName: 'Coddy',
      lastName: 'Kit',
      isActive: true,
    });
    return this.usersRepository.save(newUser);
  }

  async findAll(): Promise<User[]> {
    return this.usersRepository.find();
  }
}

TypeORM Quick Check

Which decorator is used to mark a class as an entity that maps to a database table in TypeORM?

Recap: TypeORM Basics

You've learned the basics of integrating TypeORM into your NestJS application!

We configured TypeOrmModule in our AppModule.
We defined an Entity using decorators like @Entity(), @PrimaryGeneratedColumn(), and @Column().
We understood how to use Repositories to perform basic database operations like creating and reading records.

Next, you'll explore more advanced CRUD operations and data handling techniques!

常见问题解答

「TypeORM 集成基础」课时是免费的吗？

是的 — 「TypeORM 集成基础」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 NestJS Enterprise Backend APIs 课程的其余内容，请升级到 CoddyKit PRO。 NestJS Enterprise Backend APIs 课程共包含 3 节课。

「TypeORM 集成基础」这节课中我会学到什么？

在 NestJS 中设置 TypeORM、定义实体，并使用存储库执行基本数据库操作。你通过在浏览器中直接运行的动手代码来练习 NestJS Enterprise Backend APIs，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 NestJS Enterprise Backend APIs 需要有经验吗？

无需任何先前经验。CoddyKit 上的 NestJS Enterprise Backend APIs 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 3 节课，共 3 节。

「TypeORM 集成基础」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 NestJS Enterprise Backend APIs 课中编写并运行代码吗？

能。每节 NestJS Enterprise Backend APIs 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 NestJS Enterprise Backend APIs