document explicitly that filter restrictions are written in SQL

Signed-off-by: Gavin King <gavin@hibernate.org>
This commit is contained in:
Gavin King 2024-09-05 23:10:06 +02:00
parent 35f96d6e90
commit a7c3e9a4e9
1 changed files with 2 additions and 0 deletions

View File

@ -46,6 +46,8 @@ _Typically_, but not necessarily, a `@FilterDef` specifies a default restriction
package org.hibernate.example; package org.hibernate.example;
---- ----
Note that filter restrictions are always written in the native SQL dialect of the database, _not_ in HQL.
The restriction must contain a reference to the parameter of the filter, specified using the usual syntax for named parameters. The restriction must contain a reference to the parameter of the filter, specified using the usual syntax for named parameters.
Any entity or collection which is affected by a filter must be annotated link:{doc-javadoc-url}org/hibernate/annotations/Filter.html[`@Filter`]: Any entity or collection which is affected by a filter must be annotated link:{doc-javadoc-url}org/hibernate/annotations/Filter.html[`@Filter`]: