Class TypeInfoORMService

A service using TypeInfo to perform ORM operations with one or many DBServiceItemDriver instances.

Implements

TypeInfoORMAPI

Index

Methods

checkRelationships create createRelationship delete deleteRelationship list listRelationships read update

Methods

checkRelationships

checkRelationships(relationshipItemOrigin, candidateToPrimaryFieldValues): Promise<CheckRelationshipsResults>
Check which relationships exist for a list of candidate items.
Parameters
- relationshipItemOrigin: {
      fromTypeFieldName: string;
      fromTypeName: string;
      fromTypePrimaryFieldValue: string;
  }
  - fromTypeFieldName: string
  - fromTypeName: string
  - fromTypePrimaryFieldValue: string
- candidateToPrimaryFieldValues: string[]
Returns Promise<CheckRelationshipsResults>
Implementation of TypeInfoORMAPI.checkRelationships
- Defined in src/api/ORM/TypeInfoORMService.ts:873

create

create(typeName, item): Promise<any>
Create a new item of the given type.
Parameters
- typeName: string
- item: TypeInfoDataItem
Returns Promise<any>
Implementation of TypeInfoORMAPI.create
- Defined in src/api/ORM/TypeInfoORMService.ts:1247

createRelationship

createRelationship(relationshipItem): Promise<boolean>
Create a new relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
Returns Promise<boolean>
Implementation of TypeInfoORMAPI.createRelationship
- Defined in src/api/ORM/TypeInfoORMService.ts:623

delete

delete(typeName, primaryFieldValue): Promise<boolean>
Delete an existing item of the given type.
Parameters
- typeName: string
- primaryFieldValue: any
Returns Promise<boolean>
Implementation of TypeInfoORMAPI.delete
- Defined in src/api/ORM/TypeInfoORMService.ts:1418

deleteRelationship

deleteRelationship(relationshipItem): Promise<DeleteRelationshipResults>
Delete a relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
Returns Promise<DeleteRelationshipResults>
Implementation of TypeInfoORMAPI.deleteRelationship
- Defined in src/api/ORM/TypeInfoORMService.ts:731

list

list(typeName, config, selectedFields?): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List items of the given type, with the given criteria.
Parameters
- typeName: string
- config: ListItemsConfig
- Optional selectedFields: string[]
Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
Implementation of TypeInfoORMAPI.list
- Defined in src/api/ORM/TypeInfoORMService.ts:1458

listRelationships

listRelationships(config): Promise<ListItemsResults<ItemRelationshipInfo>>
List the relationships for a given item.
Parameters
- config: ListRelationshipsConfig
Returns Promise<ListItemsResults<ItemRelationshipInfo>>
Implementation of TypeInfoORMAPI.listRelationships
- Defined in src/api/ORM/TypeInfoORMService.ts:803

read

read(typeName, primaryFieldValue, selectedFields?): Promise<Partial<TypeInfoDataItem>>
Read an existing item of the given type.
Parameters
- typeName: string
- primaryFieldValue: any
- Optional selectedFields: string[]
Returns Promise<Partial<TypeInfoDataItem>>
Implementation of TypeInfoORMAPI.read
- Defined in src/api/ORM/TypeInfoORMService.ts:1274

update

update(typeName, item): Promise<boolean>
Update an existing item of the given type.

This update will always act as a patch. Use null to signify the deletion of a field. Assign values to all fields to perform a replacement.

The item must always contain its primary field value.
Parameters
- typeName: string
- item: TypeInfoDataItem
Returns Promise<boolean>
Implementation of TypeInfoORMAPI.update
- Defined in src/api/ORM/TypeInfoORMService.ts:1328