Jooq and JDBCTemplate implementation of scenario ten - call stored procedure or function.

Function itself is implemented in register_employee.sql

Author: bwajtr

dbscenarios.txt

@@ -7,5 +7,5 @@
 7. Fetch entity and it's one-to-many relation (Departments for Company)
 8. Update entities one-to-many relation - add two items, update two items and delete one item
 9. Complex select - construct select where conditions based on some boolean conditions + throw in some joins
-10. Call stored procedure
+10. Call stored procedure/function and process results
 11. Optimistic locking

jooq.gradle

@@ -1,5 +1,5 @@
 // You can invoke JOOQ code generation using this script.
-// Just run it from IDE, or use "gradle --rerun-tasks -b jooq.gradle"
+// Just run it from IDE, or to force code generation use "gradle --rerun-tasks -b jooq.gradle"
 
 buildscript {
     repositories {

sql-updates/SimpleCompanyModel.xml …updates/SimpleCompanyModel (draw.io).xmlsql-updates/SimpleCompanyModel.xml renamed to sql-updates/SimpleCompanyModel (draw.io).xml sql-updates/SimpleCompanyModel.xml renamed to sql-updates/SimpleCompanyModel (draw.io).xml

@@ -1,4 +1,6 @@
 -- Meant for PostgreSQL 9.5  --
+-- DO NOT FORGET TO EXECUTE ALSO sql_functions/register_employee.sql
+
 
 -- (re)create tables first
 
@@ -10,7 +12,7 @@ DROP TABLE Company;
 
 CREATE TABLE Company (
   pid SERIAL PRIMARY KEY,
-  name TEXT NOT NULL,
+  name TEXT NOT NULL UNIQUE,
   address TEXT
 );
 
@@ -21,14 +23,16 @@ CREATE TABLE Department (
 );
 
 CREATE TABLE Employee (
-  pid SERIAL PRIMARY KEY,
+  pid            SERIAL PRIMARY KEY,
   department_pid INTEGER NOT NULL REFERENCES Department (pid) ON DELETE CASCADE,
-  name TEXT NOT NULL,
-  surname TEXT NOT NULL,
-  email TEXT,
-  salary numeric(10,2) CHECK (salary > 0)
+  name           TEXT    NOT NULL,
+  surname        TEXT    NOT NULL,
+  email          TEXT,
+  salary         NUMERIC(10, 2) CHECK (salary > 0),
+  CONSTRAINT emloyee_name_surname_unique UNIQUE (name, surname)
 );
 
+
 CREATE TABLE Project (
   pid SERIAL PRIMARY KEY,
   name TEXT NOT NULL,
@@ -88,3 +92,4 @@ INSERT INTO ProjectEmployee (project_pid, employee_pid) VALUES (1, 9);
 INSERT INTO ProjectEmployee (project_pid, employee_pid) VALUES (2, 10);
 INSERT INTO ProjectEmployee (project_pid, employee_pid) VALUES (2, 5);
 INSERT INTO ProjectEmployee (project_pid, employee_pid) VALUES (1, 4);
+

sql-updates/create-script.sql

@@ -0,0 +1,51 @@
+-- Procedure which allows to register new employee and assign it to department and company.
+-- Reason why it's in stored procedure is, that we want to allow to register the employee even if
+-- the department and/or company does not exist in DB yet - in such case we would create such
+-- company/department records along with the employee record. It would mean to do lot of DB
+-- roundtrips if we want do such thing in java code.
+
+CREATE OR REPLACE FUNCTION register_employee(_name   TEXT, _surname TEXT, _email TEXT,
+                                            _salary NUMERIC(10, 2), _department_name TEXT, _company_name TEXT)
+  returns TABLE  (
+    employee_id integer,
+    department_id integer,
+    company_id integer
+  )
+AS
+$$
+DECLARE
+  _employee_id integer;
+  _department_id integer;
+  _company_id integer;
+BEGIN
+  -- check if company exists; create it if it doesn't
+  select pid into _company_id from company where company.name = _company_name;
+  IF (_company_id is null) THEN
+    INSERT INTO company (name)
+    values (_company_name) RETURNING PID INTO _company_id;
+    raise notice 'Created new company with pid %', _company_id;
+  ELSE
+    raise notice 'Found existing company with pid %', _company_id;
+  END IF;
+
+  -- check if department exists; create it if it doesn't
+  select pid into _department_id from department where department.name = _department_name and department.company_pid = _company_id;
+  IF (_department_id is null) THEN
+    INSERT INTO department (company_pid, name)
+    values (_company_id, _department_name) RETURNING PID INTO _department_id;
+    raise notice 'Created new department with pid %', _department_id;
+  ELSE
+    raise notice 'Found existing department with pid %', _department_id;
+  END IF;
+
+  -- now we have company and department, finally insert the employee record
+  INSERT INTO employee (department_pid, name, surname, email, salary) VALUES
+    (_department_id, _name, _surname, _email, _salary) RETURNING PID into _employee_id;
+  raise notice 'Inserted new employee record with PID %', _employee_id;
+
+  --return out what happened here with relevant data
+  return query
+  select _employee_id, _department_id, _company_id;
+
+END
+$$ LANGUAGE plpgsql;

sql-updates/sql_functions/register_employee.sql

@@ -213,8 +213,19 @@ private List<Department> createNewDepartmentsList(Company company) {
     public void scenarioNine() {
         List<ProjectsWithCostsGreaterThanOutput> projectsWithCostsGreaterThan = repository.getProjectsWithCostsGreaterThan(70000);
 
-        logger.info("scenarioNine output: " + projectsWithCostsGreaterThan);
+        logger.info("scenarioNine output: {}", projectsWithCostsGreaterThan);
     }
+
+    /**
+     * Execute stored procedure/function and process results
+     *
+     */
+    public void scenarioTen() {
+        RegisterEmployeeOutput output = repository.callRegisterEmployee("Bretislav", "Wajtr", "bretislav.wajtr@test.com", new BigDecimal(40000), "MyDepartment", "MyCompany");
+
+        logger.info("scenarioTen output: {}", output);
+    }
+
 }
 
 

src/main/java/com/clevergang/dbtests/Scenarios.java

@@ -2,6 +2,7 @@
 
 import com.clevergang.dbtests.repository.api.data.*;
 
+import java.math.BigDecimal;
 import java.util.List;
 
 /**
@@ -35,11 +36,14 @@ public interface DataRepository {
 
     List<Integer> insertProjects(List<Project> projects);
 
+    List<ProjectsWithCostsGreaterThanOutput> getProjectsWithCostsGreaterThan(int totalCostBoundary);
+
     // employees
 
     List<Employee> employeesWithSalaryGreaterThan(Integer minSalary);
 
     void updateEmployee(Employee employeeToUpdate);
 
-    List<ProjectsWithCostsGreaterThanOutput> getProjectsWithCostsGreaterThan(int totalCostBoundary);
+    RegisterEmployeeOutput callRegisterEmployee(String name, String surname, String email, BigDecimal salary,
+                                                String departmentName, String companyName);
 }

src/main/java/com/clevergang/dbtests/repository/api/DataRepository.java

@@ -0,0 +1,60 @@
+package com.clevergang.dbtests.repository.api.data;
+
+import java.util.Objects;
+
+/**
+ * @author Bretislav Wajtr <bretislav.wajtr@ibacz.eu>
+ */
+public class RegisterEmployeeOutput {
+    private Integer companyPid;
+    private Integer departmentPid;
+    private Integer employeePid;
+
+    public Integer getCompanyPid() {
+        return companyPid;
+    }
+
+    public void setCompanyPid(Integer companyPid) {
+        this.companyPid = companyPid;
+    }
+
+    public Integer getDepartmentPid() {
+        return departmentPid;
+    }
+
+    public void setDepartmentPid(Integer departmentPid) {
+        this.departmentPid = departmentPid;
+    }
+
+    public Integer getEmployeePid() {
+        return employeePid;
+    }
+
+    public void setEmployeePid(Integer employeePid) {
+        this.employeePid = employeePid;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        RegisterEmployeeOutput that = (RegisterEmployeeOutput) o;
+        return Objects.equals(companyPid, that.companyPid) &&
+                Objects.equals(departmentPid, that.departmentPid) &&
+                Objects.equals(employeePid, that.employeePid);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(companyPid, departmentPid, employeePid);
+    }
+
+    @Override
+    public String toString() {
+        return "RegisterEmployeeOutput{" +
+                "companyPid=" + companyPid +
+                ", departmentPid=" + departmentPid +
+                ", employeePid=" + employeePid +
+                '}';
+    }
+}

src/main/java/com/clevergang/dbtests/repository/api/data/RegisterEmployeeOutput.java

@@ -13,6 +13,7 @@
 import org.springframework.jdbc.support.KeyHolder;
 import org.springframework.stereotype.Repository;
 
+import java.math.BigDecimal;
 import java.sql.Date;
 import java.util.HashMap;
 import java.util.List;
@@ -185,6 +186,37 @@ public List<ProjectsWithCostsGreaterThanOutput> getProjectsWithCostsGreaterThan(
         return jdbcTemplate.query(query, params, mapper);
     }
 
+    @Override
+    public RegisterEmployeeOutput callRegisterEmployee(String name, String surname, String email, BigDecimal salary, String departmentName, String companyName) {
+        String query;
+        query = "SELECT employee_id, department_id, company_id FROM register_employee(\n" +
+                "  _name := :name, \n" +
+                "  _surname := :surname, \n" +
+                "  _email := :email, \n" +
+                "  _salary := :salary, \n" +
+                "  _department_name := :departmentName, \n" +
+                "  _company_name := :companyName\n" +
+                ")";
+
+        Map<String, Object> params = new HashMap<>();
+        params.put("name", name);
+        params.put("surname", surname);
+        params.put("email", email);
+        params.put("salary", salary);
+        params.put("departmentName", departmentName);
+        params.put("companyName", companyName);
+
+        RowMapper<RegisterEmployeeOutput> mapper = (rs, rowNum) -> {
+            RegisterEmployeeOutput row = new RegisterEmployeeOutput();
+            row.setEmployeePid(rs.getInt("employee_id"));
+            row.setDepartmentPid(rs.getInt("department_id"));
+            row.setCompanyPid(rs.getInt("company_id"));
+            return row;
+        };
+
+        return jdbcTemplate.queryForObject(query, params, mapper);
+    }
+
     @Override
     public List<Department> findDepartmentsOfCompany(Company company) {
         String query = "SELECT pid, company_pid, name" +

src/main/java/com/clevergang/dbtests/repository/impl/jdbctemplate/JDBCDataRepositoryImpl.java

@@ -2,6 +2,8 @@
 
 import com.clevergang.dbtests.repository.api.DataRepository;
 import com.clevergang.dbtests.repository.api.data.*;
+import com.clevergang.dbtests.repository.impl.jooq.generated.Routines;
+import com.clevergang.dbtests.repository.impl.jooq.generated.routines.RegisterEmployee;
 import com.clevergang.dbtests.repository.impl.jooq.generated.tables.records.DepartmentRecord;
 import com.clevergang.dbtests.repository.impl.jooq.generated.tables.records.EmployeeRecord;
 import org.jooq.*;
@@ -147,6 +149,20 @@ public List<ProjectsWithCostsGreaterThanOutput> getProjectsWithCostsGreaterThan(
         return getProjectsWithCostsUsingNativeQuery(totalCostBoundary);
     }
 
+    @Override
+    public RegisterEmployeeOutput callRegisterEmployee(String name, String surname, String email, BigDecimal salary, String departmentName, String companyName) {
+        // very easy way how to call a stored procedure. Notice that RegisterEmployee class is generated by jooq...
+        RegisterEmployeeOutput result = new RegisterEmployeeOutput();
+
+        RegisterEmployee output = Routines.registerEmployee(create.configuration(), name, surname, email, salary, departmentName, companyName);
+
+        result.setCompanyPid(output.getCompanyId());
+        result.setDepartmentPid(output.getDepartmentId());
+        result.setEmployeePid(output.getEmployeeId());
+
+        return result;
+    }
+
     private List<ProjectsWithCostsGreaterThanOutput> getProjectsWithCostsUsingNativeQuery(int totalCostBoundary) {
         // FIXME: We should cache loaded scripts in real production code!
         String query = loadSQLScript("queries/getProjectsWithCostsUsingNativeQuery.sql");