Spring boot: MongoDB: Querying documents on embedded fields

You can query the embedded documents using '.' operator.

Example

Query query = new Query();

query.addCriteria(Criteria.where("addresses.city").is("Hyderabad"));

Find the below working application.

Address.java

package com.sample.app.entity;

public class Address {
 private String city;
 private String country;

 public Address(String city, String country) {
  this.city = city;
  this.country = country;
 }

 public String getCity() {
  return city;
 }

 public void setCity(String city) {
  this.city = city;
 }

 public String getCountry() {
  return country;
 }

 public void setCountry(String country) {
  this.country = country;
 }

 @Override
 public String toString() {
  StringBuilder builder = new StringBuilder();
  builder.append("Address [city=").append(city).append(", country=").append(country).append("]");
  return builder.toString();
 }

}

Employee.java

package com.sample.app.entity;

import java.util.List;

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document("employees")
public class Employee {
 @Id
 private String id;

 private String firstName;

 private String lastName;

 private List<Address> addresses;

 public Employee() {
 }

 public Employee(String firstName, String lastName, List<Address> addresses) {
  this.firstName = firstName;
  this.lastName = lastName;
  this.addresses = addresses;
 }

 public String getId() {
  return id;
 }

 public void setId(String id) {
  this.id = id;
 }

 public String getFirstName() {
  return firstName;
 }

 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }

 public String getLastName() {
  return lastName;
 }

 public void setLastName(String lastName) {
  this.lastName = lastName;
 }

 @Override
 public String toString() {
  StringBuilder builder = new StringBuilder();
  builder.append("Employee [id=").append(id).append(", firstName=").append(firstName).append(", lastName=")
    .append(lastName).append(", addresses=").append(addresses).append("]");
  return builder.toString();
 }

}

EmployeeRepository.java

package com.sample.app.repository;

import java.util.List;
import java.util.stream.Stream;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.mongodb.repository.Query;
import org.springframework.stereotype.Repository;

import com.sample.app.entity.Employee;

@Repository
public interface EmployeeRepository extends MongoRepository<Employee, String> {
 List<Employee> findByFirstName(String firstName);
 
 List<Employee> findByLastName(String lastName);
 
 List<Employee> findByFirstNameAndLastName(String firstName, String lastName);
 
 @Query("{'firstName' : ?0}")
 Stream<Employee> findAllByCustomQueryAndStream(String firstName);
}

application.properties

spring.data.mongodb.database=myorg
spring.data.mongodb.port=27017
spring.data.mongodb.host=localhost

logging.level.org.springframework.data=WARN

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>springDataMongo</groupId>
 <artifactId>springDataMongo</artifactId>
 <version>1</version>

 <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.1.6.RELEASE</version>
 </parent>

 <dependencies>
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-mongodb</artifactId>
  </dependency>
 </dependencies>
</project>

App.java

package com.sample.app;

import java.util.Arrays;
import java.util.List;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;

import com.mongodb.MongoClient;
import com.sample.app.entity.Address;
import com.sample.app.entity.Employee;

@SpringBootApplication
public class App {
 @Value("${spring.data.mongodb.database}")
 private String database;

 @Value("${spring.data.mongodb.host}")
 private String host;

 @Value("${spring.data.mongodb.port}")
 private int port;

 public static void main(String[] args) {

  SpringApplication.run(App.class, args);
 }

 public void dropPreviousData() {
  MongoClient mongoClient = new MongoClient(host, port);

  MongoOperations mongoOps = new MongoTemplate(mongoClient, database);

  mongoOps.dropCollection("employees");
 }

 @Bean
 public CommandLineRunner demo() {
  return (args) -> {

   dropPreviousData();

   MongoClient mongoClient = new MongoClient(host, port);
   MongoTemplate mongoTemplate = new MongoTemplate(mongoClient, database);

   List<Address> emp1Addresses = Arrays.asList(new Address("Bangalore", "India"),
     new Address("Hyderabad", "India"));
   List<Address> emp2Addresses = Arrays.asList(new Address("Hyderabad", "India"));
   List<Address> emp3Addresses = Arrays.asList(new Address("Chennai", "India"),
     new Address("Hyderabad", "India"));
   List<Address> emp4Addresses = Arrays.asList(new Address("Amaravathi", "India"),
     new Address("Ongole", "India"));

   Employee emp1 = new Employee("Phalgun", "Garimella", emp1Addresses);
   Employee emp2 = new Employee("Sankalp", "Dubey", emp2Addresses);
   Employee emp3 = new Employee("Arpan", "Garimella", emp3Addresses);
   Employee emp4 = new Employee("Phalgun", "Dubey", emp4Addresses);

   mongoTemplate.save(emp1);
   mongoTemplate.save(emp2);
   mongoTemplate.save(emp3);
   mongoTemplate.save(emp4);

   List<Employee> emps = mongoTemplate.findAll(Employee.class);
   System.out.println("All Employees");
   System.out.println("**************************************");
   emps.forEach(System.out::println);

   Query query = new Query();
   query.addCriteria(Criteria.where("addresses.city").is("Hyderabad"));

   emps = mongoTemplate.findAllAndRemove(query, Employee.class);
   System.out.println("All Employees whose city is Hyderabad");
   System.out.println("**************************************");
   emps.forEach(System.out::println);
  };
 }
}

Total project structure looks like below.

Run App.java, you can see below messages in console.

**************************************
Employee [id=5d538b8098c4b25482c66f80, firstName=Phalgun, lastName=Garimella, addresses=[Address [city=Bangalore, country=India], Address [city=Hyderabad, country=India]]]
Employee [id=5d538b8098c4b25482c66f81, firstName=Sankalp, lastName=Dubey, addresses=[Address [city=Hyderabad, country=India]]]
Employee [id=5d538b8098c4b25482c66f82, firstName=Arpan, lastName=Garimella, addresses=[Address [city=Chennai, country=India], Address [city=Hyderabad, country=India]]]
Employee [id=5d538b8098c4b25482c66f83, firstName=Phalgun, lastName=Dubey, addresses=[Address [city=Amaravathi, country=India], Address [city=Ongole, country=India]]]
All Employees whose city is Hyderabad
**************************************
Employee [id=5d538b8098c4b25482c66f80, firstName=Phalgun, lastName=Garimella, addresses=[Address [city=Bangalore, country=India], Address [city=Hyderabad, country=India]]]
Employee [id=5d538b8098c4b25482c66f81, firstName=Sankalp, lastName=Dubey, addresses=[Address [city=Hyderabad, country=India]]]
Employee [id=5d538b8098c4b25482c66f82, firstName=Arpan, lastName=Garimella, addresses=[Address [city=Chennai, country=India], Address [city=Hyderabad, country=India]]]  

You can download complete working application from this link.

Previous                                                    Next                                                    Home