Class JpqlQueryBuilder

java.lang.Object

org.springframework.data.jpa.repository.query.JpqlQueryBuilder

public final class JpqlQueryBuilder
extends Object

A Domain-Specific Language to build JPQL queries using Java code.

Since:

4.0

Author:

Mark Paluch, Choi Wang Gyu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JpqlQueryBuilder.AbstractJpqlQuery	Abstract base class for JPQL queries.
static interface	JpqlQueryBuilder.AliasedExpression	Aliased expression.
static final class	JpqlQueryBuilder.Entity	The root entity.
static interface	JpqlQueryBuilder.Expression	Interface specifying an expression that can be rendered to String.
static final class	JpqlQueryBuilder.Join	A joined entity or element collection.
static interface	JpqlQueryBuilder.Origin	An origin that is used to select data from. selection origins are used with paths to define where a path is anchored.
static final record	JpqlQueryBuilder.ParameterPlaceholder	Value object capturing parameter placeholder.
static interface	JpqlQueryBuilder.PathExpression	Extension to JpqlQueryBuilder.Expression that contains a PropertyPath.
static interface	JpqlQueryBuilder.Predicate	WHERE predicate.
static interface	JpqlQueryBuilder.Renderable	Interface specifying a predicate or expression that can be rendered to String.
static class	JpqlQueryBuilder.RenderContext	Context used during rendering.
static class	JpqlQueryBuilder.Select	SELECT statement.
static interface	JpqlQueryBuilder.Selection
static interface	JpqlQueryBuilder.SelectStep	Fluent interface to build a JpqlQueryBuilder.Select.
static interface	JpqlQueryBuilder.WhereStep	Fluent interface to build a JpqlQueryBuilder.Predicate.

Method Summary

Modifier and Type	Method	Description
static @Nullable JpqlQueryBuilder.Predicate	and(List<JpqlQueryBuilder.Predicate> intermediate)
static JpqlQueryBuilder.Entity	entity(JpaEntityMetadata<?> from)	Create an JpqlQueryBuilder.Entity from the given JpaEntityMetadata.
static JpqlQueryBuilder.Expression	expression(String expression)	Create a simple expression from a string as-is.
static JpqlQueryBuilder.Expression	expression(JpqlQueryBuilder.Origin source, org.springframework.data.core.PropertyPath path)	Create a qualified expression for a PropertyPath.
static JpqlQueryBuilder.Expression	function(String function, JpqlQueryBuilder.Expression... arguments)	Invoke a function with the given arguments.
static JpqlQueryBuilder.Join	innerJoin(JpqlQueryBuilder.Origin origin, String path)	Create a INNER JOIN.
static JpqlQueryBuilder.Join	leftJoin(JpqlQueryBuilder.Origin origin, String path)	Create a LEFT JOIN.
static JpqlQueryBuilder.Expression	literal(Number literal)	Create a simple numeric literal.
static JpqlQueryBuilder.Expression	literal(String literal)	Create a simple literal from a string by quoting it.
static JpqlQueryBuilder.Predicate	nested(JpqlQueryBuilder.Predicate predicate)	Nest the given JpqlQueryBuilder.Predicate.
static @Nullable JpqlQueryBuilder.Predicate	or(List<JpqlQueryBuilder.Predicate> intermediate)
static JpqlQueryBuilder.Expression	orderBy(JpqlQueryBuilder.Expression sortExpression)	Create a new ordering expression.
static JpqlQueryBuilder.Expression	orderBy(JpqlQueryBuilder.Expression sortExpression, Sort.Direction direction)	Create a new ordering expression.
static JpqlQueryBuilder.Expression	orderBy(JpqlQueryBuilder.Expression sortExpression, Sort.Order order)	Create a new ordering expression.
static JpqlQueryBuilder.Expression	parameter(String parameter)	A parameter placeholder.
static JpqlQueryBuilder.Expression	parameter(JpqlQueryBuilder.ParameterPlaceholder placeholder)	A parameter placeholder.
static JpqlQueryBuilder.SelectStep	selectFrom(JpqlQueryBuilder.Entity from)	Start building a JpqlQueryBuilder.Select statement by selecting from.
static JpqlQueryBuilder.WhereStep	where(JpqlQueryBuilder.Expression rhs)	Start building a WHERE predicate by providing the right-hand side.
static JpqlQueryBuilder.WhereStep	where(JpqlQueryBuilder.Origin source, org.springframework.data.core.PropertyPath path)	Start building a WHERE predicate by providing the right-hand side.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

