【TS】你們要的TypeORM中文文檔Ta來(lái)了

TypeORM

TypeORM 是一個(gè)ORM框架肢藐,它可以運(yùn)行在 NodeJS、Browser吱韭、Cordova吆豹、PhoneGap、Ionic、React Native痘煤、Expo 和 Electron 平臺(tái)上鸳吸,可以與 TypeScript 和 JavaScript (ES5,ES6,ES7,ES8)一起使用。 它的目標(biāo)是始終支持最新的 JavaScript 特性并提供額外的特性以幫助你開(kāi)發(fā)任何使用數(shù)據(jù)庫(kù)的(不管是只有幾張表的小型應(yīng)用還是擁有多數(shù)據(jù)庫(kù)的大型企業(yè)應(yīng)用)應(yīng)用程序速勇。

不同于現(xiàn)有的所有其他 JavaScript ORM 框架,TypeORM 支持 Active RecordData Mapper 模式坎拐,這意味著你可以以最高效的方式編寫(xiě)高質(zhì)量的烦磁、松耦合的、可擴(kuò)展的哼勇、可維護(hù)的應(yīng)用程序都伪。

TypeORM 參考了很多其他優(yōu)秀 ORM 的實(shí)現(xiàn), 比如 Hibernate, DoctrineEntity Framework

TypeORM 的一些特性:

  • 支持 DataMapperActiveRecord (隨你選擇)
  • 實(shí)體和列
  • 數(shù)據(jù)庫(kù)特性列類(lèi)型
  • 實(shí)體管理
  • 存儲(chǔ)庫(kù)和自定義存儲(chǔ)庫(kù)
  • 清晰的對(duì)象關(guān)系模型
  • 關(guān)聯(lián)(關(guān)系)
  • 貪婪和延遲關(guān)系
  • 單向的积担,雙向的和自引用的關(guān)系
  • 支持多重繼承模式
  • 級(jí)聯(lián)
  • 索引
  • 事務(wù)
  • 遷移和自動(dòng)遷移
  • 連接池
  • 主從復(fù)制
  • 使用多個(gè)數(shù)據(jù)庫(kù)連接
  • 使用多個(gè)數(shù)據(jù)庫(kù)類(lèi)型
  • 跨數(shù)據(jù)庫(kù)和跨模式查詢
  • 優(yōu)雅的語(yǔ)法陨晶,靈活而強(qiáng)大的 QueryBuilder
  • 左聯(lián)接和內(nèi)聯(lián)接
  • 使用聯(lián)查查詢的適當(dāng)分頁(yè)
  • 查詢緩存
  • 原始結(jié)果流
  • 日志
  • 監(jiān)聽(tīng)者和訂閱者(鉤子)
  • 支持閉包表模式
  • 在模型或者分離的配置文件中聲明模式
  • json / xml / yml / env 格式的連接配置
  • 支持 MySQL / MariaDB / Postgres / SQLite / Microsoft SQL Server / Oracle / sql.js
  • 支持 MongoDB NoSQL 數(shù)據(jù)庫(kù)
  • 可在 NodeJS / 瀏覽器 / Ionic / Cordova / React Native / Expo / Electron 平臺(tái)上使用
  • 支持 TypeScript 和 JavaScript
  • 生成高性能、靈活帝璧、清晰和可維護(hù)的代碼
  • 遵循所有可能的最佳實(shí)踐
  • 命令行工具

還有更多...

TypeORM功能很強(qiáng)大先誉,但是文檔也有點(diǎn).......

文檔始終有點(diǎn)不如意啊...

痛點(diǎn):

typeorm的文檔說(shuō)明站點(diǎn):https://typeorm.io/ 國(guó)內(nèi)訪問(wèn)超級(jí)慢,內(nèi)容還無(wú)法加載的烁,百度了一大堆褐耳,沒(méi)有一篇文檔是全的。要么就是寫(xiě)到一半的文檔渴庆, 對(duì)初學(xué)者來(lái)說(shuō)铃芦,入門(mén)就更難了。

解決方案:

為了讓更多的人方便學(xué)習(xí)襟雷,站長(zhǎng)業(yè)余時(shí)間刃滓,將源站typeorm.io的文檔內(nèi)容整理并同步了一份到

TypeORM 中文網(wǎng) https://typeorm.biunav.com/

若后期還有建議搭建的文檔站點(diǎn),請(qǐng)留言耸弄。

快速開(kāi)始

通過(guò)使用 TypeORM 你的 models 看起來(lái)像這樣:

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @Column()
  age: number;
}

邏輯操作就像是這樣:

const user = new User();
user.firstName = "Timber";
user.lastName = "Saw";
user.age = 25;
await repository.save(user);

const allUsers = await repository.find();
const firstUser = await repository.findOne(1); // find by id
const timber = await repository.findOne({
  firstName: "Timber",
  lastName: "Saw",
});

await repository.remove(timber);

或者咧虎,如果你更喜歡使用ActiveRecord實(shí)現(xiàn),也可以這樣用:

import { Entity, PrimaryGeneratedColumn, Column, BaseEntity } from "typeorm";

@Entity()
export class User extends BaseEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @Column()
  age: number;
}

邏輯操作如下所示:

const user = new User();
user.firstName = "Timber";
user.lastName = "Saw";
user.age = 25;
await user.save();

