How do you perform CRUD operations with Couchbase in Spring Boot?

Table of Contents

• Introduction
• Performing CRUD Operations with Couchbase in Spring Boot
  • 1. Setting Up Spring Boot with Couchbase
  • 2. Create Operation: Inserting a Document
    • Example:
  • 3. Read Operation: Fetching Documents
    • Example:
  • 4. Update Operation: Modifying a Document
    • Example:
  • 5. Delete Operation: Removing a Document
    • Example:
• Practical Example: Full CRUD Implementation
• Conclusion

Introduction

Couchbase is a NoSQL database that provides a flexible data model with support for key-value pairs, JSON documents, and indexes. Integrating Couchbase with Spring Boot enables easy management of documents and allows you to perform CRUD (Create, Read, Update, Delete) operations seamlessly. In this guide, we'll walk through how to implement CRUD operations using Spring Boot and Couchbase.

Performing CRUD Operations with Couchbase in Spring Boot

1. Setting Up Spring Boot with Couchbase

Before performing CRUD operations, ensure your Spring Boot application is configured to connect with Couchbase. You need to add the necessary dependencies in your pom.xml file:

You also need to configure Couchbase connection properties in the application.properties or application.yml:

2. Create Operation: Inserting a Document

You can insert a new document into the Couchbase database using the CouchbaseRepository or CouchbaseTemplate. Below is an example of using a CouchbaseRepository to create a document:

Example:

In this example, the createProduct() method saves a new Product document to Couchbase.

3. Read Operation: Fetching Documents

You can read documents from Couchbase using the repository’s find methods or by executing N1QL queries. Here's an example of fetching a product by ID:

Example:

You can also use custom queries with N1QL for more complex read operations:

4. Update Operation: Modifying a Document

To update an existing document, you can use the save() method from the repository. This will update the document if it already exists:

Example:

This method retrieves the product by ID, updates its properties, and saves the updated document back to Couchbase.

5. Delete Operation: Removing a Document

To delete a document, you can use the deleteById() method provided by the CouchbaseRepository:

Example:

Alternatively, you can delete the document directly by finding it first and passing the object to the delete() method:

Practical Example: Full CRUD Implementation

Here’s an example service that implements full CRUD operations:

In this example, ProductService handles CRUD operations for the Product entity.

Conclusion

Performing CRUD operations with Couchbase in Spring Boot is straightforward with the help of CouchbaseRepository and CouchbaseTemplate. These tools allow you to create, read, update, and delete documents efficiently, supporting both simple and complex operations. By integrating Couchbase with Spring Boot, you can leverage its scalability and flexibility for NoSQL data storage in your applications.