TypeORM 数据源(DataSource)详解与使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00394/article/details/148326421

TypeORM 数据源(DataSource)详解与使用指南

typeorm TypeORM 是一个用于 JavaScript 和 TypeScript 的 ORM（对象关系映射）库，用于在 Node.js 中操作关系数据库。* 提供了一种将 JavaScript 对象映射到关系数据库中的方法；支持多种数据库，如 MySQL、PostgreSQL、MariaDB、SQLite 等；支持查询构建器和实体关系映射。* 特点：支持 TypeScript；支持异步操作；支持迁移和种子功能；支持复杂查询。项目地址: https://gitcode.com/gh_mirrors/ty/typeorm

什么是数据源(DataSource)

在 TypeORM 中，DataSource 是与数据库交互的核心组件。它相当于数据库连接的中央管理器，负责以下关键功能：

连接配置管理：存储数据库连接的所有配置参数
连接池管理：根据使用的RDBMS类型，建立初始数据库连接或连接池
生命周期控制：通过initialize和destroy方法管理连接的创建和销毁

数据源的生命周期通常与应用程序一致：

在应用启动时调用initialize建立连接
在应用结束时调用destroy关闭连接（对于长期运行的服务器应用，通常不需要主动销毁）

创建数据源实例

创建数据源的基本流程如下：

import { DataSource } from "typeorm"

// 创建数据源实例
const AppDataSource = new DataSource({
    type: "mysql",       // 数据库类型
    host: "localhost",   // 数据库主机地址
    port: 3306,          // 数据库端口
    username: "test",    // 数据库用户名
    password: "test",    // 数据库密码
    database: "test",    // 数据库名称
    entities: [/* 实体类列表 */],  // 使用的实体类
    synchronize: true    // 是否自动同步数据库结构
})

// 初始化连接
AppDataSource.initialize()
    .then(() => console.log("数据库连接已建立"))
    .catch(err => console.error("连接失败", err))

关键配置选项

数据源支持多种配置参数，主要分为：

基础连接配置：
- type: 数据库类型(mysql/postgres/sqlite等)
- host/port: 数据库地址和端口
- username/password: 认证信息
- database: 数据库名称
高级配置：
- entities: 使用的实体类列表
- synchronize: 是否自动同步数据库结构(开发环境使用)
- logging: 是否启用SQL日志
- poolSize: 连接池大小
多数据源场景：可以创建多个数据源实例，分别连接不同的数据库：

const PrimaryDB = new DataSource({ /* 主库配置 */ });
const ReportDB = new DataSource({ /* 报表库配置 */ });

数据源的使用方法

初始化后的数据源可以在应用的任何地方使用，主要通过以下两种方式操作数据库：

1. 使用EntityManager

import { AppDataSource } from "./data-source"
import { User } from "../entity/User"

// 使用实体管理器进行CRUD操作
const userRepository = AppDataSource.manager;
const users = await userRepository.find(User);
const newUser = userRepository.create(User, { /* 数据 */ });
await userRepository.save(newUser);

2. 使用Repository模式

// 获取特定实体的Repository
const userRepository = AppDataSource.getRepository(User);

// 使用Repository API
const adminUsers = await userRepository.findBy({ role: "admin" });
const userCount = await userRepository.count();