Make CRUD simple with Node, GraphQL, and React

title: Make CRUD simple with Node, GraphQL, and React published: true tags: graphql,node,react canonical_url: https://blog.logrocket.com/crud-with-node-graphql-react/ cover_image: https://thepracticaldev.s3.amazonaws.com/i/6zyj75ds1cwn9ktrm18l.jpeg

Written by Avanthika Meenakshi✏️

GraphQL reduces the complexity of building APIs by abstracting all requests to a single endpoint. Unlike traditional REST APIs, it is declarative; whatever is requested is returned.

Of course, not all projects require GraphQL — it is merely a tool to consolidate data. It has well-defined schema, so we know for sure we won’t overfetch. But if we already have a stable RESTful API system where we rely on data from a single data source, we don’t need GraphQL.

For instance, let’s assume we are creating a blog for ourselves and we decide to store, retrieve, and communicate to data in a single MongoDB database. In this case, we are not doing anything architecturally complex, and we don’t need GraphQL.

On the other hand, let’s imagine we have a full-fledged product that relies on data from multiple sources (e.g., MongoDB, MySQL, Postgres, and other APIs). In this case, we should go for GraphQL.

For example, if we’re designing a portfolio site for ourselves and we want data from social media and GitHub (to show contributions), and we also have our own database to maintain a blog, we can use GraphQL to write the business logic and schema. It will consolidate data as a single source of truth.

Once we have the resolver functions to dispatch the right data to the front end, we will easily be able to manage data within a single source. In this article, we’re going to implement simple end-to-end CRUD operations with GraphQL.

CRUD with graphql-server

Setting up our server

We are going to spin off a simple GraphQL server using express-graphql and get it connected to a MySQL database. The source code and the MySQL files are in this repository.

A GraphQL server is built on top of schema and resolvers. As a first step, we build a schema (defining types, queries, mutations, and subscriptions). This schema describes the whole app structure.

Secondly, for the stuff defined in the schema, we’re building respective resolvers to compute and dispatch data. A resolver maps actions with functions; for each query declared in typedef, we create a resolver to return data.

Finally, we complete server settings by defining an endpoint and passing configurations. We initialize /graphql as the endpoint for our app. To the graphqlHTTP middleware, we pass the built schema and root resolver.

Along with the schema and root resolver, we’re enabling the GraphiQL playground. GraphiQL is an interactive in-browser GraphQL IDE that helps us play around with the GraphQL queries we build.

```jsx var express = require('express'); var graphqlHTTP = require('express-graphql'); var { buildSchema } = require('graphql');

var schema = buildSchema(type Query { hello: String });

var root = { hello: () => "World" };

var app = express();

app.use('/graphql', graphqlHTTP({ schema: schema, rootValue: root, graphiql: true, }));

app.listen(4000);

console.log('Running a GraphQL API server at localhost:4000/graphql'); ```

Once the server is good to go, running the app with node index.js will start the server on http://localhost:4000/graphql. We can query for hello and get the string “World” as a response.

Connecting the database

I’m going to establish the connection with the MySQL database as shown below:

```jsx var mysql = require('mysql');

app.use((req, res, next) => { req.mysqlDb = mysql.createConnection({ host : 'localhost', user : 'root', password : '', database : 'userapp' }); req.mysqlDb.connect(); next(); }); ```

We can connect multiple databases/sources and get them consolidated in the resolvers. I’m connecting to a single MySQL database here. The database dump I’ve used for this article is in the GitHub repository.

Reading and writing data with GraphQL

We use queries and mutations to read and modify data in data-sources. In this example, I’ve defined a generic queryDB function to help query the database.

Queries

All the SELECT statements (or read operations) to list and view data goes into the type Querytypedef. We have two queries defined here: one to list all the users in the database, and another to view a single user by id.

1. Listing data: To list users, we’re defining a GraphQL schema object type called User, which represents what we can fetch or expect from the getUsers query. We then define the getUsers query to return an array of users.
2. Viewing a single record: To view a single record, we’re taking id as an argument with the getUserInfo query we have defined. It queries for that particular id in the database and returns the data to the front end.

Now that we have put together the queries to fetch all records and to view record by id, when we try to query for users from GraphiQL, it will list an array of users on the screen! 🙂

