TABLE과 COLUMN에 COMMENT 설정

👉 COMMENT의 역할

• 메타데이터의 한 형태로 사용
• 데이터베이스 스키마의 이해를 돕기 위해 설계자나 개발자가 추가한 설명 또는 주석
• 실제 데이터베이스의 기능성에는 영향을 주지 않음
• 데이터베이스의 사용자에게 해당 테이블이나 컬럼이 어떤 목적으로 사용되는지, 어떤 종류의 데이터를 저장하는지 등의 정보를 제공
  
  
  
  

👉 COMMENT 설정 예시

• 테이블 생성 시에 설정

  CREATE TABLE employee (
      id INT AUTO_INCREMENT PRIMARY KEY,
      name VARCHAR(100) NOT NULL COMMENT '직원의 이름',
      role VARCHAR(100) COMMENT '직원의 역할',
      regDate DATE COMMENT '직원이 입사한 날짜'
  ) COMMENT='직원 정보를 저장하는 테이블';

• 생성된 테이블에 설정

  ALTER TABLE employee COMMENT = '직원 정보를 저장하는 테이블';

• 생성된 컬럼에 설정

  ALTER TABLE employee MODIFY `name` VARCHAR(100) NOT NULL COMMENT '직원의 이름';

  • 컬럼 전체 정의를 다시 명시해야 하기 때문에 데이터 형과 제약 조건 등을 적어줘야 함
    
    
    
    

👉 COMMENT 조회

• COLUMN의 COMMENT 조회

  SELECT COLUMN_NAME, COLUMN_COMMENT
  FROM INFORMATION_SCHEMA.COLUMNS
  WHERE TABLE_SCHEMA = '데이터베이스 이름' AND TABLE_NAME = '테이블 이름';

• TABLE의 COMMENT 조회

  SELECT TABLE_NAME, TABLE_COMMENT
  FROM INFORMATION_SCHEMA.TABLES
  WHERE TABLE_SCHEMA = '데이터베이스 이름' AND TABLE_NAME = '테이블 이름';

• SHOW CREATE TABLE을 통한 조회

  SHOW CREATE TABLE 테이블 이름;

  • 테이블을 생성하기 위한 SQL문을 보여줌