const allUsers = await User.find();
const firstUser = await User.findOne(1);
const timber = await User.findOne({ firstName: "Timber", lastName: "Saw" });

await timber.remove();

入門(mén)

安裝

  1. 通過(guò)npm安裝:

    npm install typeorm --save

  2. 你還需要安裝 reflect-metadata:

    npm install reflect-metadata --save

    并且需要在應(yīng)用程序的全局位置導(dǎo)入(例如在app.ts中)

    import "reflect-metadata";

  3. 你可能還需要安裝 node typings(以此來(lái)使用 Node 的智能提示):

    npm install @types/node --save

  4. 安裝數(shù)據(jù)庫(kù)驅(qū)動(dòng):

    • MySQL 或者 MariaDB

      npm install mysql --save (也可以安裝 mysql2)

    • PostgreSQL

      npm install pg --save

    • SQLite

      npm install sqlite3 --save

    • Microsoft SQL Server

      npm install mssql --save

    • sql.js

      npm install sql.js --save

    • Oracle

      npm install oracledb --save

      根據(jù)你使用的數(shù)據(jù)庫(kù)计呈,僅安裝其中一個(gè)即可老客。
      要使 Oracle 驅(qū)動(dòng)程序正常工作,需要按照其站點(diǎn)中的安裝說(shuō)明進(jìn)行操作震叮。

    • MongoDB (試驗(yàn)性)

      npm install mongodb --save

    • NativeScript, react-nativeCordova

      查看 支持的平臺(tái)

TypeScript 配置

此外胧砰,請(qǐng)確保你使用的是 TypeScript 編譯器版本2.3或更高版本,并且已經(jīng)在tsconfig.json中啟用了以下設(shè)置:

"emitDecoratorMetadata": true,
"experimentalDecorators": true,

你可能還需要在編譯器選項(xiàng)的lib中啟用es6苇瓣,或者從@types安裝es6-shim尉间。

快速開(kāi)始

開(kāi)始使用 TypeORM 的最快方法是使用其 CLI 命令生成啟動(dòng)項(xiàng)目。
只有在 NodeJS 應(yīng)用程序中使用 TypeORM 時(shí),此操作才有效哲嘲。如果你使用的是其他平臺(tái)豆赏,請(qǐng)繼續(xù)執(zhí)行分步指南

首先全局安裝 TypeORM:

npm install typeorm -g

然后轉(zhuǎn)到要?jiǎng)?chuàng)建新項(xiàng)目的目錄并運(yùn)行命令:

typeorm init --name MyProject --database mysql

其中name是項(xiàng)目的名稱苍柏,database是您將使用的數(shù)據(jù)庫(kù)宜岛。

數(shù)據(jù)庫(kù)可以是以下值之一: mysql, mariadb, postgres, sqlite, mssql, oracle, mongodb,
cordova, react-native, expo, nativescript.

此命令將在MyProject目錄中生成一個(gè)包含以下文件的新項(xiàng)目:

MyProject
├── src              // TypeScript 代碼
│   ├── entity       // 存儲(chǔ)實(shí)體(數(shù)據(jù)庫(kù)模型)的位置
│   │   └── User.ts  // 示例 entity
│   ├── migration    // 存儲(chǔ)遷移的目錄
│   └── index.ts     // 程序執(zhí)行主文件
├── .gitignore       // gitignore文件
├── ormconfig.json   // ORM和數(shù)據(jù)庫(kù)連接配置
├── package.json     // node module 依賴
├── README.md        // 簡(jiǎn)單的 readme 文件
└── tsconfig.json    // TypeScript 編譯選項(xiàng)

你還可以在現(xiàn)有 node 項(xiàng)目上運(yùn)行typeorm init,但要注意囱怕,此操作可能會(huì)覆蓋已有的某些文件霍弹。

接下來(lái)安裝項(xiàng)目依賴項(xiàng):

cd MyProject
npm install

在安裝過(guò)程中,編輯ormconfig.json文件并在其中放置您自己的數(shù)據(jù)庫(kù)連接配置選項(xiàng):

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

絕大多數(shù)情況下娃弓,你只需要配置
host, username, password, database 或者 port典格。

完成配置并安裝所有 node modules 后,即可運(yùn)行應(yīng)用程序:

npm start

至此你的應(yīng)用程序應(yīng)該成功運(yùn)行并將新用戶插入數(shù)據(jù)庫(kù)台丛。你可以繼續(xù)使用此項(xiàng)目并集成所需的其他模塊并創(chuàng)建更多實(shí)體耍缴。

你可以通過(guò)運(yùn)行typeorm init --name MyProject --database mysql --express來(lái)生成一個(gè)更高級(jí)的 Express 項(xiàng)目

分步指南

您對(duì) ORM 有何期待?您期望它將為您創(chuàng)建數(shù)據(jù)庫(kù)表挽霉,并且無(wú)需編寫(xiě)大量難以維護(hù)的 SQL 語(yǔ)句來(lái)查找/插入/更新/刪除您的數(shù)據(jù)防嗡。本指南將向您展示如何從頭開(kāi)始設(shè)置 TypeORM 并實(shí)現(xiàn)這些操作。

創(chuàng)建一個(gè)模型

使用數(shù)據(jù)庫(kù)從創(chuàng)建表開(kāi)始侠坎。如何告訴 TypeORM 創(chuàng)建數(shù)據(jù)庫(kù)表本鸣?答案是 - 通過(guò)模型。
應(yīng)用程序中的模型即是數(shù)據(jù)庫(kù)中的表硅蹦。

