diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-03-12 10:14:52 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-03-12 10:14:52 -0400 |
| commit | f211ad254d53b85aae319b41cc7b206f3e693660 (patch) | |
| tree | 087610772d2b4d91122d26f29b404e0dda53c771 | |
| parent | e3b46bd62405b6ff57119e164718118f3e3565e0 (diff) | |
| download | sqlalchemy-f211ad254d53b85aae319b41cc7b206f3e693660.tar.gz | |
- try to document how to get columns from constraints.
unfortunately Sphinx refuses to work correctly for the columns
attribute so we just add a lame message to contains_column().
| -rw-r--r-- | doc/build/core/constraints.rst | 8 | ||||
| -rw-r--r-- | doc/build/core/internals.rst | 3 | ||||
| -rw-r--r-- | lib/sqlalchemy/sql/schema.py | 8 |
3 files changed, 16 insertions, 3 deletions
diff --git a/doc/build/core/constraints.rst b/doc/build/core/constraints.rst index dfe9e9cdd..197eeb8a9 100644 --- a/doc/build/core/constraints.rst +++ b/doc/build/core/constraints.rst @@ -706,6 +706,13 @@ Constraints API .. autoclass:: Constraint :members: +.. autoclass:: ColumnCollectionMixin + :members: + +.. autoclass:: ColumnCollectionConstraint + :members: + :inherited-members: + .. autoclass:: CheckConstraint :members: :inherited-members: @@ -728,6 +735,7 @@ Constraints API :members: :inherited-members: + .. autofunction:: sqlalchemy.schema.conv .. _schema_indexes: diff --git a/doc/build/core/internals.rst b/doc/build/core/internals.rst index 81b4f1a81..56b6162e9 100644 --- a/doc/build/core/internals.rst +++ b/doc/build/core/internals.rst @@ -7,9 +7,6 @@ Some key internal constructs are listed here. .. currentmodule: sqlalchemy -.. autoclass:: sqlalchemy.schema.ColumnCollectionMixin - :members: - .. autoclass:: sqlalchemy.engine.interfaces.Compiled :members: diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py index 2120e303b..e022c5768 100644 --- a/lib/sqlalchemy/sql/schema.py +++ b/lib/sqlalchemy/sql/schema.py @@ -2373,6 +2373,7 @@ def _to_schema_column_or_string(element): class ColumnCollectionMixin(object): + columns = None """A :class:`.ColumnCollection` of :class:`.Column` objects. @@ -2455,6 +2456,13 @@ class ColumnCollectionConstraint(ColumnCollectionMixin, Constraint): return self._schema_item_copy(c) def contains_column(self, col): + """Return True if this constraint contains the given column. + + Note that this object also contains an attribute ``.columns`` + which is a :class:`.ColumnCollection` of :class:`.Column` objects. + + """ + return self.columns.contains_column(col) def __iter__(self): |