Class DataSourceWrapper

Hierarchy

DataSourceWrapper

Constructors

constructor

new DataSourceWrapper(): DataSourceWrapper
Returns DataSourceWrapper

Methods

addEdge

addEdge<TCreatedItem>(context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, edgeName: string, srcUuid: string, srcLabel: undefined | string, destUuid: string, destLabel: undefined | string, properties: Record<string, any>, unique: boolean, validate?: boolean, executeHooks?: boolean): Promise<TCreatedItem>
Creates an edge.
Type Parameters
- TCreatedItem = Record<string, any>
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities
- edgeName: string
  
  The label of the edge that is to be created
- srcUuid: string
- srcLabel: undefined | string
- destUuid: string
- destLabel: undefined | string
- properties: Record<string, any>
  
  The initial data that to be added to the edge
- unique: boolean
  
  TRUE to make edge unique
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
- Optional executeHooks: boolean
Returns Promise<TCreatedItem>
- Defined in src/backends/DataSourceWrapper.d.ts:229

checkActionAccess

checkActionAccess(context: KosmosUserContext<object>, label: string, uuid: string, action: string, throwError?: boolean): Promise<boolean>
Runs ACL for the specific action.

Returns
Parameters
- context: KosmosUserContext<object>
  
  the context of the user who the call is being made on behalf of.
- label: string
  
  entiti label
- uuid: string
  
  entity ID
- action: string
  
  policy action
- Optional throwError: boolean
  
  throw an error on forbidden
Returns Promise<boolean>
- Defined in src/backends/DataSourceWrapper.d.ts:525

createVertex

createVertex<TCreatedItem>(context: KosmosUserContext<object>, type: string, data: Record<string, any>, connectToVertices: ConnectionToAdd[], validate?: boolean, traitData?: TraitDataObject<unknown, Record<string, any>, Promise<any>>, executeHooksArg?: boolean): Promise<TCreatedItem>
This function is used to create a vertex

TODO: Remove data argument, use traitData.args instead since it's the same.
Type Parameters
- TCreatedItem = Record<string, any>
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- type: string
  
  The type of vertex that is to be created
- data: Record<string, any>
  
  The initial data that to be added to the vertex
- connectToVertices: ConnectionToAdd[]
  
  The connections that should be added to the vertex once it has been created.
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
- Optional traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities TODO document traitData object.
- Optional executeHooksArg: boolean
Returns Promise<TCreatedItem>
- Defined in src/backends/DataSourceWrapper.d.ts:159

deleteCacheItemById

deleteCacheItemById(context: KosmosUserContext<object>, id: string): Promise<void>
This function is used to delete a Vertex by ID from the cache.
Parameters
- context: KosmosUserContext<object>
  
  The context of the user
- id: string
  
  The id of the item to delete
Returns Promise<void>
- Defined in src/backends/DataSourceWrapper.d.ts:540

deleteEdge

deleteEdge<InVertex, OutVertex, TDeletedItem>(context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, edgeId: string, validate?: boolean, executeHooks?: boolean): Promise<{
done: boolean;
value: TDeletedItem;
}>
Deletes an edge.
Type Parameters
- InVertex extends ItemWithIdAndLabel
- OutVertex extends ItemWithIdAndLabel
- TDeletedItem extends ConnectionItem<InVertex, OutVertex, TDeletedItem>
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities
- edgeId: string
  
  The ID of the edge that is to be deleted
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
- Optional executeHooks: boolean
Returns Promise<{
done: boolean;
value: TDeletedItem;
}>
- Defined in src/backends/DataSourceWrapper.d.ts:253

deleteVertex

deleteVertex(context: KosmosUserContext<object>, type: string, uuid: string, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, validate?: boolean): Promise<{
id?: string;
}>
This function is used to delete an entity specified by a uuid.
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- type: string
  
  The type of entity to be deleted.
- uuid: string
  
  The uuid of the entity.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
Returns Promise<{
id?: string;
}>
- Defined in src/backends/DataSourceWrapper.d.ts:180

edgeConnection

edgeConnection<TRetrievedItem>(parent: ItemWithId, context: KosmosUserContext<object>, info: GraphQLResolveInfo, args: ConnectionsListQueryArguments, inverse?: boolean): Promise<ListResponse<TRetrievedItem>>
Retrieves edge connection response.