舉個(gè)例子, 你有一個(gè)Photo 模型:

export class Photo {
  id: number;
  name: string;
  description: string;
  filename: string;
  views: number;
}

并且希望將 photos 存儲(chǔ)在數(shù)據(jù)庫(kù)中荣德。要在數(shù)據(jù)庫(kù)中存儲(chǔ)內(nèi)容,首先需要一個(gè)數(shù)據(jù)庫(kù)表童芹,并從模型中創(chuàng)建數(shù)據(jù)庫(kù)表涮瞻。但是并非所有模型,只有您定義為entities的模型假褪。

創(chuàng)建一個(gè)實(shí)體

Entity是由@Entity裝飾器裝飾的模型署咽。將為此類(lèi)模型創(chuàng)建數(shù)據(jù)庫(kù)表。你可以使用 TypeORM 處理各處的實(shí)體生音,可以使用它們 load/insert/update/remove 并執(zhí)行其他操作宁否。

讓我們將Photo模型作為一個(gè)實(shí)體

import { Entity } from "typeorm";

@Entity()
export class Photo {
  id: number;
  name: string;
  description: string;
  filename: string;
  views: number;
  isPublished: boolean;
}

現(xiàn)在,將為Photo實(shí)體創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)表缀遍,我們將能夠在應(yīng)用程序中的任何位置使用它慕匠。
我們已經(jīng)創(chuàng)建了一個(gè)數(shù)據(jù)庫(kù)表,但是沒(méi)有哪個(gè)字段屬于哪一列域醇,下面讓我們?cè)跀?shù)據(jù)庫(kù)表中創(chuàng)建幾列台谊。

添加表列

要添加數(shù)據(jù)庫(kù)列蓉媳,你只需要將要生成的實(shí)體屬性加上@Column裝飾器。

import { Entity, Column } from "typeorm";

@Entity()
export class Photo {
  @Column()
  id: number;

  @Column()
  name: string;

  @Column()
  description: string;

  @Column()
  filename: string;

  @Column()
  views: number;

  @Column()
  isPublished: boolean;
}

現(xiàn)在 id, name, description, filename, viewsisPublished 列將會(huì)被添加到photo表中锅铅。
數(shù)據(jù)庫(kù)中的列類(lèi)型是根據(jù)你使用的屬性類(lèi)型推斷的酪呻,例如: number將被轉(zhuǎn)換為integerstring將轉(zhuǎn)換為varchar盐须,boolean轉(zhuǎn)換為bool等玩荠。但你也可以通過(guò)在@Column裝飾器中隱式指定列類(lèi)型來(lái)使用數(shù)據(jù)庫(kù)支持的任何列類(lèi)型。

我們已經(jīng)生成了一個(gè)包含列的數(shù)據(jù)庫(kù)表贼邓,但還剩下一件事阶冈。每個(gè)數(shù)據(jù)庫(kù)表必須具有包含主鍵的列。

創(chuàng)建主列

每個(gè)實(shí)體必須至少有一個(gè)主鍵列立帖。這是必須的,你無(wú)法避免悠砚。要使列成為主鍵晓勇,您需要使用@PrimaryColumn裝飾器。

import { Entity, Column, PrimaryColumn } from "typeorm";

@Entity()
export class Photo {
  @PrimaryColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  description: string;

  @Column()
  filename: string;

  @Column()
  views: number;

  @Column()
  isPublished: boolean;
}

創(chuàng)建自動(dòng)生成的列

假設(shè)你希望 id 列自動(dòng)生成(這稱為 auto-increment/sequence/serial/generated identity column)灌旧。為此你需要將@PrimaryColumn裝飾器更改為@PrimaryGeneratedColumn裝飾器:

import { Entity, Column, PrimaryGeneratedColumn } from "typeorm";

@Entity()
export class Photo {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  description: string;

  @Column()
  filename: string;

  @Column()
  views: number;

  @Column()
  isPublished: boolean;
}

列數(shù)據(jù)類(lèi)型

接下來(lái)绑咱,讓我們修復(fù)數(shù)據(jù)類(lèi)型。默認(rèn)情況下枢泰,字符串被映射到一個(gè) varchar(255)類(lèi)型(取決于數(shù)據(jù)庫(kù)類(lèi)型)描融。
數(shù)字被映射到一個(gè)類(lèi)似整數(shù)類(lèi)型(取決于數(shù)據(jù)庫(kù)類(lèi)型)。但是我們不希望所有的列都是有限的 varchars 或整數(shù)衡蚂,讓我們修改下代碼以設(shè)置想要的數(shù)據(jù)類(lèi)型:

import { Entity, Column, PrimaryGeneratedColumn } from "typeorm";

@Entity()
export class Photo {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({
    length: 100,
  })
  name: string;

  @Column("text")
  description: string;

  @Column()
  filename: string;

  @Column("double")
  views: number;

  @Column()
  isPublished: boolean;
}

列類(lèi)型是特定于數(shù)據(jù)庫(kù)的窿克。你可以設(shè)置數(shù)據(jù)庫(kù)支持的任何列類(lèi)型。有關(guān)支持的列類(lèi)型的更多信息毛甲,請(qǐng)參見(jiàn)此處年叮。

創(chuàng)建數(shù)據(jù)庫(kù)的連接

