summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/create.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-09-22 11:16:04 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-09-22 11:16:04 -0400
commit9ed0d194bd7918a1e87cc8e02a55fcd8134de66d (patch)
treebfd997ba2e2048340f96855bc93d26469b0682a1 /lib/sqlalchemy/engine/create.py
parenta162c1d714fe16fefb5da11981a4e788ca195d6a (diff)
downloadsqlalchemy-9ed0d194bd7918a1e87cc8e02a55fcd8134de66d.tar.gz
changelog, doc edits
Change-Id: Iafb50de7e28626d9cee755db9c05ac7189b4d963
Diffstat (limited to 'lib/sqlalchemy/engine/create.py')
-rw-r--r--lib/sqlalchemy/engine/create.py20
1 files changed, 12 insertions, 8 deletions
diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index f9dccb66c..5e56ecdd9 100644
--- a/lib/sqlalchemy/engine/create.py
+++ b/lib/sqlalchemy/engine/create.py
@@ -261,14 +261,18 @@ def create_engine(url, **kwargs):
:ref:`dbengine_logging` - further detail on how to configure
logging.
- :param implicit_returning=True: When ``True``, a RETURNING-
- compatible construct, if available, will be used to
- fetch newly generated primary key values when a single row
- INSERT statement is emitted with no existing returning()
- clause. This applies to those backends which support RETURNING
- or a compatible construct, including PostgreSQL, Firebird, Oracle,
- Microsoft SQL Server. Set this to ``False`` to disable
- the automatic usage of RETURNING.
+ :param implicit_returning=True: Legacy flag that when set to ``False``
+ will disable the use of ``RETURNING`` on supporting backends where it
+ would normally be used to fetch newly generated primary key values for
+ single-row INSERT statements that do not otherwise specify a RETURNING
+ clause. This behavior applies primarily to the PostgreSQL, Oracle,
+ SQL Server backends.
+
+ .. warning:: this flag originally allowed the "implicit returning"
+ feature to be *enabled* back when it was very new and there was not
+ well-established database support. In modern SQLAlchemy, this flag
+ should **always be set to True**. Some SQLAlchemy features will
+ fail to function properly if this flag is set to ``False``.
:param isolation_level: this string parameter is interpreted by various
dialects in order to affect the transaction isolation level of the