Skip to main content
Module

x/typeorm/src/index.ts>RelationQueryBuilder

Forked from https://github.com/typeorm/typeorm
denolib/typeorm
Latest
class RelationQueryBuilder
extends QueryBuilder<Entity>
import { RelationQueryBuilder } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/index.ts";

Allows to work with entity relations and perform specific operations with those relations.

todo: add transactions everywhere

Methods

add(value: any | any[]): Promise<void>

Adds (binds) given value to entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

addAndRemove(added: any | any[], removed: any | any[]): Promise<void>

Adds (binds) and removes (unbinds) given values to/from entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

getQuery(): string

Gets generated sql query without parameters being replaced.

loadMany<T = any>(): Promise<T[]>

Loads many entities (relational) from the relation. You can also provide ids of relational entities to filter by.

loadOne<T = any>(): Promise<T | undefined>

Loads a single entity (relational) from the relation. You can also provide id of relational entity to filter by.

of(entity: any | any[]): this

Sets entity (target) which relations will be updated.

remove(value: any | any[]): Promise<void>

Removes (unbinds) given value from entity relation. Value can be entity, entity id or entity id map (if entity has composite ids). Value also can be array of entities, array of entity ids or array of entity id maps (if entity has composite ids). Works only for many-to-many and one-to-many relations. For many-to-one and one-to-one use #set method instead.

set(value: any): Promise<void>

Sets entity relation's value. Value can be entity, entity id or entity id map (if entity has composite ids). Works only for many-to-one and one-to-one relations. For many-to-many and one-to-many relations use #add and #remove methods instead.