diff options
Diffstat (limited to 'lib/sqlalchemy/ext/sqlsoup.py')
| -rw-r--r-- | lib/sqlalchemy/ext/sqlsoup.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/sqlalchemy/ext/sqlsoup.py b/lib/sqlalchemy/ext/sqlsoup.py index e54cde3ed..e8234e7c7 100644 --- a/lib/sqlalchemy/ext/sqlsoup.py +++ b/lib/sqlalchemy/ext/sqlsoup.py @@ -3,7 +3,15 @@ Introduction ============ SqlSoup provides a convenient way to access existing database tables without -having to declare table or mapper classes ahead of time. It is built on top of the SQLAlchemy ORM and provides a super-minimalistic interface to an existing database. +having to declare table or mapper classes ahead of time. It is built on top of +the SQLAlchemy ORM and provides a super-minimalistic interface to an existing +database. + +SqlSoup effectively provides a coarse grained, alternative interface to +working with the SQLAlchemy ORM, providing a "self configuring" interface +for extremely rudimental operations. It's somewhat akin to a +"super novice mode" version of the ORM. While SqlSoup can be very handy, +users are strongly encouraged to use the full ORM for non-trivial applications. Suppose we have a database with users, books, and loans tables (corresponding to the PyWebOff dataset, if you're curious). |