org.springframework.data.jpa.repository

Annotation Type EntityGraph

@Retention(value=RUNTIME)
 @Target(value={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 via attributePaths() ad-hoc fetch-graph configuration.

Since:

1.6

Author:

Christoph Strobl If attributePaths() are specified then we ignore the entity-graph name value() and treat this EntityGraph as dynamic., Thomas Darimont

Optional Element Summary

Optional Elements

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

Element Detail

value

public abstract String value

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

Returns:

Default:

""

type

public abstract EntityGraph.EntityGraphType type

The Type of the EntityGraph to use, defaults to Type#FETCH.

Returns:

Default:

org.springframework.data.jpa.repository.EntityGraph.EntityGraphType.FETCH

attributePaths

public abstract 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:

{}