ENH: add optional logging to read_sql

[jimenezj8]

Feature Type

• Adding new functionality to pandas

• Changing existing functionality in pandas

• Removing existing functionality in pandas

Problem Description

It would be a nice QoL upgrade to be able to pass any additional, optional, params to calls to pandas.read_sql which will be passed to any call to sqlalchemy.create_engine. My particular use case is that I would like to pass echo=True to pd.read_sql so that the executed statements would be logged automatically, when using a connection string rather than an existing SQLAlchemy Connection.

Feature Description

Add a new parameter to pandas.read_sql, either connect_kwargs or echo. I'll provide an example for adding connect_kwargs

# pandas/pandas/io/sql.py

class SQLDatabase(..., **connect_kwargs):  
    ...
    if isinstance(con, str):  # line 1576
        con = create_engine(con, **connect_kwargs)
    ...

def pandasSQL_builder(..., **connect_kwargs) -> PandasSQL:
    ...
    if sqlalchemy is not None and isinstance(con, (str, sqlalchemy.engine.Connectable)):  # line 850
        return SQLDatabase(con, schema, need_transaction, **connect_kwargs)
    ...

def read_sql(..., **connect_kwargs):
    ...
    with pandasSQL_builder(con, **connect_kwargs) as pandas_sql:  # line 652
        ...
    ...

Alternative Solutions

No alternative solution, besides using a SQLAlchemy connectable rather than the proposed edits.

Additional Context

No response

[hvsesha]

@jimenezj8 Kindly provide example how to add kwargs

[jimenezj8]

@hvsesha here is an example of an updated call to pandas.read_sql:

import pandas as pd

sql_str = "SELECT * FROM example"
con_str = "postgresql://..."

pd.read_sql(sql_str, con=con_str, echo=True)

This works with the implementation example provided in the original description - any kwargs not present on the function signature will be packed into the value **connect_kwargs.

[WillAyd]

Have you looked at SQLAlchemy's logging? Does this not work?

https://docs.sqlalchemy.org/en/20/core/engines.html#configuring-logging

[jimenezj8]

@WillAyd that works, this suggestion is just to minimize the boilerplate needed to configure logging