Package org.springframework.data.jpa.repository

Annotation Interface EntityGraph

@Retention(RUNTIME)
@Target({METHOD,ANNOTATION_TYPE})
@Documented
public @interface EntityGraph

Annotation to configure the JPA 2.1 EntityGraphs that should be used on repository methods. Since 1.9 we support the definition of dynamic EntityGraphs by allowing to customize the fetch-graph via attributePaths() ad-hoc fetch-graph configuration. If attributePaths() are specified then we ignore the entity-graph name value() and treat this EntityGraph as dynamic.

Since:

1.6

Author:

Christoph Strobl, Thomas Darimont, Oerd Cukalla

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityGraph.EntityGraphType	Enum for JPA 2.1 EntityGraph types.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	attributePaths	The paths of attributes of this EntityGraph to use, empty by default.
EntityGraph.EntityGraphType	type	The EntityGraph.EntityGraphType of the EntityGraph to use, defaults to EntityGraph.EntityGraphType.FETCH.
String	value	The name of the EntityGraph to use.

Element Details

value

String value

The name of the EntityGraph to use. If empty we fall-back to JpaQueryMethod.getNamedQueryName() as the value.

Returns:

Default:

""

type

EntityGraph.EntityGraphType type

The EntityGraph.EntityGraphType of the EntityGraph to use, defaults to EntityGraph.EntityGraphType.FETCH.

Returns:

Default:

FETCH

attributePaths

String[] attributePaths

The paths of attributes of this EntityGraph to use, empty by default. You can refer to direct properties of the entity or nested properties via a property.nestedProperty.

Returns:

Since:

1.9

Default:

{}