• 快速开始

    快速开始

    开始使用 TypeORM 的最快方法是使用其 CLI 命令生成启动项目。只有在 NodeJS 应用程序中使用 TypeORM 时，此操作才有效。如果你使用的是其他平台，请继续执行分步指南。

    首先全局安装 TypeORM:

    1. npm install typeorm -g

    然后转到要创建新项目的目录并运行命令：

    1. typeorm init --name MyProject --database mysql

    其中name是项目的名称，database是您将使用的数据库。

    数据库可以是以下值之一: mysql, mariadb, postgres, sqlite, mssql, oracle, mongodb,cordova, react-native, expo, nativescript.

    此命令将在MyProject目录中生成一个包含以下文件的新项目:

    1. MyProject
    2. ├── src              // TypeScript 代码
    3. │   ├── entity       // 存储实体（数据库模型）的位置
    4. │   │   └── User.ts  // 示例 entity
    5. │   ├── migration    // 存储迁移的目录
    6. │   └── index.ts     // 程序执行主文件
    7. ├── .gitignore       // gitignore文件
    8. ├── ormconfig.json   // ORM和数据库连接配置
    9. ├── package.json     // node module 依赖
    10. ├── README.md        // 简单的 readme 文件
    11. └── tsconfig.json    // TypeScript 编译选项

    你还可以在现有 node 项目上运行typeorm init，但要注意，此操作可能会覆盖已有的某些文件。

    接下来安装项目依赖项：

    1. cd MyProject
    2. npm install

    在安装过程中，编辑ormconfig.json文件并在其中放置您自己的数据库连接配置选项：

    1. {
    2.   "type": "mysql",
    3.   "host": "localhost",
    4.   "port": 3306,
    5.   "username": "test",
    6.   "password": "test",
    7.   "database": "test",
    8.   "synchronize": true,
    9.   "logging": false,
    10.   "entities": ["src/entity/**/*.ts"],
    11.   "migrations": ["src/migration/**/*.ts"],
    12.   "subscribers": ["src/subscriber/**/*.ts"]
    13. }

    绝大多数情况下，你只需要配置host, username, password, database 或者 port。

    完成配置并安装所有 node modules 后，即可运行应用程序：

    1. npm start

    至此你的应用程序应该成功运行并将新用户插入数据库。你可以继续使用此项目并集成所需的其他模块并创建更多实体。

    你可以通过运行typeorm init --name MyProject --database mysql --express来生成一个更高级的 Express 项目