Skip to main content

NestJS API CRUD Operation Using PostgreSQL Relational Database

NestJS API is a server-side framework that runs on NodeJS frameworks like Express. NestJS application has the ability to talk with both SQL and Non-SQL databases.

Here we will develop a sample NestJS API application that communicates with the PostgreSQL relational database.

NestJS Database Communication Flow:

The 'pg'(PostgreSQL NodeJS library) library was used for communicating with the PostgreSQL database. The 'typeorm'(NodeJS library) library is a framework used for querying the database or manipulating the database using the specified database library(in our case 'pg' node library). The 'typeorm' will be used for all database configurations also. The '@nestjs/typeorm'(NestJS ORM library) is an overlay or wrapper for the 'typeorm'(NodeJS library). By using '@nestjs/typeorm' it gives the advantage of Typescript compatibility and additional feature over 'typeorm'(NodeJS library). So while implementing NestJS application in max scenarios we will only use the '@nestjs/typeorm' library which will internally communicate with 'typeorm'(NodeJS library).

PostgreSQL Database Using ElephantSQL Cloud Service:

So for our application, we need to set up a PostgreSQL relational database. Here I'm going to set up a free cloud service PostgreSQL database provided by ElephantSQL for our demo purpose. It is a very easy setup, to do it takes 3-5minutes to setup, click here for steps to configure the ElephantSQL cloud service.

Create A Sample NestJS App:

Let's begin our sample by creating a NestJS application. Here we use NestJS CLI(command line interface) to create app.
Command To Install Nest CLI:

npm i -g @nestjs/cli
NestJS CLI Command To Create APP:

nest new your_project_name
By default NestJS application configured to run on portnumber '3000'. So execute the below command to start the application.
Commands To Start App:

npm run start
npm run start:dev ---> runs application in watch mode prefered for development time
npm run start:prod ---> production mode 

Npm Packages:

Install the following npm packages that are needed to accomplish our sample NestJS application.
Install NestJS Typeorm:

npm install --save @nestjs/typeorm
Install NodeJS Typeorm:

npm install --save typeorm
Install NodeJS PostgreSQL:

npm install --save pg

typeorm Decorators For Table Entities:

To make our typescript entity or model as table related entity, then we need to use decorators that are provided by the 'typeorm'(node js library).

@Entity() - This decorator is used to mark classes that will be an entity(table or document depends on database type). A database scheme will be created for all classes decorate with it, and the repository can be retrieved and used for it.

@PrimaryColumn() - This decorator is used to mark the property of an entity as a primary column of the table. It has the capability of the incremental integer value to save.

@Column() - This decorator is used to mark the property of class as the column of the table.

Create An Employee Table Entity:

In this sample, we are going to develop CRUD operations on the Employee table in the PostgreSQL relational database.

As a first step lets create a typescript Employee class that represents the database table.
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

export class Employee {
id: number; @Column() name: string; @Column() salary: number; @Column() age: number; }
  • (Line: 1) all required decorators are imported from the 'typeorm'(NodeJS library)
  • (Line: 3) typescript class Employee decorated with '@Entity()' decorator to make it as table class.
  • (Line: 5) 'id' property decorated with '@PrimaryColumn' decorator to make compatible with the primary column of the table.
  • @column() decorator was used on all other properties of the typescript class to represent the table columns.

TypeOrmModule Of @nestjs/typeorm:

TypeOrmModule of @nestjs/typerorm(NestJs library) will be used to configure database settings, register table entities, register injectable repositories of entity types, etc. TypeOrmModule implements static overloaded methods like:
  • forRoot() - this method takes configuration like database settings to set up communication between the NestJS application and the database. This method always registered in the parent or root module of the application like the 'app module'.
  • forFeature() - this method is similar to the forRoot() method but it will be registered for child modules of the 'appmodule'.
  • forRootAsync() - this async form forRoot() method.

Add PostgreSQL Configuration To AppModule:

