查询选项

非官方测试版翻译

本页面由 PageTurner AI 翻译（测试版）。未经项目官方认可。 发现错误？ 报告问题 →

基础选项

所有仓库和管理器的 .find* 方法都接受特殊选项，您无需使用 QueryBuilder 即可查询所需数据：

• select - 指定主对象必须选择的属性

userRepository.find({
    select: {
        firstName: true,
        lastName: true,
    },
})

将执行以下查询：

SELECT "firstName", "lastName" FROM "user"

• relations - 需要随主实体加载的关系（支持加载子关系，是 join 和 leftJoinAndSelect 的简写形式）

userRepository.find({
    relations: {
        profile: true,
        photos: true,
        videos: true,
    },
})
userRepository.find({
    relations: {
        profile: true,
        photos: true,
        videos: {
            videoAttributes: true,
        },
    },
})

将执行以下查询：

SELECT * FROM "user"
LEFT JOIN "profile" ON "profile"."id" = "user"."profileId"
LEFT JOIN "photos" ON "photos"."id" = "user"."photoId"
LEFT JOIN "videos" ON "videos"."id" = "user"."videoId"

SELECT * FROM "user"
LEFT JOIN "profile" ON "profile"."id" = "user"."profileId"
LEFT JOIN "photos" ON "photos"."id" = "user"."photoId"
LEFT JOIN "videos" ON "videos"."id" = "user"."videoId"
LEFT JOIN "video_attributes" ON "video_attributes"."id" = "videos"."video_attributesId"

• where - 用于查询实体的简单条件

userRepository.find({
    where: {
        firstName: "Timber",
        lastName: "Saw",
    },
})

将执行以下查询：

SELECT * FROM "user"
WHERE "firstName" = 'Timber' AND "lastName" = 'Saw'

查询嵌入实体的列时，应按照其定义层次结构进行。例如：

userRepository.find({
    relations: {
        project: true,
    },
    where: {
        project: {
            name: "TypeORM",
            initials: "TORM",
        },
    },
})

将执行以下查询：

SELECT * FROM "user"
LEFT JOIN "project" ON "project"."id" = "user"."projectId"
WHERE "project"."name" = 'TypeORM' AND "project"."initials" = 'TORM'

使用 OR 运算符查询：

userRepository.find({
    where: [
        { firstName: "Timber", lastName: "Saw" },
        { firstName: "Stan", lastName: "Lee" },
    ],
})

将执行以下查询：

SELECT * FROM "user" WHERE ("firstName" = 'Timber' AND "lastName" = 'Saw') OR ("firstName" = 'Stan' AND "lastName" = 'Lee')

• order - 结果排序规则

userRepository.find({
    order: {
        name: "ASC",
        id: "DESC",
    },
})

将执行以下查询：

SELECT * FROM "user"
ORDER BY "name" ASC, "id" DESC

• withDeleted - 包含已被 softDelete 或 softRemove 软删除的实体（即设置了 @DeleteDateColumn 列的实体），默认不包含软删除实体

userRepository.find({
    withDeleted: true,
})

返回多个实体的 find* 方法（find, findBy, findAndCount, findAndCountBy）还接受以下选项：

• skip - 实体获取的偏移量（用于分页）

userRepository.find({
    skip: 5,
})

SELECT * FROM "user"
OFFSET 5

• take - 实体获取的数量上限（用于分页）

userRepository.find({
    take: 10,
})

将执行以下查询：

SELECT * FROM "user"
LIMIT 10

** skip 和 take 需配合使用**

** 在 MSSQL 中使用 TypeORM 时，若需使用 take 或 limit，必须同时指定排序规则，否则将出现错误：'Invalid usage of the option NEXT in the FETCH statement.'**

userRepository.find({
    order: {
        columnName: "ASC",
    },
    skip: 0,
    take: 10,
})

将执行以下查询：

SELECT * FROM "user"
ORDER BY "columnName" ASC
LIMIT 10 OFFSET 0

• cache - 启用或禁用查询结果缓存，详见缓存

userRepository.find({
    cache: true,
})

• lock - 启用查询锁定机制（仅适用于 findOne 和 findOneBy 方法） lock 是对象类型，可定义为：

{ mode: "optimistic", version: number | Date }

或

{
    mode: "pessimistic_read" |
        "pessimistic_write" |
        "dirty_read" |
        /*
            "pessimistic_partial_write" and "pessimistic_write_or_fail" are deprecated and
            will be removed in a future version.

            Use onLocked instead.
         */
        "pessimistic_partial_write" |
        "pessimistic_write_or_fail" |
        "for_no_key_update" |
        "for_key_share",

    tables: string[],
    onLocked: "nowait" | "skip_locked"
}

例如：

userRepository.findOne({
    where: {
        id: 1,
    },
    lock: { mode: "optimistic", version: 1 },
})

详见锁模式获取更多信息

