如何在 NestJS 中使用 TypeORM 实现多数据库连接配置

2024-01-09 00:36

本文主要是介绍如何在 NestJS 中使用 TypeORM 实现多数据库连接配置,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

当你打算在一个 NestJS 应用中操作多个数据库时,TypeORM 提供了优雅而强大的解决方案。在本教程中,我们将一步步了解如何在 NestJS 项目中配置 TypeORM 以使用多个数据库。

实现步骤

一、创建 NestJS 项目

如果你还没有一个 NestJS 项目,请使用以下命令创建一个新项目:

nest new multi-database-app

进入项目后,我们准备好基础设施。

二、安装 TypeORM 和数据库驱动

请确保你已安装了 TypeORM 并添加了对你将使用的数据库的支持。例如,如果你使用 MySQL 和 PostgreSQL,则需要安装它们的驱动:

npm install @nestjs/typeorm typeorm mysql pg

三、创建数据库配置文件

在项目的根目录下,创建两个配置文件 ormconfig.mysql.jsonormconfig.postgres.json,用于存放两个不同数据库的配置。

ormconfig.mysql.json 示例:

{"name": "mysqlConnection","type": "mysql","host": "localhost","port": 3306,"username": "your_mysql_username","password": "your_mysql_password","database": "your_mysql_db","entities": ["dist/**/*.entity{.ts,.js}"],"synchronize": true
}

ormconfig.postgres.json 示例:

{"name": "postgresConnection","type": "postgres","host": "localhost","port": 5432,"username": "your_postgres_username","password": "your_postgres_password","database": "your_postgres_db","entities": ["dist/**/*.entity{.ts,.js}"],"synchronize": true
}

确保配置文件对应到正确的数据库和认证信息。entities 配置了实体位置,方便 TypeORM 自动加载。

四、设置多个数据库连接

修改 app.module.ts 来包含多个数据库连接:

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as mysqlConfig from './ormconfig.mysql.json';
import * as postgresConfig from './ormconfig.postgres.json';@Module({imports: [TypeOrmModule.forRoot(mysqlConfig),TypeOrmModule.forRoot(postgresConfig)],
})
export class AppModule {}

我们使用 TypeOrmModule.forRoot() 方法两次,分别传入两个数据库的配置。

五、创建数据库实体

根据你的业务需求为每个数据库创建实体类。这里我们假设 MySQl 用于存储 User 实体,而 PostgreSQL 存储 Post 实体。

src 目录下创建 user.entity.ts

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';@Entity()
export class User {@PrimaryGeneratedColumn()id: number;@Column()name: string;
}

src 目录下创建 post.entity.ts

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';@Entity()
export class Post {@PrimaryGeneratedColumn()id: number;@Column()title: string;@Column()content: string;
}

确保这些实体类遵循 TypeORM 的装饰器模式进行定义。

六、在服务中注入并使用多个数据库连接

要在服务中使用不同的数据库连接,我们需要为每个数据库创建一个特殊的符号,让 NestJS 可以识别并注入正确的 Repository。

首先,创建两个服务类,users.service.ts(用于操作 MySQL 数据库的 User 实体)和 posts.service.ts(用于操作 PostgreSQL 数据库的 Post 实体)。

  1. UsersService - 使用 MySQL

    src 目录下创建 users.service.ts

    import { Injectable } from '@nestjs/common';
    import { InjectRepository } from '@nestjs/typeorm';
    import { User } from './user.entity';
    import { Repository } from 'typeorm';@Injectable()
    export class UsersService {constructor(@InjectRepository(User, 'mysqlConnection')private readonly userRepository: Repository<User>,) {}// 添加用户的逻辑async createUser(userInfo: CreateUserDto): Promise<User> {const user = this.userRepository.create(userInfo);return this.userRepository.save(user);}// 其他 CRUD 操作...
    }

    这里使用 InjectRepository 装饰器和连接名 mysqlConnection 来注入特定的 Repository。

  2. PostsService - 使用 PostgreSQL

    src 目录下创建 posts.service.ts

    import { Injectable } from '@nestjs/common';
    import { InjectRepository } from '@nestjs/typeorm';
    import { Post } from './post.entity';
    import { Repository } from 'typeorm';@Injectable()
    export class PostsService {constructor(@InjectRepository(Post, 'postgresConnection')private readonly postRepository: Repository<Post>,) {}// 添加文章的逻辑async createPost(postData: CreatePostDto): Promise<Post> {const post = this.postRepository.create(postData);return this.postRepository.save(post);}// 其他 CRUD 操作...
    }

    类似地,这里使用 InjectRepository 装饰器和连接名 postgresConnection 来注入 Post 的 Repository。

