diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-12-18 23:53:40 +0000 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-12-18 23:53:40 +0000 |
| commit | ba0267a955d40efb09de06ce226fbab63994aa78 (patch) | |
| tree | b2a24709e6b3c474949e0ee50b2755c24cc49e56 /lib/sqlalchemy/schema.py | |
| parent | 1dc4546aa95d3adfff910430afe922bf137bf595 (diff) | |
| download | sqlalchemy-ba0267a955d40efb09de06ce226fbab63994aa78.tar.gz | |
introductory docstring bonanza
Diffstat (limited to 'lib/sqlalchemy/schema.py')
| -rw-r--r-- | lib/sqlalchemy/schema.py | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/lib/sqlalchemy/schema.py b/lib/sqlalchemy/schema.py index 301acdc2b..dd925a508 100644 --- a/lib/sqlalchemy/schema.py +++ b/lib/sqlalchemy/schema.py @@ -6,15 +6,23 @@ """The schema module provides the building blocks for database metadata. -This means all the entities within a SQL database that we might want -to look at, modify, or create and delete are described by these -objects, in a database-agnostic way. - -A structure of SchemaItems also provides a *visitor* interface which is -the primary method by which other methods operate upon the schema. -The SQL package extends this structure with its own clause-specific -objects as well as the visitor interface, so that the schema package -*plugs in* to the SQL package. +Each element within this module describes a database entity +which can be created and dropped, or is otherwise part of such an entity. +Examples include tables, columns, sequences, and indexes. + +All entities are subclasses of [sqlalchemy.schema#SchemaItem], and as +defined in this module they are intended to be agnostic of any +vendor-specific constructs. + +A collection of entities are grouped into a unit called [sqlalchemy.schema#MetaData]. +MetaData serves as a logical grouping of schema elements, and can also +be associated with an actual database connection such that operations +involving the contained elements can contact the database as needed. + +Two of the elements here also build upon their "syntactic" counterparts, +which are defined in [sqlalchemy.sql.expression#], specifically [sqlalchemy.schema#Table] +and [sqlalchemy.schema#Column]. Since these objects are part of the +SQL expression language, they are usable as components in SQL expressions. """ import re, inspect |
