Class GraphConnector

Hierarchy

GraphConnector

Index

Constructors

Methods

applyQueryAccessControl bulkLoadConnectedVertices bulkLoadConnectedZeroToManyCounts bulkLoadConnectedZeroToManyVertices debugQuerySteps findEdgeByEdgeLabelAndDestinationType findEdgeByLabel findVertexByEdgeLabelAndDestinationType getEdgeProperties getTraitGraphConnection getVertexValueMapById

Constructors

constructor

new GraphConnector(): GraphConnector
Returns GraphConnector

Methods

applyQueryAccessControl

applyQueryAccessControl(context: KosmosUserContext<object>, query: GraphTraversal, type: string, options?: {
action?: string;
allowUnions?: boolean;
}): GraphTraversal
Applies access control conditions to the query.
Parameters
- context: KosmosUserContext<object>
  
  User context.
- query: GraphTraversal
  
  The query.
- type: string
  
  Vertex/edge type.
- Optional options: {
  action?: string;
  allowUnions?: boolean;
  }
  
  Query builder options.
  - Optional action?: string
  - Optional allowUnions?: boolean
Returns GraphTraversal
- Defined in src/backends/graph/GraphConnector.d.ts:117

bulkLoadConnectedVertices

bulkLoadConnectedVertices(context: KosmosUserContext<object>, direction: VertexRelationshipDirection, destinationLabel: string, sourceUuids: string[], edgeLabels: string[]): Promise<BulkLoadConnectedVerticesResultRow[]>
Retrieves all 1:1 connections edges (and connected vertices) going to/from given vertex type.

This method loads all edges/vertices pairs of same type and direction for given lists of source vertices UUIDs and edges labels.

Used by SingleConnectedVertexLoader.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- direction: VertexRelationshipDirection
  
  The edge direction.
- destinationLabel: string
  
  The destination vertex label.
- sourceUuids: string[]
  
  A list of source vertices UUIDs. Note that 'source vertex' means graph traversal source here and not the edge source vertex.
- edgeLabels: string[]
  
  The list of edge types (labels).
Returns Promise<BulkLoadConnectedVerticesResultRow[]>
- Defined in src/backends/graph/GraphConnector.d.ts:51

bulkLoadConnectedZeroToManyCounts

bulkLoadConnectedZeroToManyCounts(context: KosmosUserContext<object>, direction: VertexRelationshipDirection, destinationLabel: string, sourceUuids: string[], edgeLabel: string, filter?: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>, edgeFilter?: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>): Promise<BulkLoadConnectedVerticesCountsResultRow[]>
Retrieves counts of all zero to many connections of specific type (edge label and destination vertex) going from/to given vertices.

Used by ZeroToManyRelationCountLoader.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- direction: VertexRelationshipDirection
  
  The edge direction.
- destinationLabel: string
  
  The destination vertex label.
- sourceUuids: string[]
  
  A list of source vertices UUIDs. Note that 'source vertex' means graph traversal source here and not the edge source vertex.
- edgeLabel: string
  
  The edge types (label).
- Optional filter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
  
  The vertices filter.
- Optional edgeFilter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
  
  The edges filter.
Returns Promise<BulkLoadConnectedVerticesCountsResultRow[]>
- Defined in src/backends/graph/GraphConnector.d.ts:99

bulkLoadConnectedZeroToManyVertices

bulkLoadConnectedZeroToManyVertices(context: KosmosUserContext<object>, direction: VertexRelationshipDirection, destinationLabel: string, sourceUuids: string[], edgeLabel: string, listOptions: ParsedConnectionsListQueryArguments): Promise<BulkLoadConnectedVerticesResultRow[]>
Retrieves all zero to many connections of specific type (edge label and destination vertex) going from/to given vertices.

Used by ZeroToManyRelationVertexLoader.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- direction: VertexRelationshipDirection
  
  The edge direction.
- destinationLabel: string
  
  The destination vertex or union label.
- sourceUuids: string[]
  
  A list of source vertices UUIDs. Note that 'source vertex' means graph traversal source here and not the edge source vertex.
- edgeLabel: string
  
  The edge types (label).
- listOptions: ParsedConnectionsListQueryArguments
  
  Ordering/filtering arguments.
Returns Promise<BulkLoadConnectedVerticesResultRow[]>
- Defined in src/backends/graph/GraphConnector.d.ts:74

debugQuerySteps

debugQuerySteps(stepInstructions: any, depth?: number, pretty?: boolean): string
Deprecated
use standalone debugQuerySteps from utils instead.
Parameters
- stepInstructions: any
- Optional depth: number
- Optional pretty: boolean
Returns string
- Defined in src/backends/graph/GraphConnector.d.ts:32

findEdgeByEdgeLabelAndDestinationType

findEdgeByEdgeLabelAndDestinationType<T>(context: KosmosUserContext<object>, label: string, sourceId: string, direction: "in" | "out", edgeProperties: object, destinationType: string, vertexProperties: object): Promise<IteratorResult<T, any>>
Find vertex by edge label and destination type.

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/graph/GraphConnector.d.ts:184

