EclipseLink/UserGuide/JPA/Basic JPA Development/Querying/Native

EclipseLink JPA

• EclipseLink Destinations:
• Documentation
• FAQ
• Examples
• Development

Key API

• SqlResultSetMapping
• SqlResultSetMappings
• EntityResult
• FieldResult
• ColumnResult

Native API

• SQLCall

Native SQL Queries

JPA allows SQL to be used for querying entity objects, or data. SQL queries are not translated, and passed directly to the database. SQL queries can be used for advanced queries that require database specific syntax, or by users who are more comfortable in the SQL language than JPQL or Java.

SQL queries are created from the EntityManager using the createNativeQuery API or via named queries. A Query object is returned and executed the same as any other JPA query. An SQL query can be created for an entity class, or return an object array of data. If returning entities, the SQL query must return the correct column names that the entity's mappings expect, or an SqlResultSetMapping can be used. An SqlResultSetMapping allows for the SQL result set to be mapped to an entity, or set of entities and data.

SQL queries can be used to execute SQL or DML, for SQL queries that return results, getSingleResult or getResultList can be used, for SQL queries that do not return results, executeUpdate must be used. executeUpdate can only be used within a transaction. SQL queries can be used to execute database operations and some stored procedures and functions. Stored prcoedures that return output parameters, or certain complex stored procedures, cannot be execute with SQL queries. EclipseLink supports stored procedures through stored procedure queries, for more information see Stored Procedures.

Query settings and query hints that affect the generated SQL are not supported with SQL queries. Unsupported query hints include:

• eclipselink.batch
• eclipselink.history.as-of
• eclipselink.inheritance.outer-join
• eclipselink.sql.hint
• eclipselink.join-fetch - join-fetch is supported, but requires that the SQL select all of the joined columns.
• eclipselink.fetch-group - fetch-group is supported, but requires that the SQL select all of the fetched columns.
• eclipselink.pessimistic-lock - pessimistic-lock is supported, but requires that the SQL lock the result rows.

Native SQL query examples

Query query = em.createNativeQuery("SELECT * FROM EMPLOYEE", Employee.class);
List<Employee> result = query.getResultList();

Query query = em.createNativeQuery("SELECT SYSDATE FROM DUAL");
Date result = (Date)query.getSingleResult();

Query query = em.createNativeQuery("SELECT MAX(SALARY), MIN(SALARY) FROM EMPLOYEE");
List<Object[]> results = query.getResultList();
int max = results.get(0)[0];
int min = results.get(0)[1];

Query query = em.createNativeQuery("DELETE FROM EMPLOYEE");
int rowCount = query.executeUpdate();

Parameters

Parameters to SQL queries are delimited using the ? character. Only indexed parameters are supported, named parameters are not supported. The index can be used in the delimiter, i.e. ?1. Parameter values are set on the Query using the setParameter API. Indexed parameters start at the index 1 not 0.

Native SQL query parameter example

Query query = em.createNativeQuery("SELECT * FROM EMPLOYEE WHERE F_NAME = ? AND L_NAME = ?", Employee.class);
query.setParameter(1, "Bob");
query.setParameter(2, "Smith");
List<Employee> result = query.getResultList();

Named Native SQL Queries

Native SQL queries can be defined as named queries in annotations or XML using the NamedNativeQuery annotation or <named-native-query> XML element. Named native SQL queries are executed the same as any named query.

NamedNativeQuery example

@NamedNativeQuery(name="findEmployeesByName", query="SELECT * FROM EMPLOYEE WHERE F_NAME = ? AND L_NAME = ?", resultClass=Employee.class)
@Entity
public class Employee {
  ...
}

Query query = em.createNamedQuery("findEmployeesByName");
query.setParameter(1, "Bob");
query.setParameter(2, "Smith");
List<Employee> result = query.getResultList();

SQL Result Set Mapping

An SqlResultSetMapping can be used to map the results of an SQL query to an entity if the result column names do not match what the entity mappings expect. It can also be used to return multiple entities, or entities and data from a single SQL query. EntityResult and FieldResult are used to map the SQL query result column to the entity attribute. ColumnResult can be used to add a data element to the result.

SqlResultSetMappings are defined through annotations or XML using the @SqlResultSetMapping annotation or <sql-result-set-mapping> XML element. They are referenced from native SQL queries by name.

SqlResultSetMapping example

@SqlResultSetMapping(
  name="archive-map"
  entities={
    @EntityResult(
      entityClass=Employee.class,
      fields={
        @FieldResult(name="id", column="ARCHIVE_ID"),
        @FieldResult(name="firstName", column="ARCHIVE_F_NAME"),
        @FieldResult(name="lastName", column="ARCHIVE_L_NAME")
  }
)
@NamedNativeQuery(name="findArchivedEmployees", query="SELECT * FROM ARCHIVE_EMPLOYEE", resultSetMapping="archive-map")
@Entity
public class Employee {
 
   ...
	@Column(name="first_name")
	protected String firstName;
 
	@Column(name="last_name")
	protected String lastName;
  ...
}

Version: 2.4 DRAFT
Other versions...

Criteria API	Querying	Query Hints
EclipseLink Home JPA User Guide: Table of Contents, Search
How to contribute to this guide...