summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/schema.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2017-03-07 14:54:53 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2017-03-07 14:54:53 -0500
commit74bec18c2a3cc8e9c031808fc44bc0f2c5af8b43 (patch)
treed0b5b104fb803176f81266a4652f3af9548bfb92 /lib/sqlalchemy/sql/schema.py
parentb54cefc379dcb99bcaf39094b29093f1e4be9b2b (diff)
downloadsqlalchemy-74bec18c2a3cc8e9c031808fc44bc0f2c5af8b43.tar.gz
- document ForeignKeyConstraint columns / elements, fixes #2904
Change-Id: Ia50a3100d1bd88020c30224932b16aeadd7f4c75
Diffstat (limited to 'lib/sqlalchemy/sql/schema.py')
-rw-r--r--lib/sqlalchemy/sql/schema.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py
index 08f23c4af..e6eabc461 100644
--- a/lib/sqlalchemy/sql/schema.py
+++ b/lib/sqlalchemy/sql/schema.py
@@ -2630,6 +2630,12 @@ class ColumnCollectionConstraint(ColumnCollectionMixin, Constraint):
Constraint.__init__(self, **kw)
ColumnCollectionMixin.__init__(self, *columns, _autoattach=_autoattach)
+ columns = None
+ """A :class:`.ColumnCollection` representing the set of columns
+ for this constraint.
+
+ """
+
def _set_parent(self, table):
Constraint._set_parent(self, table)
ColumnCollectionMixin._set_parent(self, table)
@@ -2871,6 +2877,22 @@ class ForeignKeyConstraint(ColumnCollectionConstraint):
self.columns.add(column)
self.elements.append(fk)
+ columns = None
+ """A :class:`.ColumnCollection` representing the set of columns
+ for this constraint.
+
+ """
+
+ elements = None
+ """A sequence of :class:`.ForeignKey` objects.
+
+ Each :class:`.ForeignKey` represents a single referring column/referred
+ column pair.
+
+ This collection is intended to be read-only.
+
+ """
+
@property
def _elements(self):
# legacy - provide a dictionary view of (column_key, fk)