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

適用対象: 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 と、そのアプリケーションに必要なその他のパッケージ用の自己完結型ディレクトリです。

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

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

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

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

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

pip install psycopg2
pip install azure-identity

pip install psycopg2

認証コードを追加する

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

Python の例を実行する方法

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

1. テキスト エディターで新しいファイルを作成します。

2. ファイルにコード例を追加します。

3. ファイルに .py 拡張子を付けてプロジェクト フォルダーに保存します。たとえば、postgres-insert.py のように指定します。 Windows の場合は、ファイルを保存するときに UTF-8 エンコードを選択するようにしてください。

4. プロジェクト フォルダーに、python に続けてファイル名を入力します (例: python postgres-insert.py)。

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

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

import psycopg2
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg2.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 psycopg2
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg2.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 psycopg2
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg2.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 psycopg2
from get_conn import get_connection_uri

conn_string = get_connection_uri()

conn = psycopg2.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()

次のステップ