Graphweaver allows users to connect many data sources together. Many datasources are included as a part of our open source repo and a few are a part of our enterprise repo. If you want to connect to something we don’t already have a provider for, you can create your own data integration and extend the Graphweaver’s functionality.

There’s nothing special to inherit from, you just need to comply with the BackendProvider interface. If you’d like to start from a base class that implements everything with stub methods that throw Not Implemented use the BaseDataProvider here. A minimal example looks like this:

import { BaseDataProvider, Entity, Field, ID } from "@exogee/graphweaver";
import Graphweaver from "@exogee/graphweaver-server";

class MyProvider extends BaseDataProvider<any> {
  constructor() {
    super("MyProvider");
  }

  public async find(filter) {
    return Promise.resolve([{ id: "1", magicWord: "orange" }]);
  }

  public async findOne(filter) {
    return Promise.resolve({ id: "1", magicWord: "orange" });
  }
}

@Entity("Test", {
  provider: new MyProvider(),
})
export class Test {
  @Field(() => ID)
  id!: string;

  @Field(() => String)
  magicWord!: string;
}

export const graphweaver = new Graphweaver();

With this, the admin area will display as follows:

Base Provider Methods

The following methods can be implemented. D in these types refers to the generic type argument passed to BaseDataProvider or BackendProvider, which represents the data object returned by your provider. G in these types refers to the GraphQL Entity (in the schema folder) shape.

Read

find(filter: Filter<D>, pagination?: PaginationOptions): Promise<D[]>;

find accepts arguments for filtering and pagination. find returns an array of the entities that match the filter and pagination params.

findOne(filter: Filter<D>): Promise<D | null>;

findOne accepts a filter with the id of the entity being loaded and returns a single entity.

findByRelatedId(
		entity: Constructor<G>,
		relatedField: string,
		relatedIds: readonly string[],
		filter?: Filter<D>
	): Promise<D[]>;

findByRelatedId gets entities by id that are related to the parent entity. This is called when Graphweaver is joining and using DataLoader to load related entities across a relationship.

Update

updateOne(id: string | number, updateArgs: Partial<D>): Promise<D>;

updateOne updates an entity with the primary key specified with a payload. This is called when someone runs the update[entity name] mutation.

updateMany(entities: Partial<D>[]): Promise<D[]>;

updateMany updates multiple entities with a specified payload. The primary key for each entity that needs updating is in the payload.