diff options
author | mike bayer <mike_mp@zzzcomputing.com> | 2021-01-20 14:26:19 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@bbpush.zzzcomputing.com> | 2021-01-20 14:26:19 +0000 |
commit | 3df145c57c966e1511bccc117161563123ec6f0b (patch) | |
tree | fd24f5bbbc99e8087f790c29fc543a9379adf741 /lib/sqlalchemy/sql/selectable.py | |
parent | 0af22b4cfc21a8798b6fab125275b735302575fa (diff) | |
parent | e48d97b46a4ad19d4efe3c22d23d89d0ed92a310 (diff) | |
download | sqlalchemy-3df145c57c966e1511bccc117161563123ec6f0b.tar.gz |
Merge "Document Table/Column accessors"
Diffstat (limited to 'lib/sqlalchemy/sql/selectable.py')
-rw-r--r-- | lib/sqlalchemy/sql/selectable.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/sqlalchemy/sql/selectable.py b/lib/sqlalchemy/sql/selectable.py index a1dfa8b56..b4f6c8bc9 100644 --- a/lib/sqlalchemy/sql/selectable.py +++ b/lib/sqlalchemy/sql/selectable.py @@ -749,9 +749,17 @@ class FromClause(roles.AnonymizedFromClauseRole, Selectable): @util.memoized_property def foreign_keys(self): - """Return the collection of :class:`_schema.ForeignKey` objects + """Return the collection of :class:`_schema.ForeignKey` marker objects which this FromClause references. + Each :class:`_schema.ForeignKey` is a member of a + :class:`_schema.Table`-wide + :class:`_schema.ForeignKeyConstraint`. + + .. seealso:: + + :attr:`_schema.Table.foreign_key_constraints` + """ self._init_collections() self._populate_column_collection() |