Skip to content

Commit 1226203

Browse files
committed
Fix incorrect usage in documentation
1 parent e614186 commit 1226203

File tree

6 files changed

+51
-44
lines changed

6 files changed

+51
-44
lines changed

docs/advanced/filter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,17 +321,17 @@ class UserRole(Base):
321321

322322
```python
323323
# 创建复合主键记录
324-
user_role_data = {"user_id": 1, "role_id": 2, "assigned_at": datetime.now()}
324+
user_role_data = UserRoleCreate(user_id=1, role_id=2, assigned_at=datetime.now())
325325
user_role = await user_role_crud.create_model(session, user_role_data)
326326

327327
# 查询复合主键记录
328328
user_role = await user_role_crud.select_model(session, pk=(1, 2))
329329

330330
# 更新复合主键记录
331-
updated_user_role = await user_role_crud.update_model(
331+
updated_count = await user_role_crud.update_model(
332332
session,
333333
pk=(1, 2),
334-
obj_in={"assigned_at": datetime.now()}
334+
obj={"assigned_at": datetime.now()}
335335
)
336336

337337
# 删除复合主键记录

docs/api/errors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ except ModelColumnError as e:
6666
from sqlalchemy_crud_plus.errors import MultipleResultsFoundError
6767

6868
try:
69-
user = await user_crud.update_model_by_column(
69+
count = await user_crud.update_model_by_column(
7070
session,
71-
obj_in={"name": "新名称"},
71+
obj={"name": "新名称"},
7272
name__like='%张%' # 可能匹配多条记录
7373
)
7474
except MultipleResultsFoundError as e:

docs/getting-started/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ post_crud = CRUDPlus(Post)
5959

6060
```python
6161
# 创建单个用户
62-
user_data = {"name": "张三", "email": "zhangsan@example.com"}
62+
user_data = UserCreate(name="张三", email="zhangsan@example.com")
6363
user = await user_crud.create_model(session, user_data)
6464

6565
# 批量创建
6666
users_data = [
67-
{"name": "李四", "email": "lisi@example.com"},
68-
{"name": "王五", "email": "wangwu@example.com"}
67+
UserCreate(name="李四", email="lisi@example.com"),
68+
UserCreate(name="王五", email="wangwu@example.com")
6969
]
7070
users = await user_crud.create_models(session, users_data)
7171
```

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ crud_user = CRUDPlus(User)
4545

4646
# 基础 CRUD 操作
4747
user = await crud_user.create_model(session, user_data)
48-
user = await crud_user.select_model(session, user_id=1)
49-
await crud_user.update_model(session, user_id=1, update_data)
50-
await crud_user.delete_model(session, user_id=1)
48+
user = await crud_user.select_model(session, pk=1)
49+
await crud_user.update_model(session, pk=1, obj=update_data)
50+
await crud_user.delete_model(session, pk=1)
5151
```
5252

5353
### 关系查询
@@ -56,7 +56,7 @@ await crud_user.delete_model(session, user_id=1)
5656
# 预加载关系
5757
user = await crud_user.select_model(
5858
session,
59-
user_id=1,
59+
pk=1,
6060
load_strategies=['posts', 'profile']
6161
)
6262

docs/relationships/overview.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ from sqlalchemy.orm import selectinload, joinedload
1919

