Skip to content

Commit

Permalink
Added Engine Disposal Documentation
Browse files Browse the repository at this point in the history
Created hyperlink to SQLAlchemy docs for Engine Disposal
responsibilities of user. Unified wording of legacy support for sqlite
  • Loading branch information
emattiza authored and vn50dpg committed Aug 17, 2019
1 parent 9f93d57 commit 0561adc
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 13 deletions.
1 change: 1 addition & 0 deletions doc/source/whatsnew/v0.25.1.rst
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`)
-

Plotting
Expand Down
44 changes: 31 additions & 13 deletions pandas/io/sql.py
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
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,9 @@ 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 +286,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
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 +370,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 +473,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

0 comments on commit 0561adc

Please sign in to comment.