@@ -140,10 +140,14 @@ def execute(sql, con, cur=None, params=None):
140
140
----------
141
141
sql : string
142
142
SQL query to be executed.
143
- con : SQLAlchemy connectable(engine/connection) or sqlite3 connection
144
- Using SQLAlchemy makes it possible to use any DB supported by the
145
- library.
146
- If a DBAPI2 object, only sqlite3 is supported.
143
+ con : SQLAlchemy connectable (engine/connection) or database string URI
144
+ or DBAPI2 connection (fallback mode)
145
+ Using SQLAlchemy makes it possible to use any DB supported by that
146
+ library. Legacy support is provided for sqlite3.Connection objects.
147
+ Note: The user is responsible for engine disposal and connection
148
+ closure for the SQLAlchemy connectable. See `EngineDisposal
149
+ <https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
150
+
147
151
cur : deprecated, cursor is obtained from connection, default: None
148
152
params : list or tuple, optional, default: None
149
153
List of parameters to pass to execute method.
@@ -187,6 +191,9 @@ def read_sql_table(
187
191
con : SQLAlchemy connectable or str
188
192
A database URI could be provided as as str.
189
193
SQLite DBAPI connection mode not supported.
194
+ Note: The user is responsible for engine disposal and connection
195
+ closure for the SQLAlchemy connectable. See `EngineDisposal
196
+ <https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
190
197
schema : str, default None
191
198
Name of SQL schema in database to query (if database flavor
192
199
supports this). Uses default schema if None (default).
@@ -279,11 +286,15 @@ def read_sql_query(
279
286
----------
280
287
sql : string SQL query or SQLAlchemy Selectable (select or text object)
281
288
SQL query to be executed.
282
- con : SQLAlchemy connectable(engine/connection), database string URI,
289
+ con : SQLAlchemy connectable(engine/connection) or database string URI
283
290
or sqlite3 DBAPI2 connection
284
- Using SQLAlchemy makes it possible to use any DB supported by that
285
- library.
286
- If a DBAPI2 object, only sqlite3 is supported.
291
+ Using SQLAlchemy makes it possible to use any DB supported by
292
+ that library. Legacy support is provided for sqlite3.Connection
293
+ objects.
294
+ Note: The user is responsible for engine disposal and connection
295
+ closure for the SQLAlchemy connectable. See `EngineDisposal
296
+ <https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
297
+
287
298
index_col : string or list of strings, optional, default: None
288
299
Column(s) to set as index(MultiIndex).
289
300
coerce_float : boolean, default True
@@ -359,9 +370,12 @@ def read_sql(
359
370
SQL query to be executed or a table name.
360
371
con : SQLAlchemy connectable (engine/connection) or database string URI
361
372
or DBAPI2 connection (fallback mode)
362
-
363
373
Using SQLAlchemy makes it possible to use any DB supported by that
364
- library. If a DBAPI2 object, only sqlite3 is supported.
374
+ library. Legacy support is provided for sqlite3.Connection objects.
375
+ Note: The user is responsible for engine disposal and connection
376
+ closure for the SQLAlchemy connectable. See `EngineDisposal
377
+ <https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
378
+
365
379
index_col : string or list of strings, optional, default: None
366
380
Column(s) to set as index(MultiIndex).
367
381
coerce_float : boolean, default True
@@ -459,9 +473,13 @@ def to_sql(
459
473
Name of SQL table.
460
474
con : SQLAlchemy connectable(engine/connection) or database string URI
461
475
or sqlite3 DBAPI2 connection
462
- Using SQLAlchemy makes it possible to use any DB supported by that
463
- library.
464
- If a DBAPI2 object, only sqlite3 is supported.
476
+ Using SQLAlchemy makes it possible to use any DB supported by
477
+ that library. Legacy support is provided for sqlite3.Connection
478
+ objects.
479
+ Note: The user is responsible for engine disposal and connection
480
+ closure for the SQLAlchemy connectable. See `EngineDisposal
481
+ <https://docs.sqlalchemy.org/en/13/core/connections.html?highlight=engine#engine-disposal>`_.
482
+
465
483
schema : string, default None
466
484
Name of SQL schema in database to write to (if database flavor
467
485
supports this). If None, use default schema (default).
0 commit comments