entity

public static JpqlQueryBuilder.Entity entity(JpaEntityMetadata<?> from)

Create an JpqlQueryBuilder.Entity from the given JpaEntityMetadata.

Parameters:

from - the entity type to select from.

Returns:

innerJoin

public static JpqlQueryBuilder.Join innerJoin(JpqlQueryBuilder.Origin origin,
 String path)

Create a INNER JOIN.

Parameters:

origin - the selection origin (a join or the entity itself) to select from.

path -

Returns:

leftJoin

public static JpqlQueryBuilder.Join leftJoin(JpqlQueryBuilder.Origin origin,
 String path)

Create a LEFT JOIN.

Parameters:

origin - the selection origin (a join or the entity itself) to select from.

path -

Returns:

selectFrom

public static JpqlQueryBuilder.SelectStep selectFrom(JpqlQueryBuilder.Entity from)

Start building a JpqlQueryBuilder.Select statement by selecting from.

Parameters:

from - the entity source to select from.

Returns:

a new select builder.

function

public static JpqlQueryBuilder.Expression function(String function,
 JpqlQueryBuilder.Expression... arguments)

Invoke a function with the given arguments.

Parameters:

function - function name.

arguments - function arguments.

Returns:

an expression representing a function call.

nested

public static JpqlQueryBuilder.Predicate nested(JpqlQueryBuilder.Predicate predicate)

Nest the given JpqlQueryBuilder.Predicate.

Parameters:

predicate -

Returns:

expression

public static JpqlQueryBuilder.Expression expression(JpqlQueryBuilder.Origin source,
 org.springframework.data.core.PropertyPath path)

Create a qualified expression for a PropertyPath.

Parameters:

source -

path -

Returns:

expression

public static JpqlQueryBuilder.Expression expression(String expression)

Create a simple expression from a string as-is.

Parameters:

expression -

Returns:

literal

public static JpqlQueryBuilder.Expression literal(Number literal)

Create a simple numeric literal.

Parameters:

literal -

Returns:

literal

public static JpqlQueryBuilder.Expression literal(String literal)

Create a simple literal from a string by quoting it.

Parameters:

literal -

Returns:

parameter

public static JpqlQueryBuilder.Expression parameter(String parameter)

A parameter placeholder.

Parameters:

parameter -

Returns:

parameter

public static JpqlQueryBuilder.Expression parameter(JpqlQueryBuilder.ParameterPlaceholder placeholder)

A parameter placeholder.

Parameters:

placeholder - the placeholder to use.

Returns:

orderBy

public static JpqlQueryBuilder.Expression orderBy(JpqlQueryBuilder.Expression sortExpression)

Create a new ordering expression.

Parameters:

sortExpression -

Returns:

Since:

4.0

orderBy

public static JpqlQueryBuilder.Expression orderBy(JpqlQueryBuilder.Expression sortExpression,
 Sort.Order order)

Create a new ordering expression.

Parameters:

sortExpression -

order -

Returns:

orderBy

public static JpqlQueryBuilder.Expression orderBy(JpqlQueryBuilder.Expression sortExpression,
 Sort.Direction direction)

Create a new ordering expression.

Parameters:

sortExpression -

direction -

Returns:

Since:

4.0

where

public static JpqlQueryBuilder.WhereStep where(JpqlQueryBuilder.Origin source,
 org.springframework.data.core.PropertyPath path)

Start building a WHERE predicate by providing the right-hand side.

Parameters:

source -

path -

Returns:

where

public static JpqlQueryBuilder.WhereStep where(JpqlQueryBuilder.Expression rhs)

Start building a WHERE predicate by providing the right-hand side.

Parameters:

rhs -

Returns:

and

public static @Nullable JpqlQueryBuilder.Predicate and(List<JpqlQueryBuilder.Predicate> intermediate)

or

public static @Nullable JpqlQueryBuilder.Predicate or(List<JpqlQueryBuilder.Predicate> intermediate)