next part of the docs and api documentation in beta ver
This commit is contained in:
36
docs/api/query-set/order-query.md
Normal file
36
docs/api/query-set/order-query.md
Normal file
@ -0,0 +1,36 @@
|
||||
<a name="queryset.order_query"></a>
|
||||
# queryset.order\_query
|
||||
|
||||
<a name="queryset.order_query.OrderQuery"></a>
|
||||
## OrderQuery Objects
|
||||
|
||||
```python
|
||||
class OrderQuery()
|
||||
```
|
||||
|
||||
Modifies the select query with given list of order_by clauses.
|
||||
|
||||
<a name="queryset.order_query.OrderQuery.__init__"></a>
|
||||
#### \_\_init\_\_
|
||||
|
||||
```python
|
||||
| __init__(sorted_orders: Dict) -> None
|
||||
```
|
||||
|
||||
<a name="queryset.order_query.OrderQuery.apply"></a>
|
||||
#### apply
|
||||
|
||||
```python
|
||||
| apply(expr: sqlalchemy.sql.select) -> sqlalchemy.sql.select
|
||||
```
|
||||
|
||||
Applies all order_by clauses if set.
|
||||
|
||||
**Arguments**:
|
||||
|
||||
- `expr (sqlalchemy.sql.selectable.Select)`: query to modify
|
||||
|
||||
**Returns**:
|
||||
|
||||
`(sqlalchemy.sql.selectable.Select)`: modified query
|
||||
|
||||
Reference in New Issue
Block a user