nocobase/docs/en-US/api/database/relation-repository/has-many-repository.md
2023-01-26 22:58:32 +08:00

2.5 KiB

HasManyRepository

HasManyRepository is the Relation Repository for handling HasMany relationships.

Class Method

find()

Find associated objects.

Signature

  • async find(options?: FindOptions): Promise<M[]>

Detailed Information

Query parameters are the same as Repository.find().

findOne()

Find associated objects, only to return one record.

Signature

  • async findOne(options?: FindOneOptions): Promise<M>

count()

Return the number of records matching the query criteria.

Signature

  • async count(options?: CountOptions)

Type

interface CountOptions extends Omit<SequelizeCountOptions, 'distinct' | 'where' | 'include'>, Transactionable {
  filter?: Filter;
}

findAndCount()

Find datasets from the database with the specified filtering conditions and return the number of results.

Signature

  • async findAndCount(options?: FindAndCountOptions): Promise<[any[], number]>

Type

type FindAndCountOptions = CommonFindOptions

create()

Create associated objects.

Signature

  • async create(options?: CreateOptions): Promise<M>

update()

Update associated objects that match the conditions.

Signature

  • async update(options?: UpdateOptions): Promise<M>

destroy()

Delete associated objects.

Signature

  • async destroy(options?: TK | DestroyOptions): Promise<M>

add()

Add association relationships between objects.

Signature

  • async add(options: TargetKey | TargetKey[] | AssociatedOptions)

Type

interface AssociatedOptions extends Transactionable {
  tk?: TargetKey | TargetKey[];
}

Detailed Information

  • tk - The targetKey value of the associated object, either as a single value or an array.

remove()

Remove the association with the given object.

Signature

  • async remove(options: TargetKey | TargetKey[] | AssociatedOptions)

Detailed Information

Same parameters as the add() method.

set()

Set the associated object of the current relationship.

Signature

  • async set(options: TargetKey | TargetKey[] | AssociatedOptions)

Detailed Information

Same parameters as the add() method.