@@ -143,8 +143,8 @@ def execute(sql, con, cur=None, params=None):
143
143
Using SQLAlchemy makes it possible to use any DB supported by that
144
144
library.
145
145
If a DBAPI2 object, only sqlite3 is supported.
146
- cur : deprecated, cursor is obtained from connection
147
- params : list or tuple, optional
146
+ cur : deprecated, cursor is obtained from connection, default: None
147
+ params : list or tuple, optional, default: None
148
148
List of parameters to pass to execute method.
149
149
150
150
Returns
@@ -189,8 +189,9 @@ def tquery(sql, con=None, cur=None, retry=True):
189
189
----------
190
190
sql: string
191
191
SQL query to be executed
192
- con: DBAPI2 connection
193
- cur: deprecated, cursor is obtained from connection
192
+ con: DBAPI2 connection, default: None
193
+ cur: deprecated, cursor is obtained from connection, default: None
194
+ retry: boolean value to specify whether to retry after failure, default: True
194
195
195
196
Returns
196
197
-------
@@ -242,9 +243,10 @@ def uquery(sql, con=None, cur=None, retry=True, params=None):
242
243
----------
243
244
sql: string
244
245
SQL query to be executed
245
- con: DBAPI2 connection
246
- cur: deprecated, cursor is obtained from connection
247
- params: list or tuple, optional
246
+ con: DBAPI2 connection, default: None
247
+ cur: deprecated, cursor is obtained from connection, default: None
248
+ retry: boolean value to specify whether to retry after failure, default: True
249
+ params: list or tuple, optional, default: None
248
250
List of parameters to pass to execute method.
249
251
250
252
Returns
@@ -294,12 +296,12 @@ def read_sql_table(table_name, con, schema=None, index_col=None,
294
296
schema : string, default None
295
297
Name of SQL schema in database to query (if database flavor
296
298
supports this). If None, use default schema (default).
297
- index_col : string, optional
299
+ index_col : string, optional, default: None
298
300
Column to set as index
299
301
coerce_float : boolean, default True
300
302
Attempt to convert values to non-string, non-numeric objects (like
301
303
decimal.Decimal) to floating point. Can result in loss of Precision.
302
- parse_dates : list or dict
304
+ parse_dates : list or dict, default: None
303
305
- List of column names to parse as dates
304
306
- Dict of ``{column_name: format string}`` where format string is
305
307
strftime compatible in case of parsing string times or is one of
@@ -308,7 +310,7 @@ def read_sql_table(table_name, con, schema=None, index_col=None,
308
310
to the keyword arguments of :func:`pandas.to_datetime`
309
311
Especially useful with databases without native Datetime support,
310
312
such as SQLite
311
- columns : list
313
+ columns : list, default: None
312
314
List of column names to select from sql table
313
315
chunksize : int, default None
314
316
If specified, return an iterator where `chunksize` is the number of
@@ -369,18 +371,18 @@ def read_sql_query(sql, con, index_col=None, coerce_float=True, params=None,
369
371
Using SQLAlchemy makes it possible to use any DB supported by that
370
372
library.
371
373
If a DBAPI2 object, only sqlite3 is supported.
372
- index_col : string, optional
374
+ index_col : string, optional, default: None
373
375
Column name to use as index for the returned DataFrame object.
374
376
coerce_float : boolean, default True
375
377
Attempt to convert values to non-string, non-numeric objects (like
376
378
decimal.Decimal) to floating point, useful for SQL result sets
377
- params : list, tuple or dict, optional
379
+ params : list, tuple or dict, optional, default: None
378
380
List of parameters to pass to execute method. The syntax used
379
381
to pass parameters is database driver dependent. Check your
380
382
database driver documentation for which of the five syntax styles,
381
383
described in PEP 249's paramstyle, is supported.
382
384
Eg. for psycopg2, uses %(name)s so use params={'name' : 'value'}
383
- parse_dates : list or dict
385
+ parse_dates : list or dict, default: None
384
386
- List of column names to parse as dates
385
387
- Dict of ``{column_name: format string}`` where format string is
386
388
strftime compatible in case of parsing string times or is one of
@@ -428,18 +430,18 @@ def read_sql(sql, con, index_col=None, coerce_float=True, params=None,
428
430
Using SQLAlchemy makes it possible to use any DB supported by that
429
431
library.
430
432
If a DBAPI2 object, only sqlite3 is supported.
431
- index_col : string, optional
433
+ index_col : string, optional, default: None
432
434
column name to use as index for the returned DataFrame object.
433
435
coerce_float : boolean, default True
434
436
Attempt to convert values to non-string, non-numeric objects (like
435
437
decimal.Decimal) to floating point, useful for SQL result sets
436
- params : list, tuple or dict, optional
438
+ params : list, tuple or dict, optional, default: None
437
439
List of parameters to pass to execute method. The syntax used
438
440
to pass parameters is database driver dependent. Check your
439
441
database driver documentation for which of the five syntax styles,
440
442
described in PEP 249's paramstyle, is supported.
441
443
Eg. for psycopg2, uses %(name)s so use params={'name' : 'value'}
442
- parse_dates : list or dict
444
+ parse_dates : list or dict, default: None
443
445
- List of column names to parse as dates
444
446
- Dict of ``{column_name: format string}`` where format string is
445
447
strftime compatible in case of parsing string times or is one of
@@ -448,7 +450,7 @@ def read_sql(sql, con, index_col=None, coerce_float=True, params=None,
448
450
to the keyword arguments of :func:`pandas.to_datetime`
449
451
Especially useful with databases without native Datetime support,
450
452
such as SQLite
451
- columns : list
453
+ columns : list, default: None
452
454
List of column names to select from sql table (only used when reading
453
455
a table).
454
456
chunksize : int, default None
@@ -1061,13 +1063,13 @@ def read_table(self, table_name, index_col=None, coerce_float=True,
1061
1063
----------
1062
1064
table_name : string
1063
1065
Name of SQL table in database
1064
- index_col : string, optional
1066
+ index_col : string, optional, default: None
1065
1067
Column to set as index
1066
1068
coerce_float : boolean, default True
1067
1069
Attempt to convert values to non-string, non-numeric objects
1068
1070
(like decimal.Decimal) to floating point. This can result in
1069
1071
loss of precision.
1070
- parse_dates : list or dict
1072
+ parse_dates : list or dict, default: None
1071
1073
- List of column names to parse as dates
1072
1074
- Dict of ``{column_name: format string}`` where format string is
1073
1075
strftime compatible in case of parsing string times or is one of
@@ -1076,7 +1078,7 @@ def read_table(self, table_name, index_col=None, coerce_float=True,
1076
1078
to the keyword arguments of :func:`pandas.to_datetime`.
1077
1079
Especially useful with databases without native Datetime support,
1078
1080
such as SQLite
1079
- columns : list
1081
+ columns : list, default: None
1080
1082
List of column names to select from sql table
1081
1083
schema : string, default None
1082
1084
Name of SQL schema in database to query (if database flavor
@@ -1123,18 +1125,18 @@ def read_query(self, sql, index_col=None, coerce_float=True,
1123
1125
----------
1124
1126
sql : string
1125
1127
SQL query to be executed
1126
- index_col : string, optional
1128
+ index_col : string, optional, default: None
1127
1129
Column name to use as index for the returned DataFrame object.
1128
1130
coerce_float : boolean, default True
1129
1131
Attempt to convert values to non-string, non-numeric objects (like
1130
1132
decimal.Decimal) to floating point, useful for SQL result sets
1131
- params : list, tuple or dict, optional
1133
+ params : list, tuple or dict, optional, default: None
1132
1134
List of parameters to pass to execute method. The syntax used
1133
1135
to pass parameters is database driver dependent. Check your
1134
1136
database driver documentation for which of the five syntax styles,
1135
1137
described in PEP 249's paramstyle, is supported.
1136
1138
Eg. for psycopg2, uses %(name)s so use params={'name' : 'value'}
1137
- parse_dates : list or dict
1139
+ parse_dates : list or dict, default: None
1138
1140
- List of column names to parse as dates
1139
1141
- Dict of ``{column_name: format string}`` where format string is
1140
1142
strftime compatible in case of parsing string times or is one of
@@ -1143,6 +1145,9 @@ def read_query(self, sql, index_col=None, coerce_float=True,
1143
1145
to the keyword arguments of :func:`pandas.to_datetime`
1144
1146
Especially useful with databases without native Datetime support,
1145
1147
such as SQLite
1148
+ chunksize : int, default None
1149
+ If specified, return an iterator where `chunksize` is the number
1150
+ of rows to include in each chunk.
1146
1151
1147
1152
Returns
1148
1153
-------
@@ -1650,11 +1655,11 @@ def get_schema(frame, name, flavor='sqlite', keys=None, con=None, dtype=None):
1650
1655
The flavor of SQL to use. Ignored when using SQLAlchemy connectable.
1651
1656
'mysql' is deprecated and will be removed in future versions, but it
1652
1657
will be further supported through SQLAlchemy engines.
1653
- keys : string or sequence
1658
+ keys : string or sequence, default: None
1654
1659
columns to use a primary key
1655
1660
con: an open SQL database connection object or a SQLAlchemy connectable
1656
1661
Using SQLAlchemy makes it possible to use any DB supported by that
1657
- library.
1662
+ library, default: None
1658
1663
If a DBAPI2 object, only sqlite3 is supported.
1659
1664
dtype : dict of column name to SQL type, default None
1660
1665
Optional specifying the datatype for columns. The SQL type should
0 commit comments