Method getReference

packages/core/src/EntityManager.ts:2266–2290

* Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded

(
    entityName: EntityName<Entity>,
    id: Primary<Entity>,
    options: GetReferenceOptions = {},
  )

   * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
   */
  getReference<Entity extends object>(
    entityName: EntityName<Entity>,
    id: Primary<Entity>,
    options: GetReferenceOptions = {},
  ): Entity | Ref<Entity> | Reference<Entity> {
    options.schema ??= this.schema;
    options.convertCustomTypes ??= false;
    const meta = this.metadata.get(entityName);

    if (Utils.isPrimaryKey(id)) {
      if (meta.compositePK) {
        throw ValidationError.invalidCompositeIdentifier(meta);
      }

      id = [id] as Primary<Entity>;
    }

    const entity = this.getEntityFactory().createReference<Entity>(entityName, id, { merge: true, ...options });

    if (options.wrapped) {
      return Reference.create(entity);
    }

    return entity;
  }

  /**
   * Returns total number of entities matching your `where` query.