Spring Data JPA - Containing Query Method Example

In this tutorial, we will learn how to write a Containing query method or finder method using Spring Data JPA.

Example: Let's write the Spring Data JPA query method to find or retrieve filtered products that match the given text ( contains check).

Maven Dependencies

Create a Spring boot project and add the following maven dependencies to it:



Product Entity

Let's first create a Product entity class and add the following content to it:

package com.springdatajpa.springboot.entity;

import lombok.*;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;

import javax.persistence.*;
import java.math.BigDecimal;
import java.time.LocalDateTime;

        name = "products",
        schema = "ecommerce",
        uniqueConstraints = {
                        name = "sku_unique",
                        columnNames = "stock_keeping_unit"
public class Product {

            strategy = GenerationType.IDENTITY
    private Long id;

    @Column(name = "stock_keeping_unit", nullable = false)
    private String sku;

    @Column(nullable = false)
    private String name;

    private String description;
    private BigDecimal price;
    private boolean active;
    private String imageUrl;

    private LocalDateTime dateCreated;

    private LocalDateTime lastUpdated;


Let's create ProductRepository which extends JpaRepository and add the following code to it:
package com.springdatajpa.springboot.repository;

import com.springdatajpa.springboot.entity.Product;
import org.springframework.data.jpa.repository.JpaRepository;
import java.math.BigDecimal;
import java.util.List;

public interface ProductRepository extends JpaRepository<Product, Long> {
     * Return the filtered the product records that match the given text
     * @param name
     * @return
    List<Product> findByNameContaining(String name);
Spring Data JPA query method to find or retrieve filtered products that match the given text ( contains check):
    List<Product> findByNameContaining(String name);

Configure MySQL and Hibernate Properties

Let's use the MySQL database to store and retrieve the data in this example and we gonna use Hibernate properties to create and drop tables.

Open the application.properties file and add the following configuration to it:


spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5InnoDBDialect

spring.jpa.hibernate.ddl-auto = create-drop

Make sure that you will create ecommerce database before running the Spring boot application. Also, change the MySQL username and password as per your MySQL installation on your machine.

Testing Spring Data JPA - Containing Query Method

Let's write the JUnit test to test Spring Data JPA - Containing Query Method:

import com.springdatajpa.springboot.entity.Product;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
import java.math.BigDecimal;

public class QueryMethodsTest {

    private ProductRepository productRepository;

    void findByNameContainingMethod(){

        List<Product> products = productRepository.findByNameContaining("product 1");
        products.forEach((p) -> {

Here is the output of the above JUnit test: