import { QueryBuilder } from "./QueryBuilder"; import type { ObjectLiteral } from "../common/ObjectLiteral"; /** * Allows to work with entity relations and perform specific operations with those relations. * * todo: add transactions everywhere */ export declare class RelationQueryBuilder extends QueryBuilder { readonly "@instanceof": symbol; /** * Gets generated SQL query without parameters being replaced. */ getQuery(): string; /** * Sets entity (target) which relations will be updated. * * @param entity */ of(entity: any | any[]): this; /** * 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. * * @param value */ set(value: any): Promise; /** * 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. * * @param value */ add(value: any | any[]): Promise; /** * 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. * * @param value */ remove(value: any | any[]): Promise; /** * 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. * * @param added * @param removed */ addAndRemove(added: any | any[], removed: any | any[]): Promise; /** * Loads a single entity (relational) from the relation. * You can also provide id of relational entity to filter by. */ loadOne(): Promise; /** * Loads many entities (relational) from the relation. * You can also provide ids of relational entities to filter by. */ loadMany(): Promise; }