Class SearchTrait

The Elasticsearch integration trait.

Indexes Kosmos contents in Elasticsearch, then hooks into filtering queries for these fields and converts normal Gremlin queries to Neptune-specific fulltext queries.

Requires AWS Neptune and AWS OpenSearch.

Usage:

traits:
  type: search
  fields:
    - title
    - body
    - data
  exclude_child_properties:
    - data.additionalProperties
    - data.interests
  index:
    accessKeys:
      appRole:
        traversals:
          - out(hasSchema).inE(permission).outV().hasLabel(AppRole)
    relationships:
      tags:
        traversals:
          - out(taggedWith).hasLabel(Tag)
      activities:
        traversals:
          - out(hasActivity).hasLabel(Activity)
  reindex_connected_vertices:
    - out(taggedWith).hasLabel(Tag)

In config.yml

search:
  roles:
    org:
      accessKeys:
        custom:
          appRole:
            traversals:
             - out(hasRole).hasLabel(AppRole)
          organisation:
            traversals:
             - out(memberOf).hasLabel(Organisation)

    service:
      accessKeys:
        label:
          - Answer

    # no access
    webmaster:

    admin:
      fullAccess: true

Mermaid

Content indexing

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant Kosmos participant Neptune participant Elasticsearch User->>Kosmos: Create/Update/Delete mutation Kosmos->>Neptune: Create/Update/Delete vertices activate Neptune Neptune->>Kosmos: OK deactivate Neptune Kosmos->>Elasticsearch: Create/Update/Delete document activate Elasticsearch Elasticsearch->>Kosmos: OK deactivate Elasticsearch Kosmos->>User: OK

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant Kosmos participant Neptune participant Elasticsearch User->>Kosmos: Create/Update/Delete mutation Kosmos->>Neptune: Create/Update/Delete vertices activate Neptune Neptune->>Kosmos: OK deactivate Neptune Kosmos->>Elasticsearch: Create/Update/Delete document activate Elasticsearch Elasticsearch->>Kosmos: OK deactivate Elasticsearch Kosmos->>User: OK

sequenceDiagram
    actor User
    participant Kosmos
    participant Neptune
    participant Elasticsearch
    User->>Kosmos: Create/Update/Delete mutation
    Kosmos->>Neptune: Create/Update/Delete vertices
    activate Neptune
    Neptune->>Kosmos: OK
    deactivate Neptune
    Kosmos->>Elasticsearch: Create/Update/Delete document
    activate Elasticsearch
    Elasticsearch->>Kosmos: OK
    deactivate Elasticsearch
    Kosmos->>User: OK

Mermaid

Search query

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant Kosmos participant Neptune participant Elasticsearch User->>Kosmos: GraphQL query Kosmos->>Neptune: Gremlin query activate Neptune Neptune->>Elasticsearch: Search query activate Elasticsearch Elasticsearch->>Neptune: Content IDs deactivate Elasticsearch Neptune->>Kosmos: Gremlin & ES results intersection deactivate Neptune Kosmos->>User: GraphQL response

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant Kosmos participant Neptune participant Elasticsearch User->>Kosmos: GraphQL query Kosmos->>Neptune: Gremlin query activate Neptune Neptune->>Elasticsearch: Search query activate Elasticsearch Elasticsearch->>Neptune: Content IDs deactivate Elasticsearch Neptune->>Kosmos: Gremlin & ES results intersection deactivate Neptune Kosmos->>User: GraphQL response

sequenceDiagram
    actor User
    participant Kosmos
    participant Neptune
    participant Elasticsearch
    User->>Kosmos: GraphQL query
    Kosmos->>Neptune: Gremlin query
    activate Neptune
    Neptune->>Elasticsearch: Search query
    activate Elasticsearch
    Elasticsearch->>Neptune: Content IDs
    deactivate Elasticsearch
    Neptune->>Kosmos: Gremlin & ES results intersection
    deactivate Neptune
    Kosmos->>User: GraphQL response

Hierarchy

Trait<SearchTraitConfig>
- SearchTrait

Implements

Index

Constructors

constructor

