Class Handler

Hierarchy

Handler
- GraphHandler

Constructors

constructor

new Handler(): Handler
Returns Handler

Methods

addEdge

addEdge(context: KosmosUserContext<object>, access: AccessControl, edgeName: any, src_uuid: any, src_label: any, dest_uuid: any, dest_label: any, properties: any, unique: any, validate?: boolean, extraInfo?: {
destVertex: any;
srcVertex: any;
}): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- edgeName: any
- src_uuid: any
- src_label: any
- dest_uuid: any
- dest_label: any
- properties: any
- unique: any
- Optional validate: boolean
- Optional extraInfo: {
  destVertex: any;
  srcVertex: any;
  }
  - destVertex: any
  - srcVertex: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:68

allEdgesByTypeFromVertex

allEdgesByTypeFromVertex(context: KosmosUserContext<object>, access: AccessControl, parentId: any, sourceType: any, edgeType: any, vertexType: any, after: any, firstPlusOne: any, orderByProperty?: string, orderBy?: FilterOrderDirection): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- parentId: any
- sourceType: any
- edgeType: any
- vertexType: any
- after: any
- firstPlusOne: any
- Optional orderByProperty: string
- Optional orderBy: FilterOrderDirection
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:182

checkActionAccess

checkActionAccess(context: KosmosUserContext<object>, label: string, uuid: string, action: string): Promise<void>
Parameters
- context: KosmosUserContext<object>
- label: string
- uuid: string
- action: string
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:198

close

close(): void
This is the close method which is triggered on connection close

Returns void
- Defined in src/backends/Handler.d.ts:13

createVertex

createVertex(context: KosmosUserContext<object>, access: AccessControl, type: any, data: any, connectToVertices: any, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, dataSourceWrapper: DataSourceWrapper, validate?: boolean): Promise<void>
Methods which need to be implemented
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- type: any
- data: any
- connectToVertices: any
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- dataSourceWrapper: DataSourceWrapper
- Optional validate: boolean
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:27

deleteEdge

deleteEdge(context: KosmosUserContext<object>, access: AccessControl, edge_id: any, validate?: boolean): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- edge_id: any
- Optional validate: boolean
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:81

deleteVertex

deleteVertex(context: KosmosUserContext<object>, type: any, uuid: any): Promise<void>
Parameters
- context: KosmosUserContext<object>
- type: any
- uuid: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:55

edgeConnection

edgeConnection(parent: any, context: KosmosUserContext<object>, info: any, data: any, inverse?: boolean, runHooks?: boolean): Promise<null | ItemWithId | ListResponse<RetrievedKosmosItem>>
Deprecated
For retrieving data use SingleConnectedVertexLoader, ZeroToManyRelationVertexLoader and ZeroToManyRelationCountLoader services. For GraphQL connection field resolvers, use ConnectionsManager.
Parameters
- parent: any
- context: KosmosUserContext<object>
- info: any
- data: any
- Optional inverse: boolean
- Optional runHooks: boolean
Returns Promise<null | ItemWithId | ListResponse<RetrievedKosmosItem>>
- Defined in src/backends/Handler.d.ts:174

findEdge

findEdge(context: KosmosUserContext<object>, access: AccessControl, src_uuid: any, dest_uuid: any, edge_name: any): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- src_uuid: any
- dest_uuid: any
- edge_name: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:94

findEdgeByEdgeLabelAndDestinationType

findEdgeByEdgeLabelAndDestinationType(context: KosmosUserContext<object>, access: AccessControl, label: any, sourceId: any, direction: any, edgeProperties: any, destinationType: any, vertexProperties: any): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- label: any
- sourceId: any
- direction: any
- edgeProperties: any
- destinationType: any
- vertexProperties: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:120

findEdgeByLabel

findEdgeByLabel(context: KosmosUserContext<object>, access: AccessControl, entity_uuid: any, edge_name: any, out?: boolean, properties?: {}, mapElements?: boolean): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- entity_uuid: any
- edge_name: any
- Optional out: boolean
- Optional properties: {}
- Optional mapElements: boolean
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:101

findVertex

findVertex(context: KosmosUserContext<object>, access: AccessControl, uuid: any, includeLabel: undefined | boolean, type: any): Promise<any>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- uuid: any
- includeLabel: undefined | boolean
- type: any
Returns Promise<any>
- Defined in src/backends/Handler.d.ts:37

findVertexByEdgeLabelAndDestinationType

findVertexByEdgeLabelAndDestinationType(context: KosmosUserContext<object>, access: AccessControl, label: any, sourceId: any, direction: any, edgeProperties: any, destinationType: any, vertexProperties: any): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- label: any
- sourceId: any
- direction: any
- edgeProperties: any
- destinationType: any
- vertexProperties: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:110

getDestinationVertexEdge

getDestinationVertexEdge(vertex: string, edge: string): string
This function is used to get the destination vertex that the source vertex is pointing to via the defined edge/relationship.

Returns
Returns the vertex conencted by the source vertex and edge.
Parameters
- vertex: string
  
  The label of the vertex.
- edge: string
  
  The label of the edge.
Returns string
- Defined in src/backends/Handler.d.ts:23

getEdge