當(dāng)實(shí)體被創(chuàng)建后,讓我們創(chuàng)建一個(gè)index.ts(或app.ts玻募,無(wú)論你怎么命名)文件只损,并配置數(shù)據(jù)庫(kù)連接::

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

createConnection({
  type: "mysql",
  host: "localhost",
  port: 3306,
  username: "root",
  password: "admin",
  database: "test",
  entities: [Photo],
  synchronize: true,
  logging: false,
})
  .then((connection) => {
    // 這里可以寫(xiě)實(shí)體操作相關(guān)的代碼
  })
  .catch((error) => console.log(error));

我們?cè)诖耸纠惺褂?MySQL,你可以使用任何其他受支持的數(shù)據(jù)庫(kù)七咧。要使用其他數(shù)據(jù)庫(kù)跃惫,只需將選項(xiàng)中的type更改為希望使用的數(shù)據(jù)庫(kù)類(lèi)型:mysql,mariadb艾栋,postgres爆存,sqlite,mssql蝗砾,oracle终蒂,cordova蜂林,nativescript,react-native拇泣,expo 或 mongodb噪叙。同時(shí)還要確保 host, port, username, password 和數(shù)據(jù)庫(kù)設(shè)置的正確性。

我們將 Photo 實(shí)體添加到此連接的實(shí)體列表中霉翔。所有需要在連接中使用的每個(gè)實(shí)體都必須加到這個(gè)表中睁蕾。

設(shè)置synchronize可確保每次運(yùn)行應(yīng)用程序時(shí)實(shí)體都將與數(shù)據(jù)庫(kù)同步。

加載目錄中所有實(shí)體

之后當(dāng)我們創(chuàng)建更多實(shí)體時(shí)债朵,都需要將一一它們添加到配置中的實(shí)體中子眶,但是這不是很方便,所以我們可以設(shè)置整個(gè)目錄序芦,從中連接所有實(shí)體并在連接中使用:

import { createConnection } from "typeorm";

createConnection({
  type: "mysql",
  host: "localhost",
  port: 3306,
  username: "root",
  password: "admin",
  database: "test",
  entities: [__dirname + "/entity/*.js"],
  synchronize: true,
})
  .then((connection) => {
    // 這里可以寫(xiě)實(shí)體操作相關(guān)的代碼
  })
  .catch((error) => console.log(error));

但要小心這種方法臭杰。
如果使用的是ts-node,則需要指定.ts文件的路徑谚中。
如果使用的是outDir渴杆,那么需要在outDir目錄中指定.js文件的路徑。
如果使用outDir宪塔,當(dāng)你刪除或重命名實(shí)體時(shí)磁奖,請(qǐng)確保清除outDir目錄并再次重新編譯項(xiàng)目,因?yàn)楫?dāng)你刪除.ts源文件時(shí)某筐,其編譯的.js版本不會(huì)從輸出目錄中刪除,并且 TypeORM 依然會(huì)從outDir中加載這些文件比搭,從而導(dǎo)致異常。

啟動(dòng)應(yīng)用

現(xiàn)在可以啟動(dòng)app.ts南誊,啟動(dòng)后可以發(fā)現(xiàn)數(shù)據(jù)庫(kù)自動(dòng)被初始化身诺,并且 Photo 這個(gè)表也會(huì)創(chuàng)建出來(lái)。

+-------------+--------------+----------------------------+
|                         photo                           |
+-------------+--------------+----------------------------+
| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |
| name        | varchar(500) |                            |
| description | text         |                            |
| filename    | varchar(255) |                            |
| views       | int(11)      |                            |
| isPublished | boolean      |                            |
+-------------+--------------+----------------------------+

添加和插入 photo

現(xiàn)在創(chuàng)建一個(gè)新的 photo 存到數(shù)據(jù)庫(kù):

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then((connection) => {
    let photo = new Photo();
    photo.name = "Me and Bears";
    photo.description = "I am near polar bears";
    photo.filename = "photo-with-bears.jpg";
    photo.views = 1;
    photo.isPublished = true;

    return connection.manager.save(photo).then((photo) => {
      console.log("Photo has been saved. Photo id is", photo.id);
    });
  })
  .catch((error) => console.log(error));

保存實(shí)體后抄囚,它將獲得新生成的 ID戚长。 save方法返回傳遞給它的同一對(duì)象的實(shí)例。但它不是對(duì)象的新副本怠苔,只是修改了它的"id"并返回它同廉。

使用 async/await 語(yǔ)法

我們可以使用最新的 ES8(ES2017)功能,并使用 async / await 語(yǔ)法代替:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    let photo = new Photo();
    photo.name = "Me and Bears";
    photo.description = "I am near polar bears";
    photo.filename = "photo-with-bears.jpg";
    photo.views = 1;
    photo.isPublished = true;

    await connection.manager.save(photo);
    console.log("Photo has been saved");
  })
  .catch((error) => console.log(error));

使用 Entity Manager

我們剛創(chuàng)建了一張新 photo 并將其保存在數(shù)據(jù)庫(kù)中柑司。使用EntityManager你可以操縱應(yīng)用中的任何實(shí)體迫肖。

例如,加載已經(jīng)保存的實(shí)體:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let savedPhotos = await connection.manager.find(Photo);
    console.log("All photos from the db: ", savedPhotos);
  })
  .catch((error) => console.log(error));

