From: Mike Bayer Date: Fri, 4 Nov 2022 20:44:29 +0000 (-0400) Subject: fix doc symbols X-Git-Tag: rel_1_4_43~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14cfef495dddb4faea2e4506a00afc9c0f1c01f5;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git fix doc symbols for 1.4, these are ambiguous due to the presence of future names Change-Id: I3694e75da73fe20c19445007c8823030789fc6c0 --- diff --git a/doc/build/changelog/unreleased_14/8717.rst b/doc/build/changelog/unreleased_14/8717.rst index dba7b830c6..10c7ceec84 100644 --- a/doc/build/changelog/unreleased_14/8717.rst +++ b/doc/build/changelog/unreleased_14/8717.rst @@ -2,17 +2,17 @@ :tags: bug, engine, regression :tickets: 8717 - Fixed issue where the :meth:`.PoolEvents.reset` event hook would not be - be called in all cases when a :class:`.Connection` were closed and was + Fixed issue where the :meth:`.PoolEvents.reset` event hook would not be be + called in all cases when a :class:`_engine.Connection` were closed and was in the process of returning its DBAPI connection to the connection pool. - The scenario was when the :class:`.Connection` had already emitted - ``.rollback()`` on its DBAPI connection within the process of returning - the connection to the pool, where it would then instruct the connection - pool to forego doing its own "reset" to save on the additional method - call. However, this prevented custom pool reset schemes from being - used within this hook, as such hooks by definition are doing more than - just calling ``.rollback()``, and need to be invoked under all - circumstances This was a regression that appeared in version 1.4. + The scenario was when the :class:`_engine.Connection` had already emitted + ``.rollback()`` on its DBAPI connection within the process of returning the + connection to the pool, where it would then instruct the connection pool to + forego doing its own "reset" to save on the additional method call. + However, this prevented custom pool reset schemes from being used within + this hook, as such hooks by definition are doing more than just calling + ``.rollback()``, and need to be invoked under all circumstances This was a + regression that appeared in version 1.4. For version 1.4, the :meth:`.PoolEvents.checkin` remains viable as an alternate event hook to use for custom "reset" implementations. Version 2.0 diff --git a/doc/build/core/defaults.rst b/doc/build/core/defaults.rst index c875808ec7..ca78e3aa04 100644 --- a/doc/build/core/defaults.rst +++ b/doc/build/core/defaults.rst @@ -403,7 +403,7 @@ table will include: :paramref:`.MetaData.schema` setting on the :class:`.MetaData` in use; see :ref:`sequence_metadata` for background. -When :class:`.Insert` DML constructs are invoked against the ``cartitems`` +When :class:`_dml .Insert` DML constructs are invoked against the ``cartitems`` table, without an explicit value passed for the ``cart_id`` column, the ``cart_id_seq`` sequence will be used to generate a value on participating backends. Typically, the sequence function is embedded in the INSERT statement, @@ -416,10 +416,11 @@ returned to the Python process: VALUES (next_val(cart_id_seq), 'some description', '2015-10-15 12:00:15') RETURNING cart_id -When using :meth:`.Connection.execute` to invoke an :class:`.Insert` construct, -newly generated primary key identifiers, including but not limited to those -generated using :class:`.Sequence`, are available from the :class:`.CursorResult` -construct using the :attr:`.CursorResult.inserted_primary_key` attribute. +When using :meth:`_engine.Connection.execute` to invoke an :class:`_dml.Insert` +construct, newly generated primary key identifiers, including but not limited +to those generated using :class:`.Sequence`, are available from the +:class:`.CursorResult` construct using the +:attr:`.CursorResult.inserted_primary_key` attribute. When the :class:`~sqlalchemy.schema.Sequence` is associated with a :class:`_schema.Column` as its **Python-side** default generator, the diff --git a/doc/build/core/pooling.rst b/doc/build/core/pooling.rst index c147b1d0b7..a93b9477f8 100644 --- a/doc/build/core/pooling.rst +++ b/doc/build/core/pooling.rst @@ -153,7 +153,7 @@ performance reasons. This can be affected by using the is also available from :func:`_sa.create_engine` as :paramref:`_sa.create_engine.pool_reset_on_return`, passing a value of ``None``. This is illustrated in the example below, in conjunction with the -:paramref:`.create_engine.isolation_level` parameter setting of +:paramref:`_sa.create_engine.isolation_level` parameter setting of ``AUTOCOMMIT``:: non_acid_engine = create_engine(