在 SQLAlchemy 中,server_default, default, 和 default_factory 都是用来为数据库表的字段指定默认值的选项,但它们各自的工作方式和适用场景有所不同:
- server_default:
- server_default 用于在数据库层面设置默认值。
- 它是一个 SQL 表达式,例如 func.now()(在 PostgreSQL 中为当前时间)或一个常量值。
- 当新记录插入到数据库中且没有为该字段提供值时,将使用 server_default 指定的值。
- 这个默认值是在数据库端计算的,而不是在 Python 应用程序端。
- default:
- default 是 SQLAlchemy 在 Python 端设置默认值的方式。
- 它可以是一个值或一个返回值的函数。
- 当新记录被添加到会话中,且没有为该字段提供值时,将使用 default 提供的值。
- 这个默认值是在 Python 应用程序端计算的,而不是在数据库端。
- default_factory:
- default_factory 是 SQLAlchemy 2.0 中引入的新特性。
- 它接受一个无参数的可调用对象,每次需要默认值时都会调用这个对象。
- default_factory 适用于那些需要动态生成默认值的情况,例如使用 Python 的日期时间函数或其他动态值。
- 这个默认值是在 Python 应用程序端计算的,而不是在数据库端。
代码示例
class MyModel(Base):
__tablename__ = "my_model"
__table_args__ = ({'comment': '测试表'})
# 使用 default 参数
# 这里 default 设置为一个固定的字符串值
avatar: Mapped[str] = mapped_column(String(500), default="https://image.kinit.top/1.jpg")
# 使用 default 参数,但这次是一个函数
# 这个函数在每次插入记录时调用,生成当前的时间戳
timestamp = Mapped[int] = mapped_column(default=datetime.now())
# 使用 server_default 设置当前时间为默认值
create_datetime: Mapped[datetime] = mapped_column(server_default=func.now())
# 使用 default_factory 动态生成一个默认值
iso_time: Mapped[str] = mapped_column(default_factory=lambda: f"iso_time_{datetime.now().isoformat()}")
总结来说,server_default 是在数据库层面设置默认值,适用于数据库支持的默认值表达式;default 是在 Python 层面设置默认值,适用于简单的值或需要应用程序逻辑来生成默认值的情况;而 default_factory 是一个更灵活的 Python 端选项,适用于需要动态生成默认值的场景。