NOTE: This method would also execute any postView hooks associated with retrieved entities. To get a raw result, call edgeConnection instead.

Deprecated
For retrieving data use SingleConnectedVertexLoader, ZeroToManyRelationVertexLoader and ZeroToManyRelationCountLoader services. For GraphQL connection field resolvers, use ConnectionsManager.
Type Parameters
- TRetrievedItem extends RetrievedKosmosItem = RetrievedKosmosItem & Record<string, any>
Parameters
- parent: ItemWithId
- context: KosmosUserContext<object>
- info: GraphQLResolveInfo
- args: ConnectionsListQueryArguments
- Optional inverse: boolean
Returns Promise<ListResponse<TRetrievedItem>>
- Defined in src/backends/DataSourceWrapper.d.ts:492

findEdge

findEdge(context: KosmosUserContext<object>, srcUuid: string, destUuid: string, edgeName: string): Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
Returns edge between source and dest vertices.

Returns
edge
Parameters
- context: KosmosUserContext<object>
- srcUuid: string
- destUuid: string
- edgeName: string
Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
- Defined in src/backends/DataSourceWrapper.d.ts:278

findEdgeByEdgeLabelAndDestinationType

findEdgeByEdgeLabelAndDestinationType<T>(context: KosmosUserContext<object>, label: string, sourceId: string, direction: "in" | "out", edgeProperties: object, destinationType: string, vertexProperties: object): Promise<IteratorResult<T, any>>
Returns
Type Parameters
- T extends ItemWithIdAndLabel = ItemWithIdAndLabel
Parameters
- context: KosmosUserContext<object>
- label: string
- sourceId: string
- direction: "in" | "out"
- edgeProperties: object
- destinationType: string
- vertexProperties: object
Returns Promise<IteratorResult<T, any>>
- Defined in src/backends/DataSourceWrapper.d.ts:412

findEdgeById

findEdgeById(context: KosmosUserContext<object>, edgeUuid: string): Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
Parameters
- context: KosmosUserContext<object>
- edgeUuid: string
Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
- Defined in src/backends/DataSourceWrapper.d.ts:288

findEdgeByLabel

findEdgeByLabel<T>(context: KosmosUserContext<object>, entityUuid: string, edgeName: undefined | string, out?: boolean, properties?: object, mapElements?: boolean): Promise<IteratorResult<T, any>>
TODO: Document me.

Returns
Type Parameters
- T extends ItemWithIdAndLabel = ItemWithIdAndLabel
Parameters
- context: KosmosUserContext<object>
- entityUuid: string
- edgeName: undefined | string
- Optional out: boolean
- Optional properties: object
- Optional mapElements: boolean
Returns Promise<IteratorResult<T, any>>
- Defined in src/backends/DataSourceWrapper.d.ts:373

findEdgesBetweenVertices

findEdgesBetweenVertices(context: KosmosUserContext<object>, edgeConditions: EdgeMatchCondition[]): Promise<EdgeMatchCondition[]>
Returns the list of existing edges matching criteria.

Returns
The filtered list of edges.
Parameters
- context: KosmosUserContext<object>
- edgeConditions: EdgeMatchCondition[]
Returns Promise<EdgeMatchCondition[]>
- Defined in src/backends/DataSourceWrapper.d.ts:304

findRealEntityType

findRealEntityType(context: KosmosUserContext<object>, schemaItemName: undefined | string, entityId: string): Promise<undefined | string>
Finds a real entity type of the entity.

Returns the same string as passed in for vertex types, tries to determine a real entity type of vertex if type is a union.

Returns
Real entity type
Parameters
- context: KosmosUserContext<object>
  
  the context of the user who the call is being made on behalf of.
- schemaItemName: undefined | string
  
  vertex schema type name; could be either real entity type name or union
- entityId: string
  
  entity ID
Returns Promise<undefined | string>
- Defined in src/backends/DataSourceWrapper.d.ts:323

findVertex

findVertex<TRetrievedItem>(context: KosmosUserContext<object>, uuid: string, includeLabel?: boolean, type?: string, validate?: boolean, clearCacheFirst?: boolean): Promise<null | TRetrievedItem>
This function is used to retrieve a Vertex by its uuid.
Type Parameters
- TRetrievedItem = ItemWithId
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- uuid: string
  
  The uuid of the entity
