SQLModel 教程：创建数据库和表的完整指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00071/article/details/148376056

SQLModel 教程：创建数据库和表的完整指南

sqlmodel SQL databases in Python, designed for simplicity, compatibility, and robustness. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlmodel

什么是 SQLModel

SQLModel 是一个基于 Python 类型注解的 ORM（对象关系映射）库，它结合了 SQLAlchemy 和 Pydantic 的优势，为开发者提供了简洁而强大的数据库操作接口。通过 SQLModel，我们可以用 Python 类来定义数据库表结构，同时享受类型检查和自动完成等现代 Python 开发特性。

基础模型定义

在 SQLModel 中，我们通过继承 SQLModel 类来定义数据模型。下面是一个定义英雄(Hero)模型的示例：

from typing import Optional
from sqlmodel import Field, SQLModel

class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str
    secret_name: str
    age: Optional[int] = None

这段代码定义了一个 Hero 类，对应数据库中的 hero 表。关键点解析：

table=True 参数告诉 SQLModel 这个类应该映射到数据库表
每个类属性对应表中的一列，类型注解定义了列的数据类型
Field 用于指定额外的列属性，如主键、默认值等
Optional 表示该字段可以为空

数据库连接配置

定义好模型后，我们需要配置数据库连接。SQLModel 使用 SQLAlchemy 的引擎系统来处理数据库连接：

sqlite_file_name = "database.db"
sqlite_url = f"sqlite:///{sqlite_file_name}"
engine = create_engine(sqlite_url, echo=True)

这里我们使用了 SQLite 数据库，echo=True 参数会在控制台输出执行的 SQL 语句，非常适合开发和调试阶段使用。

创建数据库表

有了模型和引擎后，创建表非常简单：

SQLModel.metadata.create_all(engine)

这行代码会检查所有继承自 SQLModel 且设置了 table=True 的类，并在数据库中创建对应的表。如果表已存在，则不会重复创建。

深入理解模型定义

让我们更详细地看看 Hero 模型的各个部分：

主键字段：id 字段被标记为主键，primary_key=True 表示这是表的主键列。使用 Optional[int] 表示它可以为 None，因为主键通常由数据库自动生成。
必填字段：name 和 secret_name 都是 str 类型，没有设置为 Optional，表示这些字段在创建记录时必须提供值。
可选字段：age 被定义为 Optional[int] 且默认值为 None，表示这个字段是可选的，创建记录时可以不提供。

实际应用建议

开发环境：在开发阶段保持 echo=True 可以方便调试，但在生产环境应该关闭以减少日志输出。
数据库选择：虽然示例使用了 SQLite，但 SQLModel 支持所有 SQLAlchemy 支持的数据库，只需更改连接字符串即可切换到 PostgreSQL、MySQL 等。
模型设计：良好的模型设计是应用的基础，建议在定义模型前仔细规划表结构和关系。
迁移工具：对于生产环境，考虑使用 Alembic 等迁移工具来管理数据库结构变更。