pandas 1.4.2

NotesParametersReturnsBackRef
read_sql_table(table_name: 'str', con, schema: 'str | None' = None, index_col: 'str | Sequence[str] | None' = None, coerce_float: 'bool' = True, parse_dates=None, columns=None, chunksize: 'int | None' = None) -> 'DataFrame | Iterator[DataFrame]'

Given a table name and a SQLAlchemy connectable, returns a DataFrame. This function does not support DBAPI connections.

Notes

Any datetime values with time zone information will be converted to UTC.

Parameters

table_name : str

Name of SQL table in database.

con : SQLAlchemy connectable or str

A database URI could be provided as str. SQLite DBAPI connection mode not supported.

schema : str, default None

Name of SQL schema in database to query (if database flavor supports this). Uses default schema if None (default).

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. Can result in loss of Precision.

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.

columns : list, default None

List of column names to select from SQL table.

chunksize : int, default None

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

Returns

DataFrame or Iterator[DataFrame]

A SQL table is returned as two-dimensional data structure with labeled axes.

Read SQL database table into a DataFrame.

See Also

read_sql

Read SQL query or database table into a DataFrame.

read_sql_query

Read SQL query into a DataFrame.

Examples

This example is valid syntax, but we were not able to check execution
>>> pd.read_sql_table('table_name', 'postgres:///db_name')  # doctest:+SKIP
See :

Back References

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

pandas.io.sql.SQLDatabase.read_table pandas.io.sql.SQLDatabase.read_query pandas.io.sql.read_sql_query pandas.io.sql.read_sql

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#219
type: <class 'function'>
Commit: