add tests for cross model forward references, add docs for processing forwardrefs, wip on refactoring queries into separate pages based on functionality
This commit is contained in:
@ -74,7 +74,7 @@ Creates text clause with table name with aliased name.
|
||||
#### add\_relation\_type
|
||||
|
||||
```python
|
||||
| add_relation_type(source_model: Type["Model"], relation_name: str, reverse_name: str = None, is_multi: bool = False) -> None
|
||||
| add_relation_type(source_model: Type["Model"], relation_name: str, reverse_name: str = None) -> None
|
||||
```
|
||||
|
||||
Registers the relations defined in ormar models.
|
||||
@ -94,12 +94,28 @@ on one model as well as from multiple different models in one join.
|
||||
- `source_model (source Model)`: model with relation defined
|
||||
- `relation_name (str)`: name of the relation to define
|
||||
- `reverse_name (Optional[str])`: name of related_name fo given relation for m2m relations
|
||||
- `is_multi (bool)`: flag if relation being registered is a through m2m model
|
||||
|
||||
**Returns**:
|
||||
|
||||
`(None)`: none
|
||||
|
||||
<a name="relations.alias_manager.AliasManager.add_alias"></a>
|
||||
#### add\_alias
|
||||
|
||||
```python
|
||||
| add_alias(alias_key: str) -> str
|
||||
```
|
||||
|
||||
Adds alias to the dictionary of aliases under given key.
|
||||
|
||||
**Arguments**:
|
||||
|
||||
- `alias_key (str)`: key of relation to generate alias for
|
||||
|
||||
**Returns**:
|
||||
|
||||
`(str)`: generated alias
|
||||
|
||||
<a name="relations.alias_manager.AliasManager.resolve_relation_alias"></a>
|
||||
#### resolve\_relation\_alias
|
||||
|
||||
|
||||
@ -98,7 +98,7 @@ Returns the actual relation and not the related model(s).
|
||||
|
||||
```python
|
||||
| @staticmethod
|
||||
| add(parent: "Model", child: "Model", child_name: str, virtual: bool, relation_name: str) -> None
|
||||
| add(parent: "Model", child: "Model", field: Type["ForeignKeyField"]) -> None
|
||||
```
|
||||
|
||||
Adds relation on both sides -> meaning on both child and parent models.
|
||||
@ -112,9 +112,7 @@ on both ends.
|
||||
|
||||
- `parent (Model)`: parent model on which relation should be registered
|
||||
- `child (Model)`: child model to register
|
||||
- `child_name (str)`: potential child name used if related name is not set
|
||||
- `virtual (bool)`:
|
||||
- `relation_name (str)`: name of the relation
|
||||
- `field (ForeignKeyField)`: field with relation definition
|
||||
|
||||
<a name="relations.relation_manager.RelationsManager.remove"></a>
|
||||
#### remove
|
||||
|
||||
@ -114,7 +114,7 @@ to the parent model only, without need for user to filter them.
|
||||
| async remove(item: "Model", keep_reversed: bool = True) -> None
|
||||
```
|
||||
|
||||
Removes the item from relation with parent.
|
||||
Removes the related from relation with parent.
|
||||
|
||||
Through models are automatically deleted for m2m relations.
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
#### get\_relations\_sides\_and\_names
|
||||
|
||||
```python
|
||||
get_relations_sides_and_names(to_field: Type[BaseField], parent: "Model", child: "Model", child_name: str, virtual: bool, relation_name: str) -> Tuple["Model", "Model", str, str]
|
||||
get_relations_sides_and_names(to_field: Type[ForeignKeyField], parent: "Model", child: "Model") -> Tuple["Model", "Model", str, str]
|
||||
```
|
||||
|
||||
Determines the names of child and parent relations names, as well as
|
||||
@ -13,12 +13,9 @@ changes one of the sides of the relation into weakref.proxy to model.
|
||||
|
||||
**Arguments**:
|
||||
|
||||
- `to_field (BaseField)`: field with relation definition
|
||||
- `to_field (ForeignKeyField)`: field with relation definition
|
||||
- `parent (Model)`: parent model
|
||||
- `child (Model)`: child model
|
||||
- `child_name (str)`: name of the child
|
||||
- `virtual (bool)`: flag if relation is virtual
|
||||
- `relation_name ()`:
|
||||
|
||||
**Returns**:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user