savedPhotos是一個(gè) Photo 對(duì)象數(shù)組攒驰,其中包含從數(shù)據(jù)庫(kù)加載的數(shù)據(jù)蟆湖。

了解更多有關(guān) EntityManager 的信息。

使用 Repositories

現(xiàn)在讓我們重構(gòu)之前的代碼玻粪,并使用Repository而不是EntityManager隅津。每個(gè)實(shí)體都有自己的存儲(chǔ)庫(kù)诬垂,可以處理其實(shí)體的所有操作。當(dāng)你經(jīng)常處理實(shí)體時(shí)伦仍,Repositories 比 EntityManagers 更方便使用:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    let photo = new Photo();
    photo.name = "Me and Bears";
    photo.description = "I am near polar bears";
    photo.filename = "photo-with-bears.jpg";
    photo.views = 1;
    photo.isPublished = true;

    let photoRepository = connection.getRepository(Photo);

    await photoRepository.save(photo);
    console.log("Photo has been saved");

    let savedPhotos = await photoRepository.find();
    console.log("All photos from the db: ", savedPhotos);
  })
  .catch((error) => console.log(error));

了解更多有關(guān) Repository 的信息结窘。

從數(shù)據(jù)庫(kù)加載

讓我們使用 Repository 嘗試更多的加載操作:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let allPhotos = await photoRepository.find();
    console.log("All photos from the db: ", allPhotos);

    let firstPhoto = await photoRepository.findOne(1);
    console.log("First photo from the db: ", firstPhoto);

    let meAndBearsPhoto = await photoRepository.findOne({
      name: "Me and Bears",
    });
    console.log("Me and Bears photo from the db: ", meAndBearsPhoto);

    let allViewedPhotos = await photoRepository.find({ views: 1 });
    console.log("All viewed photos: ", allViewedPhotos);

    let allPublishedPhotos = await photoRepository.find({ isPublished: true });
    console.log("All published photos: ", allPublishedPhotos);

    let [allPhotos, photosCount] = await photoRepository.findAndCount();
    console.log("All photos: ", allPhotos);
    console.log("Photos count: ", photosCount);
  })
  .catch((error) => console.log(error));

在數(shù)據(jù)庫(kù)中更新

讓我們從數(shù)據(jù)庫(kù)加載出 photo,更新并保存到數(shù)據(jù)庫(kù):

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let photoToUpdate = await photoRepository.findOne(1);
    photoToUpdate.name = "Me, my friends and polar bears";
    await photoRepository.save(photoToUpdate);
  })
  .catch((error) => console.log(error));

這個(gè)id = 1的 photo 在數(shù)據(jù)庫(kù)中就成功更新了充蓝。

從數(shù)據(jù)庫(kù)中刪除

讓我們從數(shù)據(jù)庫(kù)中刪除我們的 Photo:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let photoToRemove = await photoRepository.findOne(1);
    await photoRepository.remove(photoToRemove);
  })
  .catch((error) => console.log(error));

這個(gè)id = 1的 photo 在數(shù)據(jù)庫(kù)中被移除了隧枫。

創(chuàng)建一對(duì)一的關(guān)系

讓我們與另一個(gè)類(lèi)創(chuàng)建一對(duì)一的關(guān)系。先在PhotoMetadata.ts中創(chuàng)建一個(gè)新類(lèi)谓苟。此 PhotoMetadata 類(lèi)應(yīng)包含 photo 的其他元信息:

import {
  Entity,
  Column,
  PrimaryGeneratedColumn,
  OneToOne,
  JoinColumn,
} from "typeorm";
import { Photo } from "./Photo";

@Entity()
export class PhotoMetadata {
  @PrimaryGeneratedColumn()
  id: number;

  @Column("int")
  height: number;

  @Column("int")
  width: number;

  @Column()
  orientation: string;

  @Column()
  compressed: boolean;

  @Column()
  comment: string;

  @OneToOne((type) => Photo)
  @JoinColumn()
  photo: Photo;
}

這里我們使用了一個(gè)名為@OneToOne的新裝飾器,它允許我們?cè)趦蓚€(gè)實(shí)體之間創(chuàng)建一對(duì)一的關(guān)系官脓。
type => Photo是一個(gè)函數(shù),返回我們想要與之建立關(guān)系的實(shí)體的類(lèi)涝焙。由于特定于語(yǔ)言的關(guān)系卑笨,我們只能使用一個(gè)返回類(lèi)的函數(shù),而不是直接使用該類(lèi)仑撞。
同時(shí)也可以把它寫(xiě)成()=> Photo赤兴,但是type => Photo顯得代碼更有可讀性。type 變量本身不包含任何內(nèi)容派草。

我們還添加了一個(gè)@JoinColumn裝飾器搀缠,表明實(shí)體鍵的對(duì)應(yīng)關(guān)系铛楣。關(guān)系可以是單向的或雙向的近迁。但是只有一方是擁有者。在關(guān)系的所有者方面需要使用@JoinColumn 裝飾器簸州。

如果運(yùn)行該應(yīng)用程序鉴竭,你將看到一個(gè)新生成的表,它將包含一個(gè)帶有關(guān)系外鍵的列:

+-------------+--------------+----------------------------+
|                     photo_metadata                      |
+-------------+--------------+----------------------------+
| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |
| height      | int(11)      |                            |
| width       | int(11)      |                            |
| comment     | varchar(255) |                            |
| compressed  | boolean      |                            |
| orientation | varchar(255) |                            |
| photoId     | int(11)      | FOREIGN KEY                |
+-------------+--------------+----------------------------+

