Interface VulcanGenericDataSource<TDocument>

A valid data source in Vulcan must include this API

Based on Mongo data source API

You can use SQL data sources as well as long as they implement this field

see: https://www.apollographql.com/docs/apollo-server/data/data-sources/
see: https://github.com/GraphQLGuide/apollo-datasource-mongodb/
see: https://github.com/GraphQLGuide/apollo-datasource-mongodb/#api

Type parameters

TDocument = any

Hierarchy

DataSource
- VulcanGenericDataSource

Index

Methods

Methods

findByFields

findByFields(fields: {}): Promise<TDocument[]>

- Defined in packages/graphql/server/contextBuilder/typings.ts:15
Parameters
- fields: {}
  - [fieldName: string]: any
Returns Promise<TDocument[]>

findManyByIds

findManyByIds(ids: string[]): Promise<TDocument[]>

- Defined in packages/graphql/server/contextBuilder/typings.ts:18
Parameters
- ids: string[]
Returns Promise<TDocument[]>

findOneById

findOneById(id: string): Promise<TDocument>

- Defined in packages/graphql/server/contextBuilder/typings.ts:14
Parameters
- id: string
Returns Promise<TDocument>

Optional initialize

initialize(config: DataSourceConfig<any>): void | Promise<void>

Inherited from DataSource.initialize
- Defined in node_modules/apollo-datasource/dist/index.d.ts:7
Parameters
- config: DataSourceConfig<any>
Returns void | Promise<void>

Generated using TypeDoc