Vai al contenuto principale

Opzioni di Ricerca

Traduzione Beta Non Ufficiale

Questa pagina è stata tradotta da PageTurner AI (beta). Non ufficialmente approvata dal progetto. Hai trovato un errore? Segnala problema →

Opzioni di base

Tutti i metodi .find* dei repository e dei manager accettano opzioni speciali che puoi utilizzare per interrogare i dati necessari senza usare QueryBuilder:

  • select - indica quali proprietà dell'oggetto principale devono essere selezionate
userRepository.find({
select: {
firstName: true,
lastName: true,
},
})

eseguirà la seguente query:

SELECT "firstName", "lastName" FROM "user"
  • relations - relazioni da caricare con l'entità principale. Possono essere caricate anche sotto-relazioni (scorciatoia per join e leftJoinAndSelect)
userRepository.find({
relations: {
profile: true,
photos: true,
videos: true,
},
})
userRepository.find({
relations: {
profile: true,
photos: true,
videos: {
videoAttributes: true,
},
},
})

eseguirà le seguenti query:

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 - condizioni semplici per interrogare l'entità.
userRepository.find({
where: {
firstName: "Timber",
lastName: "Saw",
},
})

eseguirà la seguente query:

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

L'interrogazione di una colonna da un'entità incorporata deve rispettare la gerarchia in cui è stata definita. Esempio:

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

eseguirà la seguente query:

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

Interrogazione con operatore OR:

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

eseguirà la seguente query:

SELECT * FROM "user" WHERE ("firstName" = 'Timber' AND "lastName" = 'Saw') OR ("firstName" = 'Stan' AND "lastName" = 'Lee')
  • order - ordine di selezione.
userRepository.find({
order: {
name: "ASC",
id: "DESC",
},
})

eseguirà la seguente query:

SELECT * FROM "user"
ORDER BY "name" ASC, "id" DESC
  • withDeleted - include entità eliminate logicamente con softDelete o softRemove, ad esempio quelle con colonna @DeleteDateColumn impostata. Per impostazione predefinita, le entità eliminate logicamente non sono incluse.
userRepository.find({
withDeleted: true,
})

I metodi find* che restituiscono più entità (find, findBy, findAndCount, findAndCountBy) accettano anche le seguenti opzioni:

  • skip - offset (paginato) da cui iniziare a prendere le entità.
userRepository.find({
skip: 5,
})
SELECT * FROM "user"
OFFSET 5
  • take - limite (paginato) - numero massimo di entità da prendere.
userRepository.find({
take: 10,
})

eseguirà la seguente query:

SELECT * FROM "user"
LIMIT 10

** skip e take dovrebbero essere usati insieme

** Se usi TypeORM con MSSQL e vuoi utilizzare take o limit, devi specificare anche l'ordine, altrimenti riceverai l'errore: 'Invalid usage of the option NEXT in the FETCH statement.'

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

eseguirà la seguente query:

SELECT * FROM "user"
ORDER BY "columnName" ASC
LIMIT 10 OFFSET 0
  • cache - Abilita o disabilita la cache dei risultati della query. Vedi caching per maggiori informazioni e opzioni.
userRepository.find({
cache: true,
})
  • lock - Abilita il meccanismo di lock per la query. Può essere utilizzato solo nei metodi findOne e findOneBy. lock è un oggetto che può essere definito come:
{ mode: "optimistic", version: number | Date }

oppure

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

ad esempio:

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

Consulta lock modes per maggiori informazioni

Esempio completo di opzioni di ricerca:

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

Ricerca senza argomenti:

userRepository.find()

eseguirà la seguente query:

SELECT * FROM "user"

Opzioni avanzate

TypeORM offre molti operatori integrati per creare confronti più complessi:

  • Not
import { Not } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "title" != 'About #1'
  • LessThan
import { LessThan } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "likes" < 10
  • LessThanOrEqual
import { LessThanOrEqual } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "likes" <= 10
  • MoreThan
import { MoreThan } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "likes" > 10
  • MoreThanOrEqual
import { MoreThanOrEqual } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "likes" >= 10
  • Equal
import { Equal } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "title" = 'About #2'
  • Like
import { Like } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "title" LIKE '%out #%'
  • ILike
import { ILike } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "title" ILIKE '%out #%'
  • Between
import { Between } from "typeorm"

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

eseguirà la seguente query:

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

eseguirà la seguente query:

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

eseguirà la seguente query (notazione 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(),
})

eseguirà la seguente query:

SELECT * FROM "post" WHERE "title" IS NULL
  • ArrayContains
import { ArrayContains } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "categories" @> '{TypeScript}'
  • ArrayContainedBy
import { ArrayContainedBy } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "categories" <@ '{TypeScript}'
  • ArrayOverlap
import { ArrayOverlap } from "typeorm"

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

eseguirà la seguente query:

SELECT * FROM "post" WHERE "categories" && '{TypeScript}'
  • JsonContains (solo PostgreSQL/CockroachDB)
import { JsonContains } from "typeorm"

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

eseguirà la seguente query:

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

eseguirà la seguente query:

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

Nel caso più semplice, una query raw viene inserita subito dopo il simbolo di uguale. Ma puoi anche riscrivere completamente la logica di confronto utilizzando la funzione.

import { Raw } from "typeorm"

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

eseguirà la seguente query:

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

Se devi fornire input utente, non includerlo direttamente nella query per evitare vulnerabilità SQL injection. Utilizza invece il secondo argomento della funzione Raw per passare parametri da associare alla query.

import { Raw } from "typeorm"

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

eseguirà la seguente query:

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

Se devi fornire input utente sotto forma di array, puoi associarli come elenco di valori nell'istruzione SQL usando una sintassi speciale:

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

eseguirà la seguente query:

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

Combinazione di opzioni avanzate

Puoi anche combinare questi operatori con quelli seguenti:

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

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

eseguirà la seguente query:

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

eseguirà la seguente query:

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

eseguirà la seguente query:

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