new SearchTrait(_runtimeConfig: RuntimeConfig, _schemaManager: SchemaManager, _graphqlSchemaManager: GraphQLSchemaManager, _dataSourceWrapper: DataSourceWrapper, _access: AccessControl, _client: Client, _search: Search, _accessKeysService: AccessKeysService, _queryCache: QueryCache): SearchTrait
Parameters
- _runtimeConfig: RuntimeConfig
- _schemaManager: SchemaManager
- _graphqlSchemaManager: GraphQLSchemaManager
- _dataSourceWrapper: DataSourceWrapper
- _access: AccessControl
- _client: Client
- _search: Search
- _accessKeysService: AccessKeysService
- _queryCache: QueryCache
Returns SearchTrait
Overrides Trait.constructor
- Defined in src/traits/SearchTrait.ts:405

Properties

`Protected` _access

_access: AccessControl

`Protected` _accessKeysService

_accessKeysService: AccessKeysService

`Protected` _client

_client: Client

`Protected` `Optional` _config

_config?: SearchTraitConfig

Trait instance configuration.

`Protected` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` _queryCache

_queryCache: QueryCache

`Protected` _runtimeConfig

_runtimeConfig: RuntimeConfig

`Protected` _schemaManager

_schemaManager: SchemaManager

`Protected` _search

_search: Search

`Protected` `Optional` _type

_type?: "search"

Trait type.

`Private` userVertexLabel

userVertexLabel: string = 'User'

`Static` `Private` schemaAttached

schemaAttached: boolean = false

Ensure that the global schema hooks only run once.

`Static` `Private` searchEnabledVertices

searchEnabledVertices: string[] = []

Keep track of the vertex types on which search is enabled.

`Static` synonymsEnabled

synonymsEnabled: boolean = false

A flag to enable synonyms functionalities once for both the retrieval and updating of the index.

`Static` `Private` unionsAltered

unionsAltered: boolean = false

Keep track of whether the union schema has been altered yet.

Methods

_getTraitStorage

_getTraitStorage(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Record<any, any>
Helper method which initializes/returns SearchTrait storage object.

Returns
SearchTraitStorage
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Record<any, any>
- Defined in src/traits/SearchTrait.ts:2116

addGraphqlTypes

addGraphqlTypes(types: string[]): void
Parameters
- types: string[]
Returns void
- Defined in src/traits/SearchTrait.ts:1455

alterUnions

alterUnions(_type: SchemaItemType, _conf: SearchTraitConfig, _schemaManager: SchemaManager, unions: SchemaUnion[]): SchemaUnion[]
Implements alterUnions.

Adds a SearchResultsUnion union with all the possible search result types.

The possible types are gathered when setConfig() is called.

types defined in the trait configuration, and an additional MissingEntity type for notifications that relate to deleted entities.

Note that enabling this trait on multiple schema types is not supported, and doing so will cause the union to be declared multiple times.
Parameters
- _type: SchemaItemType
- _conf: SearchTraitConfig
- _schemaManager: SchemaManager
- unions: SchemaUnion[]
Returns SchemaUnion[]
Implementation of TraitAlterUnions.alterUnions
- Defined in src/traits/SearchTrait.ts:2308

autoConfig

autoConfig(type: SchemaItemType, conf: SearchTraitConfig, schemaManager: SchemaManager): undefined | SearchTraitConfig
Implements autoConfig.

Automatically add and configure relationship definitions for vertex schemas, or conditionally enable the trait for edge schemas, as required to support search-based connections.

Since this pseudo-hook is only called on enabled traits, the "conditionally enable" bit is done by enabling it on the base trait, and conditionally disabling it.
Parameters
- type: SchemaItemType
- conf: SearchTraitConfig
- schemaManager: SchemaManager
Returns undefined | SearchTraitConfig
Implementation of TraitAutoConfig.autoConfig
- Defined in src/traits/SearchTrait.ts:2028

`Private` buildAccessKeys

buildAccessKeys(item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<string[]>
Prepares values for the access_keys field.
Parameters
- item: StoredKosmosItem
- datasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<string[]>
- Defined in src/traits/SearchTrait.ts:485

`Protected` buildElasticsearchQueryString

buildElasticsearchQueryString(filtersTree: FilterTreeExpression): string
Parameters
- filtersTree: FilterTreeExpression
Returns string
- Defined in src/traits/SearchTrait.ts:1429

`Protected` buildFilterExpressionsTree

buildFilterExpressionsTree(expression: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>): FilterTreeExpression
Helper function for legacy filter search.
Parameters
- expression: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
Returns FilterTreeExpression
- Defined in src/traits/SearchTrait.ts:1369

`Private` buildRelationships

buildRelationships(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<Record<string, any>>
Prepares values for the relationships field (backward compatibility wrapper).
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<Record<string, any>>
- Defined in src/traits/SearchTrait.ts:470

`Protected` buildSingleElasticsearchQueryStringFilter

buildSingleElasticsearchQueryStringFilter(expression: LuceneQueryFieldExpression): string
Parameters
- expression: LuceneQueryFieldExpression
Returns string
- Defined in src/traits/SearchTrait.ts:1439

`Private` createEdgeSearchDocument

createEdgeSearchDocument(__namedParameters: ElasticsearchEdgeIndexOperationOptions): Promise<void>
Creates an edge search document in ES.
Parameters
- __namedParameters: ElasticsearchEdgeIndexOperationOptions
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:1114

`Private` deleteOrphanEdgeDocuments

deleteOrphanEdgeDocuments(tenant_id: string, vertexId: string): Promise<void>
Delete all edge documents connected to a deleted vertex.

Ensuring that the vertex itself is deleted is the caller's responsibility.
Parameters
- tenant_id: string
- vertexId: string
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:1055

`Private` deleteSearchDocument

deleteSearchDocument(options: ElasticsearchDeleteOperationOptions): Promise<void>
Deletes a search document in ES.
Parameters
- options: ElasticsearchDeleteOperationOptions
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:1165

elasticsearchIndex

elasticsearchIndex(): string
Returns Elasticsearch index name.

Returns string
- Defined in src/traits/SearchTrait.ts:2285

`Private` extractFields

extractFields(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: EntityObject): Fields
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: EntityObject
Returns Fields
- Defined in src/traits/SearchTrait.ts:1183

getBatchItems

getBatchItems(type: "edge" | "vertex", after: string, size: number, label: undefined | string, context: KosmosUserContext<object>, g: (() => Promise<TraitGraphQuery<any>>)): Promise<{
hasNextPage: boolean;
items: any[];
}>
Parameters
- type: "edge" | "vertex"
- after: string
- size: number
- label: undefined | string
- context: KosmosUserContext<object>
- g: (() => Promise<TraitGraphQuery<any>>)
  - - (): Promise<TraitGraphQuery<any>>
    - Returns Promise<TraitGraphQuery<any>>
Returns Promise<{
hasNextPage: boolean;
items: any[];
}>
- Defined in src/traits/SearchTrait.ts:1653

`Private` getConfigForEntity

getConfigForEntity(label: string): SearchTraitConfig
Parameters
- label: string
Returns SearchTraitConfig
- Defined in src/traits/SearchTrait.ts:643

`Private` getConfiguredEdgeProperties

getConfiguredEdgeProperties(edge: {
    id: string;
    inV: {
        id: string;
        label: string;
    };
    label: string;
    outV: {
        id: string;
        label: string;
    };
}): Record<string, unknown>
Extract only the edge properties that are configured to be indexed.

Returns
A name-value record of the properties to be indexed.
Parameters
- edge: {
      id: string;
      inV: {
          id: string;
          label: string;
      };
      label: string;
      outV: {
          id: string;
          label: string;
      };
  }
  
  The edge object
  - id: string
  - inV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
  - label: string
  - outV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
Returns Record<string, unknown>
- Defined in src/traits/SearchTrait.ts:739

`Protected` getFiltersTreeType

getFiltersTreeType(schemaItem: SchemaItem<SchemaItemType> | SchemaItem<SchemaItemType>[], tree: FilterTreeExpression): FiltersTreeType
Helper function for legacy filter search.
Parameters
- schemaItem: SchemaItem<SchemaItemType> | SchemaItem<SchemaItemType>[]
- tree: FilterTreeExpression
Returns FiltersTreeType
- Defined in src/traits/SearchTrait.ts:1320

getRelationships

getRelationships(): any
Get the search relationships defined for this schema.

Returns
The relationships, as possibly altered by autoConfig.

Returns any
- Defined in src/traits/SearchTrait.ts:463

`Private` getVertices

getVertices(item: StoredKosmosItem, context: KosmosUserContext<object>, datasourceWrapper: DataSourceWrapper): Promise<any[]>
Parameters
- item: StoredKosmosItem
- context: KosmosUserContext<object>
- datasourceWrapper: DataSourceWrapper
Returns Promise<any[]>
- Defined in src/traits/SearchTrait.ts:554

handleOptimizeFilterOperation

handleOptimizeFilterOperation(...__namedParameters: [query: GraphTraversalAndExpression]): GraphTraversalAndExpression
Helper function for legacy filter search.
Parameters
- Rest ...__namedParameters: [query: GraphTraversalAndExpression]
Returns GraphTraversalAndExpression
- Defined in src/traits/SearchTrait.ts:1191

handleSearch

handleSearch(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<null | {
    count: any;
    data: {};
    entities: undefined | any[];
    facets: undefined | string;
    relationships: undefined | any[];
    results: Record<string, any>;
}>
Search field resolver.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<null | {
    count: any;
    data: {};
    entities: undefined | any[];
    facets: undefined | string;
    relationships: undefined | any[];
    results: Record<string, any>;
}>
- Defined in src/traits/SearchTrait.ts:1969

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/SearchTrait.ts:2133

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Overrides Trait.hookIntoSchemaManager
- Defined in src/traits/SearchTrait.ts:2330

`Private` indexEdge

indexEdge(edge: {
    id: string;
    inV: {
        id: string;
        label: string;
    };
    label: string;
    outV: {
        id: string;
        label: string;
    };
}, tenant: string, g: QueryFactory<any>): Promise<boolean>
Parameters
- edge: {
      id: string;
      inV: {
          id: string;
          label: string;
      };
      label: string;
      outV: {
          id: string;
          label: string;
      };
  }
  - id: string
  - inV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
  - label: string
  - outV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
- tenant: string
- g: QueryFactory<any>
Returns Promise<boolean>
- Defined in src/traits/SearchTrait.ts:679

`Private` indexVertex

indexVertex(item: StoredKosmosItem, context: KosmosUserContext<object>, datasourceWrapper: DataSourceWrapper, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, created?: string): Promise<void>
Parameters
- item: StoredKosmosItem
- context: KosmosUserContext<object>
- datasourceWrapper: DataSourceWrapper
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Optional created: string
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:600

`Private` invalidateCacheTag

invalidateCacheTag(tenant: string, tag: string): Promise<void>
Parameters
- tenant: string
- tag: string
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:498

`Protected` isElasticSearchField

isElasticSearchField(schemaItem: SchemaItem<SchemaItemType> | SchemaItem<SchemaItemType>[], fieldName: string): boolean
Checks if given field is searched with Elasticsearch.
Parameters
- schemaItem: SchemaItem<SchemaItemType> | SchemaItem<SchemaItemType>[]
- fieldName: string
Returns boolean
- Defined in src/traits/SearchTrait.ts:1397

listSynonyms

listSynonyms(_parent: unknown, _args: Record<string, any>, context: KosmosUserContext<object>): Promise<string[]>
This handles the retrieval of the synonyms for a tenant.

Returns
An array of synonym strings
Parameters
- _parent: unknown
  
  The parent
- _args: Record<string, any>
- context: KosmosUserContext<object>
  
  The user context
Returns Promise<string[]>
- Defined in src/traits/SearchTrait.ts:1532

makeGlobal

makeGlobal(): SearchTrait
Makes this Trait instance global.

Returns SearchTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

`Private` mapToObject

mapToObject(map: Entry[]): Record<string, string>
Parameters
- map: Entry[]
Returns Record<string, string>
- Defined in src/traits/SearchTrait.ts:1037

mutationSchema

mutationSchema(schemaString: string): string
This is where any GraphQL mutation entries that are required by the trait are added.

Returns
Returns graphql schema segment for inclusion in main graphql doc.
Parameters
- schemaString: string
  
  {string}
Returns string
- Defined in src/traits/SearchTrait.ts:1555

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

postAddHandleRelationship

postAddHandleRelationship(documentType: SchemaItemType, ...param1: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
The postHandleAddRelationship hook implementation, is called when an edge has been added to a vertex. As the edge may change the data we hold in Elasticsearch we need to update the documents accessKeys and relationships fields.
Parameters
- documentType: SchemaItemType
  
  The type of the document vertex or edge
- Rest ...param1: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
  
  An array of parameters passed to the hook see VertexPostRelationshipUpdateHookCallback
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:759

postCreate

postCreate(documentType: SchemaItemType, ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Post-create hook implementation.

Inherit Doc
Parameters
- documentType: SchemaItemType
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:507

postDelete

postDelete(documentType: SchemaItemType, ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Post-delete hook implementation.

Inherit Doc
Parameters
- documentType: SchemaItemType
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:970

postHandleEntityRelationshipUpdate

postHandleEntityRelationshipUpdate(documentType: SchemaItemType, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, entityId: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
The postHandleEntityRelationshipUpdate hook implementation, is called when an edge has been added to / removed from a vertex. As the edge may change the data we hold in OpenSearch we need to update the document's accessKeys and relationships fields.
Parameters
- documentType: SchemaItemType
  
  Vertex or Edge
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data
- entityId: string
  
  The id of the entity that has been updated
- datasourceWrapper: DataSourceWrapper
  
  The datasource wrapper
- context: KosmosUserContext<object>
  
  The user context
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:856

postHandleRemoveRelationship

postHandleRemoveRelationship(documentType: SchemaItemType, ...parameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, relationshipData: RelationshipData, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
The postHandleRemoveRelationship hook implementation, is called when an edge has been removed from a vertex. As the edge may change the data we hold in Elasticsearch.
Parameters
- documentType: SchemaItemType
  
  The type of the document vertex or edge
- Rest ...parameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, relationshipData: RelationshipData, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
  
  An array of parameters passed to the hook [@see VertexPostRelationshipUpdateHookCallback]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:815

postUpdate

postUpdate(documentType: SchemaItemType, ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Post-update hook implementation.

Inherit Doc
Parameters
- documentType: SchemaItemType
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:537

postUpdateHandleRelationship

postUpdateHandleRelationship(documentType: SchemaItemType, ...param1: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
The postUpdateHandleRelationship hook implementation, is called when an edge has been updated. As the edge may change the data we hold in Elasticsearch we need to update the documents accessKeys and relationships fields.
Parameters
- documentType: SchemaItemType
  
  The type of the document vertex or edge
- Rest ...param1: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
  
  An array of parameters passed to the hook see VertexPostRelationshipUpdateHookCallback
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:787

preDelete

preDelete(entityType: SchemaItemType, ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Pre-delete hook implementation.

Inherit Doc
Parameters
- entityType: SchemaItemType
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:919

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

querySchemaGlobal

querySchemaGlobal(schemaString: string): string
This method is used to retrieve additions to the GraphQL schema and to register the callbacks associated to the Vertex.

Returns
- GraphQL schema with trait schema appended.
Parameters
- schemaString: string
  
  Existing GraphQL schema.
Returns string
- Defined in src/traits/SearchTrait.ts:1500

`Protected` rebuildLuceneQueryExpression

rebuildLuceneQueryExpression(gremlinExpressions: FilterTreeExpression): LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
Helper function for legacy filter search.
Parameters
- gremlinExpressions: FilterTreeExpression
Returns LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>
- Defined in src/traits/SearchTrait.ts:1289

reindexBatch

reindexBatch(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<{
    hasNextPage: boolean;
    next: string;
    successful: number;
}>
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<{
    hasNextPage: boolean;
    next: string;
    successful: number;
}>
- Defined in src/traits/SearchTrait.ts:1733

reindexBatchItems

reindexBatchItems(type: "edge" | "vertex", items: any[], context: KosmosUserContext<object>, g: (() => Promise<TraitGraphQuery<any>>)): Promise<{
next: string;
successful: number;
}>
Parameters
- type: "edge" | "vertex"
- items: any[]
- context: KosmosUserContext<object>
- g: (() => Promise<TraitGraphQuery<any>>)
  - - (): Promise<TraitGraphQuery<any>>
    - Returns Promise<TraitGraphQuery<any>>
Returns Promise<{
next: string;
successful: number;
}>
- Defined in src/traits/SearchTrait.ts:1700

`Private` reindexConnectedVertices

reindexConnectedVertices(item: StoredKosmosItem, context: KosmosUserContext<object>, datasourceWrapper: DataSourceWrapper, prefetchedVertices?: any[]): Promise<void>
Parameters
- item: StoredKosmosItem
- context: KosmosUserContext<object>
- datasourceWrapper: DataSourceWrapper
- Optional prefetchedVertices: any[]
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:577

reindexEdge

reindexEdge(edge: {
    id: string;
    inV: {
        id: string;
        label: string;
    };
    label: string;
    outV: {
        id: string;
        label: string;
    };
}, tenant: string, g: QueryFactory<any>): Promise<boolean>
Parameters
- edge: {
      id: string;
      inV: {
          id: string;
          label: string;
      };
      label: string;
      outV: {
          id: string;
          label: string;
      };
  }
  - id: string
  - inV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
  - label: string
  - outV: {
    id: string;
    label: string;
    }
    - id: string
    - label: string
- tenant: string
- g: QueryFactory<any>
Returns Promise<boolean>
- Defined in src/traits/SearchTrait.ts:671

reindexVertex

reindexVertex(vertex: StoredKosmosItem, tenant: string, g: (() => Promise<TraitGraphQuery<any>>)): Promise<boolean>
Parameters
- vertex: StoredKosmosItem
- tenant: string
- g: (() => Promise<TraitGraphQuery<any>>)
  - - (): Promise<TraitGraphQuery<any>>
    - Returns Promise<TraitGraphQuery<any>>
Returns Promise<boolean>
- Defined in src/traits/SearchTrait.ts:655

setConfig

setConfig(config: SearchTraitConfig): void
Inherit Doc
are not really overriding how config is set; rather, we exploit the fact that this method is called at a particular point during initialisation to keep track of the schemas on which the trait is enabled.

Specifically: it's called after autoConfig, which decides whether the trait will be enabled on this entity type or not; but before alterUnions, which is where we need to use that information.
Parameters
- config: SearchTraitConfig
Returns void
Overrides Trait.setConfig
- Defined in src/traits/SearchTrait.ts:443

traitConfig

traitConfig(): SearchTraitConfig
Returns SearchTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

transformBatchItems

transformBatchItems(type: "edge" | "vertex", items: any[]): any[]
Parameters
- type: "edge" | "vertex"
- items: any[]
Returns any[]
- Defined in src/traits/SearchTrait.ts:1689

updateSynonyms

updateSynonyms(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<boolean>
This handles the update functionality for the synonyms,
- A synonyms file is created in bucket with the key prexised by tenant id.
- The synonyms are stored as a single string with each synonym separated by a new line.
Returns
Success or failure
Parameters
- _parent: unknown
  
  The parent
- args: Record<string, any>
  
  The synonyms to update
- context: KosmosUserContext<object>
  
  The user context
Returns Promise<boolean>
- Defined in src/traits/SearchTrait.ts:1594

updateSynonymsCustomPackage

updateSynonymsCustomPackage(context: KosmosUserContext<object>, bucket: string, key: string): Promise<undefined | PackageDetails>
NOT CURRENTLY USED

Returns
The package details
Parameters
- context: KosmosUserContext<object>
  
  The user context
- bucket: string
  
  The bucket to store the synonyms file in
- key: string
  
  The key for the synonyms file
Returns Promise<undefined | PackageDetails>
- Defined in src/traits/SearchTrait.ts:1898

updateSynonymsIndex

updateSynonymsIndex(context: KosmosUserContext<object>, synonyms: string[]): Promise<boolean>
--- NOT CURRENTLY USED --- This function is used to update the synonyms package in OpenSearch, it uses the method of updating the analyser settings for the index.
- The index is closed
- The analyser settings are updated
- The index is opened
Once the above steps are completed the synonyms will be updated, however it will be required to re-index the data.

Returns
Boolean indicating success or failure
Parameters
- context: KosmosUserContext<object>
  
  The user context
- synonyms: string[]
  
  The synonyms to store
Returns Promise<boolean>
- Defined in src/traits/SearchTrait.ts:1829

updateSynonymsStoreFile

updateSynonymsStoreFile(context: KosmosUserContext<object>, bucket: string, key: string, synonyms: string[]): Promise<void>
This function is used to update the synonyms file in the S3 bucket.
Parameters
- context: KosmosUserContext<object>
  
  The user context
- bucket: string
  
  The bucket to store the synonyms file in
- key: string
  
  The key for the synonyms file
- synonyms: string[]
  
  The synonyms to store
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:1792

`Private` updateVertexSearchDocument

updateVertexSearchDocument(__namedParameters: ElasticsearchVertexIndexOperationOptions): Promise<void>
Updates a vertex search document in ES.
Parameters
- __namedParameters: ElasticsearchVertexIndexOperationOptions
Returns Promise<void>
- Defined in src/traits/SearchTrait.ts:1078

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/SearchTrait.ts:427

Class SearchTrait

Mermaid

Content indexing

Mermaid

Search query

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_runtimeConfig: RuntimeConfig

_schemaManager: SchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

_dataSourceWrapper: DataSourceWrapper

_access: AccessControl

_client: Client

_search: Search

_accessKeysService: AccessKeysService

_queryCache: QueryCache

Returns SearchTrait

Properties

Protected _access

Protected _accessKeysService

Protected _client

Protected Optional _config

Protected _dataSourceWrapper

Protected _global

Protected _graphqlSchemaManager

Protected _queryCache

Protected _runtimeConfig

Protected _schemaManager

Protected _search

Protected Optional _type

Private userVertexLabel

Static Private schemaAttached

Static Private searchEnabledVertices

Static synonymsEnabled

Static Private unionsAltered

Methods

_getTraitStorage

Returns

Parameters

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

Returns Record<any, any>

addGraphqlTypes

Parameters

types: string[]

Returns void

alterUnions

Parameters

_type: SchemaItemType

_conf: SearchTraitConfig

_schemaManager: SchemaManager

unions: SchemaUnion[]

Returns SchemaUnion[]

autoConfig

Parameters

type: SchemaItemType

conf: SearchTraitConfig

schemaManager: SchemaManager

Returns undefined | SearchTraitConfig

Private buildAccessKeys

Parameters

item: StoredKosmosItem

datasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

Returns Promise<string[]>

Protected buildElasticsearchQueryString

Parameters

filtersTree: FilterTreeExpression

Returns string

Protected buildFilterExpressionsTree

Parameters

expression: LuceneQueryFieldExpression | LuceneQueryNodeExpression<true>

Returns FilterTreeExpression

Private buildRelationships

`Protected` _access

`Protected` _accessKeysService

`Protected` _client

`Protected` `Optional` _config

`Protected` _dataSourceWrapper

`Protected` _global

`Protected` _graphqlSchemaManager

`Protected` _queryCache

`Protected` _runtimeConfig

`Protected` _schemaManager

`Protected` _search

`Protected` `Optional` _type

`Private` userVertexLabel

`Static` `Private` schemaAttached

`Static` `Private` searchEnabledVertices

`Static` synonymsEnabled

`Static` `Private` unionsAltered

`Private` buildAccessKeys

`Protected` buildElasticsearchQueryString

`Protected` buildFilterExpressionsTree

`Private` buildRelationships

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

`Protected` buildSingleElasticsearchQueryStringFilter

`Private` createEdgeSearchDocument

`Private` deleteOrphanEdgeDocuments

`Private` deleteSearchDocument

`Private` extractFields

Returns Promise<{
hasNextPage: boolean;
items: any[];
}>

`Private` getConfigForEntity

`Private` getConfiguredEdgeProperties

edge: {
id: string;
inV: {
id: string;
label: string;
};
label: string;
outV: {
id: string;
label: string;
};
}

inV: {
id: string;
label: string;
}

outV: {
id: string;
label: string;
}

`Protected` getFiltersTreeType

`Private` getVertices