summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/base.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-03-15 10:15:48 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-03-15 10:15:48 -0400
commit755316e66e0543f2524aeef0f11c107f95420d8a (patch)
tree9793ab34a17368ca0d1cc87985b7ab54ea50aabf /lib/sqlalchemy/engine/base.py
parent16b13ba06b661a6dfb13b1537ee873c9065b084e (diff)
downloadsqlalchemy-755316e66e0543f2524aeef0f11c107f95420d8a.tar.gz
documentation updates
Change-Id: I43d0e8de1f90abcff4b278637808d1ebc8fd6c97
Diffstat (limited to 'lib/sqlalchemy/engine/base.py')
-rw-r--r--lib/sqlalchemy/engine/base.py17
1 files changed, 12 insertions, 5 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 906de08bb..a748270d0 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -31,11 +31,14 @@ _EMPTY_EXECUTION_OPTS = util.immutabledict()
class Connection(Connectable):
"""Provides high-level functionality for a wrapped DB-API connection.
- Provides execution support for string-based SQL statements as well as
- :class:`_expression.ClauseElement`, :class:`.Compiled` and
- :class:`.DefaultGenerator`
- objects. Provides a :meth:`begin` method to return :class:`.Transaction`
- objects.
+ **This is the SQLAlchemy 1.x.x version** of the :class:`_engine.Connection`
+ class. For the :term:`2.0 style` version, which features some API
+ differences, see :class:`_future.Connection`.
+
+ The :class:`_engine.Connection` object is procured by calling
+ the :meth:`_engine.Engine.connect` method of the :class:`_engine.Engine`
+ object, and provides services for execution of SQL statements as well
+ as transaction control.
The Connection object is **not** thread-safe. While a Connection can be
shared among threads using properly synchronized access, it is still
@@ -2581,6 +2584,10 @@ class Engine(Connectable, log.Identified):
:class:`~sqlalchemy.engine.interfaces.Dialect` together to provide a
source of database connectivity and behavior.
+ This is the **SQLAlchemy 1.x version** of :class:`_engine.Engine`. For
+ the :term:`2.0 style` version, which includes some API differences,
+ see :class:`_future.Engine`.
+
An :class:`_engine.Engine` object is instantiated publicly using the
:func:`~sqlalchemy.create_engine` function.