MySQL에서 테이블의 특정 열에 주석(Comment)을 추가하려면 ALTER TABLE 명령과 함께 COMMENT 키워드를 사용하면 됩니다. 열의 정의를 수정(MODIFY)하는 과정에서 주석을 함께 지정할 수 있어, 별도의 도구 없이 SQL 쿼리만으로 컬럼 설명을 관리할 수 있습니다.
ALTER TABLE로 열에 주석 추가하기
예를 들어, testing 테이블의 id 열에 '직원 ID'라는 의미의 주석을 추가하고 싶다면 다음과 같은 쿼리를 실행합니다.
mysql> ALTER TABLE testing MODIFY id INT COMMENT 'id of employees'; Query OK, 0 rows affected (0.07 sec) Records: 0 Duplicates: 0 Warnings: 0
여기서 주의할 점은 MODIFY 절을 사용할 때 기존 열의 데이터 타입(INT 등)을 그대로 명시해야 한다는 것입니다. 타입을 생략하면 오류가 발생하며, 기존 정의와 다르게 작성하면 의도치 않게 열 속성이 변경될 수 있습니다.
추가된 주석 확인하기
주석이 제대로 등록되었는지 확인하려면 SHOW FULL COLUMNS 문을 사용합니다. 이 명령은 각 열의 상세 정보와 함께 Comment 필드의 내용도 보여줍니다.
mysql> Show full columns from testing\G
*************************** 1. row ***************************
Field: id
Type: int(11)
Collation: NULL
Null: NO
Key: PRI
Default: 0
Extra:
Privileges: select,insert,update,references
Comment: id of employees
*************************** 2. row ***************************
Field: Name
Type: varchar(20)
Collation: latin1_swedish_ci
Null: YES
Key:
Default: NULL
Extra:
Privileges: select,insert,update,references
Comment:
2 rows in set (0.05 sec)위 출력 결과에서 첫 번째 행의 Comment: id of employees 항목을 통해 id 열에 주석이 성공적으로 추가된 것을 확인할 수 있습니다. 반면 두 번째 행의 Name 열처럼 주석이 지정되지 않은 열은 Comment 필드가 비어 있게 됩니다.
정리
- 주석 추가:
ALTER TABLE 테이블명 MODIFY 열명 데이터타입 COMMENT '주석내용'; - 주석 확인:
SHOW FULL COLUMNS FROM 테이블명; - MODIFY 사용 시 기존 데이터 타입과 속성을 정확히 유지해야 합니다.
- 주석은 데이터베이스 문서화에 유용하며, 협업 시 컬럼의 용도를 명확히 전달하는 데 도움이 됩니다.