保存一對(duì)一的關(guān)系

現(xiàn)在來(lái)創(chuàng)建一個(gè) photo岸浑,它的元信息將它們互相連接起來(lái)搏存。

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";
import { PhotoMetadata } from "./entity/PhotoMetadata";

createConnection(/*...*/)
  .then(async (connection) => {
    // 創(chuàng)建 photo
    let photo = new Photo();
    photo.name = "Me and Bears";
    photo.description = "I am near polar bears";
    photo.filename = "photo-with-bears.jpg";
    photo.isPublished = true;

    // 創(chuàng)建 photo metadata
    let metadata = new PhotoMetadata();
    metadata.height = 640;
    metadata.width = 480;
    metadata.compressed = true;
    metadata.comment = "cybershoot";
    metadata.orientation = "portait";
    metadata.photo = photo; // 聯(lián)接兩者

    // 獲取實(shí)體 repositories
    let photoRepository = connection.getRepository(Photo);
    let metadataRepository = connection.getRepository(PhotoMetadata);

    // 先保存photo
    await photoRepository.save(photo);

    // 然后保存photo的metadata
    await metadataRepository.save(metadata);

    // 完成
    console.log(
      "Metadata is saved, and relation between metadata and photo is created in the database too"
    );
  })
  .catch((error) => console.log(error));

反向關(guān)系

關(guān)系可以是單向的或雙向的。目前 PhotoMetadata 和 Photo 之間的關(guān)系是單向的矢洲。關(guān)系的所有者是 PhotoMetadata璧眠,而 Photo 對(duì) PhotoMetadata 一無(wú)所知。這使得從 Photo 中訪問(wèn) PhotoMetadata 變得很復(fù)雜读虏。要解決這個(gè)問(wèn)題责静,我們應(yīng)該在 PhotoMetadata 和 Photo 之間建立雙向關(guān)系。讓我們來(lái)修改一下實(shí)體:

import {
  Entity,
  Column,
  PrimaryGeneratedColumn,
  OneToOne,
  JoinColumn,
} from "typeorm";
import { Photo } from "./Photo";

@Entity()
export class PhotoMetadata {
  /* ... other columns */

  @OneToOne((type) => Photo, (photo) => photo.metadata)
  @JoinColumn()
  photo: Photo;
}
import { Entity, Column, PrimaryGeneratedColumn, OneToOne } from "typeorm";
import { PhotoMetadata } from "./PhotoMetadata";

@Entity()
export class Photo {
  /* ... other columns */

  @OneToOne((type) => PhotoMetadata, (photoMetadata) => photoMetadata.photo)
  metadata: PhotoMetadata;
}

photo => photo.metadata是用來(lái)指定反向關(guān)系的名稱盖桥。Photo 類(lèi)的元數(shù)據(jù)屬性是在 Photo 類(lèi)中存儲(chǔ) PhotoMetadata 的地方灾螃。你可以選擇簡(jiǎn)單地將字符串傳遞給@OneToOne裝飾器,而不是傳遞返回 photo 屬性的函數(shù)揩徊,例如"metadata"腰鬼。這種函數(shù)類(lèi)型的方法使我們的重構(gòu)更容易嵌赠。

注意,我們應(yīng)該僅在關(guān)系的一側(cè)使用@JoinColumn裝飾器熄赡。你把這個(gè)裝飾者放在哪一方將是這段關(guān)系的擁有方姜挺。關(guān)系的擁有方包含數(shù)據(jù)庫(kù)中具有外鍵的列。

取出關(guān)系對(duì)象的數(shù)據(jù)

在一個(gè)查詢中加載 photo 及 photo metadata 有兩種方法本谜。使用find *或使用QueryBuilder初家。我們先使用find *方法。 find *方法允許你使用FindOneOptions / FindManyOptions接口指定對(duì)象乌助。

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";
import { PhotoMetadata } from "./entity/PhotoMetadata";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let photoRepository = connection.getRepository(Photo);
    let photos = await photoRepository.find({ relations: ["metadata"] });
  })
  .catch((error) => console.log(error));

photos 將包含來(lái)自數(shù)據(jù)庫(kù)的 photos 數(shù)組溜在,每個(gè) photo 將包含其 photo metadata。詳細(xì)了解本文檔中的查找選項(xiàng)他托。

使用查找選項(xiàng)很簡(jiǎn)單掖肋,但是如果你需要更復(fù)雜的查詢,則應(yīng)該使用QueryBuilder赏参。 QueryBuilder允許以更優(yōu)雅的方式使用更復(fù)雜的查詢:

import { createConnection } from "typeorm";
import { Photo } from "./entity/Photo";
import { PhotoMetadata } from "./entity/PhotoMetadata";

createConnection(/*...*/)
  .then(async (connection) => {
    /*...*/
    let photos = await connection
      .getRepository(Photo)
      .createQueryBuilder("photo")
      .innerJoinAndSelect("photo.metadata", "metadata")
      .getMany();
  })
  .catch((error) => console.log(error));

