Skip to main content

Implementing DataLoader For Query Execution Using Hot Chocolate GraphQL In .Net

In this article, we are going to understand and implement the DataLoader concept in Hot Chocolate GraphQL.

Here we will use an existing Hot Chocolate sample application that was created in the introduction articles on Hot chocolate GraphQL. I recommend reading those articles:
Part-1 Introduction On Hot Chocolate GraphQL

Issues Need To Fix:

Before implementing the DataLoader into our sample we must aware of the issues we are facing. In GrphQL we have an option like Fragments Query. Fragments query is used to display the comparison results very effective way.
Fragments Query:
   Gadget2:GetByBrand(brand:"red mi"){
Here we request a GraphQL endpoint to serve the different gadgets for comparison this type of query called Fragments Query.

Now this kind of Fragments Query produces issues like:
  • We will face a threading issue with the database context on using the async database communication calls.
  • In a normal process, this Fragments Query will run the query resolver method(logic that contains database communication) count is like based on n-number of comparison queries. This means if you observe the above sample query we requesting 2 comparison results so the revolver method will execute 2 times(which means 2 database calls). This might leads to performance issues.

Async Calls Database Context Issue:

Let's expose ourselves to the kind of issue we will get using the asynchronous calls.

In Part-2  written a resolver method as synchronous like below.
SchemaCore/Query.cs:(Existing Logic)
public List<Gadgets> GetByBrand(string brand, [Service] MyWorldDbContext context)
	return context.Gadgets.Where(_ => _.Brand.ToLower() == brand.ToLower()).ToList();
The results look as below.

Now let's update our resolver to an asynchronous approach.
SchemaCore/Query.cs:(Existing Logic)
public async Task<List<Gadgets>> GetByBrand(string brand, [Service] MyWorldDbContext context)
  return await context.Gadgets
  .Where(_ => _.Brand.ToLower() == brand.ToLower()).ToListAsync();
Let's check the results for the asynchronous calls.
You can see we are getting errors in the result set. But the actual error is like this:-

An exception occurred while iterating over the results of a query for contexttype'HC.GraphQL.Sample.Data.Context.MyWorldDbContext'.
System.InvalidOperationException: A second operation was started in this context before a previous operation completed. This is usually caused by different threads concurrently using the same instance of DbContext. For more information on how to avoid threading issues with DbContext.

This error because in the fragment query we are requested 2 comparison results, since our resolver is an asynchronous resolver so 2 requests are executed parallel and both are trying to access the database context at the same time.

Use Database Context Pool To Resolve The Threading Issue:

In .net DbContext pool keeps by default 128 Dbcontext alive in the pool. So that these instances will be served to requests without destroying them immediately. So if our fragment request will use separate DBContext for each thread request.

Existing DbContext registration looks like as below:
Startup.cs:(Existing Code)
services.AddDbContext<MyWorldDbContext>(options => {
Now let's update our code to register the DbContext pool as below:
Startup.cs:(Updated Code)
services.AddPooledDbContextFactory<MyWorldDbContext>(options => {
Now let's implement our logic to fetch the DbContext instance from the pool of DbContext. So let's create an extension method of the IObjectFieldDescriptor that will generate DbContext as below.
using HotChocolate.Types;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;

namespace HC.GraphQL.Sample.Extensions
  public static class ObjectFieldDescriptorExtensions
   public static IObjectFieldDescriptor UseDbContext<TDbContext>(
	this IObjectFieldDescriptor descriptor
   ) where TDbContext: DbContext
	return descriptor.UseScopedService<TDbContext>(
		create: s => s.GetRequiredService<IDbContextFactory<TDbContext>>().CreateDbContext(),
		disposeAsync: (s,c) => c.DisposeAsync()
  • (Line: 14) Fetching the context from the pool.
  • (Line: 15) Releases the allocated resource to DbContext.
Now let's create an Attribute which we are going to decorate on resolver so that they receive scoped DbContext from the pool.
using System.Reflection;
using HC.GraphQL.Sample.Data.Context;
using HotChocolate.Types;
using HotChocolate.Types.Descriptors;

namespace HC.GraphQL.Sample.Extensions
  public class UseMyWorldDbContextAttribute : ObjectFieldDescriptorAttribute
   public override void OnConfigure(IDescriptorContext context, 
   IObjectFieldDescriptor descriptor, MemberInfo member)
  • (Line: 8) Inherits from the 'HotChocolate.Types.ObjectFieldDescriptorAttribute'.
  • (Line: 13) Above create generic extension method registered here with our database context.
Now update our resolver method to decorate the attribute on it as below.
public List<Gadgets> GetByBrand(string brand, [ScopedService] MyWorldDbContext context)
  return context.Gadgets.Where(_ => _.Brand.ToLower() == brand.ToLower()).ToList();
  • (Line: 1)Decorated our 'UseMyWorldDbContext' attribute
  • (Line: 2) Used the 'ScopedService' attribute to inject the Dbcontext into our resolver method.
Now let's run our fragments query on our asynchronous resolver which will now work perfectly without any threading issue.

Fragment Query Multiple Database Calls Issue:

As mentioned that fragment query will run the resolver method multiple times based on the number of comparison queries inside of it. For the above sample query or screenshots, we used only 2 comparison queries inside of the fragment query so this will invoke the resolver method 2 times which might be performance issues. 

From the above 2 images, we can observe resolver executed 2 times.

DataLoader To Fix Multiple Database Calls Issue:

DataLoader technique in GraphQL to fetch the fragments of data with a single execution of the resolver method which gives us performance benifits.

Let's implement a DataLoader for our sample.
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using HC.GraphQL.Sample.Data.Context;
using HC.GraphQL.Sample.Data.Entities;
using HotChocolate.DataLoader;
using HotChocolate.Fetching;
using Microsoft.EntityFrameworkCore;

namespace HC.GraphQL.Sample.DataLoader
  public class GadgetsByBrandDataLoader : BatchDataLoader<string, List<Gadgets>>
	private readonly IDbContextFactory<MyWorldDbContext> _dbContextFactory;
	public GadgetsByBrandDataLoader(IDbContextFactory<MyWorldDbContext> dbContextFactory,
	BatchScheduler batchScheduler) : base(batchScheduler)
	  _dbContextFactory = dbContextFactory;
	protected override async Task<IReadOnlyDictionary<string, List<Gadgets>>> LoadBatchAsync(IReadOnlyList<string> keys, CancellationToken cancellationToken)
	 await using (MyWorldDbContext dbContext = _dbContextFactory.CreateDbContext())
	  var gadgets = await dbContext.Gadgets
	  .Where(g => keys.Select(_ => _.ToLower()).ToList().Contains(g.Brand)).ToListAsync(cancellationToken);
	  var result = gadgets.GroupBy( _ => _.Brand.ToLower())
	 .Select(_ =>new {
		key = _.Key.ToLower(),
		gadgets = _.ToList()
	 }).ToDictionary(_ => _.key, _ => _.gadgets);
	  return result;
  • (Line: 13) To create a HotChocolate GraphQL Dataloader we need to inherit base class DataLoader that is 'HotChocolate.DataLoader.BatchDataLoader<TKey,TValue>'. Here 'TKey' is the type of our query parameter value and 'TValue' is the output type returned from the delivery.
  • (Line: 16&17) Injected 'HotChocolate.Fetching.BatchScheduler' and then its value passed to the base constructor. Also injected 'Microsoft.EntityFrameworkCore.IDbContextFactory'.
  • (Line: 21) Implemented the 'LoadBatchAsync' method whose return type is key-value pair dictionary.
  • This method has input parameters is like collection string as the variable name 'keys', all these collections of string nothing but our query parameters from each comparison query this helps to fetch the data from the database with a single attempt.
  • (Line: 25-31) Fetching results based on the input parameter collection 'keys' and return the result as dictionary data.
Now register our DataLoader in Startup.cs file.
Now let's implement our resolver method where we are going to use our DataLoader to output the results.
public async Task<List<Gadgets>> GetByBrandLoader(
  string brand,
  GadgetsByBrandDataLoader dataLoader,
  CancellationToken cancellationToken)
   var result = await dataLoader.LoadAsync(brand,cancellationToken);
   return result;
  • Here for our resolver first parameter is our query parameter and the second is our Dataloader passed as a parameter this will be passed by the framework automatically.
Now let's create a GraphQL field for our new resolver method.
descriptor.Field(g => g.GetByBrandLoader(default, default, default)).Type<ListType<GadgetsObjectType>>()
Now let's test our fragments query that will return the result with a single time execution of the resolver method with the help of DataLoader.
That's all about the DataLoader in the HotChocolate GraphQL.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information about DataLoader in GraphQL. I love to have your feedback, suggestions, and better techniques in the comment section below.


Follow Me:


  1. Nice article, but I don't see the difference between the existing and the updated DbContext registration. Am I missing something?

  2. The updated DbContext registration should be this (I think, the author copied the code but forgot to change the method name):

    services.AddPooledDbContextFactory(options => {

    The article itself is awesome, thanks for it.

  3. good stuff! thanks but the code was going off the screenand i had to scroll alot to the right, just an fyi


Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti