Pandas read_sql でパラメータを渡す

概要

Pandas read_sql 関数を使用すると、SQL クエリを実行し、データベースからデータを取得できます。その機能の 1 つは、クエリにパラメーターを渡す機能です。

パラメーターの構文

パラメーターはリスト、タプル、または辞書として渡すことができます。正確な構文は、使用されているデータベース ドライバーによって異なります。一般的な例をいくつか示します:

• ?または %s: 単一値のプレースホルダー
• :1 または :name: 単一値の名前付きプレースホルダー
• %(name)s: string.format 構文を使用した名前付きプレースホルダー

名前付き引数での辞書の使用

パラメータを渡すための 1 つのオプションは、辞書を使用することです。これは、psycopg2 ドライバーを備えた PostgreSQL を含む、ほとんどのドライバーでサポートされています。ディクショナリ内のキーと値のペアは、クエリ内の名前付きプレースホルダーに対応します。

例

名前付き引数のアプローチを示すために、次の SQL クエリを考えてみましょう:

select "Timestamp", "Value" from "MyTable"
where "Timestamp" BETWEEN :dstart AND :dfinish

辞書を使用してこのクエリにパラメータを渡す方法は次のとおりです:

params = {"dstart": datetime(2014, 6, 24, 16, 0), "dfinish": datetime(2014, 6, 24, 17, 0)}

df = psql.read_sql(
    "select \"Timestamp\",\"Value\" from \"MyTable\" where \"Timestamp\" BETWEEN %(dstart)s AND %(dfinish)s",
    db,
    params=params,
    index_col=["Timestamp"],
)

この例では、params ディクショナリは、名前付きプレースホルダー :dstart および :dfinish の値を提供します。 %(name)s 構文により、値がクエリに正しく挿入されることが保証されます。