pandas.Series.to_sql

Series.to_sql(name, con, *, schema=None, if_exists='fail', index=True, index_label=None, chunksize=None, dtype=None, method=None)

将存储在 DataFrame 中的记录写入 SQL 数据库。

SQLAlchemy [1] 支持的数据库都受支持。表可以新建、追加或覆盖。

Parameters:

namestr

SQL 表的名称。

consqlalchemy.engine.(Engine or Connection) 或 sqlite3.Connection

使用 SQLAlchemy 可以使用该库支持的任何 DB。为 sqlite3.Connection 对象提供旧版支持。用户负责 SQLAlchemy connectable 的引擎处置和连接关闭。请参阅 here 。如果传递一个已处于事务中的 sqlalchemy.engine.Connection，则不会提交该事务。如果传递一个 sqlite3.Connection，将无法回滚记录插入。

schemabool, default False

指定 schema（如果数据库类型支持此功能）。如果为 None，则使用默认 schema。

if_exists{‘fail’, ‘replace’, ‘append’}，默认为 ‘fail’

如果表已存在时的行为。

• fail：引发 ValueError。

• replace：在插入新值之前删除表。

• append：将新值插入现有表中。

indexbool, default True

将 DataFrame 索引写为一个列。使用 index_label 作为表中的列名。为该列创建表索引。

index_labelstr 或 sequence，默认为 None

索引列的列标签。如果给出 None（默认值）并且 index 为 True，则使用索引名称。如果 DataFrame 使用 MultiIndex，则应给出 sequence。

chunksizeint, optional

指定一次写入的每批行数。默认情况下，所有行将被一次性写入。

dtypedict 或 scalar，可选

指定列的数据类型。如果使用字典，键应为列名，值应为 SQLAlchemy 类型或 sqlite3 旧版模式的字符串。如果提供 scalar，则将其应用于所有列。

<strong>method</strong>{None, ‘multi’, callable}，可选

控制使用的 SQL 插入子句：

• None：使用标准的 SQL INSERT 子句（每行一个）。

• ‘multi’：在一个 INSERT 子句中传递多个值。

• 具有签名 (pd_table, conn, keys, data_iter) 的 callable。

详细信息和可调用的示例实现可以在 insert method 部分找到。

Returns:

None 或 int

to_sql 影响的行数。如果 method 中传递的 callable 未返回整数行数，则返回 None。

返回的受影响行数是 sqlite3.Cursor 或 SQLAlchemy connectable 的 rowcount 属性的总和，这可能不反映实际写入的行数，如 sqlite3 或 SQLAlchemy 中所述。

在 1.4.0 版本加入.

Raises:

ValueError

当表已存在且 if_exists 为 ‘fail’（默认值）时。

参见

read_sql

从表中读取 DataFrame。

Notes

如果数据库支持，时区感知的 datetime 列将作为 Timestamp with timezone 类型写入 SQLAlchemy。否则，datetime 将以原始时区的时区无关时间戳形式存储。

并非所有数据存储都支持 method="multi"。例如，Oracle 不支持多值插入。

参考文献

[1]

https://docs.sqlalchemy.org

[2]

https://www.python.org/dev/peps/pep-0249/

Examples

创建一个内存中的 SQLite 数据库。

>>> from sqlalchemy import create_engine
>>> engine = create_engine('sqlite://', echo=False)

从头开始创建一个包含 3 行的表。

>>> df = pd.DataFrame({'name' : ['User 1', 'User 2', 'User 3']})
>>> df
     name
0  User 1
1  User 2
2  User 3

>>> df.to_sql(name='users', con=engine)
3
>>> from sqlalchemy import text
>>> with engine.connect() as conn:
...    conn.execute(text("SELECT * FROM users")).fetchall()
[(0, 'User 1'), (1, 'User 2'), (2, 'User 3')]

也可以将 sqlalchemy.engine.Connection 传递给 con：

>>> with engine.begin() as connection:
...     df1 = pd.DataFrame({'name' : ['User 4', 'User 5']})
...     df1.to_sql(name='users', con=connection, if_exists='append')
2

允许支持需要对整个操作使用相同 DBAPI 连接的操作。

>>> df2 = pd.DataFrame({'name' : ['User 6', 'User 7']})
>>> df2.to_sql(name='users', con=engine, if_exists='append')
2
>>> with engine.connect() as conn:
...    conn.execute(text("SELECT * FROM users")).fetchall()
[(0, 'User 1'), (1, 'User 2'), (2, 'User 3'),
 (0, 'User 4'), (1, 'User 5'), (0, 'User 6'),
 (1, 'User 7')]

仅使用 df2 覆盖表。

>>> df2.to_sql(name='users', con=engine, if_exists='replace',
...            index_label='id')
2
>>> with engine.connect() as conn:
...    conn.execute(text("SELECT * FROM users")).fetchall()
[(0, 'User 6'), (1, 'User 7')]

如果 PostgreSQL 数据库中的表发生主键冲突，请使用 method 定义一个可调用函数，使其不执行任何操作。

>>> from sqlalchemy.dialects.postgresql import insert
>>> def insert_on_conflict_nothing(table, conn, keys, data_iter):
...     # "a" is the primary key in "conflict_table"
...     data = [dict(zip(keys, row)) for row in data_iter]
...     stmt = insert(table.table).values(data).on_conflict_do_nothing(index_elements=["a"])
...     result = conn.execute(stmt)
...     return result.rowcount
>>> df_conflict.to_sql(name="conflict_table", con=conn, if_exists="append", method=insert_on_conflict_nothing)  
0

对于 MySQL，如果主键发生冲突，则调用一个函数来更新列 b 和 c。

>>> from sqlalchemy.dialects.mysql import insert
>>> def insert_on_conflict_update(table, conn, keys, data_iter):
...     # update columns "b" and "c" on primary key conflict
...     data = [dict(zip(keys, row)) for row in data_iter]
...     stmt = (
...         insert(table.table)
...         .values(data)
...     )
...     stmt = stmt.on_duplicate_key_update(b=stmt.inserted.b, c=stmt.inserted.c)
...     result = conn.execute(stmt)
...     return result.rowcount
>>> df_conflict.to_sql(name="conflict_table", con=conn, if_exists="append", method=insert_on_conflict_update)  
2

指定 dtype（对于带有缺失值的整数尤其有用）。请注意，虽然 pandas 被强制以浮点数形式存储数据，但数据库支持可为空的整数。在 Python 中获取数据时，我们会得到整数标量。

>>> df = pd.DataFrame({"A": [1, None, 2]})
>>> df
     A
0  1.0
1  NaN
2  2.0

>>> from sqlalchemy.types import Integer
>>> df.to_sql(name='integers', con=engine, index=False,
...           dtype={"A": Integer()})
3

>>> with engine.connect() as conn:
...   conn.execute(text("SELECT * FROM integers")).fetchall()
[(1,), (None,), (2,)]