diff --git a/docs/source/api.rst b/docs/source/api.rst index 21f44ea61..1c75ce5bb 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -151,6 +151,24 @@ Amazon Athena list_prepared_statements delete_prepared_statement +read_sql_query(sql, con, **kwargs**) +------------------------------------- + +Executes a SQL query and returns the result as a Pandas DataFrame. + +**Example**: + +.. code-block:: python + + import awswrangler as wr + import sqlalchemy + + # Create SQLAlchemy engine for MySQL + engine = sqlalchemy.create_engine("mysql+pymysql://user:password@host/dbname") + + # Run SQL query and get results into Pandas DataFrame + df = wr.read_sql_query("SELECT * FROM employees", con=engine) + Amazon Redshift ---------------