Tuesday 23 February 2021

Spring jpa: How to specify 'in' query?

There are three ways to get the result using ‘in’ query.

 

Approach 1: Using spring repository query method. In, IsIn keyword expressions are used to execute an in query.

public List<Employee> findByIdIn(List<Integer> ids);
public List<Employee> findByIdIsIn(List<Integer> ids);

 

Approach 2: Explicitly specifying the jpa query.

@Query( "select e from Employee e where id in :ids" )
public List<Employee> getEmpsByIds(@Param("ids") List<Integer> ids);

 

Approach 3: Explicitly specifying sql native query.

@Query(value="select * from employees e where e.employee_id in :ids", nativeQuery=true)
public List<Employee> getEmpsByIdsUsingNativeQuery(@Param("ids") List<Integer> ids);

Find the below working application.

 

Step 1: Create new maven project ‘in_query_demo’.

 

Step 2: Update pom.xml with maven dependencies.

 

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>com.sample.app</groupId>
    <artifactId>in_query_demo</artifactId>
    <version>1</version>

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

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

        <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-jpa -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.h2database/h2 -->
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
        </dependency>


    </dependencies>
</project>


Step 3: Create application.properties file under src/main/resources.

 

application.properties

logging.level.root=WARN
logging.level.org.hibernate=ERROR

## H2 specific properties
spring.h2.console.enabled=true
spring.h2.console.path=/h2

spring.datasource.url=jdbc:h2:file:~/db/myOrg.db;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;

spring.datasource.username=krishna
spring.datasource.password=password123

spring.datasource.driverClassName=org.h2.Driver

## JPA specific properties
# Creates the schema, destroying previous data.
spring.jpa.hibernate.ddl-auto=create

spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

#spring.jpa.show-sql=true
#spring.jpa.properties.hibernate.format_sql=true

## Database connection pooling properties
# Number of ms to wait before throwing an exception if no connection is available.
spring.datasource.max-wait=10000

# Maximum number of active connections that can be allocated from this pool at the same time.
spring.datasource.tomcat.max-active=10
spring.datasource.tomcat.max-idle=5
spring.datasource.tomcat.min-idle=3


Step 4: Create a package com.sample.app.model and define Employee entity.

 

Employee.java

package com.sample.app.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name = "employees")
public class Employee {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "employee_id")
    private Integer id;

    @Column(name = "first_name")
    private String firstName;

    @Column(name = "last_name")
    private String lastName;

    @Column(name = "age")
    private Integer age;

    @Column(name = "salary")
    private Double salary;

    public Integer getId() {
        return id;
    }

    public void setId(Integer 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;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Double getSalary() {
        return salary;
    }

    public void setSalary(Double salary) {
        this.salary = salary;
    }

    public static EmployeeBuilder builder() {
        return new EmployeeBuilder();
    }

    public static class EmployeeBuilder {
        private Employee emp;

        public EmployeeBuilder() {
            emp = new Employee();
        }

        public EmployeeBuilder firstName(String firstName) {
            emp.setFirstName(firstName);
            return this;
        }

        public EmployeeBuilder lastName(String lastName) {
            emp.setLastName(lastName);
            return this;
        }

        public EmployeeBuilder age(int age) {
            emp.setAge(age);
            return this;
        }

        public EmployeeBuilder salary(double salary) {
            emp.setSalary(salary);
            return this;
        }

        public Employee build() {
            return emp;
        }
    }

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

}


Step 5: Create com.sample.app.repository package and define EmployeeRepository interface.

 

EmployeeRepository.java

package com.sample.app.repository;

import java.util.List;

import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;

import com.sample.app.model.Employee;

public interface EmployeeRepository extends CrudRepository<Employee, Integer> {
    
    public List<Employee> findByIdIn(List<Integer> ids);
    
    public List<Employee> findByIdIsIn(List<Integer> ids);
    
    @Query( "select e from Employee e where id in :ids" )
    public List<Employee> getEmpsByIds(@Param("ids") List<Integer> ids);
    
