]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
some docs
authorMike Bayer <mike_mp@zzzcomputing.com>
Tue, 13 Mar 2007 02:45:40 +0000 (02:45 +0000)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 13 Mar 2007 02:45:40 +0000 (02:45 +0000)
lib/sqlalchemy/schema.py

index 78c31e9acd8173df0504ecbfec451d34d58eabbd..443d48ee5e443c1cafa16650b089f88af3327059 100644 (file)
@@ -178,14 +178,25 @@ class Table(SchemaItem, sql.TableClause):
     """Represent a relational database table.
 
     This subclasses ``sql.TableClause`` to provide a table that is
-    *wired* to an engine.
+    associated with an instance of ``MetaData``, which in turn
+    may be associated with an instance of ``SQLEngine``.  
 
-    Whereas ``TableClause`` represents a table as its used in a SQL
-    expression, ``Table`` represents a table as its created in the
-    database.
-
-    Be sure to look at ``sqlalchemy.sql.TableImpl`` for additional methods
-    defined on a ``Table``."""
+    Whereas ``TableClause`` represents a table as its used in an SQL
+    expression, ``Table`` represents a table as it exists in a
+    database schema.
+    
+    If this ``Table`` is ultimately associated with an engine,
+    the ``Table`` gains the ability to access the database directly
+    without the need for dealing with an explicit ``Connection`` object;
+    this is known as "implicit execution".
+    
+    Implicit operation allows the ``Table`` to access the database to
+    reflect its own properties (via the autoload=True flag), it allows
+    the create() and drop() methods to be called without passing
+    a connectable, and it also propigates the underlying engine to
+    constructed SQL objects so that they too can be executed via their
+    execute() method without the need for a ``Connection``.
+    """
 
     __metaclass__ = _TableSingleton