[Spring/JUnit] H2 예약어 user 때문에 발생 : Error executing DDL "drop table if exists user cascade " via JDBC [Syntax error in SQL statement "drop table if exists [*]user cascade "; expected "identifier";]

❗️에러 메시지

---

Error executing DDL "drop table if exists user cascade " via JDBC [Syntax error in SQL statement "drop table if exists [*]user cascade "; expected "identifier";]

 

 

 

 

 

💻 개발 환경

---

• Framework : Spring Boot`3.2.3`
• DB : MySQL(로컬), H2(테스트)
• Library : JPA, QueryDSL`5.0.0`
• Test : JUnit

 

 

 

 

 

🔎 원인

---

Spring에서 JPA Repository 테스트를 진행하는데 에러가 났다.

DB는 로컬에서 개발을 위해 MySQL을 사용하고 있지만, 테스트를 위해서 내장형 인메모리 DB인 H2를 사용하고 있었다.

 

그리고 `@BeforeEach`에서 테스트 실행 전마다 데이터를 셋업하기 위해 기존의 데이터를 삭제해주는 작업을 해주고 있었다.

에러는 User Entity와 연동된 `userRepository`에서 `deleteAll()`을 실행하는 데 발생했다.

 

 

@DataJpaTest
@Import(QueryDSLConfig.class)
class XXXRepositoryTest {

    @Autowired
    UserRepository userRepository;
    
    ...

    @BeforeEach
    public void setUp() {
        /* 기존 데이터 삭제 */
        userRepository.deleteAll(); //여기서 에러 발생

        ...
    }

    ...
}

 

 

 

 

 

Error executing DDL "drop table if exists user cascade " via JDBC [Syntax error in SQL statement "drop table if exists [*]user cascade "; expected "identifier";]

 

 

 

 

user 테이블을 드롭하는 과정에서 SQL 문법 에러가 났다. 식별자가 필요하다고 한다.

식별자는 작은 따옴표(')나 큰 따옴표(")에 묶여서 사용된다.

 

식별자가 필요한 이유는 user가 H2의 예약어이기 때문에 예약어로 인식된다. 따라서 테이블명으로 user를 사용할 수 없다.

MySQL에서는 테이블명으로 user를 사용해도 문제가 없었지만, H2에서는 아니다. 

 

 

H2 공식문서의 Advanced 섹션에 가면 예약어(Keywords) 목록을 확인할 수 있다. 

 

 

 

 

 

 

💡 해결

---

방법1) User Entity 이름 변경

구글링을 하면 가장 많이 나오는 해결책 중 하나로 User Entity의 이름을 다른 이름으로 변경하라고 한다.

Entity 클래스에 @Table 어노테이션을 붙여서 복수형인 `Users`나 비슷한 뜻의 이름인 `Member`로 변경하라고 한다.

@Table(name = "users")
public class User {
	...
}

 

 

이렇게 하면 문제를 해결할 수 있다. 하지만, 테이블 이름이 User로 바뀌어버리기 때문에 기존에 개발하면서 구축했던 DB에서 문제가 발생하게 되었다. User 테이블과 연관 관계를 맺고 있던 테이블에서 FK를 인식하지 못하는 문제가 발생했다. (기존 코드에 매핑이 user로 되어있기 때문에 매핑되는 객체들을 users로 수정해줘야 하는데 안해줘서 그렇다.)

 

기존에 개발하고 있던 DB와 테이블이 있다면 좋은 방법은 아닌 것 같다.

 

 

 

 

문제를 해결하기 위해 다른 방법을 찾아보았다. 테스트의 설정 파일(application.yml)에서 user가 예약어가 아님을 명시해주면 된다고 한다. 그런데 내 환경에서는 안먹힌다. 해결이 안된다.

spring:
  datasource:
    url: jdbc:h2:mem:testdb;NON_KEYWORDS=USER

 

 

 

 

 

방법2) 예약어를 식별자로 사용하기

테이블 이름이 바뀌는 것이 싫어서 User를 Entity의 이름으로 사용하고 싶다면, 예약어를 식별자로 사용해야 한다.

백틱(`)을 사용해서 예약어를 감싸면 식별자로 쓸 수 있다.

 

H2 예약어인 user를 `@Table` 어노테이션을 통해 테이블의 이름을 백틱(`)으로 감싸줘서 정의해주자.

@Table(name = "\"user\"")

 

 

 

 

 

📖 참고

---

• https://mag1c.tistory.com/434#google_vignette
• Spring Data JPA (H2 database) is returning DDL error during table creation  : https://stackoverflow.com/questions/70797504/spring-data-jpa-h2-database-is-returning-ddl-error-during-table-creation