QueryBuilder允許創(chuàng)建和執(zhí)行幾乎任何復(fù)雜性的 SQL 查詢志笼。使用QueryBuilder時(shí),請(qǐng)考慮創(chuàng)建 SQL 查詢把篓。在此示例中纫溃,"photo"和"metadata"是應(yīng)用于所選 photos 的 ?? 別名。你可以使用別名來(lái)訪問(wèn)所選數(shù)據(jù)的列和屬性韧掩。

使用 cascades 自動(dòng)保存相關(guān)對(duì)象

我們可以在關(guān)系中設(shè)置cascade選項(xiàng)紊浩,這是就可以在保存其他對(duì)象的同時(shí)保存相關(guān)對(duì)象。讓我們更改一下的 photo 的@OneToOne裝飾器:

export class Photo {
  /// ... other columns

  @OneToOne((type) => PhotoMetadata, (metadata) => metadata.photo, {
    cascade: true,
  })
  metadata: PhotoMetadata;
}

使用cascade允許就不需要邊存 photo 邊存元數(shù)據(jù)對(duì)象疗锐。我們可以簡(jiǎn)單地保存一個(gè) photo 對(duì)象坊谁,由于使用了 cascade,metadata 也將自動(dòng)保存滑臊。

createConnection(options)
  .then(async (connection) => {
    // 創(chuàng)建 photo 對(duì)象
    let photo = new Photo();
    photo.name = "Me and Bears";
    photo.description = "I am near polar bears";
    photo.filename = "photo-with-bears.jpg";
    photo.isPublished = true;

    // 創(chuàng)建 photo metadata 對(duì)象
    let metadata = new PhotoMetadata();
    metadata.height = 640;
    metadata.width = 480;
    metadata.compressed = true;
    metadata.comment = "cybershoot";
    metadata.orientation = "portait";

    photo.metadata = metadata; // this way we connect them

    // 獲取 repository
    let photoRepository = connection.getRepository(Photo);

    // 保存photo的同時(shí)保存metadata
    await photoRepository.save(photo);

    console.log("Photo is saved, photo metadata is saved too.");
  })
  .catch((error) => console.log(error));

創(chuàng)建多對(duì)一/一對(duì)多關(guān)系

讓我們創(chuàng)建一個(gè)多對(duì)一/一對(duì)多的關(guān)系口芍。假設(shè)一個(gè) photo 有一個(gè) author,每個(gè) author 都可以有多個(gè) photos雇卷。首先讓我們創(chuàng)建一個(gè)Author類(lèi):

import {
  Entity,
  Column,
  PrimaryGeneratedColumn,
  OneToMany,
  JoinColumn,
} from "typeorm";
import { Photo } from "./Photo";

@Entity()
export class Author {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @OneToMany((type) => Photo, (photo) => photo.author) // note: we will create author property in the Photo class below
  photos: Photo[];
}

Author 包含反向關(guān)系鬓椭。
OneToMany 總是反向的, 并且總是與 ManyToOne一起出現(xiàn)。

現(xiàn)在讓我們將關(guān)系的所有者方添加到 Photo 實(shí)體中:

import { Entity, Column, PrimaryGeneratedColumn, ManyToOne } from "typeorm";
import { PhotoMetadata } from "./PhotoMetadata";
import { Author } from "./Author";

@Entity()
export class Photo {
  /* ... other columns */

  @ManyToOne((type) => Author, (author) => author.photos)
  author: Author;
}

在多對(duì)一/一對(duì)多的關(guān)系中关划,擁有方總是多對(duì)一的小染。這意味著使用@ManyToOne的類(lèi)將存儲(chǔ)相關(guān)對(duì)象的 id。
運(yùn)行應(yīng)用程序后祭玉,ORM 將創(chuàng)建author表:

+-------------+--------------+----------------------------+
|                          author                         |
+-------------+--------------+----------------------------+
| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |
| name        | varchar(255) |                            |
+-------------+--------------+----------------------------+

它還將修改photo表氧映,添加新的author列并為其創(chuàng)建外鍵:

+-------------+--------------+----------------------------+
|                         photo                           |
+-------------+--------------+----------------------------+
| id          | int(11)      | PRIMARY KEY AUTO_INCREMENT |
| name        | varchar(255) |                            |
| description | varchar(255) |                            |
| filename    | varchar(255) |                            |
| isPublished | boolean      |                            |
| authorId    | int(11)      | FOREIGN KEY                |
+-------------+--------------+----------------------------+

創(chuàng)建多對(duì)多關(guān)系

假設(shè)一個(gè) photo 可以放在多個(gè) albums 中,每個(gè) albums 可以包含多個(gè) photo脱货。讓我們創(chuàng)建一個(gè)Album類(lèi):

import {
  Entity,
  PrimaryGeneratedColumn,
  Column,
  ManyToMany,
  JoinTable,
} from "typeorm";

@Entity()
export class Album {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @ManyToMany((type) => Photo, (photo) => photo.albums)
  @JoinTable()
  photos: Photo[];
}

@JoinTable需要指定這是關(guān)系的所有者方岛都。

現(xiàn)在添加反向關(guān)系到Photo類(lèi):

export class Photo {
  /// ... other columns

  @ManyToMany((type) => Album, (album) => album.photos)
  albums: Album[];
}

運(yùn)行后律姨,ORM 將創(chuàng)建album_photos_photo_albums_聯(lián)結(jié)表。

+-------------+--------------+----------------------------+
|                album_photos_photo_albums                |
+-------------+--------------+----------------------------+
| album_id    | int(11)      | PRIMARY KEY FOREIGN KEY    |
| photo_id    | int(11)      | PRIMARY KEY FOREIGN KEY    |
+-------------+--------------+----------------------------+

