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/sql/compiler.py | |
parent | 1dc4546aa95d3adfff910430afe922bf137bf595 (diff) | |
download | sqlalchemy-ba0267a955d40efb09de06ce226fbab63994aa78.tar.gz |
introductory docstring bonanza
Diffstat (limited to 'lib/sqlalchemy/sql/compiler.py')
-rw-r--r-- | lib/sqlalchemy/sql/compiler.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/sqlalchemy/sql/compiler.py b/lib/sqlalchemy/sql/compiler.py index 247285384..bdcd94688 100644 --- a/lib/sqlalchemy/sql/compiler.py +++ b/lib/sqlalchemy/sql/compiler.py @@ -4,7 +4,19 @@ # This module is part of SQLAlchemy and is released under # the MIT License: http://www.opensource.org/licenses/mit-license.php -"""SQL expression compilation routines and DDL implementations.""" +"""Base SQL and DDL compiler implementations. + +Provides the [sqlalchemy.sql.compiler#DefaultCompiler] class, which is +responsible for generating all SQL query strings, as well as +[sqlalchemy.sql.compiler#SchemaGenerator] and [sqlalchemy.sql.compiler#SchemaDropper] +which issue CREATE and DROP DDL for tables, sequences, and indexes. + +The elements in this module are used by public-facing constructs like +[sqlalchemy.sql.expression#ClauseElement] and [sqlalchemy.engine#Engine]. +While dialect authors will want to be familiar with this module for the purpose of +creating database-specific compilers and schema generators, the module +is otherwise internal to SQLAlchemy. +""" import string, re from sqlalchemy import schema, engine, util, exceptions |