Hibernate / JPA Overview

© luv2code LLC
Topics

• What is Hibernate?

• Benefits of Hibernate

• What is JPA?

• Benefits of JPA

• Code Snippets

www.luv2code.com © luv2code LLC

What is Hibernate?

• A framework for persisting / saving Java objects in a database

• www.hibernate.org/orm

Your Hibernate
Java
App

www.luv2code.com © luv2code LLC

Benefits of Hibernate

• Hibernate handles all of the low-level SQL

• Minimizes the amount of JDBC code you have to develop

• Hibernate provides the Object-to-Relational Mapping (ORM)

www.luv2code.com © luv2code LLC

Object-To-Relational Mapping (ORM)
• The developer defines mapping between Java class and database table

Java Class Database Table

Hibernate

www.luv2code.com © luv2code LLC

What is JPA?
• Jakarta Persistence API (JPA) … previously known as Java Persistence API

• Standard API for Object-to-Relational-Mapping (ORM)

• Only a specification www.luv2code.com/jpa-spec

• Defines a set of interfaces

• Requires an implementation to be usable

www.luv2code.com © luv2code LLC

JPA - Vendor Implementations

JPA Spec

Hibernate EclipseLink

www.luv2code.com/jpa-vendors

www.luv2code.com © luv2code LLC

What are Benefits of JPA
• By having a standard API, you are not locked to vendor's implementation

• Maintain portable, flexible code by coding to JPA spec (interfaces)

• Can theoretically switch vendor implementations

• For example, if Vendor ABC stops supporting their product

• You could switch to Vendor XYZ without vendor lock in

www.luv2code.com © luv2code LLC

JPA - Vendor Implementations

My Biz
App

JPA Spec

EclipseLink
Hibernate

www.luv2code.com © luv2code LLC

Saving a Java Object with JPA

// create Java object

Student theStudent = new Student("Paul", "Doe", "[email protected]");

// save it to database
entityManager.persist(theStudent);

Special JPA helper object The data will be stored in the database

SQL insert

www.luv2code.com © luv2code LLC

Retrieving a Java Object with JPA

// create Java object

Student theStudent = new Student("Paul", "Doe", "[email protected]");

// save it to database
entityManager.persist(theStudent);
// now retrieve from database using the primary key
int theId = 1;
Student myStudent = entityManager.find(Student.class, theId);

Query the database for given id

www.luv2code.com © luv2code LLC

Querying for Java Objects

TypedQuery<Student> theQuery = entityManager.createQuery("from Student", Student.class);

List<Student> students= theQuery.getResultList();

Returns a list of Student objects

from the database

www.luv2code.com © luv2code LLC

JPA/Hibernate CRUD Apps

• Create objects
• Read objects Your JPA
Java Hibernate
App
• Update objects
• Delete objects

www.luv2code.com © luv2code LLC

Hibernate / JPA and JDBC

© luv2code LLC
How does Hibernate / JPA
relate to JDBC?

www.luv2code.com © luv2code LLC

Hibernate / JPA and JDBC

• Hibernate / JPA uses JDBC for all database communications

JPA
Your JDBC
Hibernate
Java
App

www.luv2code.com © luv2code LLC

MySQL Database

© luv2code LLC
MySQL Database
• In this course, we will use the MySQL Database

• MySQL includes two components

• MySQL Database Server

• MySQL Workbench

www.luv2code.com © luv2code LLC

MySQL Database Server
• The MySQL Database Server is the main engine of the database

• Stores data for the database

• Supports CRUD features on the data

www.luv2code.com © luv2code LLC

MySQL Workbench
• MySQL Workbench is a client GUI for interacting with the database

• Create database schemas and tables

• Execute SQL queries to retrieve data

• Perform insert, updates and deletes on data

• Handle administrative functions such as creating users

• Others …

www.luv2code.com © luv2code LLC

Install the MySQL software
• Step 1: Install MySQL Database Server
• https://dev.mysql.com/downloads/mysql/
Please install the
MySQL software now
• Step 2: Install MySQL Workbench
• https://dev.mysql.com/downloads/workbench/

www.luv2code.com © luv2code LLC

Setup Database Table

© luv2code LLC
Two Database Scripts
1. Folder: 00-starter-sql-scripts

01-create-user.sql

02-student-tracker.sql

www.luv2code.com © luv2code LLC

About: 01-create-user.sql
1. Create a new MySQL user for our application

user id: springstudent

password: springstudent

www.luv2code.com © luv2code LLC

