PythonでMySQLのカラムにコメントを追加する方法をわかりやすく解説

コメントとは、コードやデータベースの構造に対して付ける「読み手のための説明文」のことです。プログラム内のコメントは、そのコードが何のために書かれたのかを示す役割を持ち、第三者がコードの意図や用途を理解する助けになります。

コメントはコンパイラや実行エンジンによって無視されるため、処理には一切影響しません。しかし、保守性や可読性を高める上で非常に重要な要素です。

テーブルのカラムにもコメントを付けられる

SQLでは、テーブルの各カラム（列）にもコメントを追加できます。カラムにコメントを付けておくと、「このカラムが何を表しているのか」「どのような用途で使われるのか」がひと目で分かるようになります。特に、他の人が同じテーブルを閲覧・操作する場合、コメントがあることで誤解やミスを防ぐことができます。

既存のカラムにコメントを追加するには、ALTER文を使用します。ALTERステートメントにMODIFY句とCOMMENT句を組み合わせることで、カラム定義を変更しながらコメントを設定できます。

基本構文

ALTER TABLE テーブル名
MODIFY カラム名 データ型 COMMENT "追加したいコメント";

• テーブル名：対象となるテーブルの名前
• カラム名 / データ型：変更するカラムの名前とデータ型（既存の定義も含めて再指定が必要）
• COMMENT：そのカラムに付けたいコメント文字列

PythonからMySQLでカラムにコメントを追加する手順

1. mysql.connectorモジュールをインポートする
2. connect()メソッドでMySQLサーバーへの接続を確立する
3. cursor()メソッドでカーソルオブジェクトを作成する
4. ALTER TABLE文を使ったSQLクエリを作成する
5. execute()メソッドでクエリを実行する
6. commit()で変更を確定し、接続を閉じる

サンプルコード

ここでは、「Students」というテーブルがあり、住所を格納する「Address」カラム（VARCHAR型）に「これは住所を保存するためのカラムです」というコメントを追加する例を紹介します。

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(100) "
         "COMMENT 'This is the column to store address.'")

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

db.close()

このコードを実行すると、StudentsテーブルのAddressカラムにコメントが追加されます。

コメントが正しく追加されたか確認する方法

コメントが反映されたかどうかは、次のコマンドで確認できます。

SHOW FULL COLUMNS FROM Students;

このコマンドを実行すると、各カラムの定義情報とともに、設定されているコメントも表示されます。

実行結果

COMMENT ADDED..

このように、PythonからMySQLのALTER TABLE文を実行するだけで、既存テーブルのカラムに簡単にコメントを追加できます。チーム開発や長期運用を見据えて、重要なカラムには適切なコメントを付けておくことをおすすめします。