クイックスタート:Python を使用して Azure Database for PostgreSQL - フレキシブルサーバーに接続し、データのクエリを実行する

[アーティクル]
08/15/2024

適用対象: Azure Database for PostgreSQL - フレキシブルサーバー

このクイックスタートでは、Python を使用して Azure Database for PostgreSQL のフレキシブルサーバーインスタンスに接続します。 macOS、Ubuntu Linux、Windows の各プラットフォームから SQL ステートメントを使用して、データベース内のデータを照会、挿入、更新、削除できます。

この記事の手順には、Microsoft Entra 認証と PostgreSQL 認証の 2 つの認証方法が含まれています。 [パスワードレス] タブには Microsoft Entra 認証が表示され、[パスワード] タブには PostgreSQL 認証が表示されます。

Microsoft Entra 認証は、Microsoft Entra ID で定義された ID を使用して Azure Database for PostgreSQL に接続するための仕組みです。 Microsoft Entra 認証を使用すると、データベースユーザーの ID や他の Microsoft サービスを一元管理でき、アクセス許可の管理が容易になります。詳細については、「Azure Database for PostgreSQL - フレキシブルサーバーでの Microsoft Entra 認証」を参照してください。

PostgreSQL 認証では、PostgreSQL に格納されているアカウントが使用されます。アカウントの資格情報としてパスワードを使用することを選択した場合、これらの資格情報は user テーブルに格納されます。これらのパスワードは PostgreSQL に格納されるため、パスワードのローテーションを自分で管理する必要があります。

この記事では、Python を使用した開発には慣れているものの、Azure Database for PostgreSQL のフレキシブルサーバーの使用は初めてであるユーザーを想定しています。

前提条件

アクティブなサブスクリプションが含まれる Azure アカウント。無料でアカウントを作成できます。
Azure Database for PostgreSQL フレキシブルサーバーインスタンス。 Azure Database for PostgreSQL のフレキシブルサーバーインスタンスを作成するには、Azure portal を使用した Azure Database for PostgreSQL - フレキシブルサーバーインスタンスの作成に関するページを参照してください。
Python 3.8 以降。
最新の pip パッケージインストーラー。

クライアントワークステーションのファイアウォール規則を追加する

プライベートアクセス (VNet 統合) を使用して Azure Database for PostgreSQL のフレキシブルサーバーインスタンスを作成した場合は、サーバーと同じ VNet 内のリソースからサーバーに接続する必要があります。仮想マシンを作成し、Azure Database for PostgreSQL のフレキシブルサーバーインスタンスで作成した VNet に追加できます。「Azure CLI を使用した Azure Database for PostgreSQL - フレキシブルサーバー仮想ネットワークの作成と管理」を参照してください。
パブリックアクセス (使用できる IP アドレス) を指定して Azure Database for PostgreSQL のフレキシブルサーバーインスタンスを作成した場合は、サーバー上のファイアウォール規則のリストにローカル IP アドレスを追加できます。「Azure CLI を使用した Azure Database for PostgreSQL - フレキシブルサーバーファイアウォール規則の作成と管理」を参照してください。

サーバーで Microsoft Entra 統合を構成する (パスワードレスのみ)

パスワードレス認証の手順に従っている場合は、サーバーインスタンス用に Microsoft Entra 認証を構成しており、サーバーインスタンスの Microsoft Entra 管理者として割り当てられている必要があります。 Microsoft Entra 統合の構成に関するページの手順に従って、Microsoft Entra 認証が構成されていることと、サーバーインスタンスで Microsoft Entra 管理者として割り当てられていることを確認します。

開発環境を準備する

コードを実行し、仮想環境を作成してアクティブ化するフォルダーに移動します。仮想環境は、特定のバージョンの Python と、そのアプリケーションに必要なその他のパッケージ用の自己完結型ディレクトリです。

次のコマンドを実行し、仮想環境を作成してアクティブにします。

Windows
macOS/Linux

py -3 -m venv .venv
.venv\Scripts\activate

python3 -m venv .venv
source .venv/bin/activate

Python ライブラリをインストールする

コード例を実行するために必要な Python ライブラリをインストールします。

パスワードレス (推奨)
パスワード

azure-identity ライブラリをインストールします。これによって、Azure SDK における Microsoft Entra トークン認証のサポートが提供されます。

pip install azure-identity

psycopg モジュールをインストールします。これによって、PostgreSQL データベースへの接続とクエリの実行が可能になります。

pip install psycopg

認証コードを追加する

このセクションでは、作業ディレクトリに認証コードを追加し、サーバーインスタンスでの認証と認可に必要な追加の手順を実行します。

パスワードレス (推奨)
パスワード

次のコードをエディターにコピーし、get_conn.py という名前のファイルに保存します。

import urllib.parse
import os

from azure.identity import DefaultAzureCredential

# IMPORTANT! This code is for demonstration purposes only. It's not suitable for use in production. 
# For example, tokens issued by Microsoft Entra ID have a limited lifetime (24 hours by default). 
# In production code, you need to implement a token refresh policy.