About: 02-student-tracker.sql
1. Create a new database table: student

www.luv2code.com © luv2code LLC

Setting Up Spring Boot Project

© luv2code LLC
Automatic Data Source Configuration
• In Spring Boot, Hibernate is the default implementation of JPA

• EntityManager is main component for creating queries etc …

• EntityManager is from Jakarta Persistence API (JPA)

www.luv2code.com © luv2code LLC

Automatic Data Source Configuration
• Based on configs, Spring Boot will automatically create the beans:
• DataSource, EntityManager, …

• You can then inject these into your app, for example your DAO

www.luv2code.com © luv2code LLC

Setting up Project with Spring Initialzr
• At Spring Initializr website, start.spring.io

• Add dependencies

• MySQL Driver: mysql-connector-j

• Spring Data JPA: spring-boot-starter-data-jpa

www.luv2code.com © luv2code LLC

Spring Boot - Auto configuration
• Spring Boot will automatically configure your data source for you

• Based on entries from Maven pom file

• JDBC Driver: mysql-connector-j

• Spring Data (ORM): spring-boot-starter-data-jpa

• DB connection info from application.properties

www.luv2code.com © luv2code LLC

 application.properties

spring.datasource.url=jdbc:mysql://localhost:3306/student_tracker
spring.datasource.username=springstudent
spring.datasource.password=springstudent

No need to give JDBC driver class name

Spring Boot will automatically detect it based on URL

www.luv2code.com © luv2code LLC

Creating Spring Boot - Command Line App
• We will create a Spring Boot - Command Line App

• This will allow us to focus on Hibernate / JPA

• Later in the course, we will apply this to a CRUD REST API

www.luv2code.com © luv2code LLC

Creating Spring Boot - Command Line App
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication Executed after the

public class CruddemoApplication { Spring Beans have been loaded
public static void main(String[] args) {
SpringApplication.run(CruddemoApplication.class, args);
}

@Bean
public CommandLineRunner commandLineRunner(String[] args) {
Lambda return runner -> {
expression System.out.println("Hello world"); Add our
}; custom code
}
}

www.luv2code.com © luv2code LLC

JPA Development Process

© luv2code LLC
JPA Dev Process - To Do List
1. Annotate Java Class

2. Develop Java Code to perform database operations

www.luv2code.com © luv2code LLC

Let’s just say “JPA”
• As mentioned, Hibernate is the default JPA implementation in Spring
Boot

• Going forward in this course, I will simply use the term: JPA

• Instead of saying “JPA Hibernate”

• We know that by default, Hibernate is used behind the scenes

www.luv2code.com © luv2code LLC

Terminology

Entity Class

Java class that is mapped to a database table

www.luv2code.com © luv2code LLC

Object-to-Relational Mapping (ORM)

Java Class Database Table

JPA

www.luv2code.com © luv2code LLC

Entity Class
• At a minimum, the Entity class

• Must be annotated with @Entity

• Must have a public or protected no-argument constructor

• The class can have other constructors

www.luv2code.com © luv2code LLC

Constructors in Java - Refresher
• Remember about constructors in Java

• If you don’t declare any constructors

• Java will provide a no-argument constructor for free

• If you declare constructors with arguments

• then you do NOT get a no-argument constructor for free

• In this case, you have to explicitly declare a no-argument constructor

www.luv2code.com © luv2code LLC

Java Annotations
• Step 1: Map class to database table
• Step 2: Map fields to database columns

www.luv2code.com © luv2code LLC

Step 1: Map class to database table

@Entity
@Table(name="student")
public class Student {

...
Java Class Database Table
}

www.luv2code.com © luv2code LLC

Step 2: Map fields to database columns
@Entity
@Table(name="student")
public class Student {

@Id
@Column(name="id")
private int id; Java Class Database Table
@Column(name="first_name")
private String firstName;
…
}

www.luv2code.com © luv2code LLC

@Column - Optional
• Actually, the use of @Column is optional

• If not specified, the column name is the same name as Java field

• In general, I don’t recommend this approach

• If you refactor the Java code, then it will not match existing database columns

• This is a breaking change and you will need to update database column

• Same applies to @Table, database table name is same as the class

www.luv2code.com © luv2code LLC

Terminology

Primary Key

Uniquely identifies each row in a table

Must be a unique value

Cannot contain NULL values

www.luv2code.com © luv2code LLC

MySQL - Auto Increment

