Skip to content

DOC: Clarify dispatch behavior of read_sql #18925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 26, 2017
Merged

DOC: Clarify dispatch behavior of read_sql #18925

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42f1282
DOC: Clarify dispatch behavior of read_sql [ci skip]
gfyoung Dec 24, 2017
31417d0
Address reviewer comments
gfyoung Dec 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions pandas/io/sql.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,15 +337,24 @@ def read_sql(sql, con, index_col=None, coerce_float=True, params=None,
"""
Read SQL query or database table into a DataFrame.

This function is a convenience wrapper around ``read_sql_table`` and
``read_sql_query`` (for backward compatibility). It will delegate
to the specific function depending on the provided input.

For example, a SQL query will be routed to ``read_sql_query``, while a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out "For example", as there are no other options.

(I would also keep those two paragraphs as a single paragraph, as it is explaining one topic.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

database table name will be routed to ``read_sql_table``. Note that
the delegated function might have more specific notes about their
functionality not listed here.

Parameters
----------
sql : string or SQLAlchemy Selectable (select or text object)
SQL query to be executed.
con : SQLAlchemy connectable(engine/connection) or database string URI
SQL query to be executed or a table name from which to select rows.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out "from which to select rows" (there is no way to do this)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

con : SQLAlchemy connectable (engine/connection) or database string URI
or DBAPI2 connection (fallback mode)

Using SQLAlchemy makes it possible to use any DB supported by that
library.
If a DBAPI2 object, only sqlite3 is supported.
library. If a DBAPI2 object, only sqlite3 is supported.
index_col : string or list of strings, optional, default: None
Column(s) to set as index(MultiIndex).
coerce_float : boolean, default True
Expand Down Expand Up @@ -377,14 +386,6 @@ def read_sql(sql, con, index_col=None, coerce_float=True, params=None,
-------
DataFrame

Notes
-----
This function is a convenience wrapper around ``read_sql_table`` and
``read_sql_query`` (and for backward compatibility) and will delegate
to the specific function depending on the provided input (database
table name or SQL query). The delegated function might have more specific
notes about their functionality not listed here.

See also
--------
read_sql_table : Read SQL database table into a DataFrame.
Expand Down