    @Query(value="select * from employees e where e.employee_id in :ids", nativeQuery=true)
    public List<Employee> getEmpsByIdsUsingNativeQuery(@Param("ids") List<Integer> ids);
}


Step 6: Define App class in com.sample.app package.

 

App.java

package com.sample.app;

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

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

import com.sample.app.model.Employee;
import com.sample.app.repository.EmployeeRepository;

@SpringBootApplication
public class App {

    public static void main(String args[]) {
        SpringApplication.run(App.class, args);
    }

    @Bean
    public CommandLineRunner demo(EmployeeRepository employeeRepository) {
        return (args) -> {
            Employee emp1 = Employee.builder().firstName("Ram").lastName("Gurram").age(32).salary(100000.23).build();
            Employee emp2 = Employee.builder().firstName("Joel").lastName("Chelli").age(43).salary(60000).build();
            Employee emp3 = Employee.builder().firstName("Gopi").lastName("Battu").age(45).salary(1000000).build();
            Employee emp4 = Employee.builder().firstName("Bomma").lastName("Srikanth").age(39).salary(60000).build();
            Employee emp5 = Employee.builder().firstName("Surendra").lastName("Sami").age(32).salary(100000.23).build();
            Employee emp6 = Employee.builder().firstName("Srinu").lastName("Gurram").age(32).salary(100000.23).build();
            Employee emp7 = Employee.builder().firstName("Purnima").lastName("Chelli").age(28).salary(10000.23).build();

            employeeRepository.save(emp1);
            employeeRepository.save(emp2);
            employeeRepository.save(emp3);
            employeeRepository.save(emp4);
            employeeRepository.save(emp5);
            employeeRepository.save(emp6);
            employeeRepository.save(emp7);

            System.out.println("Get all the employees whose id is in 2, 3, 5\n");
            List<Employee> emps = employeeRepository.findByIdIn(Arrays.asList(2, 3, 5));
            emps.stream().forEach(System.out::println);
            
            System.out.println("\n\n");
            emps = employeeRepository.findByIdIsIn(Arrays.asList(2, 3, 5));
            emps.stream().forEach(System.out::println);

            System.out.println("\n\n");
            emps = employeeRepository.getEmpsByIds(Arrays.asList(2, 3, 5));
            emps.stream().forEach(System.out::println);
            
            System.out.println("\n\n");
            emps = employeeRepository.getEmpsByIdsUsingNativeQuery(Arrays.asList(2, 3, 5));
            emps.stream().forEach(System.out::println);
            
            


        };
    }

}


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

Get all the employees whose id is in 2, 3, 5

Employee [id=2, firstName=Joel, lastName=Chelli, age=43, salary=60000.0]
Employee [id=3, firstName=Gopi, lastName=Battu, age=45, salary=1000000.0]
Employee [id=5, firstName=Surendra, lastName=Sami, age=32, salary=100000.23]



Employee [id=2, firstName=Joel, lastName=Chelli, age=43, salary=60000.0]
Employee [id=3, firstName=Gopi, lastName=Battu, age=45, salary=1000000.0]
Employee [id=5, firstName=Surendra, lastName=Sami, age=32, salary=100000.23]



Employee [id=2, firstName=Joel, lastName=Chelli, age=43, salary=60000.0]
Employee [id=3, firstName=Gopi, lastName=Battu, age=45, salary=1000000.0]
Employee [id=5, firstName=Surendra, lastName=Sami, age=32, salary=100000.23]



Employee [id=2, firstName=Joel, lastName=Chelli, age=43, salary=60000.0]
Employee [id=3, firstName=Gopi, lastName=Battu, age=45, salary=1000000.0]
Employee [id=5, firstName=Surendra, lastName=Sami, age=32, salary=100000.23]


You can download the complete working application from below link.

https://github.com/harikrishna553/springboot/tree/master/jpa/in_query_demo









 

 

Previous                                                    Next                                                    Home

No comments:

Post a Comment