Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

make 'element' and 'value' synonyms in doc

This commit is contained in:
Gavin King 2022-01-10 14:14:25 +01:00
parent 2e8bf3d1df
commit 64d25f16d1
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/src/main/asciidoc/userguide/chapters/query/hql/QueryLanguage.adoc
View File

@ -961,7 +961,7 @@ The following functions may be applied to a collection-valued path expression to
|===
| Function | Applies to | Interpretation | Notes
| `value()` | Any collection | The collection element or map entry value
| `value()` or `element()` | Any collection | The collection element or map entry value
| Always optional, and useful only to explicitly indicate intent.
| `index()` | Any `List` with an index column | The index of the element in the list
| For backward compatibility, it's also an alternative to ``key()``, when applied to a map.
@ -997,16 +997,16 @@ include::{sourcedir}/HQLTest.java[tags=hql-collection-index-operator-example]
There are even more functions which accept a collection-valued attribute or to-many association:
|===
| HQL Function (modern syntax) | HQL Function (old syntax) | Applies to | Purpose
| HQL Function | Synonym | Old syntax | Applies to | Purpose
| `max(element x)`| `maxelement(x)` | Collections of basic type | The maximum element
| `min(element x)`| `minelement(x)` | Collections of basic type | The minimum element
| `sum(element x)`| — | Collections of basic type | The sum of the elements
| `avg(element x)`| — | Collections of basic type | The sum of the elements
| `max(index x)`| `maxindex(x)` | Indexed collections (lists and maps) | The maximum list index or map key
| `min(index x)`| `minindex(x)` | Indexed collections (lists and maps) | The minimum list index or map key
| `sum(index x)`| — | Indexed collections (lists and maps) | The sum of the list indexes or map keys
| `avg(index x)`| — | Indexed collections (lists and maps) | The average of the list indexes or map keys
| `max(element x)` | `max(value x)` | `maxelement(x)` | Any collection with sortable elements | The maximum element or map value
| `min(element x)` | `min(value x)` | `minelement(x)` | Any collection with sortable elements | The minimum element or map value
| `sum(element x)` | `sum(value x)` | — | Any collection with numeric elements | The sum of the elements or map values
| `avg(element x)` | `avg(value x)` | — | Any collection with numeric elements | The sum of the elements or map values
| `max(index x)` | `max(key x)` | `maxindex(x)` | Indexed collections (lists and maps) | The maximum list index or map key
| `min(index x)` | `min(key x)` | `minindex(x)` | Indexed collections (lists and maps) | The minimum list index or map key
| `sum(index x)` | `sum(key x)` | — | Indexed collections (lists and maps) | The sum of the list indexes or map keys
| `avg(index x)` | `avg(key x)`| — | Indexed collections (lists and maps) | The average of the list indexes or map keys
|===
We've intentionally left two functions off this list, so we can come back to them <<hql-elements-indices,later>>.