- Optional includeLabel: boolean
  
  include the label as part of the response. Default is false.
- Optional type: string
  
  The type of the entity being requested (optional)
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
- Optional clearCacheFirst: boolean
  
  Clear cache before running the function (optional). Default is false.
Returns Promise<null | TRetrievedItem>
- Defined in src/backends/DataSourceWrapper.d.ts:134

findVertexByEdgeLabelAndDestinationType

findVertexByEdgeLabelAndDestinationType<T>(context: KosmosUserContext<object>, label: string, sourceId: string, direction: "in" | "out", edgeProperties: object, destinationType: string, vertexProperties: object): Promise<IteratorResult<T, any>>
Returns
Type Parameters
- T extends ItemWithIdAndLabel = ItemWithIdAndLabel
Parameters
- context: KosmosUserContext<object>
- label: string
- sourceId: string
- direction: "in" | "out"
- edgeProperties: object
- destinationType: string
- vertexProperties: object
Returns Promise<IteratorResult<T, any>>
- Defined in src/backends/DataSourceWrapper.d.ts:392

getTraitGraphConnection

getTraitGraphConnection<RT>(context: KosmosUserContext<object>, useReaderPool?: boolean): Promise<TraitGraphQuery<RT>>
Constructs new TraitGraphQuery object.
Type Parameters
- RT = any
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- Optional useReaderPool: boolean
  
  Whether to use the Gremlin connections pool.
Returns Promise<TraitGraphQuery<RT>>
- Defined in src/backends/DataSourceWrapper.d.ts:509

listEdgesByTypeFromVertex

listEdgesByTypeFromVertex(context: KosmosUserContext<object>, sourceUUID: string, sourceType: string, edgeType: string, offset?: string, limit?: null | number, destinationType?: string, bypassAccess?: boolean, filter?: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>, orderByProperty?: string, orderBy?: FilterOrderDirection): Promise<GremlinItem[]>
Wrapper for GraphHandler.listEdgesByTypeFromVertex().

Deprecated
Use ZeroToManyRelationVertexLoader service

Returns
The list of edges.
Parameters
- context: KosmosUserContext<object>
  
  The user context
- sourceUUID: string
  
  The source UUID of the entity
- sourceType: string
  
  The source type of the entity
- edgeType: string
  
  The type of the connecting edge
- Optional offset: string
  
  The offset defaults to Constants.DATE_EPOCH.
- Optional limit: null | number
  
  The limit defaults to 10
- Optional destinationType: string
  
  The type of the destination vertex
- Optional bypassAccess: boolean
  
  Used by trait to bypass access default false.
- Optional filter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
  
  The evaluated lucene query
- Optional orderByProperty: string
  
  Used to define what to filter by ie created /updated date, default is created date.
- Optional orderBy: FilterOrderDirection
  
  Used to define what order ie desc or asc
Returns Promise<GremlinItem[]>
- Defined in src/backends/DataSourceWrapper.d.ts:349

listInverseEdgesByTypeFromVertex

listInverseEdgesByTypeFromVertex(context: KosmosUserContext<object>, sourceUUID: string, sourceType: string, edgeType: string, offset?: string, limit?: null | number, destinationType?: string, filter?: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>, orderByProperty?: string, orderBy?: FilterOrderDirection): Promise<GremlinItem[]>
Wrapper for GraphHandler.listInverseEdgesByTypeFromVertex().

Deprecated
Use ZeroToManyRelationVertexLoader service

Returns
The list of edges.
Parameters
- context: KosmosUserContext<object>
  
  The user context
- sourceUUID: string
  
  The source UUID of the entity
- sourceType: string
  
  The source type of the entity
- edgeType: string
  
  The type of the connecting edge
- Optional offset: string
  
  The offset defaults to Constants.DATE_EPOCH.
- Optional limit: null | number
  
  The limit defaults to 10
- Optional destinationType: string
  
  The type of the destination vertex
- Optional filter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
  
  The evaluated lucene query
- Optional orderByProperty: string
  
  Used to define what to filter by ie created /updated date, default is created date.
- Optional orderBy: FilterOrderDirection
  
  Used to define what order ie desc or asc
Returns Promise<GremlinItem[]>
- Defined in src/backends/DataSourceWrapper.d.ts:441

listVertices

