CODEX

Quarkus — MongoDB Integration

On one side we have supersonic, subatomic Java framework, Quarkus and on the other side cross-platform document oriented NoSql database, MongoDB. So, it must be fun to integrate these two platforms with each other and executes our application in a supersonic way.

Quarkus & MongoDB

What is Quarkus?

Quarkus is being developed by Red Hat in Java and it is a full-stack, Kubernetes-native Java application framework.

The best two functionalities that I like about Quarkus are;

  • It is a combination of imperative coding & reactive coding,pls read the following link how it combines both;
  • It has really fast boot time comparing with other frameworks

I will not mention about how to setup your first Quarkus project because there are plenty of informative examples in its website. In order to react these examples about Quarkus, pls follow https://quarkus.io link.

Quarkus & MongoDB Connection

I have my MongoDB image in my local Docker and run my MongoDB container from this image. As MongoDB driver is not implicitly embedded in Quarkus, I am using Panache library for the MongoDB connection.

First, add our db connection to our application.properties file. My MongoDB runs on 27017 port & my database name is enterprise.

Creating our Entity with Panache

Panache works on top of MongoDB Client extension and it really makes life easier for you while creating entities in MongoDB. Just you need to extend your entity with “PanacheMongoEntity” and add @MongoEntity annotation to your class.

Here my collection name is enterprise in my enterprise DB. So, my entity has name attribute as notNull and with size restrictions and a webPage attribute. Also, I have ObjectId attribute in my enterprise DB which will see closer while creating our service to findById.

Creating Interface & Service Class

Now, I create an interface for my abstract methods and I will implement these in my service class.

I will not dive into details for my service class but important points are @ApplicationScoped & @Transactional annotations.

Also, we need to define our id as ObjectId in order to filter the collection values in our MongoDB.

Creating Resource Class

Reourse class is like our controller class in Quarkus. I implement APIs with RESTEasy, JBoss implementation of JAX-RS. JAX-RS stands for Java API for RESTful Web Services and it is a set of JAVA APIs in order to create REST webServices in our applications. You can find more detail about it from the below link.

It is easy to use and makes our code faster while implementing APIs.

Below you can find my resource class that is serving my enterprise collection in my MongoDB.

After that point, you only need to run your application and test your APIs serving to our collection.

To create a new enterprise instance in our collection;

Create a New Enterprise Instance

To search for a specific enterprise in our collection;

Search for a Specific Enterprise Instance

To search for all enterprises in our collection;

Search for All Enterprise Instances

To Sum Up

Integrating Quarkus with MongoDB is easy and you can design & use your entities quickly with Panache. And with the help of RESTEasy, it is really fast to implement APIs from your application.

You can find the code base of this example from the below link;

A Humble Human | A Software Craftsman | A GitKraken Ambassador | A TOGAF 9 Certified Architect | An Integration & Full-Stack Enthusiast | A Chess Lover