@graphql-tools/batch-execute

What is @graphql-tools/batch-execute?

@graphql-tools/batch-execute is a utility package for batching and executing GraphQL operations. It is part of the GraphQL Tools ecosystem and is designed to optimize the execution of multiple GraphQL operations by batching them together, which can improve performance and reduce the number of network requests.

What are @graphql-tools/batch-execute's main functionalities?

Batch Execution

This feature allows you to batch multiple GraphQL operations and execute them together. The code sample demonstrates creating a simple schema and batching two queries ('{ hello }' and '{ world }') for execution.

const { batchExecute } = require('@graphql-tools/batch-execute');
const { makeExecutableSchema } = require('@graphql-tools/schema');
const { graphql } = require('graphql');

const typeDefs = `
  type Query {
    hello: String
    world: String
  }
`;

const resolvers = {
  Query: {
    hello: () => 'Hello',
    world: () => 'World'
  }
};

const schema = makeExecutableSchema({ typeDefs, resolvers });

const operations = [
  { query: '{ hello }' },
  { query: '{ world }' }
];

batchExecute({ schema, operations }).then(results => {
  console.log(results);
});

Custom Execution Context

This feature allows you to provide a custom execution context for the batched operations. The code sample demonstrates how to pass a context object containing user information to the batchExecute function.

const { batchExecute } = require('@graphql-tools/batch-execute');
const { makeExecutableSchema } = require('@graphql-tools/schema');
const { graphql } = require('graphql');

const typeDefs = `
  type Query {
    hello: String
    world: String
  }
`;

const resolvers = {
  Query: {
    hello: () => 'Hello',
    world: () => 'World'
  }
};

const schema = makeExecutableSchema({ typeDefs, resolvers });

const operations = [
  { query: '{ hello }' },
  { query: '{ world }' }
];

const context = { user: { id: 1, name: 'John Doe' } };

batchExecute({ schema, operations, context }).then(results => {
  console.log(results);
});

Other packages similar to @graphql-tools/batch-execute

dataloader

Dataloader is a generic utility to batch and cache data-fetching operations. It is often used in GraphQL servers to optimize the resolution of fields that require fetching data from a database or other remote service. Unlike @graphql-tools/batch-execute, which focuses on batching GraphQL operations, Dataloader is more general-purpose and can be used for any kind of data-fetching.

apollo-server

Apollo Server is a fully-featured GraphQL server with built-in support for batching and caching. It provides a more comprehensive solution for building GraphQL APIs, including schema stitching, subscriptions, and more. While @graphql-tools/batch-execute focuses specifically on batching GraphQL operations, Apollo Server offers a broader set of features for building and optimizing GraphQL APIs.

README

Check API Reference for more information about this package; https://www.graphql-tools.com/docs/api/modules/batch_execute_src

You can also learn more about Batch Delegation in this chapter; https://www.graphql-tools.com/docs/stitch-schema-extensions#batch-delegation