記得在 ORM 中使用 ConnectionOptions 注冊(cè)Album類(lèi):

const options: ConnectionOptions = {
  // ... other options
  entities: [Photo, PhotoMetadata, Author, Album],
};

現(xiàn)在讓我們將 albums 和 photos 插入我們的數(shù)據(jù)庫(kù):

let connection = await createConnection(options);

// create a few albums
let album1 = new Album();
album1.name = "Bears";
await connection.manager.save(album1);

let album2 = new Album();
album2.name = "Me";
await connection.manager.save(album2);

// create a few photos
let photo = new Photo();
photo.name = "Me and Bears";
photo.description = "I am near polar bears";
photo.filename = "photo-with-bears.jpg";
photo.albums = [album1, album2];
await connection.manager.save(photo);

// now our photo is saved and albums are attached to it
// now lets load them:
const loadedPhoto = await connection
  .getRepository(Photo)
  .findOne(1, { relations: ["albums"] });

loadedPhoto 如下所示:

{
    id: 1,
    name: "Me and Bears",
    description: "I am near polar bears",
    filename: "photo-with-bears.jpg",
    albums: [{
        id: 1,
        name: "Bears"
    }, {
        id: 2,
        name: "Me"
    }]
}

使用 QueryBuilder

你可以使用 QueryBuilder 構(gòu)建幾乎任何復(fù)雜性的 SQL 查詢臼疫。例如择份,可以這樣做:

let photos = await connection
  .getRepository(Photo)
  .createQueryBuilder("photo") // first argument is an alias. Alias is what you are selecting - photos. You must specify it.
  .innerJoinAndSelect("photo.metadata", "metadata")
  .leftJoinAndSelect("photo.albums", "album")
  .where("photo.isPublished = true")
  .andWhere("(photo.name = :photoName OR photo.name = :bearName)")
  .orderBy("photo.id", "DESC")
  .skip(5)
  .take(10)
  .setParameters({ photoName: "My", bearName: "Mishka" })
  .getMany();

此查詢選擇所有 published 的 name 等于"My"或"Mishka"的 photos。它將從結(jié)果中的第 5 個(gè)(分頁(yè)偏移)開(kāi)始烫堤,并且僅選擇 10 個(gè)結(jié)果(分頁(yè)限制)荣赶。得到的結(jié)果將按 ID 降序排序。photo 的 albums 將被 left-joined鸽斟,其元數(shù)據(jù)將被 inner joined拔创。

由于 QueryBuilder 的自由度更高,因此在項(xiàng)目中可能會(huì)大量的使用它富蓄。
更多關(guān)于 QueryBuilder 的信息剩燥,可查看

示例

查看示例用法立倍。

下面這些 repositories 可以幫助你快速開(kāi)始:

擴(kuò)展

這幾個(gè)擴(kuò)展可以簡(jiǎn)化 TypeORM 的使用灭红,并將其與其他模塊集成:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市口注,隨后出現(xiàn)的幾起案子变擒,更是在濱河造成了極大的恐慌,老刑警劉巖寝志,帶你破解...
    沈念sama閱讀 211,290評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件娇斑,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡澈段,警方通過(guò)查閱死者的電腦和手機(jī)悠菜,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,107評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門(mén)舰攒,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)败富,“玉大人,你說(shuō)我怎么就攤上這事摩窃∈薅#” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 156,872評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵猾愿,是天一觀的道長(zhǎng)鹦聪。 經(jīng)常有香客問(wèn)我,道長(zhǎng)蒂秘,這世上最難降的妖魔是什么泽本? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,415評(píng)論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮姻僧,結(jié)果婚禮上规丽,老公的妹妹穿的比我還像新娘蒲牧。我一直安慰自己,他們只是感情好赌莺,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,453評(píng)論 6 385
  • 文/花漫 我一把揭開(kāi)白布冰抢。 她就那樣靜靜地躺著,像睡著了一般艘狭。 火紅的嫁衣襯著肌膚如雪挎扰。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,784評(píng)論 1 290
  • 那天巢音,我揣著相機(jī)與錄音遵倦,去河邊找鬼。 笑死官撼,一個(gè)胖子當(dāng)著我的面吹牛骇吭,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播歧寺,決...
    沈念sama閱讀 38,927評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼燥狰,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了斜筐?” 一聲冷哼從身側(cè)響起龙致,我...
    開(kāi)封第一講書(shū)人閱讀 37,691評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎顷链,沒(méi)想到半個(gè)月后目代,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,137評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡嗤练,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,472評(píng)論 2 326
  • 正文 我和宋清朗相戀三年榛了,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片煞抬。...
    茶點(diǎn)故事閱讀 38,622評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡霜大,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出革答,到底是詐尸還是另有隱情战坤,我是刑警寧澤,帶...
    沈念sama閱讀 34,289評(píng)論 4 329
  • 正文 年R本政府宣布残拐,位于F島的核電站途茫,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏溪食。R本人自食惡果不足惜囊卜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,887評(píng)論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧栅组,春花似錦袱衷、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,741評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至排截,卻和暖如春嫌蚤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背断傲。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留认罩,地道東北人箱蝠。 一個(gè)月前我還...
    沈念sama閱讀 46,316評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像间校,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子揭绑,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,490評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容