Class IndexingRelationshipDriver

Adapter that stores relationships as directional edges via a relational backend.

Index

Constructors

Methods

createRelationship deleteRelationship listRelationships

Constructors

constructor

new IndexingRelationshipDriver(
config: IndexingRelationshipDriverConfig,
): IndexingRelationshipDriver
Parameters
- config: IndexingRelationshipDriverConfig
  Driver configuration for relation indexing.
Returns IndexingRelationshipDriver
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:120

Methods

createRelationship

createRelationship(
    relationship: BaseItemRelationshipInfo,
    toTypeName: string,
    ensureSingle: boolean,
): Promise<void>
Create a relationship via the relational backend.
Parameters
- relationship: BaseItemRelationshipInfo
  Relationship info to create.
- toTypeName: string
  Target type name for the relationship.
- ensureSingle: boolean
  When true, remove existing outgoing edges before inserting.
Returns Promise<void>
Promise resolved once the relationship is stored.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:198

deleteRelationship

deleteRelationship(
relationship: BaseItemRelationshipInfo,
toTypeName: string,
): Promise<void>
Delete a relationship via the relational backend.
Parameters
- relationship: BaseItemRelationshipInfo
  Relationship info to delete.
- toTypeName: string
  Target type name for the relationship.
Returns Promise<void>
Promise resolved once the relationship is removed.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:225

listRelationships

listRelationships(
config: ListRelationshipsConfig,
toTypeName: string,
): Promise<ListItemsResults<ItemRelationshipInfo>>
List relationships via the relational backend.
Parameters
- config: ListRelationshipsConfig
  Relationship list configuration and origin.
- toTypeName: string
  Target type name for the relationship.
Returns Promise<ListItemsResults<ItemRelationshipInfo>>
List results with items and cursor.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:243