Class CollectionUtils

Hierarchy

CollectionUtils

Index

Constructors

constructor

Methods

aggregateRelation getFieldSchema getInverseRelation getThroughOrigin getThroughTarget getValue listRelation

Constructors

constructor

new CollectionUtils(): CollectionUtils
Returns CollectionUtils

Methods

`Static` aggregateRelation

aggregateRelation(collection: Collection, id: CompositeId, relationName: string, caller: Caller, foreignFilter: Filter, aggregation: Aggregation, limit?: number): Promise<AggregateResult[]>
Parameters
- collection: Collection
- id: CompositeId
- relationName: string
- caller: Caller
- foreignFilter: Filter
- aggregation: Aggregation
- Optional limit: number
Returns Promise<AggregateResult[]>
- Defined in packages/datasource-toolkit/src/utils/collection.ts:157

`Static` getFieldSchema

getFieldSchema(collection: Collection, path: string): FieldSchema
Parameters
- collection: Collection
- path: string
Returns FieldSchema
- Defined in packages/datasource-toolkit/src/utils/collection.ts:14

`Static` getInverseRelation

getInverseRelation(collection: Collection, relationName: string): string
Parameters
- collection: Collection
- relationName: string
Returns string
- Defined in packages/datasource-toolkit/src/utils/collection.ts:43

`Static` getThroughOrigin

getThroughOrigin(collection: Collection, relationName: string): string
Parameters
- collection: Collection
- relationName: string
Returns string
- Defined in packages/datasource-toolkit/src/utils/collection.ts:75

`Static` getThroughTarget

getThroughTarget(collection: Collection, relationName: string): string
Parameters
- collection: Collection
- relationName: string
Returns string
- Defined in packages/datasource-toolkit/src/utils/collection.ts:94

`Static` getValue

getValue(collection: Collection, caller: Caller, id: CompositeId, field: string): Promise<unknown>
Parameters
- collection: Collection
- caller: Caller
- id: CompositeId
- field: string
Returns Promise<unknown>
- Defined in packages/datasource-toolkit/src/utils/collection.ts:208

`Static` listRelation

listRelation(collection: Collection, id: CompositeId, relationName: string, caller: Caller, foreignFilter: PaginatedFilter, projection: Projection): Promise<RecordData[]>
Parameters
- collection: Collection
- id: CompositeId
- relationName: string
- caller: Caller
- foreignFilter: PaginatedFilter
- projection: Projection
Returns Promise<RecordData[]>
- Defined in packages/datasource-toolkit/src/utils/collection.ts:113

Class CollectionUtils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns CollectionUtils

Methods

Static aggregateRelation

Parameters

collection: Collection

id: CompositeId

relationName: string

caller: Caller

foreignFilter: Filter

aggregation: Aggregation

Optional limit: number

Returns Promise<AggregateResult[]>

Static getFieldSchema

Parameters

collection: Collection

path: string

Returns FieldSchema

Static getInverseRelation

Parameters

collection: Collection

relationName: string

Returns string

Static getThroughOrigin

Parameters

collection: Collection

relationName: string

Returns string

Static getThroughTarget

Parameters

collection: Collection

relationName: string

Returns string

Static getValue

Parameters

collection: Collection

caller: Caller

id: CompositeId

field: string

Returns Promise<unknown>

Static listRelation

Parameters

collection: Collection

id: CompositeId

relationName: string

caller: Caller

foreignFilter: PaginatedFilter

projection: Projection

Returns Promise<RecordData[]>

Settings

Member Visibility

Theme

`Static` aggregateRelation

`Optional` limit: number

`Static` getFieldSchema

`Static` getInverseRelation

`Static` getThroughOrigin

`Static` getThroughTarget

`Static` getValue

`Static` listRelation