From: Mike Bayer Date: Thu, 9 Sep 2010 02:39:11 +0000 (-0400) Subject: you'll all miss the last of the ASCII art X-Git-Tag: rel_0_6_5~80 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=10fd8280878d759567549ad2ad958a7d1cb8a7a9;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git you'll all miss the last of the ASCII art --- diff --git a/doc/build/core/engines.rst b/doc/build/core/engines.rst index c6364b2fd5..02c904f189 100644 --- a/doc/build/core/engines.rst +++ b/doc/build/core/engines.rst @@ -9,15 +9,9 @@ The **Engine** is the starting point for any SQLAlchemy application. It's application through a connection pool and a **Dialect**, which describes how to talk to a specific kind of database/DBAPI combination. -The general structure is this:: - - +-----------+ __________ - /---| Pool |---\ (__________) - +-------------+ / +-----------+ \ +--------+ | | - connect() <--| Engine |---x x----| DBAPI |---| database | - +-------------+ \ +-----------+ / +--------+ | | - \---| Dialect |---/ |__________| - +-----------+ (__________) +The general structure can be illustrated as follows: + +.. image:: sqla_engine_arch.png Where above, a :class:`~sqlalchemy.engine.base.Engine` references both a :class:`~sqlalchemy.engine.base.Dialect` and :class:`~sqlalchemy.pool.Pool`, diff --git a/doc/build/core/sqla_engine_arch.png b/doc/build/core/sqla_engine_arch.png new file mode 100644 index 0000000000..f54d105bd7 Binary files /dev/null and b/doc/build/core/sqla_engine_arch.png differ diff --git a/doc/build/intro.rst b/doc/build/intro.rst index f111953f1a..bf57f8d73a 100644 --- a/doc/build/intro.rst +++ b/doc/build/intro.rst @@ -8,11 +8,22 @@ Overview ======== -The SQLAlchemy SQL Toolkit and Object Relational Mapper is a comprehensive set of tools for working with databases and Python. It has several distinct areas of functionality which can be used individually or combined together. Its major components are illustrated below. The arrows represent the general dependencies of components: - -.. image:: sqla_arch_small.jpg - -Above, the two most significant front-facing portions of SQLAlchemy are the **Object Relational Mapper** and the **SQL Expression Language**. SQL Expressions can be used independently of the ORM. When using the ORM, the SQL Expression language remains part of the public facing API as it is used within object-relational configurations and queries. +The SQLAlchemy SQL Toolkit and Object Relational Mapper +is a comprehensive set of tools for working with +databases and Python. It has several distinct areas of +functionality which can be used individually or combined +together. Its major components are illustrated below. The +arrows represent the general dependencies of components: + +.. image:: sqla_arch_small.png + +Above, the two most significant front-facing portions of +SQLAlchemy are the **Object Relational Mapper** and the +**SQL Expression Language**. SQL Expressions can be used +independently of the ORM. When using the ORM, the SQL +Expression language remains part of the public facing API +as it is used within object-relational configurations and +queries. Documentation Overview ====================== diff --git a/doc/build/sqla_arch_small.jpg b/doc/build/sqla_arch_small.jpg deleted file mode 100644 index 2976030d70..0000000000 Binary files a/doc/build/sqla_arch_small.jpg and /dev/null differ diff --git a/doc/build/sqla_arch_small.png b/doc/build/sqla_arch_small.png new file mode 100644 index 0000000000..521a0813ba Binary files /dev/null and b/doc/build/sqla_arch_small.png differ