diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-03-15 10:15:48 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-03-15 10:15:48 -0400 |
| commit | 755316e66e0543f2524aeef0f11c107f95420d8a (patch) | |
| tree | 9793ab34a17368ca0d1cc87985b7ab54ea50aabf /lib/sqlalchemy/future/engine.py | |
| parent | 16b13ba06b661a6dfb13b1537ee873c9065b084e (diff) | |
| download | sqlalchemy-755316e66e0543f2524aeef0f11c107f95420d8a.tar.gz | |
documentation updates
Change-Id: I43d0e8de1f90abcff4b278637808d1ebc8fd6c97
Diffstat (limited to 'lib/sqlalchemy/future/engine.py')
| -rw-r--r-- | lib/sqlalchemy/future/engine.py | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/lib/sqlalchemy/future/engine.py b/lib/sqlalchemy/future/engine.py index bfdcdfc7f..efd0b0eab 100644 --- a/lib/sqlalchemy/future/engine.py +++ b/lib/sqlalchemy/future/engine.py @@ -24,13 +24,20 @@ def create_engine(*arg, **kw): class Connection(_LegacyConnection): """Provides high-level functionality for a wrapped DB-API connection. + The :class:`_future.Connection` object is procured by calling + the :meth:`_future.Engine.connect` method of the :class:`_future.Engine` + object, and provides services for execution of SQL statements as well + as transaction control. + **This is the SQLAlchemy 2.0 version** of the :class:`_engine.Connection` class. The API and behavior of this object is largely the same, with the following differences in behavior: - * The result object returned for results is the :class:`_engine.Result` - object. This object has a slightly different API and behavior than the - prior :class:`_engine.CursorResult` object. + * The result object returned for results is the + :class:`_engine.CursorResult` + object, which is a subclass of the :class:`_engine.Result`. + This object has a slightly different API and behavior than the + :class:`_engine.LegacyCursorResult` returned for 1.x style usage. * The object has :meth:`_future.Connection.commit` and :meth:`_future.Connection.rollback` methods which commit or roll back @@ -61,7 +68,9 @@ class Connection(_LegacyConnection): any special instructions for the SAVEPOINT (this will typically have the effect that one desires). - * There are no "nested" connections or transactions. + * The :class:`_future.Connection` object does not support "branching", + which was a pattern by which a sub "connection" would be used that + refers to this connection as a parent. |
