更新readme:数据迁移和生成CRUD,路由配置

This commit is contained in:
zhusr39924 2024-07-03 10:41:54 +08:00
parent 5af56e956c
commit afe3b042d9

View File

@ -18,45 +18,45 @@ Typer 官方文档https://typer.tiangolo.com/
SQLAlchemy 2.0 (官方): https://docs.sqlalchemy.org/en/20/intro.html#installation
SQLAlchemy 1.4 迁移到 2.0
官方https://docs.sqlalchemy.org/en/20/changelog/whatsnew_20.html#whatsnew-20-orm-declarative-typing
SQLAlchemy 1.4 迁移到 2.0 官方https://docs.sqlalchemy.org/en/20/changelog/whatsnew_20.html#whatsnew-20-orm-declarative-typing
PEP 484 语法官方https://peps.python.org/pep-0484/
## 项目结构
使用的是仿照 Django 项目结构:
- alembic数据库迁移配置目录
- versions_dev开发环境数据库迁移文件目录
- versions_pro生产环境数据库迁移文件目录
- env.py映射类配置文件
- versions_dev开发环境数据库迁移文件目录
- versions_pro生产环境数据库迁移文件目录
- env.py映射类配置文件
- application主项目配置目录也存放了主路由文件
- config基础环境配置文件
- development.py开发环境
- production.py生产环境
- settings.py主项目配置文件
- urls.py主路由文件
- config基础环境配置文件
- development.py开发环境
- production.py生产环境
- settings.py主项目配置文件
- urls.py主路由文件
- apps项目的app存放目录
- vadmin基础服务
- auth用户 - 角色 - 菜单接口服务
- modelsORM 模型目录
- params查询参数依赖项目录
- schemaspydantic 模型,用于数据库序列化操作目录
- utils登录认证功能接口服务
- curd.py数据库操作
- views.py视图函数
- vadmin基础服务
- auth用户 - 角色 - 菜单接口服务
- modelsORM 模型目录
- params查询参数依赖项目录
- schemaspydantic 模型,用于数据库序列化操作目录
- utils登录认证功能接口服务
- curd.py数据库操作
- views.py视图函数
- core核心文件目录
- crud.py关系型数据库操作核心封装
- database.py关系型数据库核心配置
- data_types.py自定义数据类型
- exception.py异常处理
- logger日志处理核心配置
- middleware.py中间件核心配置
- dependencies.py常用依赖项
- event.py全局事件
- mongo_manage.pymongodb 数据库操作核心封装
- validator.pypydantic 模型重用验证器
- crud.py关系型数据库操作核心封装
- database.py关系型数据库核心配置
- data_types.py自定义数据类型
- exception.py异常处理
- logger日志处理核心配置
- middleware.py中间件核心配置
- dependencies.py常用依赖项
- event.py全局事件
- mongo_manage.pymongodb 数据库操作核心封装
- validator.pypydantic 模型重用验证器
- dbORM模型基类
- logs日志目录
- static静态资源存放目录
@ -133,7 +133,6 @@ http://127.0.0.1:9000/docs
```
Git更新ignore文件直接修改gitignore是不会生效的需要先去掉已经托管的文件修改完成之后再重新添加并提交。
```
第一步:
git rm -r --cached .
@ -148,11 +147,9 @@ git commit -m "clear cached"
```
## 新的数据迁移
执行数据库迁移命令(终端执行)
- 新建模型:
- 在你的app目录下新建一个models目录__init__.py导入你需要迁移的models
- 在你的app目录下新建一个models目录__init__.py导入你需要迁移的models
```python
# app/.../your_app/models/__init__.py
from .your_model import YourModel,YourModel2
@ -242,36 +239,36 @@ urlpatterns = [
# 日期查询
# 值的类型str
# 值得格式:%Y-%m-%d2023-05-14
字段名称 = ("date", 值)
字段名称=("date", 值)
# 模糊查询
# 值的类型: str
字段名称 = ("like", 值)
字段名称=("like", 值)
# in 查询
# 值的类型list
字段名称 = ("in", 值)
字段名称=("in", 值)
# 时间区间查询
# 值的类型tuple 或者 list
字段名称 = ("between", 值)
字段名称=("between", 值)
# 月份查询
# 值的类型str
# 值的格式:%Y-%m2023-05
字段名称 = ("month", 值)
字段名称=("month", 值)
# 不等于查询
字段名称 = ("!=", 值)
字段名称=("!=", 值)
# 大于查询
字段名称 = (">", 值)
字段名称=(">", 值)
# 等于 None
字段名称 = ("None")
字段名称=("None")
# 不等于 None
字段名称 = ("not None")
字段名称=("not None")
```
代码部分:
@ -325,15 +322,15 @@ def __dict_filter(self, **kwargs) -> list[BinaryExpression]:
查询所有用户id为1或2或 4或6并且email不为空并且名称包括李
```python
users = UserDal(db).get_datas(limit=0, id=("in", [1, 2, 4, 6]), email=("not None",), name=("like", "李"))
users = UserDal(db).get_datas(limit=0, id=("in", [1,2,4,6]), email=("not None", ), name=("like", "李"))
# limit=0表示返回所有结果数据
# 这里的 get_datas 默认返回的是 pydantic 模型数据
# 如果需要返回用户对象列表,使用如下语句:
users = UserDal(db).get_datas(
limit=0,
id=("in", [1, 2, 4, 6]),
email=("not None",),
id=("in", [1,2,4,6]),
email=("not None", ),
name=("like", "李"),
v_return_objs=True
)
@ -344,7 +341,7 @@ users = UserDal(db).get_datas(
查询第一页,每页两条数据,并返回总数,同样可以通过 `get_datas` 实现原始查询方式:
```python
v_where = [VadminUser.id.in_([1, 2, 4, 6]), VadminUser.email.isnot(None), VadminUser.name.like(f"%李%")]
v_where = [VadminUser.id.in_([1,2,4,6]), VadminUser.email.isnot(None), VadminUser.name.like(f"%李%")]
users, count = UserDal(db).get_datas(limit=2, v_where=v_where, v_return_count=True)
# 这里的 get_datas 默认返回的是 pydantic 模型数据
@ -353,7 +350,7 @@ users, count = UserDal(db).get_datas(
limit=2,
v_where=v_where,
v_return_count=True
v_return_objs = True
v_return_objs=True
)
```