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

Updated common-parameters.md

Browse Source 
Added notation about creating column name aliaes
This commit is contained in:
VOICE1
2021-08-16 19:07:28 -07:00
committed by GitHub
parent 4dfbd79fc8
commit 450477cf75
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/fields/common-parameters.md
View File

@ -101,7 +101,23 @@ Sample usage:
!!!info !!!info
`server_default` is passed straight to sqlalchemy table definition so you can read more in [server default][server default] sqlalchemy documentation `server_default` is passed straight to sqlalchemy table definition so you can read more in [server default][server default] sqlalchemy documentation
## name
`name`: `Any` = `None` -> Defaults to None
Allows you to specify a column name alias to be used. Useful for existing database structures that use a reserved keyword.
Take for example the snippet below. `from`, being a reserved word in python, will prevent you from creating a model with that column name. Changing the model name
to `from_` and adding the parameter `name='from'` will cause ormar to use `from` for the database column name.
```
...
from_: str = ormar.String(max_length=15, name='from')
...
```
## index ## index
`index`: `bool` = `False` -> by default False, `index`: `bool` = `False` -> by default False,
@ -147,4 +163,4 @@ Used in pydantic only.
[relations]: ../relations/index.md [relations]: ../relations/index.md
[queries]: ../queries/index.md [queries]: ../queries/index.md
[pydantic]: https://pydantic-docs.helpmanual.io/usage/types/#constrained-types [pydantic]: https://pydantic-docs.helpmanual.io/usage/types/#constrained-types
[server default]: https://docs.sqlalchemy.org/en/13/core/defaults.html#server-invoked-ddl-explicit-default-expressions [server default]: https://docs.sqlalchemy.org/en/13/core/defaults.html#server-invoked-ddl-explicit-default-expressions