diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-03-13 02:45:40 +0000 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-03-13 02:45:40 +0000 |
commit | f18f2f50cba9b15b3b9e40e93702bbe1bdaeb641 (patch) | |
tree | cced0e1feedc7fccbff470ee7df2a7211d60c09b /lib/sqlalchemy/schema.py | |
parent | 0e058d4b6cf487297960007bea141e19825b7eff (diff) | |
download | sqlalchemy-f18f2f50cba9b15b3b9e40e93702bbe1bdaeb641.tar.gz |
some docs
Diffstat (limited to 'lib/sqlalchemy/schema.py')
-rw-r--r-- | lib/sqlalchemy/schema.py | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/lib/sqlalchemy/schema.py b/lib/sqlalchemy/schema.py index 78c31e9ac..443d48ee5 100644 --- a/lib/sqlalchemy/schema.py +++ b/lib/sqlalchemy/schema.py @@ -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 |