findEdgeByLabel

findEdgeByLabel<T>(context: KosmosUserContext<object>, access: AccessControl, label: string, entity_uuid: string, out: boolean, properties: object, mapElements?: boolean): Promise<IteratorResult<T, any>>
This function is used to find and edge based on the edges label and the source id of an entity.
Type Parameters
- T extends ItemWithIdAndLabel = ItemWithIdAndLabel
Parameters
- context: KosmosUserContext<object>
  
  The user context
- access: AccessControl
  
  Instance of the AccessControl object
- label: string
  
  The name of the label of the edge
- entity_uuid: string
  
  The uuid of the vertex/entity
- out: boolean
  
  Whether to check the outgoing edge
- properties: object
  
  The properties to filter by
- Optional mapElements: boolean
Returns Promise<IteratorResult<T, any>>
- Defined in src/backends/graph/GraphConnector.d.ts:138

findVertexByEdgeLabelAndDestinationType

findVertexByEdgeLabelAndDestinationType<T>(context: KosmosUserContext<object>, label: string, sourceId: string, direction: "in" | "out", edgeProperties: object, destinationType: string, vertexProperties: object): Promise<IteratorResult<T, any>>
Find vertex by edge label and destination type.

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/graph/GraphConnector.d.ts:161

getEdgeProperties

getEdgeProperties(context: KosmosUserContext<object>, access: undefined | AccessControl, edgeId: string): Promise<{}>
Parameters
- context: KosmosUserContext<object>
- access: undefined | AccessControl
- edgeId: string
Returns Promise<{}>
- Defined in src/backends/graph/GraphConnector.d.ts:214

getTraitGraphConnection

getTraitGraphConnection<RT>(context: KosmosUserContext<object>, useReaderPool?: boolean): Promise<TraitGraphQuery<RT>>
Get a new Trait Graph Connection.

Returns
Type Parameters
- RT = any
Parameters
- context: KosmosUserContext<object>
  
  The user context
- Optional useReaderPool: boolean
  
  Whether to use the Gremlin connections pool.
Returns Promise<TraitGraphQuery<RT>>
- Defined in src/backends/graph/GraphConnector.d.ts:202

getVertexValueMapById

getVertexValueMapById<T>(context: KosmosUserContext<T>, type: undefined | string, vertexId: string | string[], checkAction?: string | false): Promise<boolean | void | IteratorResult<any, any> | Traverser[]>
Type Parameters
- T extends object
Parameters
- context: KosmosUserContext<T>
- type: undefined | string
- vertexId: string | string[]
- Optional checkAction: string | false
Returns Promise<boolean | void | IteratorResult<any, any> | Traverser[]>
- Defined in src/backends/graph/GraphConnector.d.ts:207

Class GraphConnector

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns GraphConnector

Methods

applyQueryAccessControl

Parameters

context: KosmosUserContext<object>

query: GraphTraversal

type: string

Optional options: { action?: string; allowUnions?: boolean; }

Optional action?: string

Optional allowUnions?: boolean

Returns GraphTraversal

bulkLoadConnectedVertices

Parameters

context: KosmosUserContext<object>

direction: VertexRelationshipDirection

destinationLabel: string

sourceUuids: string[]

edgeLabels: string[]

Returns Promise<BulkLoadConnectedVerticesResultRow[]>

bulkLoadConnectedZeroToManyCounts

Parameters

context: KosmosUserContext<object>

direction: VertexRelationshipDirection

destinationLabel: string

sourceUuids: string[]

edgeLabel: string

Optional filter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>

Optional edgeFilter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>

Returns Promise<BulkLoadConnectedVerticesCountsResultRow[]>

bulkLoadConnectedZeroToManyVertices

Parameters

context: KosmosUserContext<object>

direction: VertexRelationshipDirection

destinationLabel: string

sourceUuids: string[]

edgeLabel: string

listOptions: ParsedConnectionsListQueryArguments

Returns Promise<BulkLoadConnectedVerticesResultRow[]>

debugQuerySteps

Deprecated

Parameters

stepInstructions: any

Optional depth: number

Optional pretty: boolean

Returns string

findEdgeByEdgeLabelAndDestinationType

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>>

findEdgeByLabel

Type Parameters

T extends ItemWithIdAndLabel = ItemWithIdAndLabel

Parameters

context: KosmosUserContext<object>

access: AccessControl

label: string

entity_uuid: string

out: boolean

properties: object

Optional mapElements: boolean

Returns Promise<IteratorResult<T, any>>

findVertexByEdgeLabelAndDestinationType

Returns

Type Parameters

`Optional` options: {
action?: string;
allowUnions?: boolean;
}

`Optional` action?: string

`Optional` allowUnions?: boolean

`Optional` filter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>

`Optional` edgeFilter: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>

`Optional` depth: number

`Optional` pretty: boolean

`Optional` mapElements: boolean

`Optional` useReaderPool: boolean

`Optional` checkAction: string | false