diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-04-26 10:59:34 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-05-01 22:37:59 -0400 |
commit | f247bb20007190ae7aa89929c02c03317b1e6876 (patch) | |
tree | d03bc02056b96ea399cf947fe2074fa4365361ff /lib/sqlalchemy/sql | |
parent | ea87d39d7a9926dc1c6bf3d70e8faf8575769cb0 (diff) | |
download | sqlalchemy-f247bb20007190ae7aa89929c02c03317b1e6876.tar.gz |
Documentation updates for ResultProxy -> Result
This is based off of
I8091919d45421e3f53029b8660427f844fee0228 and includes
all documentation-only changes as a separate merge,
once the parent is merged.
Change-Id: I711adea23df0f9f0b1fe7c76210bd2de6d31842d
Diffstat (limited to 'lib/sqlalchemy/sql')
-rw-r--r-- | lib/sqlalchemy/sql/crud.py | 2 | ||||
-rw-r--r-- | lib/sqlalchemy/sql/dml.py | 16 | ||||
-rw-r--r-- | lib/sqlalchemy/sql/elements.py | 2 |
3 files changed, 10 insertions, 10 deletions
diff --git a/lib/sqlalchemy/sql/crud.py b/lib/sqlalchemy/sql/crud.py index 4d14497c1..625183db3 100644 --- a/lib/sqlalchemy/sql/crud.py +++ b/lib/sqlalchemy/sql/crud.py @@ -40,7 +40,7 @@ def _get_crud_params(compiler, stmt, compile_state, **kw): Also generates the Compiled object's postfetch, prefetch, and returning column collections, used for default handling and ultimately - populating the ResultProxy's prefetch_cols() and postfetch_cols() + populating the CursorResult's prefetch_cols() and postfetch_cols() collections. """ diff --git a/lib/sqlalchemy/sql/dml.py b/lib/sqlalchemy/sql/dml.py index 4ed01375e..3dc4e917c 100644 --- a/lib/sqlalchemy/sql/dml.py +++ b/lib/sqlalchemy/sql/dml.py @@ -345,7 +345,7 @@ class UpdateBase( Upon execution, the values of the columns to be returned are made available via the result set and can be iterated using - :meth:`_engine.ResultProxy.fetchone` and similar. + :meth:`_engine.CursorResult.fetchone` and similar. For DBAPIs which do not natively support returning values (i.e. cx_oracle), SQLAlchemy will approximate this behavior at the result level so that a reasonable @@ -547,7 +547,7 @@ class ValuesBase(UpdateBase): True, indicating that the statement will not attempt to fetch the "last inserted primary key" or other defaults. The statement deals with an arbitrary number of rows, so the - :attr:`_engine.ResultProxy.inserted_primary_key` + :attr:`_engine.CursorResult.inserted_primary_key` accessor does not apply. @@ -684,7 +684,7 @@ class ValuesBase(UpdateBase): added to any existing RETURNING clause, provided that :meth:`.UpdateBase.returning` is not used simultaneously. The column values will then be available on the result using the - :attr:`_engine.ResultProxy.returned_defaults` accessor as a dictionary + :attr:`_engine.CursorResult.returned_defaults` accessor as a dictionary , referring to values keyed to the :class:`_schema.Column` object as well as @@ -715,7 +715,7 @@ class ValuesBase(UpdateBase): 3. It can be called against any backend. Backends that don't support RETURNING will skip the usage of the feature, rather than raising an exception. The return value of - :attr:`_engine.ResultProxy.returned_defaults` will be ``None`` + :attr:`_engine.CursorResult.returned_defaults` will be ``None`` :meth:`.ValuesBase.return_defaults` is used by the ORM to provide an efficient implementation for the ``eager_defaults`` feature of @@ -732,7 +732,7 @@ class ValuesBase(UpdateBase): :meth:`.UpdateBase.returning` - :attr:`_engine.ResultProxy.returned_defaults` + :attr:`_engine.CursorResult.returned_defaults` """ self._return_defaults = cols or True @@ -922,7 +922,7 @@ class Insert(ValuesBase): True, indicating that the statement will not attempt to fetch the "last inserted primary key" or other defaults. The statement deals with an arbitrary number of rows, so the - :attr:`_engine.ResultProxy.inserted_primary_key` + :attr:`_engine.CursorResult.inserted_primary_key` accessor does not apply. """ @@ -1064,7 +1064,7 @@ class Update(DMLWhereBase, ValuesBase): the ``default`` keyword will be compiled 'inline' into the statement and not pre-executed. This means that their values will not be available in the dictionary returned from - :meth:`_engine.ResultProxy.last_updated_params`. + :meth:`_engine.CursorResult.last_updated_params`. :param preserve_parameter_order: if True, the update statement is expected to receive parameters **only** via the @@ -1189,7 +1189,7 @@ class Update(DMLWhereBase, ValuesBase): ``default`` keyword will be compiled 'inline' into the statement and not pre-executed. This means that their values will not be available in the dictionary returned from - :meth:`_engine.ResultProxy.last_updated_params`. + :meth:`_engine.CursorResult.last_updated_params`. .. versionchanged:: 1.4 the :paramref:`_expression.update.inline` parameter diff --git a/lib/sqlalchemy/sql/elements.py b/lib/sqlalchemy/sql/elements.py index d8b5a1626..e7c1f3f77 100644 --- a/lib/sqlalchemy/sql/elements.py +++ b/lib/sqlalchemy/sql/elements.py @@ -159,7 +159,7 @@ def outparam(key, type_=None): The ``outparam`` can be used like a regular function parameter. The "output" value will be available from the - :class:`~sqlalchemy.engine.ResultProxy` object via its ``out_parameters`` + :class:`~sqlalchemy.engine.CursorResult` object via its ``out_parameters`` attribute, which returns a dictionary containing the values. """ |