Skip to content

Add where clause support to select #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2025
Merged

Add where clause support to select #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@

## 互动

[TG / Discord](https://wu-clan.github.io/homepage/)
[Discord](https://wu-clan.github.io/homepage/)

## 赞助

Expand Down
14 changes: 6 additions & 8 deletions docs/usage/count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@ class CRUDIns(CRUDPlus[ModelIns]):
async def count(
self,
session: AsyncSession,
filters: ColumnElement | list[ColumnElement] | None = None,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> int:
```

**Parameters:**

| Name | Type | Description | Default |
|---------|----------------------------------------------------|------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| filters | `ColumnElement `\|` list[ColumnElement] `\|` None` | 要应用于查询的 WHERE 子句 | `None` |
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL

**Returns:**

Expand Down
14 changes: 6 additions & 8 deletions docs/usage/exists.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@ class CRUDIns(CRUDPlus[ModelIns]):
async def exists(
self,
session: AsyncSession,
filters: ColumnElement | list[ColumnElement] | None = None,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> bool:
```

**Parameters:**

| Name | Type | Description | Default |
|---------|----------------------------------------------------|------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| filters | `ColumnElement `\|` list[ColumnElement] `\|` None` | 要应用于查询的 WHERE 子句 | `None` |
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL

**Returns:**

Expand Down
10 changes: 7 additions & 3 deletions docs/usage/select.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,20 @@ async def get_users(
## API

```py
async def select(self, **kwargs) -> Select:
async def select(self, *whereclause: ColumnExpressionArgument[bool], **kwargs) -> Select:
...
```

此方法用于构造 SQLAlchemy
Select，在一些特定场景将会很有用，例如，配合 [fastapi-pagination](https://github.com/uriyyo/fastapi-pagination) 使用

!!! note "**kwargs"
**Parameters:**

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

**Returns:**

Expand Down
16 changes: 11 additions & 5 deletions docs/usage/select_model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,21 @@ class CRUDIns(CRUDPlus[ModelIns]):
## API

```py
async def select_model(self, session: AsyncSession, pk: int) -> Model | None:
async def select_model(
self,
session: AsyncSession,
pk: int,
*whereclause: ColumnExpressionArgument[bool],
) -> Model | None:
```

**Parameters:**

| Name | Type | Description | Default |
|---------|--------------|----------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| pk | int | [主键](../advanced/primary_key.md) | 必填 |
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| pk | int | [主键](../advanced/primary_key.md) | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |

**Returns:**

Expand Down
19 changes: 11 additions & 8 deletions docs/usage/select_model_by_column.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,21 @@ class CRUDIns(CRUDPlus[ModelIns]):
## API

```py
async def select_model_by_column(self, session: AsyncSession, **kwargs) -> Model | None:
async def select_model_by_column(
self,
session: AsyncSession,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> Model | None:
```

**Parameters:**

| Name | Type | Description | Default |
|---------|--------------|----------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

**Returns:**

Expand Down
19 changes: 11 additions & 8 deletions docs/usage/select_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,21 @@ class CRUDIns(CRUDPlus[ModelIns]):
## API

```py
async def select_models(self, session: AsyncSession, **kwargs) -> Sequence[Row[Any] | RowMapping | Any]:
async def select_models(
self,
session: AsyncSession,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> Sequence[Row[Any] | RowMapping | Any]:
```

**Parameters:**

| Name | Type | Description | Default |
|---------|--------------|----------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

**Returns:**

Expand Down
37 changes: 18 additions & 19 deletions docs/usage/select_models_order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,37 @@ from sqlalchemy.ext.asyncio import AsyncSession


class ModelIns(Base):
# your sqlalchemy model
pass
# your sqlalchemy model
pass


class CRUDIns(CRUDPlus[ModelIns]):
async def create(self, db: AsyncSession) -> Sequence[ModelIns]:
return await self.select_models_order(db, sort_columns=['name', 'age'], sort_orders=['asc', 'desc'])
async def create(self, db: AsyncSession) -> Sequence[ModelIns]:
return await self.select_models_order(db, sort_columns=['name', 'age'], sort_orders=['asc', 'desc'])
```

## API

```py
async def select_models_order(
self,
session: AsyncSession,
sort_columns: str | list[str],
sort_orders: str | list[str] | None = None,
**kwargs,
async def select_models_order(
self,
session: AsyncSession,
sort_columns: str | list[str],
sort_orders: str | list[str] | None = None,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> Sequence[Row | RowMapping | Any] | None:
```

**Parameters:**

| Name | Type | Description | Default |
|--------------|--------------------------------|------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| sort_columns | `str `\|` list[str]` | 应用排序的单个列名或列名列表 | 必填 |
| sort_orders | `str `\|` list[str] `\|` None` | 单个排序顺序（asc 或 desc）或与 sort_columns 中的列相对应的排序顺序列表。 如果未提供，则默认每列的排序顺序为 asc | `None` |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| session | AsyncSession | 数据库会话 | 必填 |
| sort_columns | `str `\|` list[str]` | 应用排序的单个列名或列名列表 | 必填 |
| sort_orders | `str `\|` list[str] `\|` None` | 单个排序顺序（asc 或 desc）或与 sort_columns 中的列相对应的排序顺序列表。 如果未提供，则默认每列的排序顺序为 asc | `None` |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

**Returns:**

Expand Down
15 changes: 7 additions & 8 deletions docs/usage/select_order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,19 @@ async def select_order(
self,
sort_columns: str | list[str],
sort_orders: str | list[str] | None = None,
*whereclause: ColumnExpressionArgument[bool],
**kwargs,
) -> Select:
```

**Parameters:**

| Name | Type | Description | Default |
|--------------|--------------------------------|------------------------------------------------------------------------|---------|
| sort_columns | `str `\|` list[str]` | 应用排序的单个列名或列名列表 | 必填 |
| sort_orders | `str `\|` list[str] `\|` None` | 单个排序顺序（asc 或 desc）或与 sort_columns 中的列相对应的排序顺序列表。 如果未提供，则默认每列的排序顺序为 asc | `None` |

!!! note "**kwargs"

[条件过滤](../advanced/filter.md)，将创建条件查询 SQL
| Name | Type | Description | Default |
|--------------|----------------------------------|------------------------------------------------------------------------------------------------------|---------|
| sort_columns | `str `\|` list[str]` | 应用排序的单个列名或列名列表 | 必填 |
| sort_orders | `str `\|` list[str] `\|` None` | 单个排序顺序（asc 或 desc）或与 sort_columns 中的列相对应的排序顺序列表。 如果未提供，则默认每列的排序顺序为 asc | `None` |
| *whereclause | `ColumnExpressionArgument[bool]` | 等同于 [SQLAlchemy where](https://docs.sqlalchemy.org/en/20/tutorial/data_select.html#the-where-clause) | |
| **kwargs | | [条件过滤](../advanced/filter.md)，将创建条件查询 SQL | |

**Returns:**

Expand Down
Loading