Example Queries
The following queries are from the Player entity of the roster
application, which is documented in
The roster Application.
The following topics are addressed here:
Simple Queries
If you are unfamiliar with the query language, these simple queries are a good place to start.
The following topics are addressed here:
A Basic Select Query
-
Data retrieved: All players.
-
Description: The
FROMclause declares an identification variable namedp, omitting the optional keywordAS. If theASkeyword were included, the clause would be written as follows:The
Playerelement is the abstract schema name of thePlayerentity. -
See also: Identification Variables.
Eliminating Duplicate Values
SELECT DISTINCT p
FROM Player p
WHERE p.position = ?1
-
Data retrieved: The players with the position specified by the query’s parameter.
-
Description: The
DISTINCTkeyword eliminates duplicate values.The
WHEREclause restricts the players retrieved by checking theirposition, a persistent field of thePlayerentity. The?1element denotes the input parameter of the query. -
See also: Input Parameters and The DISTINCT Keyword.
Using Named Parameters
SELECT DISTINCT p
FROM Player p
WHERE p.position = :position AND p.name = :name
-
Data retrieved: The players having the specified positions and names.
-
Description: The
positionandnameelements are persistent fields of thePlayerentity. TheWHEREclause compares the values of these fields with the named parameters of the query, set using theQuery.setNamedParametermethod. The query language denotes a named input parameter using a colon (:) followed by an identifier. The first input parameter is:position, the second is:name.
In the query language, an expression can traverse, or navigate, to related entities. These expressions are the primary difference between the Java Persistence query language and SQL. Queries navigates to related entities, whereas SQL joins tables.
The following topics are addressed here:
A Simple Query with Relationships
SELECT DISTINCT p
FROM Player p, IN (p.teams) t
-
Data retrieved: All players who belong to a team.
-
Description: The
FROMclause declares two identification variables:pandt. Thepvariable represents thePlayerentity, and thetvariable represents the relatedTeamentity. The declaration fortreferences the previously declaredpvariable. TheINkeyword signifies thatteamsis a collection of related entities. Thep.teamsexpression navigates from aPlayerto its relatedTeam. The period in thep.teamsexpression is the navigation operator.You may also use the
JOINstatement to write the same query:SELECT DISTINCT p FROM Player p JOIN p.teams tThis query could also be rewritten as:
SELECT DISTINCT p FROM Player p WHERE p.team IS NOT EMPTY
Navigating to Single-Valued Relationship Fields
Use the JOIN clause statement to navigate to a single-valued
relationship field:
SELECT t
FROM Team t JOIN t.league l
WHERE l.sport = 'soccer' OR l.sport ='football'
In this example, the query will return all teams that are in either soccer or football leagues.
Traversing Relationships with an Input Parameter
SELECT DISTINCT p
FROM Player p, IN (p.teams) AS t
WHERE t.city = :city
-
Data retrieved: The players whose teams belong to the specified city.
-
Description: This query is similar to the previous example but adds an input parameter. The
ASkeyword in theFROMclause is optional. In theWHEREclause, the period preceding the persistent variablecityis a delimiter, not a navigation operator. Strictly speaking, expressions can navigate to relationship fields (related entities) but not to persistent fields. To access a persistent field, an expression uses the period as a delimiter.Expressions cannot navigate beyond (or further qualify) relationship fields that are collections. In the syntax of an expression, a collection-valued field is a terminal symbol. Because the
teamsfield is a collection, theWHEREclause cannot specifyp.teams.city(an illegal expression). -
See also: Path Expressions.
Traversing Multiple Relationships
SELECT DISTINCT p
FROM Player p, IN (p.teams) t
WHERE t.league = :league
-
Data retrieved: The players who belong to the specified league.
-
Description: The expressions in this query navigate over two relationships. The
p.teamsexpression navigates thePlayer-Teamrelationship, and thet.leagueexpression navigates theTeam-Leaguerelationship.
In the other examples, the input parameters are String objects; in
this example, the parameter is an object whose type is a League. This
type matches the league relationship field in the comparison
expression of the WHERE clause.
SELECT DISTINCT p
FROM Player p, IN (p.teams) t
WHERE t.league.sport = :sport
-
Data retrieved: The players who participate in the specified sport.
-
Description: The
sportpersistent field belongs to theLeagueentity. To reach thesportfield, the query must first navigate from thePlayerentity toTeam(p.teams) and then fromTeamto theLeagueentity (t.league). Because it is not a collection, theleaguerelationship field can be followed by thesportpersistent field.
Queries with Other Conditional Expressions
Every WHERE clause must specify a conditional expression, of which
there are several kinds. In the previous examples, the conditional
expressions are comparison expressions that test for equality. The
following examples demonstrate some of the other kinds of conditional
expressions. For descriptions of all conditional expressions, see
WHERE Clause.
The following topics are addressed here:
The LIKE Expression
SELECT p
FROM Player p
WHERE p.name LIKE 'Mich%'
-
Data retrieved: All players whose names begin with "Mich."
-
Description: The
LIKEexpression uses wildcard characters to search for strings that match the wildcard pattern. In this case, the query uses theLIKEexpression and the%wildcard to find all players whose names begin with the string "Mich." For example, "Michael" and "Michelle" both match the wildcard pattern. -
See also: LIKE Expressions.
The IS NULL Expression
SELECT t
FROM Team t
WHERE t.league IS NULL
-
Data retrieved: All teams not associated with a league.
-
Description: The
IS NULLexpression can be used to check whether a relationship has been set between two entities. In this case, the query checks whether the teams are associated with any leagues and returns the teams that do not have a league. -
See also: NULL Comparison Expressions and NULL Values.
The IS EMPTY Expression
SELECT p
FROM Player p
WHERE p.teams IS EMPTY
-
Data retrieved: All players who do not belong to a team.
-
Description: The
teamsrelationship field of thePlayerentity is a collection. If a player does not belong to a team, theteamscollection is empty, and the conditional expression isTRUE. -
See also: Empty Collection Comparison Expressions.
The BETWEEN Expression
SELECT DISTINCT p
FROM Player p
WHERE p.salary BETWEEN :lowerSalary AND :higherSalary
-
Data retrieved: The players whose salaries fall within the range of the specified salaries.
-
Description: This
BETWEENexpression has three arithmetic expressions: a persistent field (p.salary) and the two input parameters (:lowerSalaryand:higherSalary). The following expression is equivalent to theBETWEENexpression:p.salary >= :lowerSalary AND p.salary <= :higherSalary -
See also: BETWEEN Expressions.
Comparison Operators
SELECT DISTINCT p1
FROM Player p1, Player p2
WHERE p1.salary > p2.salary AND p2.name = :name
-
Data retrieved: All players whose salaries are higher than the salary of the player with the specified name.
-
Description: The
FROMclause declares two identification variables (p1andp2) of the same type (Player). Two identification variables are needed because theWHEREclause compares the salary of one player (p2) with that of the other players (p1). -
See also: Identification Variables.
Bulk Updates and Deletes
The following examples show how to use the UPDATE and DELETE
expressions in queries. UPDATE and DELETE operate on multiple
entities according to the condition or conditions set in the WHERE
clause. The WHERE clause in UPDATE and DELETE queries follows the
same rules as SELECT queries.
The following topics are addressed here:
Update Queries
UPDATE Player p
SET p.status = 'inactive'
WHERE p.lastPlayed < :inactiveThresholdDate
-
Description: This query sets the status of a set of players to
inactiveif the player’s last game was longer ago than the date specified ininactiveThresholdDate.
Delete Queries
DELETE
FROM Player p
WHERE p.status = 'inactive'
AND p.teams IS EMPTY
-
Description: This query deletes all inactive players who are not on a team.