Hibernate/hibernate-orm
1
0
Fork 0
mirror of https://github.com/hibernate/hibernate-orm synced 2025-03-08 02:40:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc about query method return types

Browse Source
This commit is contained in:
Gavin King 2023-07-16 19:10:37 +02:00
parent 0918791f47
commit 58aff00957
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/src/main/asciidoc/introduction/Generator.adoc
View File

@ -578,6 +578,16 @@ But when there's just one item in the `select` list, the type of that item shoul
String getBookTitleByIsbn(String isbn); String getBookTitleByIsbn(String isbn);
---- ----
A query which returns a selection list may have a query method which repackages the result as a record, as we saw in <<projection-lists>>.
[source,java]
----
record IsbnTitle(String isbn, String title) {}
@HQL("select isbn, title from Book")
List<IsbnTitle> listIsbnAndTitleForEachBook(Page page);
----
A query method might even return `TypedQuery` or `SelectionQuery`: A query method might even return `TypedQuery` or `SelectionQuery`:
[source,java] [source,java]
@ -625,6 +635,14 @@ List<Book> books =
// }) // })
// ---- // ----
An `insert`, `update`, or `delete` query must return `int` or `void`.
[source,java]
----
@HQL("delete from Book")
void deleteAllBooks();
----
On the other hand, finder methods are currently much more limited. On the other hand, finder methods are currently much more limited.
A finder method must return an entity type like `Book`, or a list of the entity type, `List<Book>`, for example. A finder method must return an entity type like `Book`, or a list of the entity type, `List<Book>`, for example.