CREATE TABLE student (

id int NOT NULL AUTO_INCREMENT,

first_name varchar(45) DEFAULT NULL,
last_name varchar(45) DEFAULT NULL,
email varchar(45) DEFAULT NULL,
PRIMARY KEY (id)

www.luv2code.com © luv2code LLC

JPA Identity - Primary Key
@Entity
@Table(name="student")
public class Student {

@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="id")
private int id;

…
}

www.luv2code.com © luv2code LLC

ID Generation Strategies

Name Description

Pick an appropriate strategy for the particular

GenerationType.AUTO
database

Assign primary keys using database identity

GenerationType.IDENTITY
column

GenerationType.SEQUENCE Assign primary keys using a database sequence

Assign primary keys using an underlying

GenerationType.TABLE
database table to ensure uniqueness

www.luv2code.com © luv2code LLC

Bonus Bonus

• You can define your own CUSTOM generation strategy :-)

• Create implementation of
org.hibernate.id.IdentifierGenerator


• Override the method: public Serializable generate(…)

www.luv2code.com © luv2code LLC

Save a Java Object

© luv2code LLC
Sample App Features
• Create a new Student

• Read a Student

• Update a Student CRUD

• Delete a Student

www.luv2code.com © luv2code LLC

Student Data Access Object
• Responsible for interfacing with the database

• This is a common design pattern: Data Access Object (DAO)

Data Access Object

Cruddemo Student
App DAO

www.luv2code.com © luv2code LLC

Student Data Access Object

Methods
save(…)
findById(…)
findAll()
findByLastName(…)
update(…)
delete(…)
deleteAll()

www.luv2code.com © luv2code LLC

Student Data Access Object
✤ Our DAO needs a JPA Entity Manager
✤ JPA Entity Manager is the main component for saving/retrieving entities

Data Access Object

Student Entity
…
DAO Manager

www.luv2code.com © luv2code LLC

JPA Entity Manager
• Our JPA Entity Manager needs a Data Source

• The Data Source defines database connection info

• JPA Entity Manager and Data Source are automatically created by Spring Boot

• Based on the file: application.properties (JDBC URL, user id, password, etc …)

• We can autowire/inject the JPA Entity Manager into our Student DAO

Data Access Object

Student Entity
Data Source
DAO Manager

www.luv2code.com © luv2code LLC

Student DAO
Step-
• Step 1: Define DAO interface By-S
tep

• Step 2: Define DAO implementation

• Inject the entity manager

• Step 3: Update main app

Data Access Object

Student Entity
Data Source
DAO Manager

www.luv2code.com © luv2code LLC

Step 1: Define DAO interface

import com.luv2code.cruddemo.entity.Student;

