Prodream/ormar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
collerek
2021-06-08 14:34:02 +02:00
parent a1557273b0
commit 96c9615229
49 changed files with 1917 additions and 994 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/api/models/mixins/alias-mixin.md
View File

@ -23,11 +23,11 @@ For fields without alias field name is returned.
**Arguments**:
- `field_name (str)`: name of the field to get alias from
- `field_name` (`str`): name of the field to get alias from
**Returns**:
`(str)`: alias (db name) if set, otherwise passed name
`str`: alias (db name) if set, otherwise passed name
<a name="models.mixins.alias_mixin.AliasMixin.get_column_name_from_alias"></a>
#### get\_column\_name\_from\_alias
@ -42,11 +42,11 @@ If field do not have alias it's returned as is.
**Arguments**:
- `alias (str)`:
- `alias` (`str`):
**Returns**:
`(str)`: field name if set, otherwise passed alias (db name)
`str`: field name if set, otherwise passed alias (db name)
<a name="models.mixins.alias_mixin.AliasMixin.translate_columns_to_aliases"></a>
#### translate\_columns\_to\_aliases
@ -62,11 +62,11 @@ Only fields present in the dictionary are translated.
**Arguments**:
- `new_kwargs (Dict)`: dict with fields names and their values
- `new_kwargs` (`Dict`): dict with fields names and their values
**Returns**:
`(Dict)`: dict with aliases and their values
`Dict`: dict with aliases and their values
<a name="models.mixins.alias_mixin.AliasMixin.translate_aliases_to_columns"></a>
#### translate\_aliases\_to\_columns
@ -82,9 +82,9 @@ Only fields present in the dictionary are translated.
**Arguments**:
- `new_kwargs (Dict)`: dict with aliases and their values
- `new_kwargs` (`Dict`): dict with aliases and their values
**Returns**:
`(Dict)`: dict with fields names and their values
`Dict`: dict with fields names and their values