📜  typeorm config - Javascript (1)

📅  最后修改于: 2023-12-03 14:48:04.516000             🧑  作者: Mango

TypeORM 配置

TypeORM 是一个强大的 ORM(对象关系映射)框架,用于将数据库与应用程序的对象模型相匹配。在使用 TypeORM 时,需要进行一些基本的配置和设置。本文将介绍如何通过 typeorm config 命令进行配置。

安装

首先,需要安装 TypeORM。可以使用以下命令:

npm install typeorm -g
typeorm config 命令

typeorm config 命令可用于生成 TypeORM 配置文件。该命令将提示您输入一些信息,生成 ormconfig.json 文件。

以下是生成 ormconfig.json 文件所需的信息:

  1. 数据库类型 - 使用什么类型的数据库,例如 MySQL、PostgreSQL、SQLite 等。
  2. 主机 - 数据库主机的名称。
  3. 端口 - 数据库端口号,默认为数据库的默认端口。
  4. 用户名 - 连接数据库的用户名。
  5. 密码 - 连接数据库的密码。
  6. 数据库名称 - 要连接的数据库的名称。

您还可以选择使用其它选项,如生成包含 TypeORM 配置的 JavaScript 文件(默认情况下为 ormconfig.json 文件)。

以下是使用 typeorm config 命令生成 ormconfig.json 文件的示例:

typeorm config -f ormconfig.js -n myapp -d mysql -h localhost -u myuser -p mypassword --port 3306

这将生成名为 ormconfig.js 的 JavaScript 文件,并配置连接到名为 myapp 的 MySQL 数据库。数据库主机是 localhost,用户名是 myuser,密码是 mypassword,而端口号为 3306。

配置选项

以下是可以配置的一些选项:

Database Connection Options

| Option | Description | Default | | --- | --- | --- | | type | 数据库类型 | n/a | | host | 数据库主机 | 'localhost' | | port | 数据库端口号 | n/a | | username | 连接数据库的用户名 | n/a | | password | 连接数据库的密码 | n/a | | database | 要连接的数据库名称 | n/a |

ORM Configuration Options

| Option | Description | Default | | --- | --- | --- | | entities | 实体文件的位置(相对于项目根目录) | ['src/entity/**/*.ts'] | | migrations | 迁移文件的位置(相对于项目根目录) | ['src/migration/**/*.ts'] | | subscribers | 订阅者文件的位置(相对于项目根目录) | ['src/subscriber/**/*.ts'] | | cli | 应为 CLI 建立链接的信息 | {} |

结论

TypeORM 是一个强大的 ORM 框架。通过 typeorm config 命令,可以轻松生成配置文件。在配置文件中,您可以指定数据库连接选项和 ORM 配置选项。具有正确的配置,您可以开始使用 TypeORM,将数据库与应用程序的对象模型相匹配。