{"id":13485155,"url":"https://github.com/denolib/typeorm","last_synced_at":"2025-11-09T12:01:44.981Z","repository":{"id":33914107,"uuid":"162539305","full_name":"denolib/typeorm","owner":"denolib","description":"Forked from https://github.com/typeorm/typeorm","archived":false,"fork":false,"pushed_at":"2022-12-30T19:33:17.000Z","size":9615,"stargazers_count":119,"open_issues_count":39,"forks_count":16,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-08-11T04:44:05.318Z","etag":null,"topics":["deno","deno-module","typeorm"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/denolib.png","metadata":{"files":{"readme":"README-zh_CN.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":"typeorm","ko_fi":null,"tidelift":null,"custom":null}},"created_at":"2018-12-20T06:55:44.000Z","updated_at":"2024-12-16T14:48:17.000Z","dependencies_parsed_at":"2023-01-15T03:31:23.587Z","dependency_job_id":null,"html_url":"https://github.com/denolib/typeorm","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/denolib/typeorm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denolib%2Ftypeorm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denolib%2Ftypeorm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denolib%2Ftypeorm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denolib%2Ftypeorm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/denolib","download_url":"https://codeload.github.com/denolib/typeorm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denolib%2Ftypeorm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270625132,"owners_count":24618327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deno","deno-module","typeorm"],"created_at":"2024-07-31T17:01:48.193Z","updated_at":"2025-11-09T12:01:42.816Z","avatar_url":"https://github.com/denolib.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"http://typeorm.io/\"\u003e\n    \u003cimg src=\"https://github.com/typeorm/typeorm/raw/master/resources/logo_big.png\" width=\"492\" height=\"228\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\t\u003ca href=\"https://travis-ci.org/typeorm/typeorm\"\u003e\n\t\t\u003cimg src=\"https://travis-ci.org/typeorm/typeorm.svg?branch=master\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://badge.fury.io/js/typeorm\"\u003e\n\t\t\u003cimg src=\"https://badge.fury.io/js/typeorm.svg\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://david-dm.org/typeorm/typeorm\"\u003e\n\t\t\u003cimg src=\"https://david-dm.org/typeorm/typeorm.svg\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://gitter.im/typeorm/typeorm?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\"\u003e\n\t\t\u003cimg src=\"https://badges.gitter.im/typeorm/typeorm.svg\"\u003e\n\t\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/div\u003e\n\nTypeORM 是一个 [ORM](https://en.wikipedia.org/wiki/Object-relational_mapping) 框架，它可以运行在 NodeJS、Browser、Cordova、PhoneGap、Ionic、React Native、Expo 和 Electron 平台上，可以与 TypeScript 和 JavaScript (ES5,ES6,ES7,ES8)一起使用。 它的目标是始终支持最新的 JavaScript 特性并提供额外的特性以帮助你开发任何使用数据库的（不管是只有几张表的小型应用还是拥有多数据库的大型企业应用）应用程序。\n\n不同于现有的所有其他 JavaScript ORM 框架，TypeORM 支持 [Active Record](./docs/active-record-data-mapper.md#what-is-the-active-record-pattern) 和 [Data Mapper](./docs/active-record-data-mapper.md#what-is-the-data-mapper-pattern) 模式，这意味着你可以以最高效的方式编写高质量的、松耦合的、可扩展的、可维护的应用程序。\n\nTypeORM 参考了很多其他优秀 ORM 的实现, 比如 [Hibernate](http://hibernate.org/orm/), [Doctrine](http://www.doctrine-project.org/) 和 [Entity Framework](https://www.asp.net/entity-framework)。\n\nTypeORM 的一些特性:\n\n- 同时支持 [DataMapper](./docs/active-record-data-mapper.md#what-is-the-data-mapper-pattern) 和 [ActiveRecord](./docs/active-record-data-mapper.md#what-is-the-active-record-pattern) (随你选择)\n- 实体和列\n- 数据库特性列类型\n- 实体管理\n- 存储库和自定义存储库\n- 清晰的对象关系模型\n- 关联（关系）\n- 贪婪和延迟关系\n- 单向的，双向的和自引用的关系\n- 支持多重继承模式\n- 级联\n- 索引\n- 事务\n- 迁移和自动迁移\n- 连接池\n- 主从复制\n- 使用多个数据库连接\n- 使用多个数据库类型\n- 跨数据库和跨模式查询\n- 优雅的语法，灵活而强大的 QueryBuilder\n- 左联接和内联接\n- 使用联查查询的适当分页\n- 查询缓存\n- 原始结果流\n- 日志\n- 监听者和订阅者（钩子）\n- 支持闭包表模式\n- 在模型或者分离的配置文件中声明模式\n- json / xml / yml / env 格式的连接配置\n- 支持 MySQL / MariaDB / Postgres / SQLite / Microsoft SQL Server / Oracle / SAP Hana / sql.js\n- 支持 MongoDB NoSQL 数据库\n- 可在 NodeJS / 浏览器 / Ionic / Cordova / React Native / Expo / Electron 平台上使用\n- 支持 TypeScript 和 JavaScript\n- 生成高性能、灵活、清晰和可维护的代码\n- 遵循所有可能的最佳实践\n- 命令行工具\n\n还有更多...\n\n通过使用 `TypeORM` 你的 `models` 看起来如下:\n\n```typescript\nimport { Entity, PrimaryGeneratedColumn, Column } from \"typeorm\";\n\n@Entity()\nexport class User {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column()\n  firstName: string;\n\n  @Column()\n  lastName: string;\n\n  @Column()\n  age: number;\n}\n```\n\n逻辑操作如下:\n\n```typescript\nconst user = new User();\nuser.firstName = \"Timber\";\nuser.lastName = \"Saw\";\nuser.age = 25;\nawait repository.save(user);\n\nconst allUsers = await repository.find();\nconst firstUser = await repository.findOne(1); // 根据id查找\nconst timber = await repository.findOne({ firstName: \"Timber\", lastName: \"Saw\" });\n\nawait repository.remove(timber);\n```\n\n或者，如果你更喜欢使用 `ActiveRecord` 模式，也可以这样用：\n\n```typescript\nimport { Entity, PrimaryGeneratedColumn, Column, BaseEntity } from \"typeorm\";\n\n@Entity()\nexport class User extends BaseEntity {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column()\n  firstName: string;\n\n  @Column()\n  lastName: string;\n\n  @Column()\n  age: number;\n}\n```\n\n逻辑操作如下所示:\n\n```typescript\nconst user = new User();\nuser.firstName = \"Timber\";\nuser.lastName = \"Saw\";\nuser.age = 25;\nawait user.save();\n\nconst allUsers = await User.find();\nconst firstUser = await User.findOne(1);\nconst timber = await User.findOne({ firstName: \"Timber\", lastName: \"Saw\" });\n\nawait timber.remove();\n```\n\n# 入门\n\n## 安装\n\n1. 通过 `npm` 安装:\n\n   `npm install typeorm --save`\n\n2. 你还需要安装 `reflect-metadata`:\n\n   `npm install reflect-metadata --save`\n\n   并且需要在应用程序的全局位置导入（例如在`app.ts`中）\n\n   `import \"reflect-metadata\";`\n\n3. 你可能还需要安装 node typings(以此来使用 Node 的智能提示):\n\n   `npm install @types/node --save`\n\n4. 安装数据库驱动:\n\n   - **MySQL** 或者 **MariaDB**\n\n     `npm install mysql --save` (也可以安装 `mysql2`)\n\n   - **PostgreSQL**\n\n     `npm install pg --save`\n\n   - **SQLite**\n\n     `npm install sqlite3 --save`\n\n   - **Microsoft SQL Server**\n\n     `npm install mssql --save`\n\n   - **sql.js**\n\n     `npm install sql.js --save`\n\n   - **Oracle**\n\n     `npm install oracledb --save`\n\n     根据你使用的数据库，仅安装其中*一个*即可。\n     要使 Oracle 驱动程序正常工作，需要按照其[站点](https://github.com/oracle/node-oracledb)中的安装说明进行操作。\n\n   - **MongoDB** (试验性)\n\n     `npm install mongodb --save`\n\n   - **NativeScript**, **react-native** 和 **Cordova**\n\n     查看 [支持的平台](/supported-platforms.md)\n\n   - **SAP Hana**\n\n     ```\n     npm config set @sap:registry https://npm.sap.com\n     npm i @sap/hdbext\n     ```\n\n##### TypeScript 配置\n\n此外，请确保你使用的 TypeScript 编译器版本是**3.3**或更高版本，并且已经在 `tsconfig.json` 中启用了以下设置:\n\n```json\n\"emitDecoratorMetadata\": true,\n\"experimentalDecorators\": true,\n```\n\n除此之外，你可能还需要在编译器选项的 `lib` 中启用 `es6`，或者安装 `es6-shim` 的 `@types`。\n\n## 快速开始\n\n快速上手 TypeORM 的方法是使用其 CLI 命令生成启动项目。\n但是只有在 NodeJS 应用程序中使用 TypeORM 时，此操作才有效。如果你使用的是其他平台，请查看[分步指南](#分步指南)。\n\n首先全局安装 TypeORM:\n\n```\nnpm install typeorm -g\n```\n\n然后转到要创建新项目的目录并运行命令：\n\n```\ntypeorm init --name MyProject --database mysql\n```\n\n其中 `name` 是项目的名称，`database` 是将使用的数据库。\n\n数据库可以是以下值之一: `mysql`、 `mariadb`、 `postgres`、 `sqlite`、 `mssql`、 `oracle`、 `mongodb`、\n`cordova`、 `react-native`、 `expo`、 `nativescript`.\n\n此命令将在 `MyProject` 目录中生成一个包含以下文件的新项目:\n\n```\nMyProject\n├── src              // TypeScript 代码\n│   ├── entity       // 存储实体（数据库模型）的位置\n│   │   └── User.ts  // 示例 entity\n│   ├── migration    // 存储迁移的目录\n│   └── index.ts     // 程序执行主文件\n├── .gitignore       // gitignore文件\n├── ormconfig.json   // ORM和数据库连接配置\n├── package.json     // node module 依赖\n├── README.md        // 简单的 readme 文件\n└── tsconfig.json    // TypeScript 编译选项\n```\n\n\u003e 你还可以在现有 node 项目上运行 `typeorm init`，但要注意，此操作可能会覆盖已有的某些文件。\n\n接下来安装项目依赖项：\n\n```\ncd MyProject\nnpm install\n```\n\n在安装过程中，编辑 `ormconfig.json` 文件并在其中编辑自己的数据库连接配置选项：\n\n```json\n{\n  \"type\": \"mysql\",\n  \"host\": \"localhost\",\n  \"port\": 3306,\n  \"username\": \"test\",\n  \"password\": \"test\",\n  \"database\": \"test\",\n  \"synchronize\": true,\n  \"logging\": false,\n  \"entities\": [\"src/entity/**/*.ts\"],\n  \"migrations\": [\"src/migration/**/*.ts\"],\n  \"subscribers\": [\"src/subscriber/**/*.ts\"]\n}\n```\n\n绝大多数情况下，你只需要配置 `host`, `username`, `password`, `database` 或者 `port` 即可。\n\n完成配置并安装所有 node modules 后，即可运行应用程序：\n\n```\nnpm start\n```\n\n至此你的应用程序应该成功运行并将新用户插入数据库。你可以继续使用此项目并集成所需的其他模块并创建更多实体。\n\n\u003e 你可以通过运行 `typeorm init --name MyProject --database mysql --express` 来生成一个更高级的 Express 项目\n\n## 分步指南\n\n你对 ORM 有何期待？期望它将为你创建数据库表，并且无需编写大量难以维护的 SQL 语句来查找/插入/更新/删除数据。本指南将向你展示如何从头开始设置 TypeORM 并实现这些操作。\n\n### 创建一个模型\n\n使用数据库从创建表开始。如何告诉 TypeORM 创建数据库表？答案是 - 通过模型。\n应用程序中的模型即是数据库中的表。\n\n举个例子, 你有一个 `Photo` 模型:\n\n```typescript\nexport class Photo {\n  id: number;\n  name: string;\n  description: string;\n  filename: string;\n  views: number;\n}\n```\n\n并且希望将 photos 存储在数据库中。要在数据库中存储内容，首先需要一个数据库表，并从模型中创建数据库表。但是并非所有模型，只有定义为*entities*的模型。\n\n### 创建一个实体\n\n*实体*是由 `@Entity` 装饰器装饰的模型。将为此类模型创建数据库表。你可以使用 TypeORM 处理各处的实体，可以使用它们 load/insert/update/remove 并执行其他操作。\n\n让我们将 `Photo` 模型作为一个实体\n\n```typescript\nimport { Entity } from \"typeorm\";\n\n@Entity()\nexport class Photo {\n  id: number;\n  name: string;\n  description: string;\n  filename: string;\n  views: number;\n  isPublished: boolean;\n}\n```\n\n现在，将为 `Photo` 实体创建一个数据库表，我们将能够在应用程序中的任何位置使用它。\n我们已经创建了一个数据库表，但是没有指明哪个字段属于哪一列，下面让我们在数据库表中创建列。\n\n### 添加表列\n\n要添加数据库列，你只需要将要生成的实体属性加上 `@Column` 装饰器。\n\n```typescript\nimport { Entity, Column } from \"typeorm\";\n\n@Entity()\nexport class Photo {\n  @Column()\n  id: number;\n\n  @Column()\n  name: string;\n\n  @Column()\n  description: string;\n\n  @Column()\n  filename: string;\n\n  @Column()\n  views: number;\n\n  @Column()\n  isPublished: boolean;\n}\n```\n\n现在 `id`, `name`, `description`, `filename`, `views` 和 `isPublished` 列将会被添加到 `photo` 表中。\n数据库中的列类型是根据你使用的属性类型推断的，例如： `number` 将被转换为 `integer`，`string` 将转换为 `varchar`，`boolean` 转换为 `bool` 等。但你也可以通过 `@Column` 装饰器中隐式指定列类型来使用数据库支持的任何列类型。\n\n我们已经生成了一个包含列的数据库表，但是别忘了，每个数据库表必须具有包含主键的列。\n\n### 创建主列\n\n每个**必须**至少有一个主键列。这是必须的，你无法避免。要使列成为主键，你需要使用 `@PrimaryColumn` 装饰器。\n\n```typescript\nimport { Entity, Column, PrimaryColumn } from \"typeorm\";\n\n@Entity()\nexport class Photo {\n  @PrimaryColumn()\n  id: number;\n\n  @Column()\n  name: string;\n\n  @Column()\n  description: string;\n\n  @Column()\n  filename: string;\n\n  @Column()\n  views: number;\n\n  @Column()\n  isPublished: boolean;\n}\n```\n\n### 创建自动生成的列\n\n假设你希望 id 列自动生成（这称为 auto-increment/sequence/serial/generated identity column）。为此你需要将`@PrimaryColumn` 装饰器更改为 `@PrimaryGeneratedColumn` 装饰器：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn } from \"typeorm\";\n\n@Entity()\nexport class Photo {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column()\n  name: string;\n\n  @Column()\n  description: string;\n\n  @Column()\n  filename: string;\n\n  @Column()\n  views: number;\n\n  @Column()\n  isPublished: boolean;\n}\n```\n\n### 列数据类型\n\n接下来，让我们修改数据类型。默认情况下，字符串被映射到一个 varchar(255) 类型（取决于数据库类型）。\n数字被映射到一个类似 integer 类型（取决于数据库类型）。但是我们不希望所有的列都是有限的 varchars 或 integer，让我们修改下代码以设置想要的数据类型：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn } from \"typeorm\";\n\n@Entity()\nexport class Photo {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column({\n    length: 100\n  })\n  name: string;\n\n  @Column(\"text\")\n  description: string;\n\n  @Column()\n  filename: string;\n\n  @Column(\"double\")\n  views: number;\n\n  @Column()\n  isPublished: boolean;\n}\n```\n\n列类型是特定于数据库的。你可以设置数据库支持的任何列类型。有关支持的列类型的更多信息，请参见[此处](./docs/entities.md#column-types)。\n\n### 创建数据库的连接\n\n当实体被创建后，让我们创建一个`index.ts`（或`app.ts`，无论你怎么命名）文件，并配置数据库连接：:\n\n```typescript\nimport \"reflect-metadata\";\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection({\n  type: \"mysql\",\n  host: \"localhost\",\n  port: 3306,\n  username: \"root\",\n  password: \"admin\",\n  database: \"test\",\n  entities: [Photo],\n  synchronize: true,\n  logging: false\n})\n  .then(connection =\u003e {\n    // 这里可以写实体操作相关的代码\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n我们在此示例中使用 MySQL，你可以使用任何其他受支持的数据库。要使用其他数据库，只需将选项中的 `type` 更改为希望使用的数据库类型：`mysql`，`mariadb`，`postgres`，`sqlite`，`mssql`，`oracle`，`cordova`，`nativescript`，`react-native`，`expo` 或 `mongodb`。同时还要确保 `host`, `port`, `username`, `password` 和 `database` 正确设置。\n\n我们将 Photo 实体添加到此连接的实体列表中，并且所有需要使用的实体都必须加进来。\n\n设置 `synchronize` 可确保每次运行应用程序时实体都将与数据库同步。\n\n### 加载目录中所有实体\n\n之后当我们创建更多实体时，都需要一一将它们添加到配置中的实体中，但是这不是很方便，所以我们可以设置加载整个目录，从中连接所有实体并使用：\n\n```typescript\nimport { createConnection } from \"typeorm\";\n\ncreateConnection({\n  type: \"mysql\",\n  host: \"localhost\",\n  port: 3306,\n  username: \"root\",\n  password: \"admin\",\n  database: \"test\",\n  entities: [__dirname + \"/entity/*.js\"],\n  synchronize: true\n})\n  .then(connection =\u003e {\n    // 这里可以写实体操作相关的代码\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n但要小心使用这种方法。\n如果使用的是 `ts-node`，则需要指定 `.ts` 文件的路径。\n如果使用的是 `outDir`，那么需要在 `outDir` 目录中指定 `.js` 文件的路径。\n如果使用 `outDir`，当你删除或重命名实体时，请确保清除 `outDir` 目录并再次重新编译项目，因为当你删除 `.ts` 源文件时，其编译的 `.js` 文件不会从输出目录中删除，并且 TypeORM 依然会从 `outDir` 中加载这些文件，从而导致异常。\n\n### 启动应用\n\n现在可以启动 `app.ts`，启动后可以发现数据库自动被初始化，并且 Photo 这个表也会创建出来。\n\n```bash\n+-------------+--------------+----------------------------+\n|                         photo                           |\n+-------------+--------------+----------------------------+\n| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |\n| name        | varchar(100) |                            |\n| description | text         |                            |\n| filename    | varchar(255) |                            |\n| views       | int(11)      |                            |\n| isPublished | boolean      |                            |\n+-------------+--------------+----------------------------+\n```\n\n### 添加和插入 photo\n\n现在创建一个新的 photo 存到数据库：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(connection =\u003e {\n    let photo = new Photo();\n    photo.name = \"Me and Bears\";\n    photo.description = \"I am near polar bears\";\n    photo.filename = \"photo-with-bears.jpg\";\n    photo.views = 1;\n    photo.isPublished = true;\n\n    return connection.manager.save(photo).then(photo =\u003e {\n      console.log(\"Photo has been saved. Photo id is\", photo.id);\n    });\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n保存实体后，将获得新生成的 ID。 `save` 方法返回传递给它的同一对象的实例，但并不是对象的新副本，只是修改了它的\"id\"并返回。\n\n### 使用 async/await 语法\n\n我们可以使用ES8(ES2017)的新特性，并使用 async/await 语法代替：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    let photo = new Photo();\n    photo.name = \"Me and Bears\";\n    photo.description = \"I am near polar bears\";\n    photo.filename = \"photo-with-bears.jpg\";\n    photo.views = 1;\n    photo.isPublished = true;\n\n    await connection.manager.save(photo);\n    console.log(\"Photo has been saved\");\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n### 使用 Entity Manager\n\n我们刚创建了一张新 photo 表并将其保存在数据库中。通过使用 `EntityManager` 你可以操纵应用中的任何实体。\n\n例如，加载已经保存的实体：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let savedPhotos = await connection.manager.find(Photo);\n    console.log(\"All photos from the db: \", savedPhotos);\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n`savedPhotos` 是一个 Photo 对象数组，其中包含从数据库加载的数据。\n\n了解更多有关 [EntityManager](./docs/working-with-entity-manager.md) 的信息。\n\n### 使用 Repositories\n\n现在让我们重构之前的代码，并使用 `Repository` 替代 `EntityManager`。每个实体都有自己的repository，可以处理其实体的所有操作。当你经常处理实体时，Repositories 比 EntityManagers 更方便使用：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    let photo = new Photo();\n    photo.name = \"Me and Bears\";\n    photo.description = \"I am near polar bears\";\n    photo.filename = \"photo-with-bears.jpg\";\n    photo.views = 1;\n    photo.isPublished = true;\n\n    let photoRepository = connection.getRepository(Photo);\n\n    await photoRepository.save(photo);\n    console.log(\"Photo has been saved\");\n\n    let savedPhotos = await photoRepository.find();\n    console.log(\"All photos from the db: \", savedPhotos);\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n了解更多有关 [Repository](./docs/working-with-repository.md) 的信息。\n\n### 从数据库加载\n\n让我们使用 Repository 尝试更多的加载操作:\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let allPhotos = await photoRepository.find();\n    console.log(\"All photos from the db: \", allPhotos);\n\n    let firstPhoto = await photoRepository.findOne(1);\n    console.log(\"First photo from the db: \", firstPhoto);\n\n    let meAndBearsPhoto = await photoRepository.findOne({ name: \"Me and Bears\" });\n    console.log(\"Me and Bears photo from the db: \", meAndBearsPhoto);\n\n    let allViewedPhotos = await photoRepository.find({ views: 1 });\n    console.log(\"All viewed photos: \", allViewedPhotos);\n\n    let allPublishedPhotos = await photoRepository.find({ isPublished: true });\n    console.log(\"All published photos: \", allPublishedPhotos);\n\n    let [allPhotos, photosCount] = await photoRepository.findAndCount();\n    console.log(\"All photos: \", allPhotos);\n    console.log(\"Photos count: \", photosCount);\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n### 从数据库中更新\n\n让我们从数据库加载出 photo，更新并保存到数据库：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let photoToUpdate = await photoRepository.findOne(1);\n    photoToUpdate.name = \"Me, my friends and polar bears\";\n    await photoRepository.save(photoToUpdate);\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n这个 `id = 1` 的 photo 在数据库中就成功更新了。\n\n### 从数据库中删除\n\n让我们从数据库中删除 Photo:\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let photoToRemove = await photoRepository.findOne(1);\n    await photoRepository.remove(photoToRemove);\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n这个 `id = 1`的 photo 在数据库中被移除了。\n\n### 创建一对一的关系\n\n要与另一个类创建一对一的关系。先在 `PhotoMetadata.ts` 中创建一个新类。此 PhotoMetadata 类应包含 photo 的其他元信息：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn, OneToOne, JoinColumn } from \"typeorm\";\nimport { Photo } from \"./Photo\";\n\n@Entity()\nexport class PhotoMetadata {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column(\"int\")\n  height: number;\n\n  @Column(\"int\")\n  width: number;\n\n  @Column()\n  orientation: string;\n\n  @Column()\n  compressed: boolean;\n\n  @Column()\n  comment: string;\n\n  @OneToOne(type =\u003e Photo)\n  @JoinColumn()\n  photo: Photo;\n}\n```\n\n这里我们使用了一个名为 `@OneToOne` 的新装饰器，它允许我们在两个实体之间创建一对一的关系。\n`type =\u003e Photo` 是一个函数，返回我们想要与之建立关系的实体的类。由于特定于语言的关系，我们只能使用一个返回类的函数，而不是直接使用该类。\n同时也可以把它写成 `()=\u003e Photo`，但是 `type =\u003e Photo` 显得代码更有可读性。type 变量本身不包含任何内容。\n\n我们还添加了一个 `@JoinColumn` 装饰器，表明实体键的对应关系。关系可以是单向的或双向的。但是只有一方可以拥有。在关系的所有者方需要使用 `@JoinColumn` 装饰器。\n\n如果运行该应用程序，你将看到一个新生成的表，它将包含一个带有外键的列：\n\n```bash\n+-------------+--------------+----------------------------+\n|                     photo_metadata                      |\n+-------------+--------------+----------------------------+\n| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |\n| height      | int(11)      |                            |\n| width       | int(11)      |                            |\n| comment     | varchar(255) |                            |\n| compressed  | boolean      |                            |\n| orientation | varchar(255) |                            |\n| photoId     | int(11)      | FOREIGN KEY                |\n+-------------+--------------+----------------------------+\n```\n\n### 保存一对一的关系\n\n现在让我们来创建一个 photo，它的元信息将它们互相连接起来。\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\nimport { PhotoMetadata } from \"./entity/PhotoMetadata\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    // 创建 photo\n    let photo = new Photo();\n    photo.name = \"Me and Bears\";\n    photo.description = \"I am near polar bears\";\n    photo.filename = \"photo-with-bears.jpg\";\n    photo.isPublished = true;\n\n    // 创建 photo metadata\n    let metadata = new PhotoMetadata();\n    metadata.height = 640;\n    metadata.width = 480;\n    metadata.compressed = true;\n    metadata.comment = \"cybershoot\";\n    metadata.orientation = \"portait\";\n    metadata.photo = photo; // 联接两者\n\n    // 获取实体 repositories\n    let photoRepository = connection.getRepository(Photo);\n    let metadataRepository = connection.getRepository(PhotoMetadata);\n\n    // 先保存photo\n    await photoRepository.save(photo);\n\n    // 然后保存photo的metadata\n    await metadataRepository.save(metadata);\n\n    // 完成\n    console.log(\"Metadata is saved, and relation between metadata and photo is created in the database too\");\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n### 反向关系\n\n关系可以是单向的或双向的。目前 PhotoMetadata 和 Photo 之间的关系是单向的。关系的所有者是 PhotoMetadata，而 Photo 对 PhotoMetadata 一无所知。这使得从 Photo 中访问 PhotoMetadata 变得很复杂。要解决这个问题，我们应该在 PhotoMetadata 和 Photo 之间建立双向关系。让我们来修改一下实体：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn, OneToOne, JoinColumn } from \"typeorm\";\nimport { Photo } from \"./Photo\";\n\n@Entity()\nexport class PhotoMetadata {\n  /* ... 其他列 */\n\n  @OneToOne(type =\u003e Photo, photo =\u003e photo.metadata)\n  @JoinColumn()\n  photo: Photo;\n}\n```\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn, OneToOne } from \"typeorm\";\nimport { PhotoMetadata } from \"./PhotoMetadata\";\n\n@Entity()\nexport class Photo {\n  /* ... 其他列 */\n\n  @OneToOne(type =\u003e PhotoMetadata, photoMetadata =\u003e photoMetadata.photo)\n  metadata: PhotoMetadata;\n}\n```\n\n`photo =\u003e photo.metadata` 是用来指定反向关系的名称。Photo 类的元数据属性是在 Photo 类中存储 PhotoMetadata 的地方。你可以选择简单地将字符串传递给 `@OneToOne` 装饰器，而不是传递返回 photo 属性的函数，例如 `\"metadata\"`。这种函数类型的方法使我们的重构更容易。\n\n注意，我们应该仅在关系的一侧使用 `@JoinColumn` 装饰器。你把这个装饰者放在哪一方将是这段关系的拥有方。关系的拥有方包含数据库中具有外键的列。\n\n### 取出关系对象的数据\n\n在一个查询中加载 photo 及 photo metadata 有两种方法。使用 `find *` 或使用 `QueryBuilder`。我们先使用 `find *` 方法。 `find *` 方法允许你使用 `FindOneOptions` / `FindManyOptions` 接口指定对象。\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\nimport { PhotoMetadata } from \"./entity/PhotoMetadata\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let photoRepository = connection.getRepository(Photo);\n    let photos = await photoRepository.find({ relations: [\"metadata\"] });\n  })\n  .catch(error =\u003e console.log(error));\n```\n\nphotos 包含来自数据库的 photos 数组，每个 photo 包含其 photo metadata。详细了解本文档中的[Find 选项](./docs/find-options.md)。\n\n使用find选项很简单，但是如果你需要更复杂的查询，则应该使用 `QueryBuilder`。 `QueryBuilder` 使用更优雅的方式执行更复杂的查询：\n\n```typescript\nimport { createConnection } from \"typeorm\";\nimport { Photo } from \"./entity/Photo\";\nimport { PhotoMetadata } from \"./entity/PhotoMetadata\";\n\ncreateConnection(/*...*/)\n  .then(async connection =\u003e {\n    /*...*/\n    let photos = await connection\n      .getRepository(Photo)\n      .createQueryBuilder(\"photo\")\n      .innerJoinAndSelect(\"photo.metadata\", \"metadata\")\n      .getMany();\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n`QueryBuilder` 允许你创建和执行几乎任何复杂性的 SQL 查询。使用 `QueryBuilder` 时，请考虑创建 SQL 查询。在此示例中，\"photo\"和\"metadata\"是应用于所选 photos 的别名。你可以使用别名来访问所选数据的列和属性。\n\n### 使用 cascades 自动保存相关对象\n\n我们可以在关系中设置 `cascade` 选项，这时就可以在保存其他对象的同时保存相关对象。让我们更改一下的 photo 的 `@OneToOne` 装饰器：\n\n```typescript\nexport class Photo {\n  /// ... 其他列\n\n  @OneToOne(type =\u003e PhotoMetadata, metadata =\u003e metadata.photo, {\n    cascade: true\n  })\n  metadata: PhotoMetadata;\n}\n```\n\n使用 `cascade` 允许就不需要边存 photo 边存元数据对象。我们可以简单地保存一个 photo 对象，由于使用了 cascade，metadata 也将自动保存。\n\n```typescript\ncreateConnection(options)\n  .then(async connection =\u003e {\n    // 创建 photo 对象\n    let photo = new Photo();\n    photo.name = \"Me and Bears\";\n    photo.description = \"I am near polar bears\";\n    photo.filename = \"photo-with-bears.jpg\";\n    photo.isPublished = true;\n\n    // 创建 photo metadata 对象\n    let metadata = new PhotoMetadata();\n    metadata.height = 640;\n    metadata.width = 480;\n    metadata.compressed = true;\n    metadata.comment = \"cybershoot\";\n    metadata.orientation = \"portait\";\n\n    photo.metadata = metadata; // this way we connect them\n\n    // 获取 repository\n    let photoRepository = connection.getRepository(Photo);\n\n    // 保存photo的同时保存metadata\n    await photoRepository.save(photo);\n\n    console.log(\"Photo is saved, photo metadata is saved too.\");\n  })\n  .catch(error =\u003e console.log(error));\n```\n\n### 创建多对一/一对多关系\n\n让我们创建一个多对一/一对多的关系。假设一个 photo 有一个 author，每个 author 都可以有多个 photos。首先让我们创建一个`Author`类：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn, OneToMany, JoinColumn } from \"typeorm\";\nimport { Photo } from \"./Photo\";\n\n@Entity()\nexport class Author {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column()\n  name: string;\n\n  @OneToMany(type =\u003e Photo, photo =\u003e photo.author) // 注意：我们将在下面的Photo类中创建author属性\n  photos: Photo[];\n}\n```\n\n`Author` 包含反向关系。\n`OneToMany` 总是反向的, 并且总是与 `ManyToOne`一起出现。\n\n现在让我们将关系的所有者方添加到 Photo 实体中：\n\n```typescript\nimport { Entity, Column, PrimaryGeneratedColumn, ManyToOne } from \"typeorm\";\nimport { PhotoMetadata } from \"./PhotoMetadata\";\nimport { Author } from \"./Author\";\n\n@Entity()\nexport class Photo {\n  /* ... other columns */\n\n  @ManyToOne(type =\u003e Author, author =\u003e author.photos)\n  author: Author;\n}\n```\n\n在多对一/一对多的关系中，拥有方总是多对一的。这意味着使用`@ManyToOne`的类将存储相关对象的 id。\n运行应用程序后，ORM 将创建`author`表：\n\n```bash\n+-------------+--------------+----------------------------+\n|                          author                         |\n+-------------+--------------+----------------------------+\n| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |\n| name        | varchar(255) |                            |\n+-------------+--------------+----------------------------+\n```\n\n它还将修改`photo`表，添加新的`author`列并为其创建外键：\n\n```bash\n+-------------+--------------+----------------------------+\n|                         photo                           |\n+-------------+--------------+----------------------------+\n| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |\n| name        | varchar(255) |                            |\n| description | varchar(255) |                            |\n| filename    | varchar(255) |                            |\n| isPublished | boolean      |                            |\n| authorId    | int(11)      | FOREIGN KEY                |\n+-------------+--------------+----------------------------+\n```\n\n### 创建多对多关系\n\n假设一个 photo 可以放在多个 albums 中，每个 albums 可以包含多个 photo。让我们创建一个`Album`类：\n\n```typescript\nimport { Entity, PrimaryGeneratedColumn, Column, ManyToMany, JoinTable } from \"typeorm\";\n\n@Entity()\nexport class Album {\n  @PrimaryGeneratedColumn()\n  id: number;\n\n  @Column()\n  name: string;\n\n  @ManyToMany(type =\u003e Photo, photo =\u003e photo.albums)\n  @JoinTable()\n  photos: Photo[];\n}\n```\n\n`@JoinTable`需要指定这是关系的所有者方。\n\n现在添加反向关系到`Photo`类：\n\n```typescript\nexport class Photo {\n  /// ... 其他列\n\n  @ManyToMany(type =\u003e Album, album =\u003e album.photos)\n  albums: Album[];\n}\n```\n\n运行后，ORM 将创建**album_photos_photo_albums**\\_联结表。\n\n```bash\n+-------------+--------------+----------------------------+\n|                album_photos_photo_albums                |\n+-------------+--------------+----------------------------+\n| album_id    | int(11)      | PRIMARY KEY FOREIGN KEY    |\n| photo_id    | int(11)      | PRIMARY KEY FOREIGN KEY    |\n+-------------+--------------+----------------------------+\n```\n\n记得在 ORM 中使用 ConnectionOptions 注册`Album`类：\n\n```typescript\nconst options: ConnectionOptions = {\n  // ... 其他选项\n  entities: [Photo, PhotoMetadata, Author, Album]\n};\n```\n\n现在让我们将 albums 和 photos 插入我们的数据库:\n\n```typescript\nlet connection = await createConnection(options);\n\n// 创建一些 albums\nlet album1 = new Album();\nalbum1.name = \"Bears\";\nawait connection.manager.save(album1);\n\nlet album2 = new Album();\nalbum2.name = \"Me\";\nawait connection.manager.save(album2);\n\n// 创建一些 photos\nlet photo = new Photo();\nphoto.name = \"Me and Bears\";\nphoto.description = \"I am near polar bears\";\nphoto.filename = \"photo-with-bears.jpg\";\nphoto.albums = [album1, album2];\nawait connection.manager.save(photo);\n\n// 现在我们的`photo`被保存了，并且'albums`被附加到它上面\n// 然后加载它们\nconst loadedPhoto = await connection.getRepository(Photo).findOne(1, { relations: [\"albums\"] });\n```\n\n`loadedPhoto` 如下所示:\n\n```typescript\n{\n    id: 1,\n    name: \"Me and Bears\",\n    description: \"I am near polar bears\",\n    filename: \"photo-with-bears.jpg\",\n    albums: [{\n        id: 1,\n        name: \"Bears\"\n    }, {\n        id: 2,\n        name: \"Me\"\n    }]\n}\n```\n\n### 使用 QueryBuilder\n\n你可以使用 QueryBuilder 构建几乎任何复杂性的 SQL 查询。例如，可以这样做：\n\n```typescript\nlet photos = await connection\n  .getRepository(Photo)\n  .createQueryBuilder(\"photo\") // 第一个参数是别名。即photos。 该参数必须指定。\n  .innerJoinAndSelect(\"photo.metadata\", \"metadata\")\n  .leftJoinAndSelect(\"photo.albums\", \"album\")\n  .where(\"photo.isPublished = true\")\n  .andWhere(\"(photo.name = :photoName OR photo.name = :bearName)\")\n  .orderBy(\"photo.id\", \"DESC\")\n  .skip(5)\n  .take(10)\n  .setParameters({ photoName: \"My\", bearName: \"Mishka\" })\n  .getMany();\n```\n\n此查询选择所有 published 的 name 等于\"My\"或\"Mishka\"的 photos。它将从结果中的第 5 个（分页偏移）开始，并且仅选择 10 个结果（分页限制）。得到的结果将按 ID 降序排序。photo 的 albums 将被 left-joined，其元数据将被 inner joined。\n\n由于 QueryBuilder 的自由度更高，因此在项目中可能会大量的使用它。\n更多关于 QueryBuilder 的信息，[可查看](./docs/select-query-builder.md)。\n\n## 示例\n\n查看[示例](https://github.com/typeorm/typeorm/tree/master/sample)用法。\n\n下面这些 repositories 可以帮助你快速开始：\n\n- [Example how to use TypeORM with TypeScript](https://github.com/typeorm/typescript-example)\n- [Example how to use TypeORM with JavaScript](https://github.com/typeorm/javascript-example)\n- [Example how to use TypeORM with JavaScript and Babel](https://github.com/typeorm/babel-example)\n- [Example how to use TypeORM with TypeScript and SystemJS in Browser](https://github.com/typeorm/browser-example)\n- [Example how to use Express and TypeORM](https://github.com/typeorm/typescript-express-example)\n- [Example how to use Koa and TypeORM](https://github.com/typeorm/typescript-koa-example)\n- [Example how to use TypeORM with MongoDB](https://github.com/typeorm/mongo-typescript-example)\n- [Example how to use TypeORM in a Cordova/PhoneGap app](https://github.com/typeorm/cordova-example)\n- [Example how to use TypeORM with an Ionic app](https://github.com/typeorm/ionic-example)\n- [Example how to use TypeORM with React Native](https://github.com/typeorm/react-native-example)\n- [Example how to use TypeORM with Electron using JavaScript](https://github.com/typeorm/electron-javascript-example)\n- [Example how to use TypeORM with Electron using TypeScript](https://github.com/typeorm/electron-typescript-example)\n\n## 扩展\n\n这几个扩展可以简化 TypeORM 的使用，并将其与其他模块集成：\n\n- [TypeORM + GraphQL framework](http://vesper-framework.com)\n- [TypeORM integration](https://github.com/typeorm/typeorm-typedi-extensions) with [TypeDI](https://github.com/pleerock/typedi)\n- [TypeORM integration](https://github.com/typeorm/typeorm-routing-controllers-extensions) with [routing-controllers](https://github.com/pleerock/routing-controllers)\n- 从现有数据库生成模型 - [typeorm-model-generator](https://github.com/Kononnable/typeorm-model-generator)\n\n## 贡献\n\n了解如何贡献[这里](https://github.com/typeorm/typeorm/blob/master/CONTRIBUTING.md)以及如何设置开发环境[这里](https://github.com/typeorm/typeorm/blob/master/DEVELOPER.md)。\n\n感谢所有贡献者：\n\n\u003ca href=\"https://github.com/typeorm/typeorm/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/typeorm/contributors.svg?width=890\u0026showBtn=false\" /\u003e\u003c/a\u003e\n\n## 赞助商\n\n开源既困难又耗时。 如果你想投资 TypeORM 的未来，你可以成为赞助商，让我们的核心团队花更多时间在 TypeORM 的改进和新功能上。[成为赞助商](https://opencollective.com/typeorm)\n\n\u003ca href=\"https://opencollective.com/typeorm\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/typeorm/tiers/sponsor.svg?width=890\"\u003e\u003c/a\u003e\n\n## 金牌赞助商\n\n成为金牌赞助商，并从我们的核心贡献者那里获得高级技术支持。 [成为金牌赞助商](https://opencollective.com/typeorm)\n\n\u003ca href=\"https://opencollective.com/typeorm\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/typeorm/tiers/gold-sponsor.svg?width=890\"\u003e\u003c/a\u003e\n\n","funding_links":["https://opencollective.com/typeorm"],"categories":["TypeScript","\u003ca name=\"TypeScript\"\u003e\u003c/a\u003eTypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenolib%2Ftypeorm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenolib%2Ftypeorm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenolib%2Ftypeorm/lists"}