TypeORM 项目教程

TypeORM 项目教程

项目地址:https://gitcode.com/gh_mirrors/type/typeorm

1. 项目的目录结构及介绍

TypeORM 项目的目录结构通常包含以下几个主要部分：

• src/：源代码目录，包含所有的 TypeScript 文件。
• entity/：实体目录，存放数据库表对应的实体类。
• migration/：迁移目录，存放数据库迁移脚本。
• subscriber/：订阅者目录，存放数据库事件订阅者。
• ormconfig.json：配置文件，用于配置数据库连接等参数。

目录结构示例

typeorm-project/
├── src/
│   ├── entity/
│   │   ├── User.ts
│   │   └── Post.ts
│   ├── migration/
│   │   ├── 1599039827321-CreateUser.ts
│   │   └── 1599039827322-CreatePost.ts
│   ├── subscriber/
│   │   └── UserSubscriber.ts
│   └── index.ts
├── ormconfig.json
└── package.json

目录介绍

• src/entity/：存放实体类，每个实体类对应数据库中的一张表。
• src/migration/：存放数据库迁移脚本，用于数据库结构的版本控制。
• src/subscriber/：存放数据库事件订阅者，用于监听数据库事件并执行相应操作。
• ormconfig.json：配置文件，包含数据库连接信息和其他配置选项。

2. 项目的启动文件介绍

项目的启动文件通常是 src/index.ts，它负责初始化数据库连接并启动应用。

启动文件示例

import "reflect-metadata";
import { createConnection } from "typeorm";
import { User } from "./entity/User";

createConnection().then(async connection => {
    console.log("Connected to the database");

    const user = new User();
    user.firstName = "John";
    user.lastName = "Doe";
    user.age = 25;

    await connection.manager.save(user);
    console.log("User has been saved");

}).catch(error => console.log(error));

启动文件介绍

• createConnection()：创建数据库连接。
• User：实体类，对应数据库中的 user 表。
• connection.manager.save(user)：保存用户实体到数据库。

3. 项目的配置文件介绍

项目的配置文件通常是 ormconfig.json，它包含数据库连接信息和其他配置选项。

配置文件示例

{
    "type": "mysql",
    "host": "localhost",
    "port": 3306,
    "username": "root",
    "password": "password",
    "database": "test",
    "synchronize": true,
    "logging": false,
    "entities": [
        "src/entity/**/*.ts"
    ],
    "migrations": [
        "src/migration/**/*.ts"
    ],
    "subscribers": [
        "src/subscriber/**/*.ts"
    ],
    "cli": {
        "entitiesDir": "src/entity",
        "migrationsDir": "src/migration",
        "subscribersDir": "src/subscriber"
    }
}

配置文件介绍

• type：数据库类型，如 mysql、postgres 等。
• host：数据库主机地址。
• port：数据库端口号。
• username：数据库用户名。
• password：数据库密码。
• database：数据库名称。
• synchronize：是否自动同步数据库结构。
• logging：是否开启日志记录。
• entities：实体类文件路径。
• migrations：迁移脚本文件路径。
• subscribers：订阅者文件路径。
• cli：命令行工具配置。

以上是 TypeORM 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

typeorm Forked from https://github.com/typeorm/typeorm 项目地址: https://gitcode.com/gh_mirrors/type/typeorm