DBeaver에서 SQL 실행 결과에 컬럼 주석(Column Comment) 표시하는 방법 (Mac 기준)

데이터베이스(DB)를 처음 접하거나, 다양한 테이블을 탐색하는 경우 컬럼(Comment)에 대한 설명은 개발자나 기획자 모두에게 매우 유용한 정보입니다.
하지만 대부분의 DB 툴에서는 컬럼 주석을 바로 확인하기 어렵고, 별도의 Table Description 창을 열어야 하기 때문에 매번 확인하는 것이 번거롭습니다.

이 글에서는 Mac에서 많이 사용하는 DBeaver 툴을 기준으로, SQL 실행 결과 화면에 컬럼 주석을 함께 표시하는 방법을 소개합니다.
작업 생산성을 높이고자 하는 사용자라면 꼭 참고해보세요.

---

✅ DBeaver에서 컬럼 주석(Column Comment) 표시 기능

DBeaver는 대표적인 무료 오픈소스 DB 툴로, 다양한 DB(MySQL, Oracle, PostgreSQL 등)를 지원하며 맥OS 사용자에게도 최적화된 인터페이스를 제공합니다.

그중에서도 유용한 기능 중 하나가, 쿼리(Query) 실행 결과 테이블의 헤더 영역에 컬럼 주석을 함께 보여주는 기능입니다.
이 기능을 활성화하면 컬럼명이 무엇을 의미하는지 바로 알 수 있어, 테이블 구조를 모르는 경우에도 빠르게 이해할 수 있습니다.

---

🔧 설정 방법: SQL 결과에 컬럼 Comment 보이게 하기

다음 단계에 따라 설정을 변경해보세요.

1. DBeaver 설정 메뉴 진입

• 메뉴 위치:
  • 윈도우(Window) → 설정(Preferences)
  • 또는 상단 메뉴바에서 DBeaver → Preferences 선택

2. 데이터 편집기 표현 방식 설정

• 편집기(Editor) → 데이터 편집기(Data Editor) → 표현방식(Presentation)으로 이동
• 아래 항목을 체크(✔)합니다:
  • ✅ Show column description in header

✅ 설정 후 저장하면, SQL 실행 결과 테이블에서 컬럼명 아래에 주석(Comment)이 함께 표시됩니다.

---

 

⚠️ 적용이 안 될 경우 확인 사항

일부 DBeaver 버전이나 특정 테이블에서는 설정 후에도 주석이 보이지 않을 수 있습니다.
예를 들어, DBeaver Community 21.3.3 (Mac) 버전에서 다음과 같은 문제가 있었습니다:

• 설정을 완료했음에도 컬럼 Comment가 바로 보이지 않음
• 이 경우, 아래 방법으로 해결 가능

📌 해결 방법: 테이블 정보 먼저 조회하기

1. 해당 테이블 선택 후 F4 키를 눌러 Table Description을 먼저 조회합니다.
2. 그 상태에서 다시 쿼리(Query)를 실행하면, 결과 테이블에 주석이 정상적으로 출력됩니다.

단점: 매번 F4를 눌러야 한다는 번거로움이 있습니다. 현재로서는 이 부분에 대한 완벽한 해결책은 없는 상태입니다.

---

✨ 마무리 및 팁

• DBeaver의 컬럼 주석 표시 기능은 DB 구조를 빠르게 이해해야 하는 개발자나 데이터 분석가에게 매우 유용합니다.
• 특히 협업 환경에서 테이블 구조가 자주 변경되는 경우, 주석 정보를 바로 확인할 수 있는 점이 큰 장점입니다.
• 설정만 잘 해두면, 매번 테이블 구조를 따로 열어보는 수고를 줄일 수 있습니다.

 

📌 향후 업데이트 예정

현재는 설정 이후에도 매번 F4 키를 눌러야 주석이 보이는 한계가 있어, 자동으로 적용되는 방법이 있는지 추가로 확인 중입니다.
더 나은 방법이 발견되면 본 포스트에 업데이트하겠습니다.

---