2020
# 使用原生 SQLAlchemy 选项
2121
user = await user_crud.select_model(
22-
session, user_id,
22+
session,
23+
pk=user_id,
2324
load_options=[
2425
selectinload(User.posts),
2526
joinedload(User.profile)
@@ -28,7 +29,8 @@ user = await user_crud.select_model(
2829

2930
# 嵌套关系
3031
user = await user_crud.select_model(
31-
session, user_id,
32+
session,
33+
pk=user_id,
3234
load_options=[
3335
selectinload(User.posts).selectinload(Post.comments),
3436
joinedload(User.profile)
@@ -43,13 +45,15 @@ user = await user_crud.select_model(
4345
```python
4446
# 列表格式(使用默认策略)
4547
user = await user_crud.select_model(
46-
session, user_id,
48+
session,
49+
pk=user_id,
4750
load_strategies=['posts', 'profile']
4851
)
4952

5053
# 字典格式(指定具体策略)
5154
user = await user_crud.select_model(
52-
session, user_id,
55+
session,
56+
pk=user_id,
5357
load_strategies={
5458
'posts': 'selectinload',
5559
'profile': 'joinedload',
@@ -59,7 +63,8 @@ user = await user_crud.select_model(
5963

6064
# 嵌套关系
6165
user = await user_crud.select_model(
62-
session, user_id,
66+
session,
67+
pk=user_id,
6368
load_strategies={
6469
'posts': 'selectinload',
6570
'posts.category': 'joinedload',
@@ -106,13 +111,15 @@ users = await user_crud.select_models(
106111
```python
107112
# 用户的多篇文章
108113
user = await user_crud.select_model(
109-
session, user_id,
114+
session,
115+
pk=user_id,
110116
load_strategies={'posts': 'selectinload'}
111117
)
112118

113119
# 文章的多条评论
114120
post = await post_crud.select_model(
115-
session, post_id,
121+
session,
122+
pk=user_id,
116123
load_strategies={'comments': 'selectinload'}
117124
)
118125
```
@@ -130,13 +137,15 @@ post = await post_crud.select_model(
130137
```python
131138
# 用户的个人资料
132139
user = await user_crud.select_model(
133-
session, user_id,
140+
session,
141+
pk=user_id,
134142
load_strategies={'profile': 'joinedload'}
135143
)
136144

137145
# 文章的分类
138146
post = await post_crud.select_model(
139-
session, post_id,
147+
session,
148+
pk=user_id,
140149
load_strategies={'category': 'joinedload'}
141150
)
142151
```
@@ -154,13 +163,15 @@ post = await post_crud.select_model(
154163
```python
155164
# 用户的多个角色
156165
user = await user_crud.select_model(
157-
session, user_id,
166+
session,
167+
pk=user_id,
158168
load_strategies={'roles': 'subqueryload'}
159169
)
160170

161171
# 文章的多个标签
162172
post = await post_crud.select_model(
163-
session, post_id,
173+
session,
174+
pk=user_id,
164175
load_strategies={'tags': 'subqueryload'}
165176
)
166177
```
@@ -191,13 +202,15 @@ users = await user_crud.select_models(
191202
```python
192203
# 禁止访问关系(抛出异常)
193204
user = await user_crud.select_model(
194-
session, user_id,
205+
session,
206+
pk=user_id,
195207
load_strategies={'posts': 'raiseload'}
196208
)
197209

198210
# 禁止加载关系(返回 None)
199211
user = await user_crud.select_model(
200-
session, user_id,
212+
session,
213+
pk=user_id,
201214
load_strategies={'posts': 'noload'}
202215
)
203216
```

docs/usage/crud.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,19 @@ SQLAlchemy CRUD Plus 提供完整的 CRUD(创建、读取、更新、删除)
77
### 单条记录
88

99
```python
10-
# 基础创建
11-
user_data = {"name": "张三", "email": "zhangsan@example.com"}
12-
user = await user_crud.create_model(session, user_data)
13-
14-
# 使用 Pydantic 模型
10+
# 使用 Pydantic 模型创建
1511
user_data = UserCreate(name="张三", email="zhangsan@example.com")
1612
user = await user_crud.create_model(session, user_data)
17-
18-
1913
```
2014

2115
### 批量创建
2216

2317
```python
2418
# 批量创建多条记录
2519
users_data = [
26-
{"name": "用户1", "email": "user1@example.com"},
27-
{"name": "用户2", "email": "user2@example.com"},
28-
{"name": "用户3", "email": "user3@example.com"}
20+
UserCreate(name="用户1", email="user1@example.com"),
21+
UserCreate(name="用户2", email="user2@example.com"),
22+
UserCreate(name="用户3", email="user3@example.com")
2923
]
3024
users = await user_crud.create_models(session, users_data)
3125
```
@@ -123,18 +117,18 @@ exists = await user_crud.exists(session, email="test@example.com")
123117
### 主键更新
124118

125119
```python
126-
# 根据主键更新
127-
updated_user = await user_crud.update_model(session, pk=1, obj_in={"name": "新名称"})
120+
# 使用字典更新
121+
updated_count = await user_crud.update_model(session, pk=1, obj={"name": "新名称"})
128122

129123
# 使用 Pydantic 模型
130124
user_update = UserUpdate(name="新名称", email="new@example.com")
131-
updated_user = await user_crud.update_model(session, pk=1, obj_in=user_update)
125+
updated_count = await user_crud.update_model(session, pk=1, obj=user_update)
132126

133127
# 使用 whereclause 位置参数(额外条件)
134-
updated_user = await user_crud.update_model(
128+
updated_count = await user_crud.update_model(
135129
session,
136130
pk=1,
137-
obj_in={"name": "新名称"},
131+
obj={"name": "新名称"},
138132
user_crud.model.is_active == True
139133
)
140134
```
@@ -143,16 +137,16 @@ updated_user = await user_crud.update_model(
143137

144138
```python
145139
# 根据条件更新单条记录
146-
updated_user = await user_crud.update_model_by_column(
140+
updated_count = await user_crud.update_model_by_column(
147141
session,
148-
obj_in={"is_active": False},
142+
obj={"is_active": False},
149143
email="user@example.com"
150144
)
151145

152146
# 使用 whereclause 位置参数(额外条件)
153-
updated_user = await user_crud.update_model_by_column(
147+
updated_count = await user_crud.update_model_by_column(
154148
session,
155-
obj_in={"name": "新名称"},
149+
obj={"name": "新名称"},
156150
user_crud.model.is_active == True,
157151
email="user@example.com"
158152
)

0 commit comments

Comments
 (0)