SQLModel 教程：使用 select 语句查询数据-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00931/article/details/148376233

SQLModel 教程：使用 select 语句查询数据

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

前言

SQLModel 是一个强大的 Python ORM 工具，它结合了 SQLAlchemy 和 Pydantic 的优点，为开发者提供了简单直观的数据模型定义和数据库操作方式。本文将重点介绍如何使用 SQLModel 的 select 语句进行数据查询操作。

数据模型定义

首先我们需要定义一个 Hero 数据模型，这个模型将映射到数据库中的表：

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

这个模型定义了四个字段：

id: 主键，自动生成
name: 英雄名称，字符串类型
secret_name: 秘密身份，字符串类型
age: 年龄，可选字段

数据库连接设置

我们使用 SQLite 作为示例数据库：

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

echo=True 参数会在控制台输出执行的 SQL 语句，便于调试。

创建数据库和表

def create_db_and_tables():
    SQLModel.metadata.create_all(engine)

这个方法会创建数据库文件（如果不存在）并根据模型定义创建对应的表结构。

插入测试数据

def create_heroes():
    hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
    hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
    hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)

    with Session(engine) as session:
        session.add(hero_1)
        session.add(hero_2)
        session.add(hero_3)
        session.commit()

我们创建了三个英雄实例并通过 session 添加到数据库中。

使用 select 查询数据

核心的查询方法如下：

def select_heroes():
    with Session(engine) as session:
        statement = select(Hero)
        results = session.exec(statement)
        heroes = results.all()
        print(heroes)

这里有几个关键点：

select(Hero) 创建了一个查询语句，表示我们要查询 Hero 表的所有记录
session.exec(statement) 执行查询语句
results.all() 获取所有结果

执行流程

def main():
    create_db_and_tables()
    create_heroes()
    select_heroes()

完整的执行流程：

创建数据库和表结构
插入测试数据
查询并打印所有英雄数据

查询结果分析

执行上述代码后，控制台会输出类似以下内容：

[Hero(id=1, name='Deadpond', secret_name='Dive Wilson', age=None), 
 Hero(id=2, name='Spider-Boy', secret_name='Pedro Parqueador', age=None), 
 Hero(id=3, name='Rusty-Man', secret_name='Tommy Sharp', age=48)]

这是查询到的所有英雄对象的列表表示，每个对象都包含我们在模型中定义的字段。