In recent years, GraphQL has gained significant traction as a powerful query language for APIs due to its flexibility and efficiency in fetching data. When coupled with Node.js, a versatile JavaScript runtime, and PostgreSQL, a robust open-source relational database, developers can create high-performing, scalable, and maintainable applications. In this blog post, we’ll delve into the integration of GraphQL with Node.js and PostgreSQL, exploring the benefits and providing insights into implementation.
GraphQL is a query language for APIs and a runtime for executing those queries. Unlike traditional REST APIs, GraphQL enables clients to request only the data they need, reducing over-fetching and under-fetching issues. It allows clients to define the structure of the data they require, providing a more efficient and customized approach to data retrieval.
Before we begin, ensure you have the following installed on your machine:
Related read: What is GraphQL? Learn How GraphQL Is Revolutionizing API Development
Let’s start by creating a new Node.js project and installing the necessary dependencies.
mkdir graphql-node-postgresql
cd graphql-node-postgresql
npm init -y
npm install apollo-server graphql pg
Assuming you have PostgreSQL installed and running, let’s create a simple database and a tasks table.
CREATE DATABASE graphql_node_postgresql;
\c graphql_node_postgresql;
CREATE TABLE IF NOT EXISTS public.tasks
(
id integer NOT NULL,
name character(250),
isCompleted boolean DEFAULT false,
CONSTRAINT tasks_pkey PRIMARY KEY (id)
)
Above step involves creating a PostgreSQL database named “graphql_node_postgresql” and a table named “tasks” within that database. The “tasks” table will have columns for “id” (an integer), “name” (a character string with a maximum length of 250 characters), and “isCompleted” (a boolean indicating whether the task is completed, defaulting to false). The primary key constraint is set on the “id” column to ensure each task has a unique identifier.
Related read: Building Powerful REST APIs with Node.js, Prisma ORM, and PostgreSQL
Now, let’s define the GraphQL schema that represents our data model. Create a file named types.js:
const { gql } = require("apollo-server");
const typeDefs = gql`
type Task {
id: Int
name: String
isCompleted: Boolean
}
type TaskResult {
id: Int
message: String
tasks: [Task]
}
type Mutation {
task(name: String): TaskResult!
}
type Query {
tasks: TaskResult!
}
`;
module.exports = typeDefs;
Here’s a breakdown of the code snippet:
Resolvers are functions responsible for fetching the data for each field defined in the schema. Create a file named resolvers.js to define the resolvers for graphQL:
const pool = require("./db");
const resolvers = {
Query: {
tasks: async () => {
try {
const result = await pool.query(`SELECT * FROM tasks`);
return { tasks: result.rows, message: "found" };
} catch (error) {
return { message: error.message };
}
},
},
Mutation: {
task: async (root, args) => {
try {
let { name } = args;
const result = await pool.query(`INSERT INTO tasks (name)
VALUES ($1)`, [name]);
return { message: "Task added successfully" };
} catch (error) {
return { message: error.message };
}
},
},
};
module.exports = resolvers;
Here’s a breakdown of the code snippet:
Create a file named db.js to set up the PostgreSQL connection:
const Pool = require('pg').Pool
const pool = new Pool({
user: 'postgres',
host: 'localhost',
database: 'graphql_node_postgresql',
password: 'postgres',
port: 5432,
})
module.exports = pool;
Create a file named index.js to set up the GraphQL server:
const { ApolloServer } = require("apollo-server");
const typeDefs = require("./types");
const resolvers = require("./resolver");
const server = new ApolloServer({ typeDefs, resolvers });
server.listen().then(({ url }) => {
console.log(`Server ready at ${url}`);
});
Here’s a breakdown of the code snippet:
node index.js
This command will start the GraphQL server, and it will be ready to accept incoming requests at the specified URL
(http://localhost:4000/graphql by default).
The integration of GraphQL with Node.js and PostgreSQL offers a powerful and efficient solution for building modern APIs and applications. By utilizing GraphQL’s query flexibility, Node.js’s event-driven architecture, and PostgreSQL’s reliability, developers can create scalable and performant systems while maintaining flexibility and ease of development. Embracing this technology stack empowers developers to meet evolving business needs and deliver exceptional user experiences in today’s dynamic digital landscape.
The team at Mindbowser was highly professional, patient, and collaborative throughout our engagement. They struck the right balance between offering guidance and taking direction, which made the development process smooth. Although our project wasn’t related to healthcare, we clearly benefited...
Founder, Texas Ranch Security
Mindbowser played a crucial role in helping us bring everything together into a unified, cohesive product. Their commitment to industry-standard coding practices made an enormous difference, allowing developers to seamlessly transition in and out of the project without any confusion....
CEO, MarketsAI
I'm thrilled to be partnering with Mindbowser on our journey with TravelRite. The collaboration has been exceptional, and I’m truly grateful for the dedication and expertise the team has brought to the development process. Their commitment to our mission is...
Founder & CEO, TravelRite
The Mindbowser team's professionalism consistently impressed me. Their commitment to quality shone through in every aspect of the project. They truly went the extra mile, ensuring they understood our needs perfectly and were always willing to invest the time to...
CTO, New Day Therapeutics
I collaborated with Mindbowser for several years on a complex SaaS platform project. They took over a partially completed project and successfully transformed it into a fully functional and robust platform. Throughout the entire process, the quality of their work...
President, E.B. Carlson
Mindbowser and team are professional, talented and very responsive. They got us through a challenging situation with our IOT product successfully. They will be our go to dev team going forward.
Founder, Cascada
Amazing team to work with. Very responsive and very skilled in both front and backend engineering. Looking forward to our next project together.
Co-Founder, Emerge
The team is great to work with. Very professional, on task, and efficient.
Founder, PeriopMD
I can not express enough how pleased we are with the whole team. From the first call and meeting, they took our vision and ran with it. Communication was easy and everyone was flexible to our schedule. I’m excited to...
Founder, Seeke
We had very close go live timeline and Mindbowser team got us live a month before.
CEO, BuyNow WorldWide
If you want a team of great developers, I recommend them for the next project.
Founder, Teach Reach
Mindbowser built both iOS and Android apps for Mindworks, that have stood the test of time. 5 years later they still function quite beautifully. Their team always met their objectives and I'm very happy with the end result. Thank you!
Founder, Mindworks
Mindbowser has delivered a much better quality product than our previous tech vendors. Our product is stable and passed Well Architected Framework Review from AWS.
CEO, PurpleAnt
I am happy to share that we got USD 10k in cloud credits courtesy of our friends at Mindbowser. Thank you Pravin and Ayush, this means a lot to us.
CTO, Shortlist
Mindbowser is one of the reasons that our app is successful. These guys have been a great team.
Founder & CEO, MangoMirror
Kudos for all your hard work and diligence on the Telehealth platform project. You made it possible.
CEO, ThriveHealth
Mindbowser helped us build an awesome iOS app to bring balance to people’s lives.
CEO, SMILINGMIND
They were a very responsive team! Extremely easy to communicate and work with!
Founder & CEO, TotTech
We’ve had very little-to-no hiccups at all—it’s been a really pleasurable experience.
Co-Founder, TEAM8s
Mindbowser was very helpful with explaining the development process and started quickly on the project.
Executive Director of Product Development, Innovation Lab
The greatest benefit we got from Mindbowser is the expertise. Their team has developed apps in all different industries with all types of social proofs.
Co-Founder, Vesica
Mindbowser is professional, efficient and thorough.
Consultant, XPRIZE
Very committed, they create beautiful apps and are very benevolent. They have brilliant Ideas.
Founder, S.T.A.R.S of Wellness
Mindbowser was great; they listened to us a lot and helped us hone in on the actual idea of the app. They had put together fantastic wireframes for us.
Co-Founder, Flat Earth
Ayush was responsive and paired me with the best team member possible, to complete my complex vision and project. Could not be happier.
Founder, Child Life On Call
The team from Mindbowser stayed on task, asked the right questions, and completed the required tasks in a timely fashion! Strong work team!
CEO, SDOH2Health LLC
Mindbowser was easy to work with and hit the ground running, immediately feeling like part of our team.
CEO, Stealth Startup
Mindbowser was an excellent partner in developing my fitness app. They were patient, attentive, & understood my business needs. The end product exceeded my expectations. Thrilled to share it globally.
Owner, Phalanx
Mindbowser's expertise in tech, process & mobile development made them our choice for our app. The team was dedicated to the process & delivered high-quality features on time. They also gave valuable industry advice. Highly recommend them for app development...
Co-Founder, Fox&Fork