To establish communication with the PostgreSQL database need to add configuration in TypeOrmModule at app.module.ts file to register globally.
import { TypeOrmModule } from '@nestjs/typeorm';
import { Employee } from './Employee/employee.entity';
// some code hidden for display purpose
  imports: [
      type: 'postgres',
      host: '',
      port: 5432,
      username: '-----------',
      password: '-----------',
      database: '-----------',
      entities: [Employee],
export class AppModule {}
  • (Line: 7) 'type' defines the database will be used since we are using the PostgreSQL database so we can pass the constant value of 'postgres'. 
  • (Line: 8) 'host' database server hosted
  • (Line: 9) the port number, '5432' is the default port number for the PostgreSQL database.
  • (Line: 10&11&12) database username, password, name of the database
  • (Line: 13) entities of the database need to register, it takes an array of entity types.
  • Click here for identifying PostgreSQL configurations

Pre-defined Repository Of typeorm:

The 'typeorm'(NodeJS library) provides Pre-defined 'Repository<TEntity>'. This pre-defined 'Repository' is supposed to work with our entity objects. It responsibilities are like 'find entities', 'insert', 'update', 'delete', etc.

InjectRepository Decorator From @nestjs/typeorm:

The '@nestjs/typeorm'(NestJS library) provides 'InjectRepository' decorator. This 'InjectRepository' decorator helps to inject the 'Repository<TEntity>' from 'typeorm'(NodeJS library) into the service files constructor of our application.

Create EmployeeService:

In general, all our logical code will be implemented in our 'service' files.
import { Injectable } from '@nestjs/common';
import { Repository } from 'typeorm';
import { InjectRepository } from '@nestjs/typeorm';

export class EmployeeService {
  constructor(@InjectRepository(Employee) private employeeRepo: Repository<Employee>) {}
  • (Line: 6) 'Injectable' decorator used on 'EmployeeService' to make it as an injectable service
  • (Line: 8) 'Repository<Employee>' injected into the service class with the help of '@InjectRepository()' decorator.

Add Fetch All Employee Logic:

Now in service using the repository, we are going to query the PostgreSQL relational database. Repository from 'typeorm'(NodeJS library) is built with a predefined query method which makes our logic simple and easy for database communication. Now here we will implement the method to fetch all our employee data.
import { Employee } from './employee.entity';
// code hidden for display purpose
export class EmployeeService {
   findAll(): Promise<Employee[]> {
    return this.employeeRepo.find();
  • The 'find()' method from the repository which will take optional filter parameters to query against the database. If no filter parameters passed it return all the data from the database.
  • The 'find()' method returns a promise of an array of the entity type.

Create Employee Controller With Read Operation:

Now let's add the Employee controller for our sample application. Create an endpoint to read all the employees from the PostgreSQL relational database.
import { Controller, Get } from '@nestjs/common';
import {EmployeeService} from './employee.service';
import {Employee} from './employee.entity';

export class EmployeeController {
    constructor(private readonly employeeService: EmployeeService){}

    async getAll():Promise<Employee[]>{
        return await this.employeeService.findAll();
  • '@Controller()' decorator that makes class as Nest controller that can receive the inbound request and produce the response.
  • '@Get()' decorator is a route handler decorator. Routes Http Get request to the specified path.
  • (Line: 7) injected 'EmployeeService'
  • (Line: 9-12)Http method that executes read operation to fetch all the employee data.

Create An Employee Module:

In NestJS implementation each business logic will be developed as simple separate modules. These Modules acts entry point to register all configuration like 'controllers', 'services', 'entities', etc. So here we need to create an Employee module for our business.
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';

import { EmployeeController } from './employee.controller';
import { Employee } from './employee.entity';
import { EmployeeService } from './employee.service';

  imports: [TypeOrmModule.forFeature([Employee])],
  providers: [EmployeeService],
  controllers: [EmployeeController],
export class EmployeeModule {}
  • 'TypeOrmModule.forFeature([Employee])' makes the 'Emplyee' entity schema available to 'Repository' from the 'typeorm'(NodeJS library) to query the database.
  • 'EmployeeService' registered to providers array to load the service for the Employee module.
  • 'EmployeeController' registered to controllers array to expose the routes.

Register Child Modules To AppModule:

Now to load or expose the child modules in an application we need to import those child modules in the app.module.ts file.
import { EmployeeModule } from './Employee/employee.module';

// code hidden for display purpose
  imports: [
export class AppModule {}
Now start the application and access the newly created endpoint and output shows as below.

Create Operation:

Now we are going to implement a create operation to create new employees.
'insert()' method provided by the 'Repository' imported from 'typeorm'(NodeJS library). This method inserts a given entity. Executes fast and efficient Insert queries. Doesn't check if the entity exists in the database, so the query will fail if a duplicate entity tries to insert.

Now in the controller let's add a post-action method.
import { Controller, Get, Post, Body, HttpCode } from '@nestjs/common';

createEmployee(@Body() newEmployee:any){
  • '@Post()' request handler decorator. Routes Http Post request to the specified path.
  • '@HttpSatatusCode' request method decorator. Defines the Http response status code. Overrides default status code for the decorated request method. '201' status code stands for created successfully.
  • '@Body()' route handler parameter decorator. Extract the entire body object from the request object and populate the decorated parameter with the value of the body.

Update Operation:

Add the following code to update a record.
'update()' method from 'Repository' imported from 'typeorm'. This method is an overloaded method. It has the capability to do a partial update without effecting other column's data.
updateEmployee(@Body() employeeToUpdate:any){

Delete Operation:

'delete()' method of 'Repository' from 'typeorm'. Bypassing the primary key id is enough to remove the record from the database.
deleteEmployee(@Param('id') id){
  • '@Delete()' route handler decorator. Routes Http Delete requests to the specified path.
  • '@Param()' this decorator is to extract the data from the route.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on creating a sample of NestJS CRUD operations using the relational database PostgreSQL. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:


  1. This was well details article. It unveiled alot to help understand NESTJS


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