[IMP] orm: Deprecated read_group

Update documentation for the deprecatation of read_group.

closes odoo/documentation#11354

Related: odoo/odoo#163300
Related: odoo/enterprise#62388
Related: odoo/upgrade#6682
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
This commit is contained in:
Rémy Voet (ryv) 2024-11-12 11:37:28 +01:00
parent e7779f1542
commit 2958013fa3
3 changed files with 8 additions and 6 deletions

View File

@ -889,8 +889,6 @@ Search/Read
.. automethod:: Model._read_group .. automethod:: Model._read_group
.. automethod:: Model.read_group
Fields Fields
~~~~~~ ~~~~~~

View File

@ -4,6 +4,12 @@
Changelog Changelog
========= =========
Odoo Online version 18.2
========================
- `read_group` has been deprecated in favor of `_read_group` for backend usage and of
`formatted_read_group` as formatted public API. See `#163300 <https://github.com/odoo/odoo/pull/163300>`_.
Odoo Online version 18.1 Odoo Online version 18.1
======================== ========================

View File

@ -2084,9 +2084,7 @@ The `filter` element can have the following attributes:
the :guilabel:`Group By` menu. When the field is of type `date` or `datetime`, the filter the :guilabel:`Group By` menu. When the field is of type `date` or `datetime`, the filter
generates a submenu of the :guilabel:`Group By` menu with the following interval options generates a submenu of the :guilabel:`Group By` menu with the following interval options
available: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and available: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and
:guilabel:`Day`. When the filter is in the default set of filters activated at the view :guilabel:`Day`.
initialization, the records are grouped by month by default. This can be changed by using the
syntax `date_field:interval`.
.. example:: .. example::
.. code-block:: xml .. code-block:: xml
@ -2095,7 +2093,7 @@ The `filter` element can have the following attributes:
<filter string="Creation Date" name="groupby_create_date" context="{'group_by': 'create_date:week'}"/> <filter string="Creation Date" name="groupby_create_date" context="{'group_by': 'create_date:week'}"/>
.. note:: .. note::
The results of `read_groups` grouped on a field may be influenced by its `group_expand` The results of `formatted_read_group` grouped on a field may be influenced by its `group_expand`
attribute, allowing to display empty groups when needed. For more information, please refer to attribute, allowing to display empty groups when needed. For more information, please refer to
:class:`~odoo.fields.Field`. :class:`~odoo.fields.Field`.