Find-Optionen

Inoffizielle Beta-Übersetzung

Diese Seite wurde von PageTurner AI übersetzt (Beta). Nicht offiziell vom Projekt unterstützt. Fehler gefunden? Problem melden →

Grundlegende Optionen

Alle .find*-Methoden von Repository und Manager akzeptieren spezielle Optionen, mit denen Sie Daten abfragen können, ohne QueryBuilder zu verwenden:

• select - gibt an, welche Eigenschaften des Hauptobjekts ausgewählt werden müssen

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

führt folgende Abfrage aus:

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

• relations - Beziehungen, die mit der Hauptentität geladen werden sollen. Unterbeziehungen können ebenfalls geladen werden (Kurzform für join und leftJoinAndSelect)

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

führt folgende Abfragen aus:

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 - einfache Bedingungen, nach denen die Entität abgefragt werden soll

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

führt folgende Abfrage aus:

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

Das Abfragen einer Spalte aus einer eingebetteten Entität sollte entsprechend der Hierarchie erfolgen, in der sie definiert wurde. Beispiel:

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

führt folgende Abfrage aus:

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

Abfragen mit OR-Operator:

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

führt folgende Abfrage aus:

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

• order - Reihenfolge der Auswahl

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

führt folgende Abfrage aus:

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

• withDeleted - schließt Entitäten ein, die mit softDelete oder softRemove weich gelöscht wurden, d.h. deren @DeleteDateColumn gesetzt ist. Standardmäßig werden weich gelöschte Entitäten nicht eingeschlossen

userRepository.find({
    withDeleted: true,
})

find*-Methoden, die mehrere Entitäten zurückgeben (find, findBy, findAndCount, findAndCountBy), akzeptieren zusätzlich folgende Optionen:

• skip - Offset (paginierte Abfrage), ab dem Entitäten genommen werden sollen

userRepository.find({
    skip: 5,
})

SELECT * FROM "user"
OFFSET 5

• take - Limit (paginierte Abfrage) - maximale Anzahl der zu berücksichtigenden Entitäten

userRepository.find({
    take: 10,
})

führt folgende Abfrage aus:

SELECT * FROM "user"
LIMIT 10

** skip und take sollten gemeinsam verwendet werden

** Bei Verwendung von TypeORM mit MSSQL müssen Sie bei Nutzung von take oder limit auch order angeben, andernfalls erhalten Sie den Fehler: 'Invalid usage of the option NEXT in the FETCH statement.'

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

führt folgende Abfrage aus:

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

• cache - Aktiviert oder deaktiviert das Caching von Abfrageergebnissen. Weitere Informationen und Optionen finden Sie unter Caching

userRepository.find({
    cache: true,
})

• lock - Aktiviert den Sperrmechanismus für die Abfrage. Kann nur in den Methoden findOne und findOneBy verwendet werden lock ist ein Objekt, das wie folgt definiert werden kann:

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

oder

{
    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"
}

Beispiel:

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

Weitere Informationen finden Sie unter Sperrmodi

Vollständiges Beispiel für Find-Optionen:

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,
})

Find ohne Argumente:

userRepository.find()

führt folgende Abfrage aus:

SELECT * FROM "user"

Erweiterte Optionen

TypeORM bietet zahlreiche integrierte Operatoren für komplexere Vergleiche:

• Not

import { Not } from "typeorm"

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

führt folgende Abfrage aus:

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

• LessThan

import { LessThan } from "typeorm"

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

führt folgende Abfrage aus:

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

• LessThanOrEqual

import { LessThanOrEqual } from "typeorm"

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

führt folgende Abfrage aus:

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

• MoreThan

import { MoreThan } from "typeorm"

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

führt folgende Abfrage aus:

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

• MoreThanOrEqual

import { MoreThanOrEqual } from "typeorm"

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

führt folgende Abfrage aus:

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

• Equal

import { Equal } from "typeorm"

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

führt folgende Abfrage aus:

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

• Like

import { Like } from "typeorm"

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

führt folgende Abfrage aus:

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

• ILike

import { ILike } from "typeorm"

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

führt folgende Abfrage aus:

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

• Between

import { Between } from "typeorm"

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

führt folgende Abfrage aus:

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"]),
})

führt folgende Abfrage aus:

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"]),
})

führt folgende Abfrage aus (Postgres-Notation):

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

• IsNull

import { IsNull } from "typeorm"

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

führt folgende Abfrage aus:

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

• ArrayContains

import { ArrayContains } from "typeorm"

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

führt folgende Abfrage aus:

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

• ArrayContainedBy

import { ArrayContainedBy } from "typeorm"

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

führt folgende Abfrage aus:

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

• ArrayOverlap

import { ArrayOverlap } from "typeorm"

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

führt folgende Abfrage aus:

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

• JsonContains (nur PostgreSQL/CockrochDB)

import { JsonContains } from "typeorm"

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

führt folgende Abfrage aus:

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"),
})

führt folgende Abfrage aus:

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

Im einfachsten Fall wird eine Rohabfrage direkt nach dem Gleichheitszeichen eingefügt. Sie können jedoch auch die gesamte Vergleichslogik mithilfe der Funktion neu schreiben.

import { Raw } from "typeorm"

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

führt folgende Abfrage aus:

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

Wenn Sie Benutzereingaben verwenden müssen, sollten Sie diese nicht direkt in Ihre Abfrage einfügen, da dies zu einer SQL-Injection-Schwachstelle führen kann. Stattdessen können Sie das zweite Argument der Raw-Funktion nutzen, um eine Liste von Parametern anzugeben, die an die Abfrage gebunden werden sollen.

import { Raw } from "typeorm"

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

führt folgende Abfrage aus:

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

Wenn Sie Benutzereingaben übergeben müssen, die ein Array sind, können Sie diese als Werteliste in der SQL-Anweisung binden, indem Sie die spezielle Ausdruckssyntax verwenden:

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",
        ],
    }),
})

führt folgende Abfrage aus:

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

Kombinieren erweiterter Optionen

Sie können diese Operatoren auch mit folgenden kombinieren:

• Not

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

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

führt folgende Abfrage aus:

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%")),
})

führt folgende Abfrage aus:

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%")),
})

führt folgende Abfrage aus:

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