Engine Configuration
====================
-The **Engine** is the starting point for any SQLAlchemy application. It's
+The :class:`.Engine` is the starting point for any SQLAlchemy application. It's
"home base" for the actual database and its :term:`DBAPI`, delivered to the SQLAlchemy
-application through a connection pool and a **Dialect**, which describes how
+application through a connection pool and a :class:`.Dialect`, which describes how
to talk to a specific kind of database/DBAPI combination.
The general structure can be illustrated as follows:
.. image:: sqla_engine_arch.png
-Where above, an :class:`~sqlalchemy.engine.Engine` references both a
-:class:`~sqlalchemy.engine.base.Dialect` and a :class:`~sqlalchemy.pool.Pool`,
+Where above, an :class:`.Engine` references both a
+:class:`.Dialect` and a :class:`.Pool`,
which together interpret the DBAPI's module functions as well as the behavior
of the database.
Supported Databases
====================
-SQLAlchemy includes many :class:`~sqlalchemy.engine.base.Dialect` implementations for various
+SQLAlchemy includes many :class:`.Dialect` implementations for various
backends. Dialects for the most common databases are included with SQLAlchemy; a handful
of others require an additional install of a separate dialect.
.. currentmodule: sqlalchemy
-.. autoclass:: sqlalchemy.engine.Compiled
+.. autoclass:: sqlalchemy.engine.interfaces.Compiled
:members:
- :undoc-members:
- :show-inheritance:
.. autoclass:: sqlalchemy.sql.compiler.DDLCompiler
:members:
.. autoclass:: sqlalchemy.engine.default.DefaultDialect
:members:
- :undoc-members:
:show-inheritance:
:inherited-members:
-.. autoclass:: sqlalchemy.engine.Dialect
+.. autoclass:: sqlalchemy.engine.interfaces.Dialect
:members:
- :undoc-members:
- :show-inheritance:
- :inherited-members:
.. autoclass:: sqlalchemy.engine.default.DefaultExecutionContext
:members:
- :undoc-members:
:show-inheritance:
-.. autoclass:: sqlalchemy.engine.ExecutionContext
+.. autoclass:: sqlalchemy.engine.interfaces.ExecutionContext
:members:
- :undoc-members:
:show-inheritance:
.. autoclass:: sqlalchemy.sql.compiler.IdentifierPreparer
return unicode_for_varchar
def type_descriptor(self, typeobj):
- """Provide a database-specific ``TypeEngine`` object, given
+ """Provide a database-specific :class:`.TypeEngine` object, given
the generic object which comes from the types module.
This method looks for a dictionary called
``colspecs`` as a class or instance-level variable,
- and passes on to ``types.adapt_type()``.
+ and passes on to :func:`.types.adapt_type`.
"""
return sqltypes.adapt_type(typeobj, self.colspecs)
'utf-8'.
statement_compiler
- a :class:`~Compiled` class used to compile SQL statements
+ a :class:`.Compiled` class used to compile SQL statements
ddl_compiler
- a :class:`~Compiled` class used to compile DDL statements
+ a :class:`.Compiled` class used to compile DDL statements
server_version_info
a tuple containing a version number for the DB backend in use.
"""Transform a generic type to a dialect-specific type.
Dialect classes will usually use the
- :func:`~sqlalchemy.types.adapt_type` function in the types module to
- make this job easy.
+ :func:`.types.adapt_type` function in the types module to
+ accomplish this.
The returned result is cached *per dialect class* so can
contain no dialect-instance state.
Deprecated. This method is only called by the default
- implementation of :meth:`get_pk_constraint()`. Dialects should
+ implementation of :meth:`.Dialect.get_pk_constraint`. Dialects should
instead implement this method directly.
"""
Classes provided include:
-:class:`~sqlalchemy.sql.compiler.SQLCompiler` - renders SQL
+:class:`.compiler.SQLCompiler` - renders SQL
strings
-:class:`~sqlalchemy.sql.compiler.DDLCompiler` - renders DDL
+:class:`.compiler.DDLCompiler` - renders DDL
(data definition language) strings
-:class:`~sqlalchemy.sql.compiler.GenericTypeCompiler` - renders
+:class:`.compiler.GenericTypeCompiler` - renders
type specification strings.
To generate user-defined SQL strings, see
-:module:`~sqlalchemy.ext.compiler`.
+:doc:`/ext/compiler`.
"""