def get_connection_uri():

    # Read URI parameters from the environment
    dbhost = os.environ['DBHOST']
    dbname = os.environ['DBNAME']
    dbuser = urllib.parse.quote(os.environ['DBUSER'])
    sslmode = os.environ['SSLMODE']

    # Use passwordless authentication via DefaultAzureCredential.
    # IMPORTANT! This code is for demonstration purposes only. DefaultAzureCredential() is invoked on every call.
    # In practice, it's better to persist the credential across calls and reuse it so you can take advantage of token
    # caching and minimize round trips to the identity provider. To learn more, see:
    # https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/TOKEN_CACHING.md 
    credential = DefaultAzureCredential()

    # Call get_token() to get a token from Microsft Entra ID and add it as the password in the URI.
    # Note the requested scope parameter in the call to get_token, "https://ossrdbms-aad.database.windows.net/.default".
    password = credential.get_token("https://ossrdbms-aad.database.windows.net/.default").token

    db_uri = f"postgresql://{dbuser}:{password}@{dbhost}/{dbname}?sslmode={sslmode}"
    return db_uri

データベース接続情報を取得します。
1. Azure portal で、ご利用の Azure Database for PostgreSQL のフレキシブルサーバー名を検索して選択します。
2. サーバーの [概要] ページで、完全修飾サーバー名をコピーします。完全修飾サーバー名は常に <my-server-name>.postgres.database.azure.com の形式になります。
3. 左側のメニューの [セキュリティ] セクションで、[認証] を選択します。 [Microsoft Entra 管理者] にアカウントの一覧が表示されていることを確認します。そうでない場合は、「サーバーで Microsoft Entra 統合を構成する (パスワードレスのみ)」の手順を完了します。
接続 URI 要素用の環境変数を設定します。
- Windows
- macOS/Linux
```
set DBHOST=<server-name>
set DBNAME=<database-name>
set DBUSER=<username>
set SSLMODE=require
```
```
export DBHOST=<server-name>
export DBNAME=<database-name>
export DBUSER=<username>
export SSLMODE=require
```
コマンドで次のプレースホルダー値を置き換えます。
- <server-name> を、Azure portal からコピーした値に置き換えます。
- <username> を、Azure ユーザー名に置き換えます。例: john@contoso.com
- <database-name> を、Azure Database for PostgreSQL のフレキシブルサーバーデータベースの名前に置き換えます。サーバーの作成時に、postgres という名前の既定のデータベースが自動的に作成されています。このデータベースを使用することも、SQL コマンドを使用して新しいデータベースを作成することもできます。
ワークステーションで Azure にサインインします。 Azure CLI、Azure PowerShell、または Azure Developer CLI を使用してサインインできます。たとえば、Azure CLI を使用してサインインするには、次のコマンドを入力します。
```
az login
```
認証コードでは、DefaultAzureCredential を使用して Microsoft Entra ID で認証し、サーバーインスタンスに対して操作を実行することを承認するトークンを取得します。 DefaultAzureCredential は、認証資格情報の種類のチェーンをサポートします。サポートされている資格情報の中には、Azure CLI、Azure PowerShell、Azure Developer CLI などの開発者ツールにサインインしている資格情報があります。

次のコードをエディターにコピーし、get_conn.py という名前のファイルに保存します。

import urllib.parse
import os

def get_connection_uri():

    # Read URI parameters from the environment
    dbhost = os.environ['DBHOST']
    dbname = os.environ['DBNAME']
    dbuser = urllib.parse.quote(os.environ['DBUSER'])
    password = os.environ['DBPASSWORD']
    sslmode = os.environ['SSLMODE']
    db_uri = f"host={dbhost} dbname={dbname} user={dbuser} password={password} sslmode ={sslmode}"
    # Construct connection URI
    return db_uri

データベース接続情報を取得します。
1. Azure portal で、ご利用の Azure Database for PostgreSQL のフレキシブルサーバー名を検索して選択します。
2. サーバーの [概要] ページで、完全修飾のサーバー名とサーバー管理者のログイン名をコピーします。完全修飾サーバー名は常に <my-server-name>.postgres.database.azure.com の形式になります。
  
  また、管理者パスワードも必要です。忘れた場合は、概要ページの上部にある [パスワードのリセット] ボタンを使用してリセットできます。
接続 URI 要素用の環境変数を設定します。
- Windows
- macOS/Linux
```
set DBHOST=<server-name>
set DBNAME=<database-name>
set DBUSER=<username>
set DBPASSWORD=<password>
set SSLMODE=require
```
```
export DBHOST=<server-name>
export DBNAME=<database-name>
export DBUSER=<username>
export DBPASSWORD=<password>
export SSLMODE=require
```
コマンドで次のプレースホルダー値を置き換えます。
- <server-name> および <username> を、Azure portal からコピーした値に指定します。
- <password> をサーバーパスワードに指定します。
- <database-name> を、Azure Database for PostgreSQL のフレキシブルサーバーデータベースの名前に置き換えます。サーバーの作成時に、postgres という名前の既定のデータベースが自動的に作成されています。このデータベースを使用することも、SQL コマンドを使用して新しいデータベースを作成することもできます。