getEdge(context: KosmosUserContext<object>, access: AccessControl, edge_id: any): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- edge_id: any
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:163

getTraitGraphConnection

getTraitGraphConnection(context: KosmosUserContext<object>, useReaderPool?: boolean): Promise<TraitGraphQuery<any>>
Parameters
- context: KosmosUserContext<object>
- Optional useReaderPool: boolean
Returns Promise<TraitGraphQuery<any>>
- Defined in src/backends/Handler.d.ts:194

listEdgesByTypeFromVertex

listEdgesByTypeFromVertex(context: KosmosUserContext<object>, sourceUUID: any, sourceType: any, edgeType: any, offset: any, limit: undefined | number, destinationType: any, bypassAccess: undefined | boolean, filter: any, orderByProperty?: string, orderBy?: FilterOrderDirection, edgeProperties?: {
name: string;
value: any;
}[]): Promise<void>
Deprecated
Use ZeroToManyRelationVertexLoader service
Parameters
- context: KosmosUserContext<object>
- sourceUUID: any
- sourceType: any
- edgeType: any
- offset: any
- limit: undefined | number
- destinationType: any
- bypassAccess: undefined | boolean
- filter: any
- Optional orderByProperty: string
- Optional orderBy: FilterOrderDirection
- Optional edgeProperties: {
  name: string;
  value: any;
  }[]
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:134

listInverseEdgesByTypeFromVertex

listInverseEdgesByTypeFromVertex(context: KosmosUserContext<object>, sourceUUID: any, sourceType: any, edgeType: any, offset: undefined | number, limit: undefined | number, destinationType: any, filter: any, orderByProperty?: string, orderBy?: FilterOrderDirection): Promise<void>
Deprecated
Use ZeroToManyRelationVertexLoader service
Parameters
- context: KosmosUserContext<object>
- sourceUUID: any
- sourceType: any
- edgeType: any
- offset: undefined | number
- limit: undefined | number
- destinationType: any
- filter: any
- Optional orderByProperty: string
- Optional orderBy: FilterOrderDirection
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:151

listVertices

listVertices(context: KosmosUserContext<object>, type: any, offset: any, limit: any, filter: any, filterOrder: any): Promise<ListResponse<RetrievedKosmosItem>>
Parameters
- context: KosmosUserContext<object>
- type: any
- offset: any
- limit: any
- filter: any
- filterOrder: any
Returns Promise<ListResponse<RetrievedKosmosItem>>
- Defined in src/backends/Handler.d.ts:60

updateEdgeProperties

updateEdgeProperties(context: KosmosUserContext<object>, access: AccessControl, edge_id: any, properties: any, validate?: boolean): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- edge_id: any
- properties: any
- Optional validate: boolean
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:87

updateVertex

updateVertex(context: KosmosUserContext<object>, access: AccessControl, type: any, data: any, connectToVertices: any, disconnectFromVertices: any, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, dataSourceWrapper: DataSourceWrapper, validate?: boolean): Promise<void>
Parameters
- context: KosmosUserContext<object>
- access: AccessControl
- type: any
- data: any
- connectToVertices: any
- disconnectFromVertices: any
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- dataSourceWrapper: DataSourceWrapper
- Optional validate: boolean
Returns Promise<void>
- Defined in src/backends/Handler.d.ts:44

Class Handler

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Handler

Methods

addEdge

Parameters

context: KosmosUserContext<object>

access: AccessControl

edgeName: any

src_uuid: any

src_label: any

dest_uuid: any

dest_label: any

properties: any

unique: any

Optional validate: boolean

Optional extraInfo: { destVertex: any; srcVertex: any; }

destVertex: any

srcVertex: any

Returns Promise<void>

allEdgesByTypeFromVertex

Parameters

context: KosmosUserContext<object>

access: AccessControl

parentId: any

sourceType: any

edgeType: any

vertexType: any

after: any

firstPlusOne: any

Optional orderByProperty: string

Optional orderBy: FilterOrderDirection

Returns Promise<void>

checkActionAccess

Parameters

context: KosmosUserContext<object>

label: string

uuid: string

action: string

Returns Promise<void>

close

Returns void

createVertex

Parameters

context: KosmosUserContext<object>

access: AccessControl

type: any

data: any

connectToVertices: any

traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>

dataSourceWrapper: DataSourceWrapper

Optional validate: boolean

Returns Promise<void>

deleteEdge

Parameters

context: KosmosUserContext<object>

access: AccessControl

edge_id: any

Optional validate: boolean

Returns Promise<void>

deleteVertex

Parameters

context: KosmosUserContext<object>

type: any

uuid: any

Returns Promise<void>

edgeConnection

Deprecated

Parameters

parent: any

context: KosmosUserContext<object>

info: any

data: any

Optional inverse: boolean

Optional runHooks: boolean

`Optional` validate: boolean

`Optional` extraInfo: {
destVertex: any;
srcVertex: any;
}

`Optional` orderByProperty: string

`Optional` orderBy: FilterOrderDirection

`Optional` validate: boolean

`Optional` validate: boolean

`Optional` inverse: boolean

`Optional` runHooks: boolean

`Optional` out: boolean

`Optional` properties: {}

`Optional` mapElements: boolean

`Optional` useReaderPool: boolean