查询选项完整示例：

userRepository.find({
    select: {
        firstName: true,
        lastName: true,
    },
    relations: {
        profile: true,
        photos: true,
        videos: true,
    },
    where: {
        firstName: "Timber",
        lastName: "Saw",
        profile: {
            userName: "tshaw",
        },
    },
    order: {
        name: "ASC",
        id: "DESC",
    },
    skip: 5,
    take: 10,
    cache: true,
})

无参数查询：

userRepository.find()

将执行以下查询：

SELECT * FROM "user"

高级选项

TypeORM 提供大量内置运算符用于创建复杂条件比较：

• Not

import { Not } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Not("About #1"),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" != 'About #1'

• LessThan

import { LessThan } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: LessThan(10),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" < 10

• LessThanOrEqual

import { LessThanOrEqual } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: LessThanOrEqual(10),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" <= 10

• MoreThan

import { MoreThan } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: MoreThan(10),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" > 10

• MoreThanOrEqual

import { MoreThanOrEqual } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: MoreThanOrEqual(10),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" >= 10

• Equal

import { Equal } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Equal("About #2"),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" = 'About #2'

• Like

import { Like } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Like("%out #%"),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" LIKE '%out #%'

• ILike

import { ILike } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: ILike("%out #%"),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" ILIKE '%out #%'

• Between

import { Between } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: Between(1, 10),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" BETWEEN 1 AND 10

• In

import { In } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: In(["About #2", "About #3"]),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" IN ('About #2','About #3')

• Any

import { Any } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Any(["About #2", "About #3"]),
})

将执行以下查询（Postgres 语法）：

SELECT * FROM "post" WHERE "title" = ANY(['About #2','About #3'])

• IsNull

import { IsNull } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: IsNull(),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" IS NULL

• ArrayContains

import { ArrayContains } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    categories: ArrayContains(["TypeScript"]),
})

将执行以下查询：

SELECT * FROM "post" WHERE "categories" @> '{TypeScript}'

• ArrayContainedBy

import { ArrayContainedBy } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    categories: ArrayContainedBy(["TypeScript"]),
})

将执行以下查询：

SELECT * FROM "post" WHERE "categories" <@ '{TypeScript}'

• ArrayOverlap

import { ArrayOverlap } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    categories: ArrayOverlap(["TypeScript"]),
})

将执行以下查询：

SELECT * FROM "post" WHERE "categories" && '{TypeScript}'

• JsonContains (仅 PostgreSQL/CockroachDB 支持)

import { JsonContains } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    metadata: JsonContains({ author: { name: "John" } }),
})

将执行以下查询：

SELECT * FROM "post" WHERE "metadata" ::jsonb @> '{"author":{"name":"John"}}'

• Raw

import { Raw } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: Raw("dislikes - 4"),
})

将执行以下查询：

SELECT * FROM "post" WHERE "likes" = "dislikes" - 4

最简单的情况下，原始查询会直接插入在等号后面。但你也可以通过函数完全重写比较逻辑：

import { Raw } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    currentDate: Raw((alias) => `${alias} > NOW()`),
})

将执行以下查询：

SELECT * FROM "post" WHERE "currentDate" > NOW()

如果需要提供用户输入，切勿直接将用户输入包含在查询中，否则可能导致 SQL 注入漏洞。你应该使用 Raw 函数的第二个参数来提供需要绑定的参数列表：

import { Raw } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    currentDate: Raw((alias) => `${alias} > :date`, { date: "2020-10-06" }),
})

将执行以下查询：

SELECT * FROM "post" WHERE "currentDate" > '2020-10-06'

当需要提供数组类型的用户输入时，可以通过特殊表达式语法将这些值作为列表绑定到 SQL 语句中：

import { Raw } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Raw((alias) => `${alias} IN (:...titles)`, {
        titles: [
            "Go To Statement Considered Harmful",
            "Structured Programming",
        ],
    }),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" IN ('Go To Statement Considered Harmful', 'Structured Programming')

组合高级选项

你还可以将这些操作符与以下逻辑组合使用：

• Not

import { Not, MoreThan, Equal } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    likes: Not(MoreThan(10)),
    title: Not(Equal("About #2")),
})

将执行以下查询：

SELECT * FROM "post" WHERE NOT("likes" > 10) AND NOT("title" = 'About #2')

• Or

import { Or, Equal, ILike } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: Or(Equal("About #2"), ILike("About%")),
})

将执行以下查询：

SELECT * FROM "post" WHERE "title" = 'About #2' OR "title" ILIKE 'About%'

• And

import { And, Not, Equal, ILike } from "typeorm"

const loadedPosts = await dataSource.getRepository(Post).findBy({
    title: And(Not(Equal("About #2")), ILike("%About%")),
})

将执行以下查询：

SELECT * FROM "post" WHERE NOT("title" = 'About #2') AND "title" ILIKE '%About%'