七、实现服务逻辑和 CRUD 示例

现在我们已经有了操作两个数据库的服务,我们可以在每个服务类中添加 CRUD 方法,实现数据的增删改查。

  1. 创建 DTOs (Data Transfer Objects)

    对于每个 CRUD 操作,建议使用 DTOs 来传递数据。在 src 目录下创建 create-user.dto.tscreate-post.dto.ts 文件定义 DTOs。

    create-user.dto.ts 示例:

    export class CreateUserDto {readonly name: string;
    }

    create-post.dto.ts 示例:

    export class CreatePostDto {readonly title: string;readonly content: string;
    }
  2. 完成 CRUD 操作

    UsersServicePostsService 服务中定义 CRUD 操作。我们已经为 UsersService 定义了 createUser 方法,现在让我们添加查询所有用户的方法:

    // users.service.tsasync getUsers(): Promise<User[]> {return this.userRepository.find();
    }

    类似地,在 PostsService 添加查询所有文章的方法:

    // posts.service.tsasync getPosts(): Promise<Post[]> {return this.postRepository.find();
    }

结语

现在你已经了解了在 NestJS 应用中使用 TypeORM 设置和操作多个数据库的完整流程。通过上述步骤,你不仅可以连接单一数据库,而且还能够灵活地同步操作多个数据库。

我们鼓励你根据自己的项目需求进一步探索 TypeORM 的高级特性,例如实体关系、事务管理、订阅功能和更多数据持久化的策略,从而充分利用异构数据库环境带来的优势。这将大大提升你的 NestJS 应用程序的可扩展性和健壮性。

这篇关于如何在 NestJS 中使用 TypeORM 实现多数据库连接配置的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/585379

相关文章

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

C++ Primer 多维数组的使用

《C++Primer多维数组的使用》本文主要介绍了多维数组在C++语言中的定义、初始化、下标引用以及使用范围for语句处理多维数组的方法,具有一定的参考价值,感兴趣的可以了解一下... 目录多维数组多维数组的初始化多维数组的下标引用使用范围for语句处理多维数组指针和多维数组多维数组严格来说,C++语言没

在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

《在SpringBoot中使用@Autowired和@Bean注解的示例详解》本文通过一个示例演示了如何在SpringBoot中使用@Autowired和@Bean注解进行依赖注入和Bean... 目录在 Spring Boot 中使用 @Autowired 和 @Bean 注解示例背景1. 定义 Stud

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque

Python如何实现PDF隐私信息检测

《Python如何实现PDF隐私信息检测》随着越来越多的个人信息以电子形式存储和传输,确保这些信息的安全至关重要,本文将介绍如何使用Python检测PDF文件中的隐私信息,需要的可以参考下... 目录项目背景技术栈代码解析功能说明运行结php果在当今,数据隐私保护变得尤为重要。随着越来越多的个人信息以电子形

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import

oracle DBMS_SQL.PARSE的使用方法和示例

《oracleDBMS_SQL.PARSE的使用方法和示例》DBMS_SQL是Oracle数据库中的一个强大包,用于动态构建和执行SQL语句,DBMS_SQL.PARSE过程解析SQL语句或PL/S... 目录语法示例注意事项DBMS_SQL 是 oracle 数据库中的一个强大包,它允许动态地构建和执行