SQLModel 项目教程
1. 项目的目录结构及介绍
SQLModel 项目的目录结构如下:
sqlmodel/
├── examples/
│ ├── basic/
│ ├── fastapi/
│ ├── mixins/
│ └── tutorial/
├── sqlmodel/
│ ├── __init__.py
│ ├── main.py
│ ├── models.py
│ └── utils.py
├── tests/
│ ├── __init__.py
│ ├── test_main.py
│ └── test_models.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py
目录结构介绍
examples/
: 包含多个示例项目,展示如何使用 SQLModel。basic/
: 基础示例。fastapi/
: 结合 FastAPI 的示例。mixins/
: 使用 mixins 的示例。tutorial/
: 教程示例。
sqlmodel/
: 核心代码目录。__init__.py
: 初始化文件。main.py
: 主程序文件。models.py
: 数据模型定义文件。utils.py
: 工具函数文件。
tests/
: 测试代码目录。__init__.py
: 初始化文件。test_main.py
: 主程序测试文件。test_models.py
: 数据模型测试文件。
.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证。README.md
: 项目说明文档。requirements.txt
: 项目依赖文件。setup.py
: 项目安装文件。
2. 项目的启动文件介绍
项目的启动文件是 sqlmodel/main.py
。该文件包含了项目的入口点,负责启动应用程序。
main.py
文件内容
from fastapi import FastAPI
from sqlmodel import SQLModel, create_engine, Session
# 数据库 URL
SQLALCHEMY_DATABASE_URL = "sqlite:///example.db"
# 创建数据库引擎
engine = create_engine(SQLALCHEMY_DATABASE_URL)
# 创建 FastAPI 应用
app = FastAPI()
# 初始化数据库
@app.on_event("startup")
def on_startup():
SQLModel.metadata.create_all(engine)
# 示例路由
@app.get("/")
def read_root():
return {"message": "Hello World"}
启动文件介绍
from fastapi import FastAPI
: 导入 FastAPI 框架。from sqlmodel import SQLModel, create_engine, Session
: 导入 SQLModel 相关模块。SQLALCHEMY_DATABASE_URL
: 定义数据库 URL。engine = create_engine(SQLALCHEMY_DATABASE_URL)
: 创建数据库引擎。app = FastAPI()
: 创建 FastAPI 应用实例。@app.on_event("startup")
: 定义启动事件,初始化数据库。@app.get("/")
: 定义示例路由。
3. 项目的配置文件介绍
项目的配置文件主要是 requirements.txt
和 setup.py
。
requirements.txt
文件内容
fastapi
sqlmodel
uvicorn
requirements.txt
文件介绍
fastapi
: FastAPI 框架依赖。sqlmodel
: SQLModel 库依赖。uvicorn
: ASGI 服务器依赖。
setup.py
文件内容
from setuptools import setup, find_packages
setup(
name="sqlmodel",
version="0.1.0",
packages=find_packages(),
install_requires=[
"fastapi",
"sqlmodel",
"uvicorn",
],
entry_points={
"console_scripts": [
"sqlmodel=sqlmodel.main:app",
],
},
)
setup.py
文件介绍
name
: 项目名称。version
: 项目版本。packages
: 自动查找项目