実務に生かすPythonサンプル

Python3でMySQL Connectorのインストール・接続方法【快適に使う方法を紹介】

こんにちは。現役Webエンジニアの三年坊主です。

 

今回は、Python3のプログラムからMySQLを操作したい人の、このような疑問に答えます。

「Python3でmysql connectorというライブラリをインストールして使いたい。基本的な使い方を教えてください。」

 

結論としては、mysql-connector-python を pipでインストールするのが一番簡単でおすすめです。

 

なお、私は大学の研究と自分の趣味、最近では業務も合わせて、合計5年以上Pythonを使ってきました。

 

この記事では、その経験を生かして、Python3で使えるmysql connectorのインストール方法と基本的な使い方、さらに変なエラーになるべく苦しまず快適に使うための知識を紹介します。よければ参考にしてください。

 

この記事の内容

  • Python3で使えるmysql connector【インストール】
  • mysql connector pythonの基本的な使い方
  • mysql connector pythonを快適に使うための知識【エラー処理】

 

Python3で使えるmysql connector【インストール】

Pythonプログラム単体で、これからライブラリをインストールして使いはじめる場合には、mysql-connetor-python をインストールして使いましょう。

仮想環境内に”pip install mysql-connector-python”でインストールする方法をおすすめします。

 

「pipで一発でインストールできるなら楽でありがたい!」

 

「ですね!」

 

 

mysql connectorは、正式には”MySQL Connector/Python”といいます。Pythonプログラムからデータベースにアクセスするためのライブラリの一つです。

 

Pythonで使えるMySQLライブラリは他にもいくつかありますが、mysql connectorにはこのような特徴があります。

  • MySQLの開発元、Oracle社によってアクティブに開発されている
  • Python Database API Specification v2.0 という共通の仕様に対応
  • 依存がPythonの標準ライブラリだけなのでインストールが楽

 

実は、Python3で使えるmysql connectorを探すと、主に2つ見つかると思いますが、

 

2018年9月現在の開発状況を踏まえて、mysql-connetor-pythonを選びましょう。

 開発状況対応している最新Pythonバージョン最終更新
mysql-connetor-python-rf4 – Beta3.32017年2月
mysql-connetor-python5 – Production/Stable3.62018年7月

 

また、mysql-connector-pythonとPythonのバージョン対応表を見てみると、特にPython3.6を使う場合は mysql-connector-pythonの最新版 (8.0) 一択のようです。

 

ちなみに、細かく見るとさらにたくさんのライブラリがありますが、他のライブラリを使わなくてよさそうと判断した理由も書いておきます。

  • mysql-connector (2.1.6):mysql-connector-pythonをもとに個人が開発している様子
  • bottle-mysql-connector (0.0.4):軽量WebフレームワークBottle 向け
  • mysql-connector-repackaged (0.3.1):最終更新が2012年と古い
  • mysql-connector-async-dd (2.0.2):非同期処理向けに改良したもの(ただし個人ベースで開発しているように見える)
  • mysql-connector-python-dd (2.0.2): Pythonの対応バージョンが3.3まで
  • py_mysql_connector (0.1):mysql-connector-pythonをもとに個人が趣味的に開発している様子

 

インストール方法

mysql-connector-pythonを、仮想環境内にpipでインストールします。

 

この記事で使う表記法

  • コメント
  • ターミナル上で実行するコマンド($マークは入力不要)
  • py3envという名前の仮想環境を有効化した状態で実行するコマンド(”(py3env) $” は入力不要)
  • Pythonを起動した状態で実行するコマンド

 

このように、Pythonプログラム単体で、これからライブラリをインストールして使いはじめる場合には、mysql-connetor-pythonをインストールしましょう。

方法としては、仮想環境内に”pip install mysql-connector-python”でインストールするのがおすすめです。

 

mysql connector pythonの基本的な使い方

mysql-connector-pythonの基本的な使い方について説明します。

 

コピペで動くサンプルコードを紹介するので、mysql-connector-pythonのインストール後、すぐにMySQLに接続して操作をはじめることができます。

 

MacでMySQLサーバをセットアップする方法は、この記事などを参考にしてください。

 

