Computer >> 컴퓨터 >  >> 프로그래밍 >> Python

Python으로 MySQL 테이블 열(Column)에 주석(Comment) 추가하는 방법

주석(Comment)은 코드나 데이터에 대해 사람이 읽기 쉬운 형태로 설명을 덧붙인 것입니다. 코드 속 주석은 해당 코드가 어떤 목적으로 작성되었는지 설명해 주며, 다른 사람이 그 코드를 이해하고 활용하는 데 큰 도움을 줍니다.

주석은 컴파일러나 데이터베이스 엔진에 의해 무시되며 실행되지 않습니다. 즉, 주석은 오직 설명을 위한 것일 뿐이지만, 코드의 유지보수성과 가독성 측면에서 매우 중요한 역할을 합니다.

SQL 테이블의 열(Column)에도 주석을 추가할 수 있습니다. 열에 달린 주석은 해당 열의 용도나 특징을 설명해 주므로, 나중에 다른 사람이 이 테이블을 보고 작업할 때 각 열이 무엇을 의미하는지 쉽게 파악할 수 있습니다.

MySQL에서는 ALTER 문과 함께 MODIFY 명령어 및 COMMENT 절을 사용하여 열에 주석을 추가할 수 있습니다.

문법(Syntax)

ALTER TABLE table_name
MODIFY column_name column_definition COMMENT "your_comment";

여기서 table_name은 테이블 이름, column_name과 column_definition은 각각 열의 이름과 데이터 타입 정의를 나타냅니다. your_comment는 해당 열에 추가하고 싶은 주석 내용입니다.

Python에서 MySQL을 사용해 열에 주석을 추가하는 단계

  • MySQL 커넥터(mysql.connector)를 임포트합니다.

  • connect() 메서드를 사용하여 데이터베이스와 연결을 설정합니다.

  • cursor() 메서드로 커서 객체를 생성합니다.

  • 적절한 MySQL 문장으로 쿼리를 작성합니다.

  • execute() 메서드로 SQL 쿼리를 실행합니다.

  • 작업이 끝나면 연결을 닫습니다(close).

예제

예를 들어 "Students"라는 테이블에 VARCHAR(50) 타입의 "Address"라는 열이 있다고 가정해 보겠습니다. 이 열이 주소를 저장하는 열이라는 사실을 알려주는 주석을 추가해 보겠습니다.

import mysql.connector

db = mysql.connector.connect(
    host="your host",
    user="your username",
    password="your password",
    database="database_name"
)

cursor = db.cursor()

query = "ALTER TABLE Students MODIFY Address VARCHAR(50) COMMENT 'This is the column to store address.'"

cursor.execute(query)
db.commit()
print("COMMENT ADDED..")

db.close()

위 코드는 Students 테이블의 "Address" 열에 주석을 추가합니다. 참고로 파이썬 문자열 안에서 주석을 감쌀 때는 큰따옴표 대신 작은따옴표를 사용하면 따옴표 충돌 없이 깔끔하게 작성할 수 있습니다.

추가된 주석은 SHOW FULL COLUMNS FROM table_name 명령으로 확인할 수 있습니다. 이 명령은 각 열의 정의 정보와 함께 설정된 주석이 있다면 그 내용까지 함께 출력해 줍니다.

출력 결과

COMMENT ADDED..