summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/schema.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2014-01-05 16:42:56 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2014-01-05 16:42:56 -0500
commit8c93a6c7718c2408688eb21a59e008a8dcca8999 (patch)
tree863680b30183eaa44accffe875084bfa1479d041 /lib/sqlalchemy/sql/schema.py
parent196f7ee6cc132aa0f31741af80fa5c0ba77efcf2 (diff)
downloadsqlalchemy-8c93a6c7718c2408688eb21a59e008a8dcca8999.tar.gz
- fix some docstring stuff
Diffstat (limited to 'lib/sqlalchemy/sql/schema.py')
-rw-r--r--lib/sqlalchemy/sql/schema.py43
1 files changed, 29 insertions, 14 deletions
diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py
index 97c160bf5..f8aaac12f 100644
--- a/lib/sqlalchemy/sql/schema.py
+++ b/lib/sqlalchemy/sql/schema.py
@@ -522,6 +522,14 @@ class Table(SchemaItem, TableClause):
@property
def key(self):
+ """Return the 'key' for this :class:`.Table`.
+
+ This value is used as the dictionary key within the
+ :attr:`.MetaData.tables` collection. It is typically the same
+ as that of :attr:`.Table.name` for a table with no :attr:`.Table.schema`
+ set; otherwise it is typically of the form ``schemaname.tablename``.
+
+ """
return _get_table_key(self.name, self.schema)
def __repr__(self):
@@ -2719,20 +2727,11 @@ class MetaData(SchemaItem):
execution.
The :class:`.Table` objects themselves are stored in the
- ``metadata.tables`` dictionary.
-
- The ``bind`` property may be assigned to dynamically. A common pattern is
- to start unbound and then bind later when an engine is available::
+ :attr:`.MetaData.tables` dictionary.
- metadata = MetaData()
- # define tables
- Table('mytable', metadata, ...)
- # connect to an engine later, perhaps after loading a URL from a
- # configuration file
- metadata.bind = an_engine
-
- MetaData is a thread-safe object after tables have been explicitly defined
- or loaded via reflection.
+ :class:`.MetaData` is a thread-safe object for read operations. Construction
+ of new tables within a single :class:`.MetaData` object, either explicitly
+ or via reflection, may not be completely thread-safe.
.. seealso::
@@ -2788,6 +2787,20 @@ class MetaData(SchemaItem):
"with reflect=True")
self.reflect()
+ tables = None
+ """A dictionary of :class:`.Table` objects keyed to their name or "table key".
+
+ The exact key is that determined by the :attr:`.Table.key` attribute;
+ for a table with no :attr:`.Table.schema` attribute, this is the same
+ as :attr:`.Table.name`. For a table with a schema, it is typically of the
+ form ``schemaname.tablename``.
+
+ .. seealso::
+
+ :attr:`.MetaData.sorted_tables`
+
+ """
+
def __repr__(self):
return 'MetaData(bind=%r)' % self.bind
@@ -2889,7 +2902,9 @@ class MetaData(SchemaItem):
.. seealso::
- :meth:`.Inspector.sorted_tables`
+ :attr:`.MetaData.tables`
+
+ :meth:`.Inspector.get_table_names`
"""
return ddl.sort_tables(self.tables.values())