ApsaraDB RDS:DBUtilsを使用したApsaraDB RDS for MySQLインスタンスへの接続

前提条件

• バージョンが3.7から3.12の範囲のPythonがアプリケーションサーバーにインストールされます。

• サーバーのIPアドレスがRDSインスタンスのIPアドレスホワイトリストに追加されます。 詳細については、「IPアドレスホワイトリストの設定」をご参照ください。

  説明

  アプリケーションがRDSインスタンスと同じリージョンおよび仮想プライベートクラウド (VPC) にあるElastic Compute Service (ECS) インスタンスにデプロイされている場合、IPアドレスホワイトリストを設定する必要はありません。

準備

• DBUtilsのインストール: 次のコマンドを実行して、サーバーにDBUtilsをインストールします。 この例では、DBUtils 3.1.0が使用されます。 詳細については、「DBUtils」をご参照ください。

  pip install DBUtils==3.1.0

• PyMySQLのインストール: 次のコマンドを実行してPyMySQLをインストールします。 サーバーをRDSインスタンスに接続する場合は、PyMySQLが必要です。

  pip install pymysql

DBUtilsを使用したRDSインスタンスへの接続

1. 関連モジュールのインポート: DBUtilsを使用してRDSインスタンスに接続する前に、次のコマンドを実行して関連モジュールをインポートします。

   from dbutils.pooled_db import PooledDB
   import importlib
   import pymysql

2. DBUtilsDemoクラスのビルド: 後続の操作でメソッドの呼び出しと管理を容易にするために、DBUtilsDemoクラスを作成し、__init__ メソッドで接続プールパラメーターを設定し、_connectメソッドと _closeメソッドをクラスに追加して接続プールからの接続を取得および返すことを推奨します。

   class DBUtilsDemo:
       def __init__(self, url, user, password, database):
           db_config = {
               "host": url,
               "port": 3306,
               "user": user,
               "db": database,
               "password": password,
               "charset": "utf8",
               "connect_timeout": 3,
               "read_timeout": 10,
               "write_timeout": 10
           }
           '''
             For more information about common parameters of the DBUtils connection pool, see the "Common parameters of the connection pool" section of this topic.
               mincached: the initial number of idle connections in the connection pool. The value 0 specifies that no connections are established upon startup. 
               maxcached: the maximum number of idle connections in the pool. The value 0 or None specifies that no limits are imposed. 
               maxshared: the maximum number of shared connections. The value 0 or None specifies that all connections are dedicated. 
               maxconnections: the maximum number of connections that are allowed in most cases. The value 0 or None specifies that no limits are imposed. 
               blocking: the operation that is performed when the number of connections exceeds the upper limit. 
               maxusage: the maximum number of times that a connection can be reused. The value 0 or None specifies that no limits are imposed. 
           '''
           self.pooled = PooledDB(pymysql, maxcached=20, maxshared=0, maxconnections=100, maxusage=20, **db_config)
   
       # Obtain a connection from the connection pool.
       def _connect(self):
           try:
               r = self.pooled.connection()
               return r
           except Exception as e:
               print("Failed to connect:" + str(e))
   
       # Return a connection to the connection pool.
       def _close(self, conn, stmt):
           if stmt:
               stmt.close()
           if conn:
               conn.close()

3. 初期化DBUtilsDemo クラスの__main__関数RDSインスタンスに接続します。の後DBUtilsDemoクラスが構築されている場合、__main_関数でクラスを初期化し、RDSインスタンス上のデータベースへの接続を取得できます。

   if __name__ == '__main__':
       # The endpoint of the RDS instance. You must specify the internal or public endpoint of the RDS instance based on the requirements of your server. 
       url = 'rm-bp**************.mysql.rds.aliyuncs.com'
       # Specify the username that is used to access the RDS instance. 
       user = 'dbuser'
       # Specify the password that is used to access the RDS instance. 
       password = '****'
       # Specify the name of the database to which you want to connect. 
       database = 'dbtest'
   
       # Obtain the connection object.
       poolUtils = DBUtilsDemo(url, user, password, database)

接続プールの共通パラメータ

DBUtilsを使用してRDSインスタンスに接続する場合、RDSインスタンスがより安定して効率的に実行されるように、接続プールに必要なパラメーターを設定することを推奨します。 __init__ メソッドによって呼び出されるPooledDB関数でパラメーターを設定できます。

その後のデータベース操作

データベースで操作を実行する場合は、DBUtilsDemoクラスにカスタムメソッドを追加できます。

if __name__ == '__main__':
    # Configure the required connection parameters and connect to the database.
    url = 'rm-bp**************.mysql.rds.aliyuncs.com'
    user = 'dbuser'
    password = '****'
    database = 'dbtest'
    poolUtils = DBUtilsDemo(url, user, password, database)

    # Query a single row of data.
    row = poolUtils.select_row("select * from tb where id = 'i001' limit 1")
    print(row)

    # Query multiple rows of data.
    rows = poolUtils.select_rows("select * from tb")
    print(rows)

if __name__ == '__main__':
    # Configure the required parameters and connect to the database.
    url = 'rm-bp**************.mysql.rds.aliyuncs.com'
    user = 'dbuser'
    password = '****'
    database = 'dbtest'
    poolUtils = DBUtilsDemo(url, user, password, database)

    # Process the write request without bound parameters.
    poolUtils.upsert_data("insert into tb(id,name,address) values ('i001','n001','a001')")

    # Process the write request with bound parameters.
    params = ['i002', 'n002', 'a002']
    poolUtils.upsert_data_prams("insert into tb(id,name,address) values (%s,%s,%s)", params)

関連ドキュメント

• Jave接続プールの詳細については、「Druidを使用したApsaraDB RDS For MySQLインスタンスへの接続」をご参照ください。

• Goドライバーパッケージの詳細については、「Go-MySQL-driverを使用したApsaraDB RDS For MySQLインスタンスへの接続」をご参照ください。

• ApsaraDB RDS For MySQLのデータベースプロキシの接続プール機能の詳細については、「接続プール機能の設定」をご参照ください。