sequence naming strategy (#17272)

Author: wynnteo

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/Book.java

@@ -0,0 +1,31 @@
+package com.baeldung.sequencenaming;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+
+@Entity
+public class Book {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.SEQUENCE)
+    private Long id;
+    private String title;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+}

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/BookRepository.java

@@ -0,0 +1,7 @@
+package com.baeldung.sequencenaming;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface BookRepository extends JpaRepository<Book, Long> {
+
+}

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/CustomSequenceNamingStrategy.java

@@ -0,0 +1,36 @@
+package com.baeldung.sequencenaming;
+
+import static org.hibernate.id.enhanced.TableGenerator.DEF_TABLE;
+
+import java.util.Map;
+
+import org.hibernate.boot.model.naming.Identifier;
+import org.hibernate.boot.model.relational.QualifiedName;
+import org.hibernate.boot.model.relational.QualifiedNameParser;
+import org.hibernate.boot.model.relational.QualifiedSequenceName;
+import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
+import org.hibernate.id.enhanced.ImplicitDatabaseObjectNamingStrategy;
+import org.hibernate.service.ServiceRegistry;
+
+public class CustomSequenceNamingStrategy implements ImplicitDatabaseObjectNamingStrategy {
+
+    @Override
+    public QualifiedName determineSequenceName(Identifier catalogName, Identifier schemaName, Map<?, ?> map, ServiceRegistry serviceRegistry) {
+        final JdbcEnvironment jdbcEnvironment = serviceRegistry.getService(JdbcEnvironment.class);
+        final String seqName = ((String) map.get("jpa_entity_name")).concat("_custom_seq");
+        return new QualifiedSequenceName(
+            catalogName,
+            schemaName,
+            jdbcEnvironment.getIdentifierHelper().toIdentifier(seqName));
+    }
+
+    @Override
+    public QualifiedName determineTableName(Identifier catalogName, Identifier schemaName, Map<?, ?> map, ServiceRegistry serviceRegistry) {
+        final JdbcEnvironment jdbcEnvironment = serviceRegistry.getService(JdbcEnvironment.class);
+
+        return new QualifiedNameParser.NameParts(
+            catalogName,
+            schemaName,
+            jdbcEnvironment.getIdentifierHelper().toIdentifier(DEF_TABLE));
+    }
+}

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/Person.java

@@ -0,0 +1,37 @@
+package com.baeldung.sequencenaming;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.SequenceGenerator;
+import jakarta.persistence.Table;
+
+@Entity
+//@Table(name = "my_person_table")
+public class Person {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.SEQUENCE)
+//    @Id
+//    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "person_custom_seq")
+//    @SequenceGenerator(name = "person_custom_seq", sequenceName = "person_custom_seq", allocationSize = 10)
+    private Long id;
+    private String name;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+}

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/PersonRepository.java

@@ -0,0 +1,6 @@
+package com.baeldung.sequencenaming;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface PersonRepository extends JpaRepository<Person, Long> {
+}

persistence-modules/hibernate6/src/main/java/com/baeldung/sequencenaming/SequenceNamingApp.java

@@ -0,0 +1,13 @@
+package com.baeldung.sequencenaming;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SequenceNamingApp {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SequenceNamingApp.class, args);
+    }
+
+}

persistence-modules/hibernate6/src/main/resources/application-test.properties

@@ -0,0 +1,18 @@
+# Database Configuration
+spring.datasource.url=jdbc:h2:mem:testdb
+spring.datasource.username=sa
+spring.datasource.password=password
+spring.datasource.driver-class-name=org.h2.Driver
+
+# Hibernate Configuration
+spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
+spring.jpa.hibernate.ddl-auto=update
+spring.jpa.show-sql=true
+spring.jpa.properties.hibernate.format_sql=true
+spring.jpa.properties.hibernate.use_sql_comments=true
+
+# Naming Strategy Configuration
+spring.jpa.properties.hibernate.id.db_structure_naming_strategy=standard
+#spring.jpa.properties.hibernate.id.db_structure_naming_strategy=legacy
+#spring.jpa.properties.hibernate.id.db_structure_naming_strategy=single
+#spring.jpa.properties.hibernate.id.db_structure_naming_strategy=com.baeldung.sequencenaming.CustomSequenceNamingStrategy

persistence-modules/hibernate6/src/test/java/com/baeldung/sequencenaming/PersonRepositoryIntegrationTest.java

@@ -0,0 +1,63 @@
+package com.baeldung.sequencenaming;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+
+import java.sql.Connection;
+import java.util.List;
+
+import javax.sql.DataSource;
+
+import org.junit.Ignore;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
+import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest(properties = "spring.config.location=classpath:application-test.properties")
+public class PersonRepositoryIntegrationTest {
+
+    @Autowired
+    private PersonRepository personRepository;
+
+    @Autowired
+    private BookRepository bookRepository;
+
+    @Test
+    @Ignore
+    void givenNamingStrategy_whenSavingPerson_thenSequenceIsCreatedWithSpecifiedNamingStrategy() {
+        // Change the naming strategy in properties file to see the differences.
+
+        Person person = new Person();
+        person.setName("John Doe");
+        personRepository.save(person);
+
+        List<Person> personList = personRepository.findAll();
+
+        assertTrue(personList.size() > 0);
+    }
+
+    @Test
+    @Ignore
+    void givenSingleNamingStrategy_whenSavingPersonAndBook_thenUsesSameSequenceForBoth() {
+        // Change the naming strategy in properties file to see the differences.
+
+        Person person = new Person();
+        person.setName("John Doe");
+        personRepository.save(person);
+
+        Book book = new Book();
+        book.setTitle("Baeldung");
+        bookRepository.save(book);
+
+        List<Person> personList = personRepository.findAll();
+        List<Book> bookList = bookRepository.findAll();
+
+        assertEquals((long)1,(long) personList.get(0).getId());
+        assertEquals((long)2, (long)bookList.get(0).getId());
+    }
+
+}