summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-03-28 13:12:38 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2010-03-28 13:12:38 -0400
commit51fd3447373611af1b9f66a7f5f0c7c4abe94bbb (patch)
tree2119202ddcc7282a59692a747703a7e234f5aa83 /lib/sqlalchemy/engine
parentfb766e69bd2fa2811de127a69ad33d507621bff7 (diff)
downloadsqlalchemy-51fd3447373611af1b9f66a7f5f0c7c4abe94bbb.tar.gz
- The sqlalchemy.orm.shard module now becomes an extension,
sqlalchemy.ext.horizontal_shard. The old import works with a deprecation warning.
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/__init__.py9
-rw-r--r--lib/sqlalchemy/engine/base.py3
2 files changed, 8 insertions, 4 deletions
diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py
index 0dbb2404f..9b3dbedd8 100644
--- a/lib/sqlalchemy/engine/__init__.py
+++ b/lib/sqlalchemy/engine/__init__.py
@@ -107,10 +107,11 @@ def create_engine(*args, **kwargs):
arguments sent as options to the dialect and resulting Engine.
The URL is a string in the form
- ``dialect://user:password@host/dbname[?key=value..]``, where
- ``dialect`` is a name such as ``mysql``, ``oracle``, ``postgresql``,
- etc. Alternatively, the URL can be an instance of
- :class:`~sqlalchemy.engine.url.URL`.
+ ``dialect+driver://user:password@host/dbname[?key=value..]``, where
+ ``dialect`` is a database name such as ``mysql``, ``oracle``,
+ ``postgresql``, etc., and ``driver`` the name of a DBAPI, such as
+ ``psycopg2``, ``pyodbc``, ``cx_oracle``, etc. Alternatively,
+ the URL can be an instance of :class:`~sqlalchemy.engine.url.URL`.
`**kwargs` takes a wide variety of options which are routed
towards their appropriate components. Arguments may be
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 5490169c6..dc42ed957 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -1420,6 +1420,9 @@ class Engine(Connectable, log.Identified):
"""
Connects a :class:`~sqlalchemy.pool.Pool` and :class:`~sqlalchemy.engine.base.Dialect`
together to provide a source of database connectivity and behavior.
+
+ An :class:`Engine` object is instantiated publically using the :func:`~sqlalchemy.create_engine`
+ function.
"""