public interface StudentDAO {

void save(Student theStudent);

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;

public class StudentDAOImpl implements StudentDAO {

private EntityManager entityManager; Inject the Entity Manager

@Autowired
public StudentDAOImpl(EntityManager theEntityManager) {
entityManager = theEntityManager;
}

@Override
public void save(Student theStudent) {
entityManager.persist(theStudent); Save the
} Java object
}

www.luv2code.com © luv2code LLC

Spring @Transactional
• Spring provides an @Transactional annotation

• Automagically begin and end a transaction for your JPA code

• No need for you to explicitly do this in your code

• This Spring magic happens behind the scenes

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.transaction.annotation.Transactional;

public class StudentDAOImpl implements StudentDAO {

private EntityManager entityManager;

@Autowired
public StudentDAOImpl(EntityManager theEntityManager) {
entityManager = theEntityManager;
}

@Override Handles transaction

@Transactional
public void save(Student theStudent) { management
entityManager.persist(theStudent);
}

www.luv2code.com © luv2code LLC

Specialized Annotation for DAOs
• Spring provides the @Repository annotation

@Component

@RestController @Repository …

www.luv2code.com © luv2code LLC

Specialized Annotation for DAOs
• Applied to DAO implementations

• Spring will automatically register the DAO implementation

• thanks to component-scanning

• Spring also provides translation of any JDBC related exceptions

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
Specialized annotation import org.springframework.beans.factory.annotation.Autowired;
for repositories import org.springframework.stereotype.Repository;
import org.springframework.transaction.annotation.Transactional;

Supports component @Repository

scanning public class StudentDAOImpl implements StudentDAO {

private EntityManager entityManager;

Translates JDBC
exceptions @Autowired
public StudentDAOImpl(EntityManager theEntityManager) {
entityManager = theEntityManager;
}

@Override
@Transactional
public void save(Student theStudent) {
entityManager.persist(theStudent);
}

www.luv2code.com © luv2code LLC

Step 3: Update main app
@SpringBootApplication
public class CruddemoApplication {

public static void main(String[] args) {

SpringApplication.run(CruddemoApplication.class, args);
Inject the StudentDAO
}

@Bean
public CommandLineRunner commandLineRunner(StudentDAO studentDAO) {
return runner -> {

createStudent(studentDAO);
}

private void createStudent(StudentDAO studentDAO) {

// create the student object

System.out.println("Creating new student object...");
Student tempStudent = new Student("Paul", "Doe", "[email protected]");

// save the student object

System.out.println("Saving the student...");
studentDAO.save(tempStudent);

// display id of the saved student

System.out.println("Saved student. Generated id: " + tempStudent.getId());
}

www.luv2code.com © luv2code LLC

Retrieving an Object

© luv2code LLC
JPA CRUD Apps
• Create objects
• Read objects
• Update objects
• Delete objects

www.luv2code.com © luv2code LLC

Retrieving a Java Object with JPA

// retrieve/read from database using the primary key

// in this example, retrieve Student with primary key: 1 


Student myStudent = entityManager.find(Student.class, 1);

Entity class Primary key

www.luv2code.com © luv2code LLC

Development Process Step-
By-S
tep
1. Add new method to DAO interface

2. Add new method to DAO implementation

3. Update main app

www.luv2code.com © luv2code LLC

Step 1: Add new method to DAO interface

import com.luv2code.cruddemo.entity.Student;

public interface StudentDAO {

…

Student findById(Integer id);

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
…

public class StudentDAOImpl implements StudentDAO {

No need to add @Transactional
private EntityManager entityManager;
…
since we are doing a query

@Override
public Student findById(Integer id) {
return entityManager.find(Student.class, id); If not found,
} returns null

}
Entity class Primary key

www.luv2code.com © luv2code LLC

Step 3: Update main app
@SpringBootApplication
public class CruddemoApplication {
…

@Bean
public CommandLineRunner commandLineRunner(StudentDAO studentDAO) {
return runner -> {

readStudent(studentDAO);
};
} private void readStudent(StudentDAO studentDAO) {
// create a student object
… System.out.println("Creating new student object...");
Student tempStudent = new Student("Daffy", "Duck", "[email protected]");

// save the student object

System.out.println("Saving the student...");
studentDAO.save(tempStudent);

// display id of the saved student

System.out.println("Saved student. Generated id: " + tempStudent.getId());

// retrieve student based on the id: primary key

System.out.println("\nRetrieving student with id: " + tempStudent.getId());

Student myStudent = studentDAO.findById(tempStudent.getId());

System.out.println("Found the student: " + myStudent);

}

www.luv2code.com © luv2code LLC

Query Objects

© luv2code LLC
JPA CRUD Apps
• Create objects
• Read objects
• Update objects
• Delete objects

www.luv2code.com © luv2code LLC

JPA Query Language (JPQL)
• Query language for retrieving objects

• Similar in concept to SQL

• where, like, order by, join, in, etc…

• However, JPQL is based on entity name and entity fields

www.luv2code.com © luv2code LLC

 Retrieving all Students
Name of JPA Entity …
the class name

TypedQuery<Student> theQuery = entityManager.createQuery("FROM Student", Student.class);

List<Student> students = theQuery.getResultList();

Note: this is NOT the name of the database table

All JPQL syntax is based on

entity name and entity fields

www.luv2code.com © luv2code LLC

Retrieving Students: lastName = ‘Doe’
Field of JPA Entity

TypedQuery<Student> theQuery = entityManager.createQuery(

"FROM Student WHERE lastName=‘Doe’", Student.class);

List<Student> students = theQuery.getResultList();

www.luv2code.com © luv2code LLC

Retrieving Students using OR predicate:
Field of JPA Entity

TypedQuery<Student> theQuery = entityManager.createQuery(

"FROM Student WHERE lastName=‘Doe’ OR firstName=‘Daffy’", Student.class);

List<Student> students = theQuery.getResultList();

Field of JPA Entity

www.luv2code.com © luv2code LLC

Retrieving Students using LIKE predicate:

TypedQuery<Student> theQuery = entityManager.createQuery(

"FROM Student WHERE email LIKE ‘%luv2code.com’", Student.class);

List<Student> students = theQuery.getResultList();

Match of email addresses

that ends with
luv2code.com

www.luv2code.com © luv2code LLC

 JPQL - Named Parameters
JPQL Named Parameters are
prefixed with a colon :
public List<Student> findByLastName(String theLastName) {

TypedQuery<Student> theQuery = entityManager.createQuery(

"FROM Student WHERE lastName=:theData", Student.class);

theQuery.setParameter("theData", theLastName);

return theQuery.getResultList();
} Think of this as a placeholder
that is filled in later

www.luv2code.com © luv2code LLC

Development Process Step-
By-S
tep
1. Add new method to DAO interface

2. Add new method to DAO implementation

3. Update main app

www.luv2code.com © luv2code LLC

Step 1: Add new method to DAO interface

import com.luv2code.cruddemo.entity.Student;
import java.util.List;

public interface StudentDAO {

…

List<Student> findAll();

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
import jakarta.persistence.TypedQuery;
import java.util.List;
…

public class StudentDAOImpl implements StudentDAO { No need to add @Transactional

private EntityManager entityManager; since we are doing a query
…

@Override
public List<Student> findAll() {
TypedQuery<Student> theQuery = entityManager.createQuery(“FROM Student", Student.class);
return theQuery.getResultList();
}
}
Name of JPA Entity

www.luv2code.com © luv2code LLC

Step 3: Update main app
@SpringBootApplication
public class CruddemoApplication {

public static void main(String[] args) {

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

@Bean
public CommandLineRunner commandLineRunner(StudentDAO studentDAO) {
return runner -> {

queryForStudents(studentDAO);
};
}

private void queryForStudents(StudentDAO studentDAO) {

// get list of students

List<Student> theStudents = studentDAO.findAll();

// display list of students

for (Student tempStudent : theStudents) {
System.out.println(tempStudent);
}
}

www.luv2code.com © luv2code LLC

Updating an Object

© luv2code LLC
JPA CRUD Apps
• Create objects
• Read objects
• Update objects
• Delete objects

www.luv2code.com © luv2code LLC

Update a Student

Student theStudent = entityManager.find(Student.class, 1);

// change first name to "Scooby"

theStudent.setFirstName("Scooby");

entityManager.merge(theStudent); Update the entity

www.luv2code.com © luv2code LLC

Update last name for all students
Field of JPA Entity

int numRowsUpdated = entityManager.createQuery(

"UPDATE Student SET lastName=‘Tester’”)
.executeUpdate();

Name of JPA Entity …

Return the number Execute this the class name
of rows updated statement

www.luv2code.com © luv2code LLC

Development Process Step-
By-S
tep
1. Add new method to DAO interface

2. Add new method to DAO implementation

3. Update main app

www.luv2code.com © luv2code LLC

Step 1: Add new method to DAO interface

import com.luv2code.cruddemo.entity.Student;

public interface StudentDAO {

…

void update(Student theStudent);

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
import org.springframework.transaction.annotation.Transactional;
…

public class StudentDAOImpl implements StudentDAO {

private EntityManager entityManager;

… Add @Transactional since
we are performing an update
@Override
@Transactional
public void update(Student theStudent) {
entityManager.merge(theStudent);
}

www.luv2code.com © luv2code LLC

Step 3: Update main app
@SpringBootApplication
public class CruddemoApplication {
…

@Bean
public CommandLineRunner commandLineRunner(StudentDAO studentDAO) {
return runner -> {

updateStudent(studentDAO);
};
} private void updateStudent(StudentDAO studentDAO) {

… // retrieve student based on the id: primary key

int studentId = 1;
System.out.println("Getting student with id: " + studentId);

Student myStudent = studentDAO.findById(studentId);

System.out.println("Updating student...");

// change first name to "Scooby"

myStudent.setFirstName("Scooby");
studentDAO.update(myStudent);

// display updated student

System.out.println("Updated student: " + myStudent);
}

www.luv2code.com © luv2code LLC

Deleting an Object

© luv2code LLC
JPA CRUD Apps
• Create objects
• Read objects
• Update objects
• Delete objects

www.luv2code.com © luv2code LLC

Delete a Student

// retrieve the student

int id = 1;
Student theStudent = entityManager.find(Student.class, id);

// delete the student

entityManager.remove(theStudent);

www.luv2code.com © luv2code LLC

Delete based on a condition Field of JPA Entity

int numRowsDeleted = entityManager.createQuery(

"DELETE FROM Student WHERE lastName=‘Smith’")
.executeUpdate();
Name of JPA Entity …
Execute this the class name
Return the number of
rows deleted statement

Method name “Update” is a generic term

We are “modifying” the database

www.luv2code.com © luv2code LLC

Delete All Students

int numRowsDeleted = entityManager

.createQuery("DELETE FROM Student")
.executeUpdate();

www.luv2code.com © luv2code LLC

Development Process Step-
By-S
tep
1. Add new method to DAO interface

2. Add new method to DAO implementation

3. Update main app

www.luv2code.com © luv2code LLC

Step 1: Add new method to DAO interface

import com.luv2code.cruddemo.entity.Student;

public interface StudentDAO {

…

void delete(Integer id);

www.luv2code.com © luv2code LLC

Step 2: Define DAO implementation
import com.luv2code.cruddemo.entity.Student;
import jakarta.persistence.EntityManager;
import org.springframework.transaction.annotation.Transactional;
…

public class StudentDAOImpl implements StudentDAO {

private EntityManager entityManager;

… Add @Transactional since
@Override
we are performing a delete
@Transactional
public void delete(Integer id) {
Student theStudent = entityManager.find(Student.class, id);
entityManager.remove(theStudent);
}

www.luv2code.com © luv2code LLC

Step 3: Update main app
@SpringBootApplication
public class CruddemoApplication {
…

@Bean
public CommandLineRunner commandLineRunner(StudentDAO studentDAO) {
return runner -> {

deleteStudent(studentDAO);
};
}
private void deleteStudent(StudentDAO studentDAO) {
… // delete the student
int studentId = 3;

System.out.println("Deleting student id: " + studentId);

studentDAO.delete(studentId);
}

www.luv2code.com © luv2code LLC

Create Database Tables from Java Code

© luv2code LLC
Create database tables: student
• Previously, we created database tables by running a SQL script

www.luv2code.com © luv2code LLC

Create database tables: student
• JPA/Hibernate provides an option to automagically create database
tables

• Creates tables based on Java code with JPA/Hibernate annotations

• Useful for development and testing

Java
Code

JPA/Hibernate SQL Database

www.luv2code.com © luv2code LLC

 Configuration
• In Spring Boot configuration file: application.properties

spring.jpa.hibernate.ddl-auto=create

• When you run your app, JPA/Hibernate will drop tables then create them

• Based on the JPA/Hibernate annotations in your Java code

Definition Language

www.luv2code.com © luv2code LLC

Creating Tables based on Java Code Hibernate will
generate and execute this
@Entity
2
@Table(name="student") 1 create table student (id integer not null auto_increment,
public class Student { email varchar(255), first_name varchar(255),
last_name varchar(255), primary key (id))
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="id")
private int id;

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

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

@Column(name="email")
private String email;

…
// constructors, getters / setters
}

www.luv2code.com © luv2code LLC

Configuration - application.properties
spring.jpa.hibernate.ddl-auto=PROPERTY-VALUE

Property Value Property Description

none No action will be performed

When database tables are dropped,
create-only Database tables are only created
all data is lost
drop Database tables are dropped

create Database tables are dropped followed by database tables creation

create-drop Database tables are dropped followed by database tables creation.

On application shutdown, drop the database tables
validate Validate the database tables schema

update Update the database tables schema

www.luv2code.com © luv2code LLC

Basic Projects
• For basic projects, can use auto configuration

spring.jpa.hibernate.ddl-auto=create

• Database tables are dropped first and then created from scratch

Note:
When database tables are dropped, all data is lost

www.luv2code.com © luv2code LLC

Basic Projects
• If you want to create tables once … and then keep data, use: update






 spring.jpa.hibernate.ddl-auto=update

• However, will ALTER database schema based on latest code updates

• Be VERY careful here … only use for basic projects

www.luv2code.com © luv2code LLC

Warning spring.jpa.hibernate.ddl-auto=create
• Don't do this on Production databases!!!

• You don't want to drop your Production data

• All data is deleted!!!

• Instead for Production, you should have DBAs run SQL scripts

www.luv2code.com © luv2code LLC

Use Case spring.jpa.hibernate.ddl-auto=create
• Automatic table generation is useful for

• Database integration testing with in-memory databases

• Basic, small hobby projects

www.luv2code.com © luv2code LLC

Recommendation
• In general, I don’t recommend auto generation for enterprise, real-time projects

• You can VERY easily drop PRODUCTION data if you are not careful

• I recommend SQL scripts

• Corporate DBAs prefer SQL scripts for governance and code review

• The SQL scripts can be customized and fine-tuned for complex database designs

• The SQL scripts can be version-controlled

• Can also work with schema migration tools such as Liquibase and Flyway

www.luv2code.com © luv2code LLC