Class EdgeCountTrait

EdgeCountTrait computes the count of edges to/from a vertex and stores the result as a property on the vertex.

The value of the computed property will also be indexed for Search.

! The trait has limitations - you can check them out here https://github.com/invotra/kosmos/pull/1926.

Usage:

traits:
- type: edge_count
  fields:
    membersCount:
      - searchField: members
          vertex:
            - User
    nonZeroTagsCount:
      - searchField: tags
        exclude:
          - property: weight
            value: 0

Hierarchy

Trait<EdgeCountTraitConfig>
- EdgeCountTrait

Index

Constructors

constructor

new EdgeCountTrait(graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, entityLoader: EntityLoader<Record<string, any>>, search: Search): EdgeCountTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- entityLoader: EntityLoader<Record<string, any>>
- search: Search
Returns EdgeCountTrait
Overrides Trait.constructor
- Defined in src/traits/EdgeCountTrait.ts:57

Properties

`Protected` `Optional` _config

_config?: EdgeCountTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Protected` `Optional` _type

_type?: "edge_count"

Trait type.

`Private` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Private` entityLoader

entityLoader: EntityLoader<Record<string, any>>

`Private` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

`Private` search

search: Search

Methods

executeSearch

executeSearch(body: any, size?: number): Promise<null | ApiResponse<Record<string, any>, unknown>>
Execute search and ignore errors.
Parameters
- body: any
- size: number = 0
Returns Promise<null | ApiResponse<Record<string, any>, unknown>>
- Defined in src/traits/EdgeCountTrait.ts:115

getFieldResolver

getFieldResolver(fieldName: string): ((datasourceWrapper: DataSourceWrapper, data: any) => Promise<number>)
Helper function for generating field resolvers.
Parameters
- fieldName: string
Returns ((datasourceWrapper: DataSourceWrapper, data: any) => Promise<number>)
- - (datasourceWrapper: DataSourceWrapper, data: any): Promise<number>
  - Parameters
    - datasourceWrapper: DataSourceWrapper
    - data: any
    Returns Promise<number>
- Defined in src/traits/EdgeCountTrait.ts:136

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/EdgeCountTrait.ts:203

hookIntoSchemaManager

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

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): EdgeCountTrait
Makes this Trait instance global.

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

name

name(): string
Used to return the name.

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

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

querySchema

querySchema(schemaString: string): string
This method is used to hook in the field change to the vertex that the EdgeCountTrait has been attached to.

Returns
Parameters
- schemaString: string
Returns string
- Defined in src/traits/EdgeCountTrait.ts:96

setConfig

setConfig(config: EdgeCountTraitConfig): void
EdgeCountTrait config setter
Parameters
- config: EdgeCountTraitConfig
  
  This configuration object
Returns void
Overrides Trait.setConfig
- Defined in src/traits/EdgeCountTrait.ts:78

traitConfig

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

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/EdgeCountTrait.ts:69

Class EdgeCountTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

entityLoader: EntityLoader<Record<string, any>>

search: Search

Returns EdgeCountTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Private dataSourceWrapper

Private entityLoader

Private graphqlSchemaManager

Private search

Methods

executeSearch

Parameters

body: any

size: number = 0

Returns Promise<null | ApiResponse<Record<string, any>, unknown>>

getFieldResolver

Parameters

fieldName: string

Returns ((datasourceWrapper: DataSourceWrapper, data: any) => Promise<number>)

Parameters

datasourceWrapper: DataSourceWrapper

data: any

Returns Promise<number>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns EdgeCountTrait

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

querySchema

Returns

Parameters

schemaString: string

Returns string

setConfig

Parameters

config: EdgeCountTraitConfig

Returns void

traitConfig

Returns EdgeCountTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

Settings

Member Visibility

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Private` dataSourceWrapper

`Private` entityLoader

`Private` graphqlSchemaManager

`Private` search

`Optional` callbackName: string

`Static` traitTypeName