MySQL-connector-pythonでOB Cloudクラウドデータベースに接続するサンプルプログラム

本記事では、Pythonドライバーを使用してOB Cloudクラウドデータベースに接続し、操作する方法について説明します。使用するドライバーはMySQL-connector-pythonです。

前提条件

• Python2.7またはPython 3.xとpipがインストール済みであること。
• OB Cloudクラウドデータベースのアカウントに登録済みで、クラスタインスタンスとMySQL互換モードのテナントを作成していること。詳細については、クラスタインスタンスの作成およびテナントの作成をご参照ください。

操作手順

1. OB Cloudクラウドデータベースの接続文字列を取得します。
2. MySQL-connector-pythonドライバーをインストールします。
3. test.py ファイルを作成し、データベース接続情報を入力します。
4. test.py ファイルを実行します。

ステップ１：OB Cloudクラウドデータベースの接続文字列を取得する

1. OB Cloudクラウドコンソールにログインします。インスタンス一覧ページで、対象インスタンスの情報を展開し、対象テナントで、接続 > 接続文字列を取得 を選択します。

   詳細な操作については、接続文字列の取得をご参照ください。

2. 既に作成されたOB Cloudクラウドデータベースに基づいて、以下のURLの該当する情報を入力します。

   obclient -h$host -P$port -u$user_name -p$password -D$database_name
   

   パラメータの説明：

   • $host：OB Cloudクラウドデータベースの接続アドレスを指定します。例：t********.********.oceanbase.cloud。

   • $port：OB Cloudクラウドデータベースの接続ポートを指定します。デフォルトは3306です。

   • $database_name：アクセスするデータベース名を指定します。

     注意

     テナントに接続するユーザーは、データベースに対する CREATE、INSERT、SELECT 権限が付与されていなければなりません。アカウント権限の詳細については、アカウントの作成と管理をご参照ください。

   • $user_name：データベースにアクセスするアカウントを指定します。

   • $password：アカウントのパスワードを指定します。

   例：

   obclient -h t********.********.oceanbase.cloud -P3306 -u mysql001 -p****** -Dtest
   

ステップ2：MySQL-connector-pythonドライバーのインストール

MySQL Connector/Pythonは、MySQLが公式に提供するMySQLデータベース接続用のドライバーです。Pythonで記述されており、PythonからMySQLデータベースへの接続と操作に使用されます。MySQL Connector/Pythonは、Python 2.7およびPython 3.xをサポートしています。

コマンドプロンプトまたはPowerShellターミナルを開き、以下のコマンドを実行してMySQL-connector-pythonドライバーをインストールします。

pip3 install mysql-connector-python

インストール完了後、以下のコマンドでインストールが成功したかどうか確認できます：

pip3 list | grep mysql-connector-python

ステップ3：test.pyファイルを作成し、データベース接続情報を入力する

ステップ1：OB Cloudクラウドデータベース接続文字列を取得する の情報に基づいて、test.py ファイルを作成し、データベース接続情報を入力します。

1. test.py という名前のファイルを作成します。

2. test.py ファイルに以下の内容を入力し、実際の状況に応じてデータベース接続情報を修正します。

   test.py ファイルの内容例は以下のとおりです：

   import mysql.connector
   
   # データベース接続情報
   config = {
       'host': 't********.********.oceanbase.cloud',
       'port': 3306,
       'user': 'mysql001',
       'password': '******',
       'database': 'test'
   }
   
   # データベース接続の作成
   conn = mysql.connector.connect(**config)
   cursor = conn.cursor()
   
   # データベースの作成
   cursor.execute("CREATE DATABASE IF NOT EXISTS test")
   
   # データベースの使用
   cursor.execute("USE test")
   
   # テーブルの作成
   cursor.execute("""
   CREATE TABLE IF NOT EXISTS test_table (
       id INT AUTO_INCREMENT PRIMARY KEY,
       name VARCHAR(255) NOT NULL,
       age INT
   )
   """)
   
   # データの挿入
   cursor.execute("""
   INSERT INTO test_table (name, age) VALUES
   ('John', 20),
   ('Lucy', 25),
   ('Tom', 30)
   """)
   
   # データの更新
   cursor.execute("""
   UPDATE test_table SET age = 26 WHERE name = 'Lucy'
   """)
   
   # データのクエリ
   cursor.execute("SELECT * FROM test_table")
   rows = cursor.fetchall()
   for row in rows:
       print(row)
   
   # 接続を閉じる
   cursor.close()
   conn.close()
   

ステップ4：test.pyファイルを実行する

コマンドプロンプトまたはPowerShellターミナルを開き、test.pyファイルを実行してデータをクエリし、結果を出力します。

1. test.pyファイルがあるディレクトリに移動します。

   例：

   cd D:\demo\demo
   

2. test.pyファイルを実行します。

   例：

   python test.py
   

   結果は次のとおりです：

   (1, 'John', 20)
   (2, 'Lucy', 26)
   (3, 'Tom', 30)
   

エラー処理

MySQL-connector-pythonを使用してOB Cloudデータベースに接続する際、さまざまなエラーが発生する可能性があります。以下は一般的なエラーとその対処方法です：

1. 接続エラー：データベースに接続できない場合は、ホスト名、ポート、ユーザー名、パスワード、データベース名を含む接続パラメータが正しいかどうか確認してください。

2. 権限エラー：権限に関連するエラーが発生した場合は、ユーザーが必要な操作を実行するための十分な権限を持っていることを確認してください。

3. SQL構文エラー：SQLステートメントに構文エラーがある場合は、SQLステートメントの構文が正しいかどうか確認してください。

4. データ型エラー：挿入したデータ型がテーブル定義とマッチしない場合は、挿入したデータ型が正しいことを確認してください。

コード内で try-except ステートメントを使用してこれらのエラーをキャッチし、処理することで、エラー発生時にプログラムがクラッシュせずに適切に対処できるようにします。同時に、logging モジュールを使用してエラー情報を記録することで、デバッグや問題の調査を容易にします。

関連ドキュメント

• OB Cloudデータベースへの接続方法の詳細については、接続方法の概要をご参照ください。