to_sql(self, frame, name, if_exists='fail', index=True, index_label=None, schema=None, chunksize=None, dtype: 'DtypeArg | None' = None, method=None, engine='auto', **engine_kwargs) -> 'int | None'

Parameters

frame : DataFrame

name : string

Name of SQL table.

if_exists : {'fail', 'replace', 'append'}, default 'fail'

• fail: If table exists, do nothing.

• replace: If table exists, drop it, recreate it, and insert data.

• append: If table exists, insert data. Create if does not exist.

index : boolean, default True

Write DataFrame index as a column.

index_label : string or sequence, default None

Column label for index column(s). If None is given (default) and :None:None:`index` is True, then the index names are used. A sequence should be given if the DataFrame uses MultiIndex.

schema : string, default None

Name of SQL schema in database to write to (if database flavor supports this). If specified, this overwrites the default schema of the SQLDatabase object.

chunksize : int, default None

If not None, then rows will be written in batches of this size at a time. If None, all rows will be written at once.

dtype : single type or dict of column name to SQL type, default None

Optional specifying the datatype for columns. The SQL type should be a SQLAlchemy type. If all columns are of the same type, one single value can be used.

method : {None', 'multi', callable}, default None

Controls the SQL insertion clause used:

engine : {'auto', 'sqlalchemy'}, default 'auto'

SQL engine library to use. If 'auto', then the option io.sql.engine is used. The default io.sql.engine behavior is 'sqlalchemy'

versionadded

**engine_kwargs :

Any additional kwargs are passed to the engine.

Write records stored in a DataFrame to a SQL database.

Examples

See :

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