BAEL-8326 - Guide to @DynamicInsert in Spring Data JPA (#17436)

Author: Alexandru-Borza

persistence-modules/spring-hibernate-6/src/main/java/com/baeldung/hibernate/dynamicinsert/AccountRepository.java

@@ -0,0 +1,11 @@
+package com.baeldung.hibernate.dynamicinsert;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+import com.baeldung.hibernate.dynamicinsert.model.Account;
+
+@Repository
+public interface AccountRepository extends JpaRepository<Account, Integer> {
+
+}

persistence-modules/spring-hibernate-6/src/main/java/com/baeldung/hibernate/dynamicinsert/DynamicInsertConfig.java

@@ -0,0 +1,81 @@
+package com.baeldung.hibernate.dynamicinsert;
+
+import java.util.Properties;
+
+import jakarta.persistence.EntityManagerFactory;
+
+import javax.sql.DataSource;
+
+import org.apache.tomcat.dbcp.dbcp2.BasicDataSource;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.PropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+import org.springframework.orm.jpa.JpaTransactionManager;
+import org.springframework.orm.jpa.JpaVendorAdapter;
+import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
+import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.transaction.annotation.EnableTransactionManagement;
+
+import com.google.common.base.Preconditions;
+
+@EnableTransactionManagement
+@Configuration
+@PropertySource({ "classpath:persistence-h2.properties" })
+@EnableJpaRepositories(basePackages = { "com.baeldung.hibernate.dynamicinsert" })
+@ComponentScan({ "com.baeldung.hibernate.dynamicinsert" })
+public class DynamicInsertConfig {
+
+    @Autowired
+    private Environment env;
+
+    @Bean
+    public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
+        LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
+        em.setDataSource(dataSource());
+        em.setPackagesToScan(new String[] { "com.baeldung.hibernate.dynamicinsert.model" });
+
+        JpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
+        em.setJpaVendorAdapter(vendorAdapter);
+        em.setJpaProperties(additionalProperties());
+
+        return em;
+    }
+
+    @Bean
+    public DataSource dataSource() {
+        final BasicDataSource dataSource = new BasicDataSource();
+        dataSource.setDriverClassName(Preconditions.checkNotNull(env.getProperty("jdbc.driverClassName")));
+        dataSource.setUrl(Preconditions.checkNotNull(env.getProperty("jdbc.url")));
+        dataSource.setUsername(env.getProperty("jdbc.user"));
+        dataSource.setPassword(env.getProperty("jdbc.pass"));
+
+        return dataSource;
+    }
+
+    @Bean
+    public PlatformTransactionManager transactionManager(EntityManagerFactory emf) {
+        JpaTransactionManager transactionManager = new JpaTransactionManager();
+        transactionManager.setEntityManagerFactory(emf);
+
+        return transactionManager;
+    }
+
+    @Bean
+    public PersistenceExceptionTranslationPostProcessor exceptionTranslation() {
+        return new PersistenceExceptionTranslationPostProcessor();
+    }
+
+    Properties additionalProperties() {
+        Properties properties = new Properties();
+        properties.setProperty("hibernate.hbm2ddl.auto", Preconditions.checkNotNull(env.getProperty("hibernate.hbm2ddl.auto")));
+        properties.setProperty("hibernate.dialect", Preconditions.checkNotNull(env.getProperty("hibernate.dialect")));
+        properties.setProperty("hibernate.show_sql", "false");
+        return properties;
+    }
+}

persistence-modules/spring-hibernate-6/src/main/java/com/baeldung/hibernate/dynamicinsert/model/Account.java

@@ -0,0 +1,71 @@
+package com.baeldung.hibernate.dynamicinsert.model;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+
+import org.hibernate.annotations.DynamicInsert;
+
+@Entity
+@DynamicInsert
+public class Account {
+
+    @Id
+    private int id;
+
+    @Column
+    private String name;
+
+    @Column
+    private String type;
+
+    @Column
+    private boolean active;
+
+    @Column
+    private String description;
+
+    public Account() {
+    }
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    public boolean isActive() {
+        return active;
+    }
+
+    public void setActive(boolean active) {
+        this.active = active;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+}

persistence-modules/spring-hibernate-6/src/test/java/com/baeldung/hibernate/dynamicinsert/DynamicInsertIntegrationTest.java

@@ -0,0 +1,39 @@
+package com.baeldung.hibernate.dynamicinsert;
+
+import jakarta.transaction.Transactional;
+
+import org.junit.jupiter.api.MethodOrderer;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.annotation.Commit;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+import com.baeldung.hibernate.dynamicinsert.model.Account;
+
+@ExtendWith(SpringExtension.class)
+@ContextConfiguration(classes = { DynamicInsertConfig.class }, loader = AnnotationConfigContextLoader.class)
+@Transactional
+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
+class DynamicInsertIntegrationTest {
+
+    private static final Integer ACCOUNT_ID = 1;
+
+    @Autowired
+    private AccountRepository accountRepository;
+
+    @Test
+    @Commit
+        // Enable Hibernate's debug logging in logback.xml to see the generated SQL statement.
+    void givenEntityWithDynamicInsert_whenSavingEntity_thenOnlyNotNullFieldsAreInserted() {
+        Account account = new Account();
+        account.setId(ACCOUNT_ID);
+        account.setName("account1");
+        account.setActive(true);
+        accountRepository.save(account);
+    }
+
+}