listVertices<TRetrievedItem>(context: KosmosUserContext<object>, type: string, after?: string, limit?: number, filter?: string, filterOrder?: string, validate?: boolean, query?: CSQL): Promise<ListResponse<TRetrievedItem>>
This function is used to get a list of Vertices of a specified type.
Type Parameters
- TRetrievedItem extends RetrievedKosmosItem = RetrievedKosmosItem & Record<string, any>
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- type: string
  
  The entity type of the requested items
- Optional after: string
  
  The offset to return from
- Optional limit: number
  
  The maximum number of items to return.
- Optional filter: string
  
  The lucene search string
- Optional filterOrder: string
  
  The property and order to sort by
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
- Optional query: CSQL
Returns Promise<ListResponse<TRetrievedItem>>
- Defined in src/backends/DataSourceWrapper.d.ts:467

updateVertex

updateVertex<TUpdatedItem>(context: KosmosUserContext<object>, type: string, data: Record<string, any>, connectToVertices: ConnectionToAdd[], disconnectFromVertices: ConnectionToRemove[], traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, validate?: boolean): Promise<null | TUpdatedItem>
This function is used to update an existing entity.
Type Parameters
- TUpdatedItem = Record<string, any>
Parameters
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
- type: string
  
  The type of entity to be updated.
- data: Record<string, any>
  
  The data to update.
- connectToVertices: ConnectionToAdd[]
  
  The connections that should be added to the vertex once it's been updated.
- disconnectFromVertices: ConnectionToRemove[]
  
  The connections that should be removed from the vertex once it's been updated.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Optional validate: boolean
  
  Used by traits for non user accessible entities. Default is true.
Returns Promise<null | TUpdatedItem>
- Defined in src/backends/DataSourceWrapper.d.ts:203

Class DataSourceWrapper

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns DataSourceWrapper

Methods

addEdge

Type Parameters

TCreatedItem = Record<string, any>

Parameters

context: KosmosUserContext<object>

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

edgeName: string

srcUuid: string

srcLabel: undefined | string

destUuid: string

destLabel: undefined | string

properties: Record<string, any>

unique: boolean

Optional validate: boolean

Optional executeHooks: boolean

Returns Promise<TCreatedItem>

checkActionAccess

Returns

Parameters

context: KosmosUserContext<object>

label: string

uuid: string

action: string

Optional throwError: boolean

Returns Promise<boolean>

createVertex

Type Parameters

TCreatedItem = Record<string, any>

Parameters

context: KosmosUserContext<object>

type: string

data: Record<string, any>

connectToVertices: ConnectionToAdd[]

Optional validate: boolean

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

Optional executeHooksArg: boolean

Returns Promise<TCreatedItem>

deleteCacheItemById

Parameters

context: KosmosUserContext<object>

id: string

Returns Promise<void>

deleteEdge

Type Parameters

InVertex extends ItemWithIdAndLabel

OutVertex extends ItemWithIdAndLabel

TDeletedItem extends ConnectionItem<InVertex, OutVertex, TDeletedItem>

Parameters

context: KosmosUserContext<object>

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

edgeId: string

Optional validate: boolean

Optional executeHooks: boolean

Returns Promise<{ done: boolean; value: TDeletedItem; }>

deleteVertex

Parameters

context: KosmosUserContext<object>

type: string

uuid: string

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

Optional validate: boolean

Returns Promise<{ id?: string; }>

edgeConnection

Deprecated

Type Parameters

TRetrievedItem extends RetrievedKosmosItem = RetrievedKosmosItem & Record<string, any>

Parameters

parent: ItemWithId

context: KosmosUserContext<object>

info: GraphQLResolveInfo

args: ConnectionsListQueryArguments

`Optional` validate: boolean

`Optional` executeHooks: boolean

`Optional` throwError: boolean

`Optional` validate: boolean

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

`Optional` executeHooksArg: boolean

`Optional` validate: boolean

`Optional` executeHooks: boolean

Returns Promise<{
done: boolean;
value: TDeletedItem;
}>

`Optional` validate: boolean

Returns Promise<{
id?: string;
}>

`Optional` inverse: boolean

Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>

Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>

`Optional` out: boolean

`Optional` properties: object

`Optional` mapElements: boolean

`Optional` includeLabel: boolean

`Optional` type: string

`Optional` validate: boolean

`Optional` clearCacheFirst: boolean