接続(コネクションの作成)

 

標準ライブラリからurlparseを使って、このように値をセットしても大丈夫です。

 

再接続の設定方法と、接続できているか確認する方法を紹介します。

 

テーブル作成 (CREATE)

cursorメソッドを使って、コネクションからカーソルを作成します。

そのカーソルに対して、executeメソッドを使ってSQL文を実行します。

 

データ挿入 (INSERT)

id, name, priceを持つテーブルを作成したので、たとえばあなたが持っている仮想通貨の金額を、日本円換算で挿入してみましょう。

 

データ選択 (SELECT)

 

データ更新 (UPDATE)・データ削除 (DELETE)

 

コネクションを閉じる

データベースの操作が終わったら、カーソルとコネクションを閉じましょう。

 

以上、基本的な操作方法について説明しました。

「コネクション作成→カーソル作成→操作→カーソル閉じる→コネクション閉じる」の流れになります。

 

mysql connector pythonを快適に使うための知識【エラー処理】

少し発展的な内容になりますが、なるべく変なエラーに苦しまず、mysql connectorを快適に使うために、簡単なエラー処理をする習慣を身につけておくと役立ちます。

 

エラー処理をして、実際にどのエラーが発生したのかすぐに確認できるようにしておくと、変な現象が起こった時に「何が原因か分からない!」と苦しむ時間を短くすることができるからです。

 

mysql-connector-python では、起こりうるエラーの一覧が整理されています。これをうまく活用しましょう。

B.3 Server Error Codes and Messages

B.4 Client Error Codes and Messages

 

リンク先を見ると、基本的に番号(error number)とメッセージ(error message)の組み合わせで一つのエラーが表現されているようです。

 

この中から、よく出現する番号とメッセージの一部を下の表にまとめます。

番号対応するシンボル (SQLSTATE)メッセージ考えられる原因(一部)
1045ER_ACCESS_DENIED_ERROR (28000)Access denied for user ‘%s’@’%s’ (using password: %s)ユーザネームかパスワードが間違っている
1049ER_BAD_DB_ERROR (42000)Unknown database ‘%s’指定した名前のデータベースが存在しない
1051ER_BAD_TABLE_ERROR (42S02)Unknown table ‘%s’指定した名前のテーブルが存在しない
2002CR_CONNECTION_ERRORCan’t connect to local MySQL server through socket ‘%s’ (%d)MySQLサーバが実行されていない
2003CR_CONN_HOST_ERRORCan’t connect to MySQL server on ‘%s’ (%d)ネットワーク接続が拒否されている

 

エラー一覧の活用方法ですが、Pythonプログラムで「エラーコードとメッセージを出力して、一覧と照らし合わせられる状態にする」のが基本です。

 

上のプログラムを実行して、もしこのようなエラーが出たら、「指定した名前のデータベースが存在しない」ということが分かります。

 

より実践的には、このようにするといいでしょう。

  • “from mysql.connector import errorcode”を一行追加する
  • mysql-connector-python関係でエラーが起こりそうなところをtryとexceptではさむ
  • 事前に予想できるエラーはなるべくif文で場合分けして、原因が分かりやすいメッセージを出力する
  • それ以外のエラーは、エラー内容をそのまま出力して一覧で確認できるようにする

 

エラー処理をしてエラーの内容を確認しやすい状態にすると、あなた自身で修正の手がかりがつかみやすいですし、人に聞くときにも原因を正しく伝えられるので、時間の節約になります。

 

コピペからはじめて大丈夫なので、簡単なエラー処理を組み込んで、mysql connectorを快適に使いましょう。

 

Pythonのインストール・環境構築の記事もよければご覧ください。

 

▼経験の棚卸しで納得のキャリアを▼
▼相場に消耗しない資産運用▼
マネースクエア
Pythonチュートリアル

Pythonをインストール、サンプルを通して使い方を学んだら、次は実際に何か作ってみませんか?

手元のパソコンで環境構築不要・Webブラウザだけで、パッと見た人の印象に残るコンテンツを作る手順を一から説明しています。

チュートリアルを見てみる

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください