Package org.hibernate.annotations

Annotation Interface SQLSelect

@Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
public @interface SQLSelect

Specifies a custom SQL query to be used in place of the default SQL generated by Hibernate when an entity or collection is loaded from the database by id. This occurs when:

• an association to an entity is fetched lazily,
• a collection is fetched lazily, or
• when an entity is retrieved using Session.get(java.lang.Class<T>, java.lang.Object) or EntityManager.find(java.lang.Class<T>, java.lang.Object).

The given SQL statement must have exactly the number of JDBC ? parameters that Hibernate expects, that is, one for each column of:

1. the primary key, in the case of an entity, or
2. the foreign key, in the case of a collection.

Optionally, an explicit result set mapping may be specified. It should have:

1. a single EntityResult, if the SQL query loads an entity, one-to-many association, or many-to-many association, or
2. a single ColumnResult or ConstructorResult, if the SQL query loads an collection of basic-typed values.

Since:

6.2

See Also:

• HQLSelect
• DialectOverride.SQLSelect

Implementation Note:

This annotation is just an abbreviation for Loader together with NamedNativeQuery.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	sql	The SQL SELECT statement.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	querySpaces	The query spaces involved in this query.
SqlResultSetMapping	resultSetMapping	A SqlResultSetMapping with a single ColumnResult or EntityResult.

Element Details

sql

String sql

The SQL SELECT statement.

resultSetMapping

SqlResultSetMapping resultSetMapping

A SqlResultSetMapping with a single ColumnResult or EntityResult.

Default:

@jakarta.persistence.SqlResultSetMapping(name="")

querySpaces

String[] querySpaces

The query spaces involved in this query.

See Also:

• SynchronizeableQuery

Default:

{}