Skip to content
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

Jump to bottom

Added Engine Disposal Documentation #27972

Closed
wants to merge 3 commits into from
Closed

Added Engine Disposal Documentation #27972

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dd1707
Added Engine Disposal Documentation
emattiza Aug 17, 2019
11f3463
Added a new line before Note in the parameters.
Aug 18, 2019
6d5ab79
Merge branch 'master' into 23086-engine-disposal-docs
poojahagawane Sep 8, 2019
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v0.25.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ I/O

- Avoid calling ``S3File.s3`` when reading parquet, as this was removed in s3fs version 0.3.0 (:issue:`27756`)
- Better error message when a negative header is passed in :func:`pandas.read_csv` (:issue:`27779`)
- Added notes on Engine Disposal and user responsibility to multiple sql related function docstrings (:issue:`23086`)
gfyoung marked this conversation as resolved.
Show resolved Hide resolved
-

Plotting
Expand Down
45 changes: 32 additions & 13 deletions pandas/io/sql.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,14 @@ def execute(sql, con, cur=None, params=None):
----------
sql : string
SQL query to be executed.
con : SQLAlchemy connectable(engine/connection) or sqlite3 connection
Using SQLAlchemy makes it possible to use any DB supported by the
library.
If a DBAPI2 object, only sqlite3 is supported.
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. Legacy support is provided for sqlite3.Connection objects.

Note: The user is responsible for engine disposal and connection
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note: The user is responsible for engine disposal and connection
Note: The user is responsible for engine disposal and connection

Copy link
Member

Choose a reason for hiding this comment

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

For these "Note:" sections, let's add a newline above (this applies to your other changes)

Copy link
Author

Choose a reason for hiding this comment

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

Hey I added the newline however its not rendering in the documentation generated.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think they end up in the same paragraph in the generated HTML.

closure for the SQLAlchemy connectable. See `EngineDisposal
<https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
cur : deprecated, cursor is obtained from connection, default: None
params : list or tuple, optional, default: None
List of parameters to pass to execute method.
Expand Down Expand Up @@ -187,6 +191,10 @@ def read_sql_table(
con : SQLAlchemy connectable or str
A database URI could be provided as as str.
SQLite DBAPI connection mode not supported.

Note: The user is responsible for engine disposal and connection
closure for the SQLAlchemy connectable. See `EngineDisposal
<https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
schema : str, default None
Name of SQL schema in database to query (if database flavor
supports this). Uses default schema if None (default).
Expand Down Expand Up @@ -279,11 +287,15 @@ def read_sql_query(
----------
sql : string SQL query or SQLAlchemy Selectable (select or text object)
SQL query to be executed.
con : SQLAlchemy connectable(engine/connection), database string URI,
con : SQLAlchemy connectable(engine/connection) or database string URI
poojahagawane marked this conversation as resolved.
Show resolved Hide resolved
or sqlite3 DBAPI2 connection
Using SQLAlchemy makes it possible to use any DB supported by that
library.
If a DBAPI2 object, only sqlite3 is supported.
Using SQLAlchemy makes it possible to use any DB supported by
that library. Legacy support is provided for sqlite3.Connection
objects.

Note: The user is responsible for engine disposal and connection
closure for the SQLAlchemy connectable. See `EngineDisposal
<https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
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 @@ -359,9 +371,12 @@ def read_sql(
SQL query to be executed or a table name.
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. Legacy support is provided for sqlite3.Connection objects.

Note: The user is responsible for engine disposal and connection
closure for the SQLAlchemy connectable. See `EngineDisposal
<https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
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 @@ -459,9 +474,13 @@ def to_sql(
Name of SQL table.
con : SQLAlchemy connectable(engine/connection) or database string URI
or sqlite3 DBAPI2 connection
Using SQLAlchemy makes it possible to use any DB supported by that
library.
If a DBAPI2 object, only sqlite3 is supported.
Using SQLAlchemy makes it possible to use any DB supported by
that library. Legacy support is provided for sqlite3.Connection
objects.

Note: The user is responsible for engine disposal and connection
closure for the SQLAlchemy connectable. See `EngineDisposal
<https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
schema : string, default None
Name of SQL schema in database to write to (if database flavor
supports this). If None, use default schema (default).
Expand Down