Python の例を実行する方法

この記事の各コード例では、次のことを行います。

テキストエディターで新しいファイルを作成します。
ファイルにコード例を追加します。
ファイルに .py 拡張子を付けてプロジェクトフォルダーに保存します。たとえば、postgres-insert.py のように指定します。 Windows の場合は、ファイルを保存するときに UTF-8 エンコードを選択するようにしてください。
プロジェクトフォルダーに、python に続けてファイル名を入力します (例: python postgres-insert.py)。

テーブルを作成してデータを挿入する

次のコード例では、psycopg.connect 関数を使用して Azure Database for PostgreSQL のフレキシブルサーバーデータベースに接続し、SQL INSERT ステートメントを使用してデータを読み込みます。 cursor.execute 関数は、データベースに対して SQL クエリを実行します。

import psycopg
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg.connect(conn_string) 
print("Connection established")
cursor = conn.cursor()

# Drop previous table of same name if one exists
cursor.execute("DROP TABLE IF EXISTS inventory;")
print("Finished dropping table (if existed)")

# Create a table
cursor.execute("CREATE TABLE inventory (id serial PRIMARY KEY, name VARCHAR(50), quantity INTEGER);")
print("Finished creating table")

# Insert some data into the table
cursor.execute("INSERT INTO inventory (name, quantity) VALUES (%s, %s);", ("banana", 150))
cursor.execute("INSERT INTO inventory (name, quantity) VALUES (%s, %s);", ("orange", 154))
cursor.execute("INSERT INTO inventory (name, quantity) VALUES (%s, %s);", ("apple", 100))
print("Inserted 3 rows of data")

# Clean up
conn.commit()
cursor.close()
conn.close()

コードが正常に実行されると、次の出力が生成されます。

Connection established
Finished dropping table (if existed)
Finished creating table
Inserted 3 rows of data

データの読み取り

次のコード例では、Azure Database for PostgreSQL のフレキシブルサーバーデータベースに接続し、cursor.execute と SQL SELECT ステートメントを使用してデータを読み取ります。この関数はクエリを受け取り、cursor.fetchall() を使用して反復処理する結果セットを返します。

import psycopg
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg.connect(conn_string) 
print("Connection established")
cursor = conn.cursor()

# Fetch all rows from table
cursor.execute("SELECT * FROM inventory;")
rows = cursor.fetchall()

# Print all rows
for row in rows:
    print("Data row = (%s, %s, %s)" %(str(row[0]), str(row[1]), str(row[2])))

# Cleanup
conn.commit()
cursor.close()
conn.close()

コードが正常に実行されると、次の出力が生成されます。

Connection established
Data row = (1, banana, 150)
Data row = (2, orange, 154)
Data row = (3, apple, 100)

データの更新

次のコード例では、Azure Database for PostgreSQL のフレキシブルサーバーデータベースに接続し、cursor.execute と SQL UPDATE ステートメントを使用してデータを更新します。

import psycopg
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg.connect(conn_string) 
print("Connection established")
cursor = conn.cursor()

# Update a data row in the table
cursor.execute("UPDATE inventory SET quantity = %s WHERE name = %s;", (200, "banana"))
print("Updated 1 row of data")

# Cleanup
conn.commit()
cursor.close()
conn.close()

データの削除

次のコード例では、Azure Database for PostgreSQL のフレキシブルサーバーデータベースに接続し、cursor.execute と SQL DELETE ステートメントを使用して、前に挿入したインベントリ項目を削除します。

import psycopg
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg.connect(conn_string) 
print("Connection established")
cursor = conn.cursor()

# Delete data row from table
cursor.execute("DELETE FROM inventory WHERE name = %s;", ("orange",))
print("Deleted 1 row of data")

# Cleanup
conn.commit()
cursor.close()
conn.close()

次のステップ

ダンプと復元を使用してデータベースを移行する

次の方法で共有

クイックスタート:Python を使用して Azure Database for PostgreSQL - フレキシブルサーバーに接続し、データのクエリを実行する

前提条件

クライアントワークステーションのファイアウォール規則を追加する

サーバーで Microsoft Entra 統合を構成する (パスワードレスのみ)

開発環境を準備する

Python ライブラリをインストールする

認証コードを追加する

Python の例を実行する方法

テーブルを作成してデータを挿入する

データの読み取り

データの更新

データの削除

次のステップ

フィードバック

その他のリソース

次の方法で共有

クイック スタート:Python を使用して Azure Database for PostgreSQL - フレキシブル サーバーに接続し、データのクエリを実行する

前提条件

クライアント ワークステーションのファイアウォール規則を追加する

サーバーで Microsoft Entra 統合を構成する (パスワードレスのみ)

開発環境を準備する

Python ライブラリをインストールする

認証コードを追加する

Python の例を実行する方法

テーブルを作成してデータを挿入する

データの読み取り

データの更新

データの削除

次のステップ

フィードバック

その他のリソース

クイックスタート:Python を使用して Azure Database for PostgreSQL - フレキシブルサーバーに接続し、データのクエリを実行する

クライアントワークステーションのファイアウォール規則を追加する