``jsx var schema = buildSchema( type User { id: String name: String job_title: String email: String } type Query { getUsers: [User], getUserInfo(id: Int) : User } `);

const queryDB = (req, sql, args) => new Promise((resolve, reject) => { req.mysqlDb.query(sql, args, (err, rows) => { if (err) return reject(err); rows.changedRows || rows.affectedRows || rows.insertId ? resolve(true) : resolve(rows); }); });

var root = { getUsers: (args, req) => queryDB(req, "select * from users").then(data => data), getUserInfo: (args, req) => queryDB(req, "select * from users where id = ?", [args.id]).then(data => data[0]) }; ```

Mutations

The write operations for the database — CREATE, UPDATE, DELETE — are generally defined under mutations. The mutations are executed in a sequential manner by the GraphQL engine. Queries are executed parallelly.

1. Creating data: We have defined a mutation, createUser, that takes the specified arguments to create data in the MySQL database.
2. Updating or deleting data: Similar to viewing a record, update (updateUserInfo) and delete (deleteUser) take id as a param and modify the database.

The functions resolve with a boolean to indicate whether the change happened or not.

``jsx var schema = buildSchema( type Mutation { updateUserInfo(id: Int, name: String, email: String, job_title: String): Boolean createUser(name: String, email: String, job_title: String): Boolean deleteUser(id: Int): Boolean } `);

var root = { updateUserInfo: (args, req) => queryDB(req, "update users SET ? where id = ?", [args, args.id]).then(data => data), createUser: (args, req) => queryDB(req, "insert into users SET ?", args).then(data => data), deleteUser: (args, req) => queryDB(req, "delete from users where id = ?", [args.id]).then(data => data) }; ```

Now that we have set and sorted the server side of things, let’s try and connect the back end to our React app.

CRUD with graphql-client

Once we have the server in place, creating client logic to display and mutate data is easy. Apollo Client helps in state management and caching. It is also highly abstracted and quick: all of the logic for retrieving your data, tracking loading and error states, and updating UI is encapsulated by the useQuery Hook.

Connecting to graphql-server

I have created a CRA boilerplate and have installed GraphQL, apollo-boost, and @apollo/react-hooks. We initialize Apollo Client and get it hooked to React.

```jsx import React from 'react'; import ReactDOM from 'react-dom'; import App from './App'; import ApolloClient from 'apollo-boost'; import { ApolloProvider } from '@apollo/react-hooks';

const client = new ApolloClient({ uri: 'http://localhost:4000/graphql' });

ReactDOM.render( , document.getElementById('root') ); ```

Reading and mutating data

I have managed all the GraphQL queries in the Queries folder of my source code. I’m going to request data from the server with the useQuery Hook, which is built on top of the React Hooks API. It helps in bringing in data into the UI.

GraphQL queries are generally wrapped in the gql function. gql helps convert query string into a query document. Here’s how we define queries in our app.

```jsx import { gql } from 'apollo-boost';

export const GET_USERS = gql{ getUsers { id, name, job_title, email } };

export const VIEW_USERS = gqlquery ($id: Int){ getUserInfo(id: $id) { id, name, job_title, email } };

export const ADD_USER = gqlmutation($name: String, $email: String, $job_title: String) { createUser (name: $name, email: $email, job_title: $job_title) };

export const EDIT_USER = gqlmutation($id: Int, $name: String, $email: String, $job_title: String) { updateUserInfo (id: $id, name: $name, email: $email, job_title: $job_title) };

export const DELETE_USER = gqlmutation($id: Int) { deleteUser(id: $id) } ```

Once ApolloProvider is set, we can request data from our GraphQL server. We pass the query we are trying to make to the useQuery Hook, and it will provide the result for us.

I’ve made two queries, with and without arguments, to show how we should be handling queries and mutations in the front end. useQuery tracks error and loading states for us and will be reflected in the associated object. Once the server sends the result, it will be reflected by the data property.

```jsx import React from 'react'; import { useQuery } from '@apollo/react-hooks'; import { GET_USERS, VIEW_USERS } from "./Queries"; import { Card, CardBody, CardHeader, CardSubtitle, Spinner } from 'reactstrap';

function App() { const getAllUsers = useQuery(GET_USERS); const userInfo = useQuery(VIEW_USERS, { variables: { id: 1 }}); if (getAllUsers.loading || userInfo.loading) return ; if (getAllUsers.error || userInfo.error) return Error :(;

return (

            {JSON.stringify(getAllUsers.data, null, 2)}
          

            {JSON.stringify(userInfo.data, null, 2)}
          

export default App; ```

Similar to querying, mutations will use the same useQuery Hook and will pass data as variables into the query.

jsx const deleteMutation = useQuery(DELETE_USER, { variables: { id: 8 }}); const editMutation = useQuery(EDIT_USER, { variables: { id: 9, name: "Username", email: "email", job_title: "job" }}); const createMutation = useQuery(ADD_USER, { variables: { name: "Username", email: "email", job_title: "job" }});

Conclusion

Ta-da! We just did end-to-end CRUD operations with GraphQL. On the client side, reading and mutating data has become very simple after the introduction of React Hooks. Apollo Client also provides provisions for authentication, better error handling, caching, and optimistic UI.

Subscriptions is another interesting concept in GraphQL. With this application as boilerplate, we can keep experimenting with other concepts like these!

Happy coding!

Editor's note: Seeing something wrong with this post? You can find the correct version here.

Plug: LogRocket, a DVR for web apps

  LogRocket is a frontend logging tool that lets you replay problems as if they happened in your own browser. Instead of guessing why errors happen, or asking users for screenshots and log dumps, LogRocket lets you replay the session to quickly understand what went wrong. It works perfectly with any app, regardless of framework, and has plugins to log additional context from Redux, Vuex, and @ngrx/store.   In addition to logging Redux actions and state, LogRocket records console logs, JavaScript errors, stacktraces, network requests/responses with headers + bodies, browser metadata, and custom logs. It also instruments the DOM to record the HTML and CSS on the page, recreating pixel-perfect videos of even the most complex single-page apps.   Try it for free.

The post Make CRUD simple with Node, GraphQL, and React appeared first on LogRocket Blog.