diff --git a/README.md b/README.md index f5864de908..39c6a9f3e6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@
SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
++ 简体中文 | English +
+ SQLModel,专为简洁、高兼容性与高稳健性设计的 Python SQL 数据库交互库。
+
+ 简体中文 | English
+
diff --git a/README.zh.md b/README.zh.md
new file mode 100644
index 0000000000..86818e5157
--- /dev/null
+++ b/README.zh.md
@@ -0,0 +1,220 @@
+
+
+
+
+
+## FastAPI 中的 SQL 数据库支持
+
+
+
+**SQLModel** 专为简化 [FastAPI](https://fastapi.tiangolo.com) 应用中与 SQL 数据库的交互而打造,两者出自同一[作者](https://tiangolo.com/)之手。😁
+
+它将 SQLAlchemy 与 Pydantic 融为一体,最大程度精简业务代码,使**代码冗余降至最低**,同时提供**极致的开发者体验**。
+
+事实上,**SQLModel** 是位于 **Pydantic** 与 **SQLAlchemy** 之上的精简抽象层,经过严谨设计以确保与两者的深度无缝兼容。
+
+## 环境要求
+
+需要受官方支持的较新 [Python 版本](https://www.python.org/downloads/)。
+
+由于 **SQLModel** 基于 **Pydantic** 和 **SQLAlchemy** 构建,因此需要这两个核心依赖项。在安装 SQLModel 时它们将被自动解析并安装。
+
+## 安装指南
+
+首先[安装 `uv`](https://docs.astral.sh/uv/getting-started/installation/),然后在项目中引入 SQLModel:
+
+
+
+以及**代码行内错误提示**:
+
+
+
+### 5. 数据持久化写入数据库
+
+通过阅读完整的**官方教程**可深入掌握 **SQLModel** 的各项高级功能;若想快速了解如何将上述模型整合并写入数据库,可参考以下代码:
+
+```Python hl_lines="16 19 21-25"
+from sqlmodel import Field, Session, SQLModel, create_engine
+
+
+class Hero(SQLModel, table=True):
+ id: int | None = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: int | None = None
+
+
+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)
+
+
+engine = create_engine("sqlite:///database.db")
+
+
+SQLModel.metadata.create_all(engine)
+
+with Session(engine) as session:
+ session.add(hero_1)
+ session.add(hero_2)
+ session.add(hero_3)
+ session.commit()
+```
+
+上述代码将在本地生成一个持久化保存有 3 位英雄记录的 **SQLite** 数据库文件。
+
+### 6. 从数据库中查询数据
+
+随后可编写查询语句从该数据库中检索数据,例如:
+
+```Python hl_lines="13-17"
+from sqlmodel import Field, Session, SQLModel, create_engine, select
+
+
+class Hero(SQLModel, table=True):
+ id: int | None = Field(default=None, primary_key=True)
+ name: str
+ secret_name: str
+ age: int | None = None
+
+
+engine = create_engine("sqlite:///database.db")
+
+with Session(engine) as session:
+ statement = select(Hero).where(Hero.name == "Spider-Boy")
+ hero = session.exec(statement).first()
+ print(hero)
+```
+
+### 7. 全流程的类型与自动补全支持
+
+**SQLModel** 经过深度打磨,**即使在从数据库执行查询提取数据后**,也能始终提供完整的类型推导与编辑器自动补全:
+
+
+
+## 深度整合 SQLAlchemy 与 Pydantic
+
+上述 `Hero` 类是一个 **SQLModel** 模型。
+
+但与此同时,✨ 它本身就是一个标准的 **SQLAlchemy** 模型 ✨。因此,可以将其与其他原生的 SQLAlchemy 模型自由混用与组合,或将现有的 SQLAlchemy 应用平滑迁移至 **SQLModel**。
+
+此外,✨ 它同时也是一个原生的 **Pydantic** 模型 ✨。可以通过类继承机制定义所有的**数据传输对象(DTO)模型**,完全杜绝重复代码。这使得与 **FastAPI** 的集成变得异常轻巧自然。
+
+## 许可证 (License)
+
+本项目遵循 [MIT 许可证](https://github.com/fastapi/sqlmodel/blob/main/LICENSE)条款授权发布。