peeweeを使用したOceanBase Cloud接続サンプルプログラム

本記事では、peeweeを使用してOceanBase Cloudに接続し、テーブルの作成、データの挿入、更新、クエリなどの基本的なデータベース操作を実行する方法について紹介します。

前提条件

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

操作手順

1. OceanBase Cloudの接続文字列を取得します。
2. peeweeとMySQLクライアントライブラリをインストールします。
3. test.py ファイルを作成し、データベース接続情報を入力します。
4. test.py ファイルを実行します。

ステップ１：OceanBase Cloudの接続文字列を取得する

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

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

2. 作成済みのOceanBase Cloudに基づいて、以下のURLの該当する情報を入力します。

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

   パラメータ説明：

   • $host：OceanBase Cloudの接続アドレスを指定します。例：t********.********.oceanbase.cloud。

   • $port：OceanBase Cloudの接続ポートを指定します。デフォルトは3306です。

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

     注意

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

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

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

   例：

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

ステップ2：peeweeとMySQLクライアントライブラリをインストールする

peeweeは軽量なPython ORM（オブジェクト関係マッピング）ライブラリであり、シンプルで強力なAPIを提供し、データベース操作を簡素化できます。peeweeはMySQL、PostgreSQL、SQLiteなど、さまざまなデータベースバックエンドをサポートしています。

コマンドプロンプトまたはPowerShellターミナルを開き、以下のコマンドを実行して、peeweeとMySQLクライアントライブラリをインストールします。

pip install peewee pymysql

インストールが完了したら、以下のコマンドを実行してインストールが正常に完了したかどうか確認します：

pip list | grep peewee

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

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

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

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

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

   from peewee import *
   
   # データベース接続情報
   DB_USER = 'mysql001'
   DB_PASSWORD = '******'
   DB_HOST = 't********.********.oceanbase.cloud'
   DB_PORT = 3306
   DB_NAME = 'test'
   
   # データベース接続の作成
   db = MySQLDatabase(
       DB_NAME,
       user=DB_USER,
       password=DB_PASSWORD,
       host=DB_HOST,
       port=DB_PORT
   )
   
   # モデルの定義
   class User(Model):
       name = CharField(max_length=50)
       age = IntegerField()
   
       class Meta:
           database = db
           table_name = 'users'
   
       def __str__(self):
           return f"{self.name} ({self.age})"
   
   # データベースへの接続
   db.connect()
   
   # テーブルの作成
   db.create_tables([User])
   
   # データの挿入
   User.create(name='John', age=20)
   User.create(name='Lucy', age=25)
   User.create(name='Tom', age=30)
   
   # データの更新
   user = User.get(User.name == 'Lucy')
   user.age = 26
   user.save()
   
   # データのクエリ
   users = User.select()
   for user in users:
       print(user)
   
   # データベース接続を閉じる
   db.close()
   

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

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

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

   例：

   cd D:\demo\demo
   

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

   例：

   python test.py
   

   実行結果は次のとおりです：

   John (20)
   Lucy (26)
   Tom (30)
   

エラー処理

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

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

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

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

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

peeweeでは、try-except ステートメントを使用してこれらのエラーをキャッチし、処理することができます。これにより、プログラムはエラーに遭遇した際にクラッシュすることなく適切に対処できます。同時に、Pythonの logging モジュールを使用してエラー情報を記録することで、デバッグや問題の調査が容易になります。

関連ドキュメント

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