awswrangler.data_api.rds.read_sql_query

awswrangler.data_api.rds.read_sql_query(sql: str, con: RdsDataApi, database: str | None = None, parameters: list[dict[str, Any]] | None = None) → DataFrame

Run an SQL query on an RdsDataApi connection and return the result as a DataFrame.

Parameters:

• sql (str) – SQL query to run.

• con (RdsDataApi) – A RdsDataApi connection instance

• database (str | None) – Database to run query on - defaults to the database specified by con.

• parameters (list[dict[str, Any]] | None) – A list of named parameters e.g. [{“name”: “col”, “value”: {“stringValue”: “val1”}}].

Return type:

DataFrame

Returns:

A Pandas DataFrame containing the query results.

Examples

>>> import awswrangler as wr
>>> df = wr.data_api.rds.read_sql_query(
>>>     sql="SELECT * FROM public.my_table",
>>>     con=con,
>>> )

>>> import awswrangler as wr
>>> df = wr.data_api.rds.read_sql_query(
>>>     sql="SELECT * FROM public.my_table WHERE col = :name",
>>>     con=con,
>>>     parameters=[
>>>        {"name": "col1", "value": {"stringValue": "val1"}}
>>>     ],
>>> )