diff options
Diffstat (limited to 'lib/sqlalchemy/orm/descriptor_props.py')
| -rw-r--r-- | lib/sqlalchemy/orm/descriptor_props.py | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/lib/sqlalchemy/orm/descriptor_props.py b/lib/sqlalchemy/orm/descriptor_props.py index 3bc009da8..7fff13101 100644 --- a/lib/sqlalchemy/orm/descriptor_props.py +++ b/lib/sqlalchemy/orm/descriptor_props.py @@ -550,14 +550,18 @@ class SynonymProperty(DescriptorProperty): :param map_column: **For classical mappings and mappings against an existing Table object only**. if ``True``, the :func:`.synonym` - construct will locate the :class:`.Column` object upon the mapped + construct will locate the :class:`_schema.Column` + object upon the mapped table that would normally be associated with the attribute name of this synonym, and produce a new :class:`.ColumnProperty` that instead - maps this :class:`.Column` to the alternate name given as the "name" + maps this :class:`_schema.Column` + to the alternate name given as the "name" argument of the synonym; in this way, the usual step of redefining - the mapping of the :class:`.Column` to be under a different name is + the mapping of the :class:`_schema.Column` + to be under a different name is unnecessary. This is usually intended to be used when a - :class:`.Column` is to be replaced with an attribute that also uses a + :class:`_schema.Column` + is to be replaced with an attribute that also uses a descriptor, that is, in conjunction with the :paramref:`.synonym.descriptor` parameter:: |