MariaDBでPython開発するなら知っておきたい！mysql.connectorの落とし穴と代替ライブラリの選び方

2024-04-02

PythonでMariaDBを使うための選択肢：mysql.connectorの代替品

そこで、MariaDBと完全な互換性を持つ、Pythonのみで動作する mysql.connector の代替品がいくつか登場しています。

mariadb-connector-python

公式のMariaDB Pythonコネクタ
MariaDBとの完全な互換性とすべての機能へのアクセス
多くのサンプルコードとドキュメント
インストール：pip install mariadb-connector-python

mysqlclient

Python標準ライブラリの MySQLdb モジュールの後継
MySQLとMariaDB両方に対応
mysql.connector と似たAPI
インストール：pip install mysqlclient

pymysql

非公式なMySQL/MariaDBコネクタ
軽量で高速
シンプルなAPI

sqlalchemy

汎用的なデータベース接続ライブラリ
MySQL、MariaDB、PostgreSQLなど、さまざまなデータベースに対応
オブジェクト指向のAPI

選択のポイント

MariaDBとの完全な互換性が必須：mariadb-connector-python
既存の mysql.connector コードとの互換性：mysqlclient
軽量で高速な接続：pymysql

各ライブラリの詳細情報は、それぞれの公式ドキュメントを参照してください。
接続文字列やその他の設定は、使用するライブラリによって異なる場合があります。

MariaDBとPythonで開発する場合は、上記の選択肢を参考に、要件に合ったライブラリを選択してください。

補足

上記の情報は2024年3月19日時点のものとなります。
最新の情報は、各ライブラリの公式ドキュメント等でご確認ください。

mariadb-connector-python

import mariadb

# 接続情報
host = "localhost"
port = 3306
user = "root"
password = "password"
database = "test"

# 接続
connection = mariadb.connect(
    host=host,
    port=port,
    user=user,
    password=password,
    database=database,
)

# カーソル作成
cursor = connection.cursor()

# クエリ実行
cursor.execute("SELECT * FROM users")

# 結果取得
results = cursor.fetchall()

# 接続クローズ
cursor.close()
connection.close()

# 結果処理
for row in results:
    print(row)

mysqlclient

import mysqlclient

# 接続情報
host = "localhost"
port = 3306
user = "root"
password = "password"
database = "test"

# 接続
connection = mysqlclient.connect(
    host=host,
    port=port,
    user=user,
    password=password,
    database=database,
)

# カーソル作成
cursor = connection.cursor()

# クエリ実行
cursor.execute("SELECT * FROM users")

# 結果取得
results = cursor.fetchall()

# 接続クローズ
cursor.close()
connection.close()

# 結果処理
for row in results:
    print(row)

pymysql

import pymysql

# 接続情報
host = "localhost"
port = 3306
user = "root"
password = "password"
database = "test"

# 接続
connection = pymysql.connect(
    host=host,
    port=port,
    user=user,
    password=password,
    database=database,
)

# カーソル作成
cursor = connection.cursor()

# クエリ実行
cursor.execute("SELECT * FROM users")

# 結果取得
results = cursor.fetchall()

# 接続クローズ
cursor.close()
connection.close()

# 結果処理
for row in results:
    print(row)

sqlalchemy

from sqlalchemy import create_engine

# 接続情報
host = "localhost"
port = 3306
user = "root"
password = "password"
database = "test"

# エンジン作成
engine = create_engine(
    "mysql+pymysql://{}:{}@{}:{}/{}".format(
        user, password, host, port, database
    )
)

# セッション作成
session = engine.connect()

# クエリ実行
results = session.execute("SELECT * FROM users")

# 結果処理
for row in results:
    print(row)

# セッションクローズ
session.close()