pandas 1.4.2

NotesParametersReturnsBackRef
read_sql_query(sql, con, index_col=None, coerce_float: 'bool' = True, params=None, parse_dates=None, chunksize: 'int | None' = None, dtype: 'DtypeArg | None' = None) -> 'DataFrame | Iterator[DataFrame]'

Returns a DataFrame corresponding to the result set of the query string. Optionally provide an :None:None:`index_col` parameter to use one of the columns as the index, otherwise default integer index will be used.

Notes

Any datetime values with time zone information parsed via the :None:None:`parse_dates` parameter will be converted to UTC.

Parameters

sql : str SQL query or SQLAlchemy Selectable (select or text object)

SQL query to be executed.

con : SQLAlchemy connectable, str, or sqlite3 connection

Using SQLAlchemy makes it possible to use any DB supported by that library. If a DBAPI2 object, only sqlite3 is supported.

index_col : str or list of str, optional, default: None

Column(s) to set as index(MultiIndex).

coerce_float : bool, default True

Attempts to convert values of non-string, non-numeric objects (like decimal.Decimal) to floating point. Useful for SQL result sets.

params : list, tuple or dict, optional, default: None

List of parameters to pass to execute method. The syntax used to pass parameters is database driver dependent. Check your database driver documentation for which of the five syntax styles, described in PEP 249's paramstyle, is supported. Eg. for psycopg2, uses %(name)s so use params={'name' : 'value'}.

parse_dates : list or dict, default: None
  • List of column names to parse as dates.

  • Dict of {column_name: format string} where format string is strftime compatible in case of parsing string times, or is one of (D, s, ns, ms, us) in case of parsing integer timestamps.

  • Dict of {column_name: arg dict} , where the arg dict corresponds to the keyword arguments of pandas.to_datetime Especially useful with databases without native Datetime support, such as SQLite.

chunksize : int, default None

If specified, return an iterator where :None:None:`chunksize` is the number of rows to include in each chunk.

dtype : Type name or dict of columns

Data type for data or columns. E.g. np.float64 or {‘a’: np.float64, ‘b’: np.int32, ‘c’: ‘Int64’}.

versionadded

Returns

DataFrame or Iterator[DataFrame]

Read SQL query into a DataFrame.

See Also

read_sql

Read SQL query or database table into a DataFrame.

read_sql_table

Read SQL database table into a DataFrame.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

pandas.io.sql.read_sql pandas.io.sql.read_sql_table

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/io/sql.py#331
type: <class 'function'>
Commit: